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. customizeCell
    13. customizeContextMenu
    14. dispose
    15. expandAllData
    16. expandData
    17. exportTo
    18. getAllConditions
    19. getAllHierarchies
    20. getAllMeasures
    21. getCell
    22. getColumns
    23. getCondition
    24. getFilter
    25. getFormat
    26. getMeasures
    27. getMembers
    28. getOptions
    29. getReport
    30. getReportFilters
    31. getRows
    32. getSelectedCell
    33. getSort
    34. getXMLACatalogs
    35. getXMLACubes
    36. getXMLADataSources
    37. getXMLAProviderName
    38. load
    39. off
    40. on
    41. open
    42. openCalculatedValueEditor
    43. openFieldsList
    44. openFilter
    45. print
    46. refresh
    47. removeAllCalculatedMeasures
    48. removeAllConditions
    49. removeCalculatedMeasure
    50. removeCondition
    51. removeSelection
    52. runQuery
    53. save
    54. setFilter
    55. setFormat
    56. setOptions
    57. setReport
    58. setSort
    59. showCharts
    60. showGrid
    61. showGridAndCharts
    62. sortingMethod
    63. sortValues
    64. 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. exportcomplete
    14. exportstart
    15. fieldslistclose
    16. fieldslistopen
    17. filterclose
    18. filteropen
    19. loadingdata
    20. loadinglocalization
    21. loadingolapstructure
    22. loadingreportfile
    23. localizationerror
    24. localizationloaded
    25. olapstructureerror
    26. olapstructureloaded
    27. openingreportfile
    28. printcomplete
    29. printstart
    30. querycomplete
    31. queryerror
    32. ready
    33. reportchange
    34. reportcomplete
    35. reportfilecancelled
    36. reportfileerror
    37. runningquery
    38. update
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 from the CSV, JSON, and OLAP 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 – 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 – the hierarchy caption.
  • hierarchy – 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 – 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 – 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 – the dimension unique name. This property can be used to group several fields under one dimension. Only for "csv" and "json" data sources.
  • dimensionCaption – 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.