Menu
Download Free Trial
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 for version 2.4.

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
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
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

List of API calls:

addCalculatedMeasure adds calculated measure
addCondition adds a conditional formatting rule
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 Fields 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
customizeCell allows customizing of separate cells
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
getData retrieves the data that pivot instance is showing or from the selected slice
getFilter returns the filtered members for the specified hierarchy
getFilterProperties returns the filter properties set for the specified hierarchy
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
openFieldsList opens Fields List
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
setBottomX sets the Bottom X filter for the specified hierarchy and measure
setFilter sets the filter for the specified hierarchy
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
setTopX sets the Top X filter for the specified hierarchy and measure
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
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)
aftergriddraw triggered after grid rendering
beforegriddraw triggered before grid rendering
beforetoolbarcreated triggered before the creation of Toolbar
cellclick triggered when a cell is clicked on the grid
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
exportcomplete triggered after the export file was generated successfully
exportstart triggered when the export of grid or chart starts
fieldslistclose triggered when the built-in Fields List is closed
fieldslistopen triggered when the built-in Fields List is opened
filteropen triggered when a filter icon is pressed
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