Dear visitor, despite all the challenges, our team continues operating at full speed.

We are ready to help with any questions you may have. Please fill out this quick form and we'll get back to you.

Fill the form
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
    13. Chart Legend 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. customizeAPIRequest
    13. customizeCell
    14. customizeChartElement
    15. customizeContextMenu
    16. dispose
    17. expandAllData
    18. expandData
    19. exportTo
    20. getAllConditions
    21. getAllHierarchies
    22. getAllMeasures
    23. getCell
    24. getColumns
    25. getCondition
    26. getFilter
    27. getFlatSort
    28. getFormat
    29. getMeasures
    30. getMembers
    31. getOptions
    32. getReport
    33. getReportFilters
    34. getRows
    35. getSelectedCell
    36. getSort
    37. getXMLACatalogs
    38. getXMLACubes
    39. getXMLADataSources
    40. getXMLAProviderName
    41. load
    42. off
    43. on
    44. open
    45. openCalculatedValueEditor
    46. openFieldsList
    47. openFilter
    48. print
    49. refresh
    50. removeAllCalculatedMeasures
    51. removeAllConditions
    52. removeCalculatedMeasure
    53. removeCondition
    54. removeSelection
    55. runQuery
    56. save
    57. setFilter
    58. setFlatSort
    59. setFormat
    60. setOptions
    61. setReport
    62. setSort
    63. showCharts
    64. showGrid
    65. showGridAndCharts
    66. sortingMethod
    67. sortValues
    68. 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. 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
  6. MongoDB Connector API
    1. All methods
    2. getSchema
    3. getMembers
    4. getSelectResult
Table of contents

Introduction

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>

<script>
    var pivot = new Flexmonster({
        container: "pivotContainer",
        toolbar: true,
        licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX"
    });
</script>

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

List of objects

Report Object contains all the possible aspects of pivot tables and pivot charts configuration
Data Source Object contains information about the data source
Mapping Object contains information about field data types, captions, multi-level hierarchies, and other view configurations of the data source
Slice Object defines what data subset from the data source is going to be shown in the report
Options Object used to specify appearance and functionality available for customers
Filter Object contains filtering information
Format Object defines the way how numeric values are formatted in the component
Conditional Format Object describes conditional formatting rules
Cell Data Object contains information about the cell
Chart Data Object contains information about the chart segment
Toolbar Object contains information about the Toolbar
Chart Legend Data Object contains information about the chart legend element

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
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
expandAllData expands all nodes and drills down all levels of all hierarchies
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
getAllMeasures returns a list of all available measures
getCell returns information about cell by row and column indexes
getColumns returns a list of hierarchies selected in the report slice for columns
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 Format Object of a default number format or the number format for the specified measure
getMeasures returns a list of the selected measures in the report
getMembers returns a list of members for the specified hierarchy
getOptions returns Options Object with component’s options
getReportFilters returns a list of hierarchies selected in the report slice for Report Filters
getReport returns Report Object which describes the current report
getRows returns a list of hierarchies selected in the report slice for rows
getSelectedCell returns information about selected cell
getSort returns the sort type which is applied to the hierarchy
getXMLACatalogs obtains a list of all available catalogs on a given data source
getXMLACubes obtains a list of all available cubes on a given data source
getXMLADataSources obtains a list of all data sources by given URL for XMLA connect
getXMLAProviderName returns dataSourceType for given proxyUrl
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 reportFilters from Slice Object and displays the result data
save saves your current report to a specified location
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
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
update triggered when the change occurred in the component