Get Free Trial
Get Free Trial
  1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. Report Object
    3. Data Source Object
    4. Slice Object
    5. Options Object
    6. Filtering
      1. Filter Object
      2. Number Query Object
      3. String Query Object
      4. Date Query Object
      5. Time Query Object
      6. Value Query Object
    7. Format Object
    8. Conditional Format Object
    9. Cell Data Object
    10. Chart Data Object
    11. Toolbar 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. customizeCell
    13. customizeContextMenu
    14. dispose
    15. expandAllData
    16. expandData
    17. exportTo
    18. getAllConditions
    19. getAllHierarchies
    20. getAllMeasures
    21. getCell
    22. getColumns
    23. getCondition
    24. getFilter
    25. getFormat
    26. getMeasures
    27. getMembers
    28. getOptions
    29. getReport
    30. getReportFilters
    31. getRows
    32. getSelectedCell
    33. getSort
    34. getXMLACatalogs
    35. getXMLACubes
    36. getXMLADataSources
    37. getXMLAProviderName
    38. load
    39. off
    40. on
    41. open
    42. openCalculatedValueEditor
    43. openFieldsList
    44. openFilter
    45. print
    46. refresh
    47. removeAllCalculatedMeasures
    48. removeAllConditions
    49. removeCalculatedMeasure
    50. removeCondition
    51. removeSelection
    52. runQuery
    53. save
    54. setFilter
    55. setFormat
    56. setOptions
    57. setReport
    58. setSort
    59. showCharts
    60. showGrid
    61. showGridAndCharts
    62. sortingMethod
    63. sortValues
    64. 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. exportcomplete
    14. exportstart
    15. fieldslistclose
    16. fieldslistopen
    17. filterclose
    18. filteropen
    19. loadingdata
    20. loadinglocalization
    21. loadingolapstructure
    22. loadingreportfile
    23. localizationerror
    24. localizationloaded
    25. olapstructureerror
    26. olapstructureloaded
    27. openingreportfile
    28. printcomplete
    29. printstart
    30. querycomplete
    31. queryerror
    32. ready
    33. reportchange
    34. reportcomplete
    35. reportfilecancelled
    36. reportfileerror
    37. runningquery
    38. update
Table of contents

All methods

Flexmonster Pivot Table & Charts Component offers plenty of methods. All of them are available through the reference to each component instance created by new Flexmonster() API call.

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
customizeCell allows customizing of separate cells
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
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
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