This object allows setting the mapping for a specific field from the dataset.
<uniqueName>: { caption: string, type: string, hierarchy: string, parent: string, folder: string, aggregations: string[], filters: boolean, visible: boolean, showEmptyValues: boolean, interval: string, calendar_interval: string, fixed_interval: string, isMeasure: boolean, time_zone: string, format: string, min_doc_count: number }
Property/Type | Description |
---|---|
caption String |
optional The field’s caption. |
type String |
optional The field’s data type. Only for "json" , "csv" , and "api" data source types. The type can be:
|
hierarchy String |
optional The hierarchy’s name. When configuring hierarchies, specify this property to mark the field as a level of a hierarchy or as a member property of a hierarchy (in this case, the type parameter should be set to "property" ). Only for "json" , "csv" , and "api" data source types.See how to configure multilevel hierarchies. |
parent String |
optional The unique name of the parent level. This property is necessary if the field is a level of a hierarchy and has a parent level. Only for "json" , "csv" , and "api" data source types.See how to configure multilevel hierarchies. |
folder String |
optional The field’s folder. Folders are used to group several fields in the Field List. folder supports nesting via / (e.g., "Folder/Subfolder/" ).Only for "json" , "csv" , and "api" data source types. |
aggregations String[] |
optional This property represents the list of aggregation functions that can be applied to the current measure. For "csv" and "json" data source types, you can also define available aggregations for all fields of a certain type. |
filters Boolean |
optional This property allows enabling and disabling the UI filters for a specific hierarchy. When set to false , the UI filters are disabled.Default value: true .
|
visible Boolean |
optional When set to false , hides the field from the Field List. |
showEmptyValues Boolean |
optional Indicates whether to show the field's members with empty values (true ) or not (false ).To configure this behavior for all fields in rows or columns, use the options.showEmptyValues property. Only for "json" , "csv" , and "api" data source types.Note that for the "api" data source type, this property has usage specifics for multilevel hierarchies:
false . |
interval String |
optional Allows rounding down dates by the given interval. For example, if the interval is "1d" , 2021-05-25T21:30:00 will be rounded to 2021-05-25T00:00:00 . See an example on JSFiddle.The interval property can be used in the following ways:
|
calendar_interval String |
optional Sets the Elasticsearch’s calendar_interval parameter for the date histogram. This parameter allows rounding down dates by the given interval. For example, if the calendar_interval is "day" , 2021-05-25T19:30:00 will be rounded to 2021-05-25T00:00:00 . See an example on JSFiddle.See the list of supported intervals: Calendar intervals. Only for Elasticsearch version 7.2 and higher. Default value: "day" .
|
fixed_interval String |
optional Sets the Elasticsearch’s fixed_interval parameter for the date histogram. This parameter allows rounding down dates by the given interval. For example, if the fixed_interval is "3h" , 2021-05-25T19:30:00 will be rounded to 2021-05-25T18:00:00 . See an example on JSFiddle.See the list of supported intervals: Fixed intervals. Only for Elasticsearch version 7.2 and higher. |
isMeasure Boolean |
optional When set to true , the field can be selected only as a measure. The isMeasure property should be used only with the strictDataTypes option (see an example on JSFiddle). Only for the "json" data source type.Default value: false .
|
time_zone String |
optional Used for the date histogram. You can specify time zones as either an ISO 8601 UTC offset (e.g., +01:00 or -08:00 ) or as a time zone ID as specified in the IANA time zone database, such as America/Los_Angeles . Check out an example here.Only for the "elasticsearch" data source type. |
format String |
optional Used to format different types of date fields. The format can be used in the following ways:
|
min_doc_count Number |
optional Used for the Elasticsearch date histogram. Can be used to show intervals with empty values (min_doc_count: 0 ).Only for the "elasticsearch" data source type.Default value: 1 (empty intervals are hidden). |
Here is an example of setting the mapping for specific fields in a CSV data source:
dataSource: { filename: "data.csv", mapping: { "Order ID": { type: "string" }, "Month": { type: "month" }, "Company Name": { type: "string" }, "Region": { type: "string", hierarchy: "Geography" }, "State": { type: "string", parent: "Region", hierarchy: "Geography" }, "City": { type: "string", parent: "State", hierarchy: "Geography" }, // Mapping for other fields }, }
See the full code on JSFiddle.