Get Free Trial
Contact us 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. Table Sizes Object
    11. Cell Data Object
    12. Chart Data Object
    13. Toolbar Object
    14. Chart Legend Data Object
    15. Share Report Connection 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. customizeChartElement
    15. customizeContextMenu
    16. dispose
    17. expandAllData
    18. expandData
    19. exportTo
    20. getAllConditions
    21. getAllHierarchies
    22. getAllHierarchiesAsync
    23. getAllMeasures
    24. getAllMeasuresAsync
    25. getCell
    26. getColumns
    27. getColumnsAsync
    28. getCondition
    29. getFilter
    30. getFlatSort
    31. getFormat
    32. getMeasures
    33. getMeasuresAsync
    34. getMembers
    35. getMembersAsync
    36. getOptions
    37. getReport
    38. getReportFilters
    39. getReportFiltersAsync
    40. getRows
    41. getRowsAsync
    42. getSelectedCell
    43. getSort
    44. getTableSizes
    45. getXMLACatalogs
    46. getXMLACatalogsAsync
    47. getXMLACubes
    48. getXMLACubesAsync
    49. getXMLADataSources
    50. getXMLADataSourcesAsync
    51. getXMLAProviderName
    52. getXMLAProviderNameAsync
    53. load
    54. off
    55. on
    56. open
    57. openCalculatedValueEditor
    58. openFieldsList
    59. openFilter
    60. print
    61. refresh
    62. removeAllCalculatedMeasures
    63. removeAllConditions
    64. removeCalculatedMeasure
    65. removeCondition
    66. removeSelection
    67. runQuery
    68. save
    69. scrollToColumn
    70. scrollToRow
    71. setFilter
    72. setFlatSort
    73. setFormat
    74. setOptions
    75. setReport
    76. setSort
    77. setTableSizes
    78. shareReport
    79. showCharts
    80. showGrid
    81. showGridAndCharts
    82. sortingMethod
    83. sortValues
    84. 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. unauthorizederror
    41. update
  5. Custom data source API
    1. All requests
    2. /handshake request
    3. /fields request
    4. /members request
    5. /select request for the pivot table
    6. /select request for the flat table
    7. /select request for the drill-through view
    8. Field Object
    9. Filter Object
    10. Filter Group Object
  6. MongoDB Connector API
    1. All methods
    2. getSchema
    3. getMembers
    4. getSelectResult
  7. Flexmonster Connector for amCharts
    1. All methods
    2. amcharts.getData
    3. amcharts.getCategoryName
    4. amcharts.getMeasureNameByIndex
    5. amcharts.getNumberOfMeasures
    6. amcharts.getNumberFormatPattern
Table of contents

Data Source Object

The data source is a required part of the report object. Flexmonster supports data from OLAP data sources, Elasticsearch, SQL databases, MongoDB databases, the custom data source API, CSV and JSON static files, and inline JSON data. Each data source requires specific properties to be set inside the dataSource section of the report object. Here is a list of all available properties for a dataSource:

  • mapping (optional) – Mapping Object | String. Allows defining field data types, captions, multilevel hierarchies, grouping fields under separate dimensions, and setting other view configurations of hierarchies. It can be either the inline Mapping Object or the URL to a JSON file with mapping. See an example on JSFiddle.
  • binary (optional) – Boolean. Flag to use Data Speed Accelerator instead of XMLA protocol. Only for "microsoft analysis services" and "mondrian" data source types.
  • browseForFile (optional) – Boolean. Only for "csv" and "json" data source types. Defines whether you want to load a file from the local file system (true) or not (false). Default value: false.
  • catalog (optional) – String. The data source catalog name of the OLAP data source. Only for "microsoft analysis services" and "mondrian" data source types.
  • cube (optional) – String. The given catalog’s cube’s name of the OLAP data source. Only for "microsoft analysis services" and "mondrian" data source types.
  • data (optional) – JSON. A property to set JSON data if it is already on the page.
  • dataSourceInfo (optional) – String. The service info of the OLAP data source. Only for "microsoft analysis services" and "mondrian" data source types.
  • type (optional) – String. Type of data source. The component supports the following types: "json", "csv", "api", "microsoft analysis services", "elasticsearch", and "mondrian".
  • effectiveUserName (optional) – String. Use when an end-user identity must be impersonated on the server. Specify the account in a domain\user format. Only for "microsoft analysis services" data source type.
  • fieldSeparator (optional) – String. Defines the specific fields separator to split each CSV row. There is no need to define it if the CSV fields are separated by , or ;. This property is required only if another character separates fields.
    For example, if you use TSV, where a tab character is used to separate fields, then the fieldSeparator parameter should be set to "\t".
    Alternatively, you can specify the field separator in the CSV file’s first row using the sep prefix. Supported prefix formats are the following: sep=fieldSep and "sep=fieldSep". For example:
    sep=|
    Country|Color|Price
    Canada|blue|1000
    Only for the "csv" data source type.
  • thousandsSeparator (optional) – String. Defines the specific character used to separate groups of digits in numbers. For example, if commas separate groups of digits in numbers (e.g., 1,000 for one thousand), set thousandsSeparator to ",". Only for the "csv" data source type.
  • filename (optional) – String. The URL to CSV or JSON file or a server-side script that generates CSV data or JSON data. Only for "csv" and "json" data source type.
  • ignoreQuotedLineBreaks (optional) – Boolean. Indicates whether the line breaks in quotes will be ignored (true) in CSV files or not (false). When set to true, CSV parsing is faster. Set it to false only if your data source has valuable for you line breaks in quotes. Please note that this might slow down CSV parsing a little bit. Default value: true.
  • localeIdentifier (optional) – Number. Microsoft Locale ID Value for your language. Only for "microsoft analysis services" data source type.
  • proxyUrl (optional) – String. The path to proxy URL to the OLAP data source, such as Microsoft Analysis Services, Mondrian. Only for "microsoft analysis services" and "mondrian" data source types. In the case of Microsoft Analysis Services, both tabular and multidimensional model types are supported.
  • url (optional) – String. The path to the API endpoints. Only for "api" data source type.
  • roles (optional) – String. Comma-delimited list of predefined roles to connect to a server or database using permissions conveyed by that role. If this property is omitted, all roles are used, and the effective permissions are the combination of all roles. Supported only for "microsoft analysis services" and "mondrian" data source types.
  • subquery (optional) – String | Object. The parameter to set the server-side filter, which helps decrease the size of the server’s response. Only for "microsoft analysis services" and "elasticsearch" data source types.
    For "microsoft analysis services" data source type should be set as a string. Example: to show reports only for one specific year, set subquery the following way: "subquery": "select {[Delivery Date].[Calendar].[Calendar Year].&[2008]} on columns from [Adventure Works]". See an example on JSFiddle.
    For "elasticsearch" data source type should be set as a Bool Query Object. See an example on JSFiddle.
  • requestHeaders (optional) – Object. For all data sources. This object allows you to add custom request headers. This object consists of "key": "value" pairs, where "key" is a header name and "value" is its value. Check out a live sample on JSFiddle. Important note: requestHeaders is not saved when obtaining the report via save() and getReport() API calls.
  • singleEndpoint – Boolean. When set to true, all custom data source API requests are sent to a single endpoint specified in the url property. Only for the "api" data source type. Default value: false.
  • node (optional) – String. The URL string for the connection. Only for "elasticsearch" data source type.
  • index (optional) – String. The name of the Elasticsearch index to connect or the dataset identifier for the custom data source API. Only for "elasticsearch" and "api" data source types.
  • useStreamLoader (optional) – Boolean. Optimizes the large file processing using the stream loader. When set to true, the stream loader is enabled. Available only when loading JSON files via URL. See an example on JSFiddle. Default value: false.
  • withCredentials (optional) – Boolean. It indicates whether cross-site Access-Control requests should be made using credentials such as authorization headers (true) or not (false). For more details, refer to MDN web docs.
    Setting the withCredentials flag to true is recommended when using Windows authentication and other types of server authentications. When set to false, the browser does not request credentials and does not include them into outgoing requests. Not supported for the "mondrian" data source type. Default value: false.

The API calls connectTo(), updateData(), load(), and open() are used to change the data source at runtime. The API call save() is used to save the report.

Find more details about Data Source Object in this tutorial with examples.