Dear visitor, despite the COVID-19 outbreak, our team continues operating at full speed.

Also, here is the form where you can apply for a special discount and we will contact you with possible options. Stay safe and continue achieving your business goals.

Fill the form
Get Free Trial
Get Free Trial
  1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. Report Object
    3. Data Source Object
    4. Mapping Object
    5. Slice Object
    6. Options Object
    7. Filtering
      1. Filter Object
      2. Number Query Object
      3. String Query Object
      4. Date Query Object
      5. Time Query Object
      6. Value Query Object
    8. Format Object
    9. Conditional Format Object
    10. Cell Data Object
    11. Chart Data Object
    12. Toolbar Object
  3. Methods
    1. All methods
    2. addCalculatedMeasure
    3. addCondition
    4. alert
    5. clear
    6. clearFilter
    7. clearXMLACache
    8. closeFieldsList
    9. collapseAllData
    10. collapseData
    11. connectTo
    12. customizeAPIRequest
    13. customizeCell
    14. customizeContextMenu
    15. dispose
    16. expandAllData
    17. expandData
    18. exportTo
    19. getAllConditions
    20. getAllHierarchies
    21. getAllMeasures
    22. getCell
    23. getColumns
    24. getCondition
    25. getFilter
    26. getFlatSort
    27. getFormat
    28. getMeasures
    29. getMembers
    30. getOptions
    31. getReport
    32. getReportFilters
    33. getRows
    34. getSelectedCell
    35. getSort
    36. getXMLACatalogs
    37. getXMLACubes
    38. getXMLADataSources
    39. getXMLAProviderName
    40. load
    41. off
    42. on
    43. open
    44. openCalculatedValueEditor
    45. openFieldsList
    46. openFilter
    47. print
    48. refresh
    49. removeAllCalculatedMeasures
    50. removeAllConditions
    51. removeCalculatedMeasure
    52. removeCondition
    53. removeSelection
    54. runQuery
    55. save
    56. setFilter
    57. setFlatSort
    58. setFormat
    59. setOptions
    60. setReport
    61. setSort
    62. showCharts
    63. showGrid
    64. showGridAndCharts
    65. sortingMethod
    66. sortValues
    67. updateData
  4. Events
    1. All events
    2. afterchartdraw
    3. aftergriddraw
    4. beforegriddraw
    5. beforetoolbarcreated
    6. cellclick
    7. celldoubleclick
    8. chartclick
    9. datachanged
    10. dataerror
    11. datafilecancelled
    12. dataloaded
    13. drillthroughclose
    14. drillthroughopen
    15. exportcomplete
    16. exportstart
    17. fieldslistclose
    18. fieldslistopen
    19. filterclose
    20. filteropen
    21. loadingdata
    22. loadinglocalization
    23. loadingolapstructure
    24. loadingreportfile
    25. localizationerror
    26. localizationloaded
    27. olapstructureerror
    28. olapstructureloaded
    29. openingreportfile
    30. printcomplete
    31. printstart
    32. querycomplete
    33. queryerror
    34. ready
    35. reportchange
    36. reportcomplete
    37. reportfilecancelled
    38. reportfileerror
    39. runningquery
    40. update
  5. Custom data source API requests
    1. All requests
    2. /handshake request
    3. /fields request
    4. /members request
    5. /select request for pivot table
    6. /select request for flat table
    7. /select request for drill-through view
    8. Field Object
  6. MongoDB Connector API
    1. All methods
    2. getSchema
    3. getMembers
    4. getSelectResult
Table of contents

Mapping Object

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.