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

setFilter

setFilter(hierarchyName:String, items:Array, negation:Boolean)

[starting from version: 1.4]

Sets the filter for the specified hierarchy.

Version: 1.7

One more property has been added – negation. If negation is false, setFilter() works the same as it works in previous versions, setFilter() tells the component to show the members of hierarchy specified in items. If negation is true, setFilter() tells the component to show all the members of hierarchy except the items. This allows for providing the shorter list of items when applying filter.

Parameters

  • hierarchyName – the name of the hierarchy
  • items – Array of hierarchy’s members to be reflected/shown according to the applied filter.
  • negation (optional) – It is false by default. It tells the component to show the members of hierarchy specified in items (true) or to show all the members of hierarchy except the items (false).

Examples

1) If you want to see data on ‘Cars’ and ‘Bikes’:

flexmonster.setFilter("Category", 
  [
    "category.[cars]", 
    "category.[bikes]"
  ]);

Try the example on JSFiddle.

2) If you want to see all the categories except ‘Accessories’ now you can do this using the following code, where negation property is true:

flexmonster.setFilter("Category", 
  [
    "category.[accessories]"
  ], 
  true);

instead of

flexmonster.setFilter("Category", 
  [
    "category.[bikes]",
    "category.[cars]",
    "category.[clothing]",
    "category.[components]"
  ]);

Check out on JSFiddle.

See also

clearFilter
getFilter
setBottomX
setTopX