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

Data Source Object

The data source is a required part of the report object. Flexmonster supports data from OLAP data sources, Elasticsearch, SQL databases, 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:

  • binary (optional) – Boolean. Flag to use Data Speed Accelerator instead of XMLA protocol. Only for MSAS and Mondrian data sources.
  • browseForFile (optional) – Boolean. Defines whether you want to load CSV file from the local file system (true) or not (false). Default value is false. Only for CSV and JSON data sources.
  • catalog (optional) – String. The data source catalog name of the OLAP data source (only for "microsoft analysis services", "mondrian" data source types).
  • cube (optional) – String. Given catalog’s cube’s name of the OLAP data source (only for "microsoft analysis services", "mondrian" data source types).
  • data (optional) – 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", "mondrian" data source types).
  • type (optional) – String. Type of data source. The component supports the following types: "microsoft analysis services", "mondrian", "elasticsearch", "csv", and "json".
  • 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 specific fields separator to split CSV row (only for CSV data source type). There is no need to define it if CSV fields are separated by , or ;. This property is used if another char separates fields. For example, if you use TSV, where tab char is used to separate fields in row, fieldSeparator parameter should be defined as "\t".
  • thousandSeparator (optional) – String. Defines specific character used to separate groups of digits in numbers. For example, to import CSV data with commas used to separate groups of digits in numbers (e.g. 1,000 for one thousand), set thousandSeparator parameter as ",".
  • filename (optional) – String. The URL to CSV or JSON file or to server-side script which 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). Default value is true, which makes CSV parsing 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.
  • 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", "mondrian" data source types). In case of Microsoft Analysis Services, both tabular and multidimensional model types are supported.
  • recordsetDelimiter (optional) – String. Defines which char is used in CSV to denote the end of CSV row (only for CSV data source type). Default value is "↵".
  • 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 sources.
  • subquery (optional) – String | Object. The parameter to set the server-side filter which helps to decrease the size of the response from the server (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]". For "elasticsearch" data source type, should be set as a Bool Query Object.
  • 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.
  • node (optional) – String | Object. The host for the connection (only for "elasticsearch" data source type). Can be set either as a URL string ("node": "") or as an object with the following properties:
    • protocol – String. node URL protocol.
    • host – String. node URL hostname.
    • port – Number. node URL port.
    • path (optional) – String. node URL path.
  • index (optional) – String. The name of Elasticsearch index to connect (only for "elasticsearch" data source type).
  • mapping (optional) – Object. An additional setting to configure index mapping (only for "elasticsearch" data source type). Use the name of the field as a key of the object with the following parameters:
    • caption (optional) – String. Overrides the default name of the field.
    • visible (optional) – Boolean. When set as false, hides the field from the Field List.
    • interval (optional) – String. Used for date histogram. 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`. Check out the example.
    • format (optional) – String. Used for date histogram. Check out date format/pattern.
    • min_doc_count (optional) – Number. Used for date histogram. Can be used to show intervals with empty values (min_doc_count: 0). Default value: 1 (empty intervals are hidden).

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.