Technical specifications

Flexmonster's API calls

API call	Description
addCalculatedMeasure	Adds a calculated measure.
addCondition	Adds a conditional formatting rule.
alert	Shows an alert pop-up window with a custom message.
clear	Clears the report.
clearFilter	Clears the filter applied to the specified field.
clearXMLACache	Requests Microsoft Analysis Services to clear the cache.
closeFieldsList	Closes the Field List.
collapseAllData	Collapses all expanded nodes and drills up all levels of every hierarchy.
collapseCell	Collapses a specific node on the grid and charts.
collapseData	Collapses all nodes of the specified field.
connectTo	Clears the current report and connects to a specified data source.
customizeAPIRequest	Allows customizing the request before it is sent to a server.
customizeCell	Sets a function for customizing particular grid cells.
customizeChartElement	Sets a function for customizing particular chart elements in Flexmonster Pivot Charts.
customizeContextMenu	Allows customizing context menu.
dispose	Prepares the pivot table instance to be deleted with the browser’s garbage collector.
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 fields and drills down all multilevel hierarchies in rows, columns, or rows and columns.
expandCell	Expands a specific node on the grid and charts.
expandData	Expands all nodes of the specified field.
exportTo	Exports the current view to Excel, PDF, CSV, HTML, or image format.
getAllConditions	Returns a list of conditional formatting rules of the report.
getAllHierarchies	Returns a list of all available fields.
getAllHierarchiesAsync	The async equivalent of getAllHierarchies.
getAllMeasures	Returns a list of all available measures.
getAllMeasuresAsync	The async equivalent of getAllMeasures.
getCell	Returns information about a cell by its row and column indexes.
getColumns	Returns a list of fields selected in the slice for columns.
getColumnsAsync	The async equivalent of getColumns.
getCondition	Returns a conditional formatting rule by its id.
getFilter	Returns the filter applied to the specified field.
getFlatSort	Returns an array of objects defining the sorting on the flat table.
getFormat	Returns a default number format or the number format for the specified measure.
getMeasures	Returns a list of measures selected in the report.
getMeasuresAsync	The async equivalent of getMeasures.
getMembers	Returns a list of members for the specified field.
getMembersAsync	The async equivalent of getMembers.
getOptions	Returns the OptionsObject of the current report.
getReport	Returns the ReportObject that describes the current report.
getReportFilters	Returns a list of fields selected in the slice for report filters.
getReportFiltersAsync	The async equivalent of getReportFilters.
getRows	Returns a list of fields selected in the slice for rows.
getRowsAsync	The async equivalent of getRows.
getSelectedCell	Returns information about selected cells.
getSort	Returns the sort type applied to the field.
getTableSizes	Returns table sizes that are set for the grid.
getXMLACatalogs	Gets a list of all available catalogs on a given data source.
getXMLACatalogsAsync	The async equivalent of getXMLACatalogs.
getXMLACubes	Gets a list of all available cubes on a given data source.
getXMLACubesAsync	The async equivalent of getXMLACubes.
getXMLADataSources	Gets a list of all data sources by given URL for XMLA connection.
getXMLADataSourcesAsync	The async equivalent of getXMLADataSources.
getXMLAProviderName	Returns type for a given proxyUrl.
getXMLAProviderNameAsync	The async equivalent of getXMLAProviderName.
load	Loads the report file from the specified URL.
off	Removes handlers for the specified event.
on	Sets a handler for the specified event.
open	Opens a local report file.
openCalculatedValueEditor	Opens the Calculated value pop-up window.
openFieldsList	Opens the Field List.
openFilter	Opens the filter view for the specified field.
print	Prints the current view via the OS print manager.
refresh	Redraws the component.
removeAllCalculatedMeasures	Removes all calculated measures.
removeAllConditions	Removes all conditional formatting rules.
removeCalculatedMeasure	Removes a calculated measure by its unique name.
removeCondition	Removes a conditional formatting rule by its id.
removeSelection	Removes selection from cells on the grid.
runQuery	Sets new rows, columns, measures, and report filters in the SliceObject and displays the updated data.
save	Saves the current report to a chosen location.
scrollToColumn	Scrolls the grid to the specified column.
scrollToRow	Scrolls the grid to the specified row.
setFilter	Applies the filter to the specified field.
setFlatSort	Sorts columns in the flat form.
setFormat	Sets the default number format or a number format for the specified measure.
setOptions	Sets options for the component.
setReport	Sets a report for the component.
setSort	Sets the sort type to the specified field.
setTableSizes	Returns table sizes set for the grid.
shareReport	Saves the current report to Flexmonster Data Server and provides a link to the saved report.
showCharts	Switches the view to the specified chart type.
showGrid	Switches to the grid view.
showGridAndCharts	Switches the view to the grid and charts; the chart type can be specified.
sortFieldsList	Sets custom sorting for Field List items.
sortingMethod	Overrides the default ascending order of field members.
sortValues	Sorts a specific row or column in the compact form, the classic form, and the chart view.
updateData	Updates data for the report without clearing the report.