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. 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. getData
    25. getFilter
    26. getFormat
    27. getMeasures
    28. getMembers
    29. getOptions
    30. getReport
    31. getReportFilters
    32. getRows
    33. getSelectedCell
    34. getSort
    35. getXMLACatalogs
    36. getXMLACubes
    37. getXMLADataSources
    38. getXMLAProviderName
    39. load
    40. off
    41. on
    42. open
    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. datachanged
    9. dataerror
    10. datafilecancelled
    11. dataloaded
    12. exportcomplete
    13. exportstart
    14. fieldslistclose
    15. fieldslistopen
    16. filterclose
    17. filteropen
    18. loadingdata
    19. loadinglocalization
    20. loadingolapstructure
    21. loadingreportfile
    22. localizationerror
    23. localizationloaded
    24. olapstructureerror
    25. olapstructureloaded
    26. openingreportfile
    27. printcomplete
    28. printstart
    29. querycomplete
    30. queryerror
    31. ready
    32. reportchange
    33. reportcomplete
    34. reportfilecancelled
    35. reportfileerror
    36. runningquery
    37. update
Table of contents

getData

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

[starting from version: 2.3]

Please note! This method is only for integration with 3rd party charting libraries.

getData 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. Please note, this property is available for CSV, OCSV and JSON data sources only.
  • 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 the pivot table was filtered/sorted/etc or a number format was changed.

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.

Example

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:"",
			negativeCurrencyFormat: "-$1",
			positiveCurrencyFormat: "$1",
			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.

Check out the example on JSFiddle.

Read a tutorial how getData is used for Integration with any charting library.