1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. Report Object
    3. Slice Object
    4. Options Object
    5. Format Object
    6. Conditional Format Object
    7. Cell Data 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. getFilterProperties
    27. getFormat
    28. getMeasures
    29. getMembers
    30. getOptions
    31. getReport
    32. getReportFilters
    33. getRows
    34. getSelectedCell
    35. getSort
    36. getXMLACatalogs
    37. getXMLACubes
    38. getXMLADataSources
    39. getXMLAProviderName
    40. load
    41. off
    42. on
    43. open
    44. openFieldsList
    45. openFilter
    46. print
    47. refresh
    48. removeAllCalculatedMeasures
    49. removeAllConditions
    50. removeCalculatedMeasure
    51. removeCondition
    52. removeSelection
    53. runQuery
    54. save
    55. setBottomX
    56. setFilter
    57. setFormat
    58. setOptions
    59. setReport
    60. setSort
    61. setTopX
    62. showCharts
    63. showGrid
    64. showGridAndCharts
    65. sortingMethod
    66. sortValues
    67. 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

getFilterProperties

getFilterProperties(hierarchyName:String):Object

[starting from version: 1.6]

Returns the filter properties set for the specified hierarchy.

Parameters

  • hierarchyName – the name of the hierarchy.

Returns

Object that describes the filter set for the hierarchy. The object always has type and members properties. It may have quantity and measure properties if filter on values is defined. It has all four properties if both filters, on hierarchy’s members and on values, are defined. Structure of the object:

  • type – Represents the filter type applied to the hierarchy. It can be:
    • 'none' – the filter is not applied to the hierarchy,
    • 'members' – the filter on hierarchy’s members is applied,
    • 'top' – the filter Top X is applied on values,
    • 'bottom' – the filter Bottom X is applied on values.
  • members (optional) – Array. Represents the filter on hierarchy’s members. Each object in array contains the following parameters: caption, uniqueName, and hierarchyName.
  • quantity (optional) – Represents the filter on values. Number of elements to choose for the Top X filter if type is 'top' or for the Bottom X filter if type is 'bottom'.
  • measure (optional) – Object. Represents the filter on values. Identifies the measure on which Top X or Bottom X filter will be applied. Has the following properties:
    • uniqueName – String. Unique measure name.
    • aggregation (optional) – String. Measure aggregation type.

Example

var filter = [
    "category.[cars]", 
    "category.[bikes]" 
];
flexmonster.setFilter('Category', filter);

flexmonster.getFilterProperties('Category');
/*
method getFilterProperties() returns the following object, where type is 'members' and members property has 2 elements
{
  type : 'members',
  members : [
   {'caption' : 'Cars', 'uniqueName' : 'category.[cars]'},
   {'caption' : 'Bikes', 'uniqueName' : 'category.[bikes]'}
  ]
}
*/

flexmonster.clearFilter('Category');

flexmonster.getFilterProperties('Category');
/*
after clearFilter() call method getFilterProperties() returns an Object with type 'none' and empty members array
{
  type : 'none',
  members : []
}
*/

Try the example on JSFiddle.

See also

clearFilter
getFilter
setFilter
setTopX
setBottomX