☝️Small business or a startup? See if you qualify for our special offer.
+
All documentation

getReportFilters

getReportFilters(): Array

[starting from version: 2.4]

Returns a list of fields selected in the report slice for report filters. Note that getReportFilters has an async equivalent - getReportFiltersAsync.

Returns

Array of FieldObjectReturned objects that describe the selected fields.

If data load is in progress an empty array will be returned.

Example

pivot.getReportFilters();

/* method returns an array of FieldObjectReturned objects
[
{
"caption": "Country",
"dimensionCaption": "Country",
"dimensionUniqueName": "Country",
"folder": "",
"label": "Country",
"sort": "asc",
"uniqueName": "Country",
"type": "string"
},
// Other fields
]
*/

Open the example on JSFiddle.

See also

getReportFiltersAsync
getAllHierarchies
getColumns
getRows
getAllMeasures
getMeasures