The Mapping Object allows defining field data types, captions, and multi-level hierarchies; grouping fields under separate dimensions and setting other view configurations of hierarchies.

The Mapping Object is available for all data sources. It presents a powerful way to neatly separate a data source from its presentation.

For each field in the data source, you can set the following properties:

• type – String. The data type. Can be:
  • "string" – the field stores string data. It can be aggregated only with count and distinctcount aggregations. Only for "csv" and "json" data sources.
  • "number" – the field stores numerical data. It can be aggregated with all the available aggregations. Only for "csv" and "json" data sources.
  • "level" – the field is a level of the hierarchy. This type is used together with other properties such as hierarchy, level and parent. Only for "csv" and "json" data sources.
  • "month" – the field stores months. Only for "csv" and "json" data sources.
  • "weekday" – the field stores days of the week. Only for "csv" and "json" data sources.
  • "date" – the field stores a date. The field of this type is split into 3 different fields: Year, Month, Day. Only for "csv" and "json" data sources.
  • "date string" – the field stores a date. It can be formatted using the datePattern option (default is "dd/MM/yyyy"). Only for "csv" and "json" data sources.
  • "year/month/day" – the field stores a date. It’s displayed as a multi-level hierarchy with the following levels: Year > Month > Day. Only for "csv" and "json" data sources.
  • "year/quarter/month/day" – the field is a date. It’s displayed as a multi-level hierarchy with the following levels: Year > Quarter > Month > Day. Only for "csv" and "json" data sources.
  • "time" – the field stores time. It can be formatted using the timePattern option (default is "HH:mm:ss"). Only for "csv" and "json" data sources.
  • "datetime" – the field is a date. It can be formatted using the dateTimePattern option (default is "dd/MM/yyyy HH:mm:ss"). min, max, count, and distinctcount aggregations can be applied to it. Only for "csv" and "json" data sources.
  • "id" – the field is an id. The field of this type can be used for editing data. It’s not shown in the Field List. Only for "csv" and "json" data sources.
  • "hidden" – the field is hidden. The field of this type is not shown in the Field List. Only for "csv" and "json" data sources.
  • "property" – the field for setting member properties. This field is not shown in the Field List. For example, it can be used to associate a productID with a product. Only for a "json" data source. See the example.
• caption – String. The hierarchy caption.
• hierarchy – String. The hierarchy name. This property is necessary to specify only if the field is a level of a hierarchy ("type": "level") or if the field is a member property of a hierarchy ("type": "property"). Only for "csv" and "json" data sources.
• level – String. The level caption. This property can be specified only if the field is a level of hierarchy ("type": "level"). Only for "csv" and "json" data sources.
• parent – String. The unique name of the parent level. This property can be specified only if the field is a level of hierarchy ("type": "level"). Only for "csv" and "json" data sources.
• dimensionUniqueName – String. The dimension unique name. This property can be used to group several fields under one dimension. Only for "csv" and "json" data sources.
• dimensionCaption – String. The dimension caption. This property specifies the name of a folder in the Field List under which several fields are grouped. Only for "csv" and "json" data sources.
• aggregations (optional) — Array of strings. It represents the list of aggregation functions that can be applied to the current measure. If it is a calculated measure, the list is [].
• visible (optional) – Boolean. When set as false, hides the field from the Field List. Only for "elasticsearch" and "api" data source types.
• interval (optional) – String. Used for date histogram. Only for "elasticsearch" data source type. Check out supported time units.
• time_zone (optional) – String. Used for date histogram. You can specify timezones as either an ISO 8601 UTC offset (e.g. +01:00 or -08:00) or as a timezone ID as specified in the IANA timezone database, such as `America/Los_Angeles`. Only for "elasticsearch" data source type. Check out the example.
• format (optional) – String. Used for date histogram. Only for "elasticsearch" data source type. Check out the date format/pattern.
• min_doc_count (optional) – Number. Only for "elasticsearch" data source type. Used for date histogram. Can be used to show intervals with empty values (min_doc_count: 0). Default value: 1 (empty intervals are hidden).

Find more details about Mapping Object in this turorial with examples.