Menu
Free Trials
  1. API reference
    1. flexmonster
    2. Report Object
    3. Options Object
    4. Format Object
  2. Methods
    1. addCalculatedMeasure
    2. addCondition
    3. addJSON
    4. addMeasure
    5. addStyleToMember
    6. addUrlToMember
    7. clear
    8. clearFilter
    9. clearXMLACache
    10. closeFieldsList
    11. collapseAllData
    12. collapseData
    13. connectTo
    14. dispose
    15. embedPivotComponent
    16. expandAllData
    17. expandData
    18. exportTo
    19. fullScreen
    20. getAllConditions
    21. getAllHierarchies
    22. getAllMeasures
    23. getCell
    24. getColumns
    25. getColumnWidth
    26. getCondition
    27. getData
    28. getFilter
    29. getFilterProperties
    30. getFormat
    31. getLabels
    32. getMeasures
    33. getMembers
    34. getOptions
    35. getPages
    36. getReport
    37. getRowHeight
    38. getRows
    39. getSelectedCell
    40. getSort
    41. getValue
    42. getXMLACatalogs
    43. getXMLACubes
    44. getXMLADataSources
    45. getXMLAProviderName
    46. gridColumnCount
    47. gridRowCount
    48. load
    49. off
    50. on
    51. open
    52. openFieldsList
    53. percentZoom
    54. print
    55. refresh
    56. removeAllCalculatedMeasures
    57. removeAllConditions
    58. removeAllMeasures
    59. removeCalculatedMeasure
    60. removeCondition
    61. removeMeasure
    62. removeSelection
    63. runQuery
    64. save
    65. setBottomX
    66. setChartTitle
    67. setColumnWidth
    68. setFilter
    69. setFormat
    70. setGridTitle
    71. setHandler
    72. setLabels
    73. setOptions
    74. setReport
    75. setRowHeight
    76. setSelectedCell
    77. setSort
    78. setStyle
    79. setTopX
    80. showCharts
    81. showGrid
    82. showGridAndCharts
    83. sortValues
    84. updateData
    85. zoomTo
    86. jsCellClickHandler
    87. jsFilterOpenHandler
    88. jsFieldsListCloseHandler
    89. jsFieldsListOpenHandler
    90. jsFullScreenHandler
    91. jsPivotCreationCompleteHandler
    92. jsPivotUpdateHandler
    93. jsReportChangeHandler
    94. jsReportLoadedHandler
  3. Events
    1. cellclick
    2. celldoubleclick
    3. dataerror
    4. datafilecancelled
    5. dataloaded
    6. exportcomplete
    7. exportstart
    8. fieldslistclose
    9. fieldslistopen
    10. filteropen
    11. loadingdata
    12. loadinglocalization
    13. loadingolapstructure
    14. loadingreportfile
    15. localizationerror
    16. localizationloaded
    17. olapstructureerror
    18. olapstructureloaded
    19. openingreportfile
    20. printcomplete
    21. printstart
    22. querycomplete
    23. queryerror
    24. ready
    25. reportchange
    26. reportcomplete
    27. reportfilecancelled
    28. reportfileerror
    29. reportfileloaded
    30. runningquery
    31. update
Table of contents

getData

getData(options:Object, callbackHandler:Function, updateHandler:Function)

[starting from version: 2.3]

Asynchronously passes the data to callbackHandler and updateHandler. You can retrieve the data that pivot instance is showing or define the slice with the data you would like to get.

Parameters

  • options – Object. This object has the following parameters:
    • slice (optional) – Object. Contains information about the slice. If not defined, the API call will return data displayed in the pivot table.
  • callbackHandler – Function. Gets one input parameter – rawData. Tracks when the data is ready.
  • updateHandler (optional) – Function. Gets one input parameter – rawData. Tracks if data in pivot was filtered/sorted/etc.

Response

rawData is the object asynchronously passed to callbackHandler and updateHandler. It has the following structure:

  • data – Array. Array of objects that represents all the data from the dataset. Each object can have c0 - cN, r0 - rN and v0 - vN parameters, where c0 - cN are for column members, r0 - rN are for row members and v0 - vN are for values. Please note that if a cell has no value, NaN will be put in corresponding v0 - vN.
  • meta – Object. Meta data about the returned data:
    • caption – String. Chart’s title.
    • cAmount – Number. The number of fields in columns in the slice.
    • c0Name – String. The caption of the first field in columns in the slice. In meta object will be as many c0Name, c1Name, c2Name, etc as cAmount.
    • formats – Array. Formats of measures from the slice. It has as many format objects as vAmount.
    • rAmount – Number. The number of fields in rows in the slice.
    • r0Name – String. The caption of the first field in rows in the slice. In meta object will be as many r0Name, r1Name, r2Name, etc as rAmount.
    • vAmount – Number. The number of measures in the slice.
    • v0Name – String. The caption of the first measure in the slice. In meta object will be as many v0Name, v1Name, v2Name, etc as vAmount.

Examples

Example of rawData response. We have the following pivot table:

Category
Color Accessories Components Total Sum of Price
blue 553 584 553 584
green 28 008 207 128 235 136
Grand Total 28 008 760 712 788 720

The result of the API call

flexmonster.getData({}, function(data) {console.log(data)})

will be the following:

{
	data:[
		{
			v0:788720
		},
		{
			r0:"blue",
			v0:553584
		},
		{
			r0:"green",
			v0:235136
		},
		{
			c0:"Accessories",
			v0:28008
		},
		{
			c0:"Components",
			v0:760712
		},
		{
			c0:"Accessories",
			r0:"blue",
			v0:NaN
		},
		{
			c0:"Components",
			r0:"blue",
			v0:553584
		},
		{
			c0:"Accessories",
			r0:"green",
			r0:28008
		},
		{
			c0:"Components",
			r0:"green",
			v0:207128
		}
	],
	meta: {
		caption:"",
		cAmount:1,
		c0Name:"Category",
		formats: [{
			name:"",
			currencySymbol:"",
			currencySymbolAlign:"left",
			decimalPlaces:-1,
			decimalSeparator:".",
			divideByZeroValue:"Infinity",
			infinityValue:"Infinity",
			isPercent:false,
			maxDecimalPlaces:-1,
			maxSymbols:20,
			nullValue:"",
			textAlign:"right",
			thousandsSeparator:" "
		}],
		rAmount:1,
		r0Name:"Color",
		vAmount:1,
		v0Name:"Sum of Price"
	}
}

data array in rawData object contains all numbers shown in the pivot table including grand totals, totals and subtotals.

Each object with grand totals contains values (v0 - vN) only. In our example this is:

		{
			v0:788720
		}

Each object with totals contains either values (v0 - vN) and columns (c0 - cN) or values and rows (r0 - rN). In our example this is:

		{
			r0:"blue",
			v0:553584
		},
		{
			r0:"green",
			v0:235136
		},
		{
			c0:"Accessories",
			v0:28008
		},
		{
			c0:"Components",
			v0:760712
		}

Depending on for which visualization tool you are requesting data from the pivot table, you may need data with grand totals, totals and subtotals or without them. For some chart types, only totals are necessary.