1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. Report Object
    3. Slice Object
    4. Options Object
    5. Format Object
    6. Conditional Format Object
    7. Cell Data 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. getData
    25. getFilter
    26. getFilterProperties
    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. openFieldsList
    45. print
    46. refresh
    47. removeAllCalculatedMeasures
    48. removeAllConditions
    49. removeCalculatedMeasure
    50. removeCondition
    51. removeSelection
    52. runQuery
    53. save
    54. setBottomX
    55. setFilter
    56. setFormat
    57. setOptions
    58. setReport
    59. setSort
    60. setTopX
    61. showCharts
    62. showGrid
    63. showGridAndCharts
    64. sortingMethod
    65. sortValues
    66. updateData
  4. Events
    1. All events
    2. aftergriddraw
    3. beforegriddraw
    4. beforetoolbarcreated
    5. cellclick
    6. celldoubleclick
    7. datachanged
    8. dataerror
    9. datafilecancelled
    10. dataloaded
    11. exportcomplete
    12. exportstart
    13. fieldslistclose
    14. fieldslistopen
    15. filteropen
    16. loadingdata
    17. loadinglocalization
    18. loadingolapstructure
    19. loadingreportfile
    20. localizationerror
    21. localizationloaded
    22. olapstructureerror
    23. olapstructureloaded
    24. openingreportfile
    25. printcomplete
    26. printstart
    27. querycomplete
    28. queryerror
    29. ready
    30. reportchange
    31. reportcomplete
    32. reportfilecancelled
    33. reportfileerror
    34. runningquery
    35. update
Table of contents

connectTo

connectTo(params:Object)

[starting from version: 1.4]

This method is used for connection to the new data source. It clears the current report and connects to the resource specified. Please note, starting from version 2.3 there is a new API call updateData to update data for the report without cleaning the report.

Possible data sources:

  • OLAP cube via XMLA protocol (Microsoft Analysis Services, Mondrian, icCube)
  • OLAP cube via our proxy (Microsoft Analysis Services, Mondrian)
  • CSV (static file or data generated by server-side script)
  • CSV file from the local file system
  • JSON (static file or data generated by server-side script)
  • JSON file from the local file system

Parameters

params – the object which contains connection parameters. List of possible parameters:

  • dataSourceType – type of data source. The component supports the following types: "microsoft analysis services", "mondrian", "iccube", "csv", "ocsv", "json".
  • proxyUrl – the path to proxy URL to the OLAP data source, such as Microsoft Analysis Services, Mondrian, icCube (only for "microsoft analysis services", "mondrian", "iccube" data source types)
  • dataSourceInfo – the service info of the OLAP data source (only for "microsoft analysis services", "mondrian", "iccube" data source types)
  • catalog – the data source catalog name of the OLAP data source (only for "microsoft analysis services", "mondrian", "iccube" data source types)
  • cube – given catalog’s cube’s name of the OLAP data source (only for "microsoft analysis services", "mondrian", "iccube" data source types)
  • filename – the URL to CSV file or to server-side script which generates CSV data (only for "csv", "ocsv" and "json" data source type)
  • browseForFile – this boolean parameter defines whether you want to load CSV file from the local file system (true) or not (false). It is false by default. (only for "csv", "ocsv" and "json" data source type)
  • fieldSeparator – 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 explicitly.
  • requestHeader (optional) – Object. This object allows adding custom request headers (only for "csv" and "json" data source types). The object consists of "key": "value" pairs, where "key" is a header name and "value" is its value. Check out live sample on JSFiddle. Important note: requestHeader is not saved when obtaining the report via save() and getReport() API calls.

Examples

1) This example on JSFiddle demonstrates the connection to the following data sources: Microsoft Analysis Services, Mondrian, icCube, CSV, and JSON.

2) Connect to Microsoft Analysis Services:

flexmonster.connectTo({
  dataSourceType: 'microsoft analysis services',
  proxyUrl: 'http://olap.flexmonster.com/olap/msmdpump.dll',
  dataSourceInfo: 'Provider=MSOLAP; Data Source=extranet;', 
  catalog: 'Adventure Works DW Standard Edition', 
  cube: 'Adventure Works'
});

3) Connect to Mondrian:

flexmonster.connectTo({
  dataSourceType: 'mondrian', 
  proxyUrl: 'http://olap.flexmonster.com:8080/mondrian/xmla', 
  dataSourceInfo: 'MondrianFoodMart', 
  catalog: 'FoodMart', 
  cube: 'Sales'
});

4) Connect to icCube:

flexmonster.connectTo({
  dataSourceType: 'iccube', 
  proxyUrl: 'http://olap.flexmonster.com:8282/icCube/xmla', 
  dataSourceInfo: 'icCube-datasource', 
  catalog: 'Sales', 
  cube: 'Sales' 
});

5) Connect to CSV data source:

flexmonster.connectTo({
  dataSourceType: 'csv', 
  filename: 'data/csv/arabic.csv'
});

6) Connect to CSV file where colon char is used to separate fields in the row. You have to define fieldSeparator explicitly:

flexmonster.connectTo({
  dataSourceType: 'csv',
  filename: 'colon-data.csv',
  fieldSeparator: ':'
});

7) Open local CSV file:

flexmonster.connectTo({
  dataSourceType: 'csv', 
  browseForFile: true
});

See also

updateData
open
load
save
getReport
setReport