Get Free Trial
  1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. ReportObject
    3. DataSourceObject
    4. MappingObject
    5. SliceObject
    6. OptionsObject
    7. GlobalObject
    8. Filtering
      1. FilterObject
      2. NumberQueryObject
      3. StringQueryObject
      4. DateQueryObject
      5. TimeQueryObject
      6. ValueQueryObject
    9. FormatObject
    10. ConditionalFormatObject
    11. TableSizesObject
    12. CellDataObject
    13. ChartDataObject
    14. ToolbarObject
    15. ChartLegendDataObject
    16. ShareReportConnectionObject
  3. Methods
    1. All methods
    2. addCalculatedMeasure
    3. addCondition
    4. alert
    5. clear
    6. clearFilter
    7. clearXMLACache
    8. closeFieldsList
    9. collapseAllData
    10. collapseCell
    11. collapseData
    12. connectTo
    13. customizeAPIRequest
    14. customizeCell
    15. customizeChartElement
    16. customizeContextMenu
    17. dispose
    18. drillDownCell
    19. drillUpCell
    20. expandAllData
    21. expandCell
    22. expandData
    23. exportTo
    24. getAllConditions
    25. getAllHierarchies
    26. getAllHierarchiesAsync
    27. getAllMeasures
    28. getAllMeasuresAsync
    29. getCell
    30. getColumns
    31. getColumnsAsync
    32. getCondition
    33. getFilter
    34. getFlatSort
    35. getFormat
    36. getMeasures
    37. getMeasuresAsync
    38. getMembers
    39. getMembersAsync
    40. getOptions
    41. getReport
    42. getReportFilters
    43. getReportFiltersAsync
    44. getRows
    45. getRowsAsync
    46. getSelectedCell
    47. getSort
    48. getTableSizes
    49. getXMLACatalogs
    50. getXMLACatalogsAsync
    51. getXMLACubes
    52. getXMLACubesAsync
    53. getXMLADataSources
    54. getXMLADataSourcesAsync
    55. getXMLAProviderName
    56. getXMLAProviderNameAsync
    57. load
    58. off
    59. on
    60. open
    61. openCalculatedValueEditor
    62. openFieldsList
    63. openFilter
    64. print
    65. refresh
    66. removeAllCalculatedMeasures
    67. removeAllConditions
    68. removeCalculatedMeasure
    69. removeCondition
    70. removeSelection
    71. runQuery
    72. save
    73. scrollToColumn
    74. scrollToRow
    75. setFilter
    76. setFlatSort
    77. setFormat
    78. setOptions
    79. setReport
    80. setSort
    81. setTableSizes
    82. shareReport
    83. showCharts
    84. showGrid
    85. showGridAndCharts
    86. sortingMethod
    87. sortValues
    88. 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. FieldObject
    9. FilterObject
    10. FilterGroupObject
  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


Flexmonster Pivot Table & Charts Component has convenient full-functional JavaScript API to embed the component into web applications.

This API documentation describes objects, calls and events.

The following example illustrates how to embed the component via initial new Flexmonster() call:

<div id="pivotContainer">The component will appear here</div>
<script src="flexmonster/flexmonster.js"></script>

    var pivot = new Flexmonster({
        container: "pivotContainer",
        toolbar: true

Open the example on JSFiddle or read more about embedding Flexmonster Component: new Flexmonster().

List of objects

ReportObject contains all the possible aspects of pivot tables and pivot charts configuration
DataSourceObject contains information about the data source
MappingObject contains information about field data types, captions, multi-level hierarchies, and other view configurations of the data source
SliceObject defines what data subset from the data source is going to be shown in the report
OptionsObject used to specify appearance and functionality available for customers
GlobalObject used to set options that will be applied to all reports
FilterObject contains filtering information
FormatObject defines the way how numeric values are formatted in the component
ConditionalFormatObject describes conditional formatting rules
TableSizesObject contains information about table sizes
CellDataObject contains information about the cell
ChartDataObject contains information about the chart segment
ToolbarObject contains information about the Toolbar
ChartLegendDataObject contains information about the chart legend element
ShareReportConnectionObject contains the configuration needed to share a report

List of API calls

addCalculatedMeasure adds calculated measure
addCondition adds a conditional formatting rule
alert shows an alert pop-up window with a custom message
clear clears the component’s data and view
clearFilter clears the filter applied previously to the specified hierarchy
clearXMLACache requests Microsoft Analysis Services to clear the cache
closeFieldsList closes the Field List
collapseAllData collapses all nodes and drills up all levels of all hierarchies
collapseCell collapses a specific node on the grid and charts
collapseData collapses all nodes of the specified hierarchy
connectTo connects to the data source without cleaning the report
customizeAPIRequest allows customizing the request before it is sent to a server
customizeCell allows customizing of separate cells
customizeChartElement allows customizing separate chart elements in Flexmonster Charts
customizeContextMenu allows customizing context menu
dispose prepares the pivot table instance to be deleted with the browser’s garbage collection
drillDownCell drills down a specific hierarchy level on the grid and charts
drillUpCell drills up a specific hierarchy level on the grid and charts
expandAllData expands all nodes and drills down all levels of all hierarchies
expandCell expands a specific node on the grid and charts
expandData expands all nodes of the specified hierarchy
exportTo exports grid or chart to CSV, HTML, PDF, Image or Excel format
getAllConditions returns a list of conditional formatting rules of the report
getAllHierarchies returns a list of all available hierarchies
getAllHierarchiesAsync the async equivalent of getAllHierarchies
getAllMeasures returns a list of all available measures
getAllMeasuresAsync the async equivalent of getAllMeasures
getCell returns information about cell by row and column indexes
getColumns returns a list of hierarchies selected in the report slice for columns
getColumnsAsync the async equivalent of getColumns
getCondition returns a conditional formatting rule by id
getFilter returns the filtered members for the specified hierarchy
getFlatSort returns an array of objects defining the sorting on the flat grid
getFormat returns the FormatObject of a default number format or the number format for the specified measure
getMeasures returns a list of the selected measures in the report
getMeasuresAsync the async equivalent of getMeasures
getMembers returns a list of members for the specified hierarchy
getMembersAsync the async equivalent of getMembers
getOptions returns the OptionsObject with component’s options
getReportFilters returns a list of hierarchies selected in the report slice for Report Filters
getReportFiltersAsync the async equivalent of getReportFilters
getReport returns the ReportObject which describes the current report
getRows returns a list of hierarchies selected in the report slice for rows
getRowsAsync the async equivalent of getRows
getSelectedCell returns information about selected cell
getSort returns the sort type which is applied to the hierarchy
getTableSizes returns table sizes that are set for the component
getXMLACatalogs obtains a list of all available catalogs on a given data source
getXMLACatalogsAsync the async equivalent of getXMLACatalogs
getXMLACubes obtains a list of all available cubes on a given data source
getXMLACubesAsync the async equivalent of getXMLACubes
getXMLADataSources obtains a list of all data sources by given URL for XMLA connect
getXMLADataSourcesAsync the async equivalent of getXMLADataSources
getXMLAProviderName returns dataSourceType for given proxyUrl
getXMLAProviderNameAsync the async equivalent of getXMLAProviderName
load loads report JSON file from the specified URL
off removes JS handlers for specified event
on sets a JS function for the specified event
open opens local report file
openCalculatedValueEditor opens the calculated value pop-up window editor
openFieldsList opens the Field List
openFilter opens the filter pop-up window for the specified hierarchy
print prints the content of the grid or chart via OS print manager
refresh redraws the component
removeAllCalculatedMeasures removes all calculated measures
removeAllConditions removes all conditional formatting rules
removeCalculatedMeasure removes the calculated measure by measure unique name
removeCondition removes the conditional formatting rule by id
removeSelection removes a selection from cells on the grid
runQuery runs a query with specified rows, columns, measures and report filters from the SliceObject and displays the result data
save saves your current report to a specified location
scrollToColumn scrolls the grid to the specified column
scrollToRow scrolls the grid to the specified row
setFilter sets the filter for the specified hierarchy
setFlatSort sets the flat table multi-column sorting
setFormat sets a default number format or the number format for the specified measure
setOptions sets the component’s options
setReport sets a report to be displayed in the component
setSort sets the sort type to the specified hierarchy
setTableSizes sets table sizes for the component
showCharts switches to the charts view and shows the chart of the specified type
showGrid switches to the grid view
showGridAndCharts switches to the grid and charts view and shows the chart of the specified type
sortingMethod sets custom sorting for hierarchy members
sortValues sorts values in a specific row or column in the pivot table
updateData updates data for the report without cleaning the report

List of events

reportcomplete triggered when the operations can be performed with the component (data source file or OLAP structure was loaded successfully and the grid/chart was rendered)
afterchartdraw triggered after chart rendering
aftergriddraw triggered after grid rendering
beforegriddraw triggered before grid rendering
beforetoolbarcreated triggered before the creation of the Toolbar
cellclick triggered when a cell is clicked on the grid
chartclick triggered when a chart element is clicked
celldoubleclick triggered when a cell is double clicked on the grid
datachanged triggered after the user edits data
dataerror triggered when some error occurred during the loading of data
datafilecancelled triggered when Open file dialog was opened and customer clicks Cancel button
dataloaded triggered when the component loaded data
drillthroughclose triggered when the drill-through view is closed
drillthroughopen triggered when the drill-through view is opened
exportcomplete triggered after the export process has finished
exportstart triggered when the export of grid or chart starts
fieldslistclose triggered when the built-in Field List is closed
fieldslistopen triggered when the built-in Field List is opened
filterclose triggered when the filter pop-up window is closed
filteropen triggered when the filter pop-up window is opened
loadingdata triggered when data starts loading from from local or remote CSV, JSON or after report was loaded
loadinglocalization triggered when localization file starts loading
loadingolapstructure triggered when structure of OLAP cube starts loading
loadingreportfile triggered when a report file started loading
localizationerror triggered when some error appeared while loading localization file
localizationloaded triggered when localization file was loaded
olapstructureerror triggered when some error appeared while loading OLAP structure
olapstructureloaded triggered when OLAP structure was loaded
openingreportfile triggered when customer uses menu Open -> Local report or API method open() is called
printcomplete triggered after OS print manager was closed
printstart triggered when print(options:Object) method was called or Export > Print was selected in the Toolbar
querycomplete triggered after the data query was complete
queryerror triggered if some error occurred while running the query
ready triggered when the component’s initial configuration completed and the component is ready to receive API calls
reportchange triggered when a report is changed in the component
reportfilecancelled triggered when customer uses menu Open -> Local report and clicks Cancel button
reportfileerror triggered when some error occurred during the loading of the report file
runningquery triggered before data query is started
unauthorizederror triggered when the Accelerator sends the 401 Unauthorized error in response to the Flexmonster request
update triggered when the change occurred in the component