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
});
</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 |
| Table Sizes Object | contains information about table sizes |
| 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 |
| 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 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 |
| getMeasuresAsync | the async equivalent of getMeasures
|
| getMembers | returns a list of members for the specified hierarchy |
| getMembersAsync | the async equivalent of getMembers
|
| getOptions | returns Options Object 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 Report Object 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 |
| 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 |
| 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 |