🍉 Meet Flexmonster Pivot Table & Charts 2.9.Check out all hot features!
Get Free Trial
  1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. Report Object
    3. Data Source Object
    4. Mapping Object
    5. Slice Object
    6. Options Object
    7. Filtering
      1. Filter Object
      2. Number Query Object
      3. String Query Object
      4. Date Query Object
      5. Time Query Object
      6. Value Query Object
    8. Format Object
    9. Conditional Format Object
    10. Table Sizes Object
    11. Cell Data Object
    12. Chart Data Object
    13. Toolbar Object
    14. Chart Legend Data Object
    15. Share Report Connection Object
  3. Methods
    1. All methods
    2. All async methods
    3. addCalculatedMeasure
    4. addCondition
    5. alert
    6. clear
    7. clearFilter
    8. clearXMLACache
    9. closeFieldsList
    10. collapseAllData
    11. collapseData
    12. connectTo
    13. customizeAPIRequest
    14. customizeCell
    15. customizeChartElement
    16. customizeContextMenu
    17. dispose
    18. expandAllData
    19. expandData
    20. exportTo
    21. getAllConditions
    22. getAllHierarchies
    23. getAllMeasures
    24. getCell
    25. getColumns
    26. getCondition
    27. getFilter
    28. getFlatSort
    29. getFormat
    30. getMeasures
    31. getMembers
    32. getOptions
    33. getReport
    34. getReportFilters
    35. getRows
    36. getSelectedCell
    37. getSort
    38. getTableSizes
    39. getXMLACatalogs
    40. getXMLACubes
    41. getXMLADataSources
    42. getXMLAProviderName
    43. load
    44. off
    45. on
    46. open
    47. openCalculatedValueEditor
    48. openFieldsList
    49. openFilter
    50. print
    51. refresh
    52. removeAllCalculatedMeasures
    53. removeAllConditions
    54. removeCalculatedMeasure
    55. removeCondition
    56. removeSelection
    57. runQuery
    58. save
    59. scrollToColumn
    60. scrollToRow
    61. setFilter
    62. setFlatSort
    63. setFormat
    64. setOptions
    65. setReport
    66. setSort
    67. setTableSizes
    68. shareReport
    69. showCharts
    70. showGrid
    71. showGridAndCharts
    72. sortingMethod
    73. sortValues
    74. updateData
  4. Events
    1. All events
    2. afterchartdraw
    3. aftergriddraw
    4. beforegriddraw
    5. beforetoolbarcreated
    6. cellclick
    7. celldoubleclick
    8. chartclick
    9. datachanged
    10. dataerror
    11. datafilecancelled
    12. dataloaded
    13. drillthroughclose
    14. drillthroughopen
    15. exportcomplete
    16. exportstart
    17. fieldslistclose
    18. fieldslistopen
    19. filterclose
    20. filteropen
    21. loadingdata
    22. loadinglocalization
    23. loadingolapstructure
    24. loadingreportfile
    25. localizationerror
    26. localizationloaded
    27. olapstructureerror
    28. olapstructureloaded
    29. openingreportfile
    30. printcomplete
    31. printstart
    32. querycomplete
    33. queryerror
    34. ready
    35. reportchange
    36. reportcomplete
    37. reportfilecancelled
    38. reportfileerror
    39. runningquery
    40. unauthorizederror
    41. update
  5. Custom data source API
    1. All requests
    2. /handshake request
    3. /fields request
    4. /members request
    5. /select request for the pivot table
    6. /select request for the flat table
    7. /select request for the drill-through view
    8. Field Object
    9. Filter Object
    10. Filter Group Object
  6. MongoDB Connector API
    1. All methods
    2. getSchema
    3. getMembers
    4. getSelectResult
  7. Flexmonster Connector for amCharts
    1. All methods
    2. amcharts.getData
    3. amcharts.getCategoryName
    4. amcharts.getMeasureNameByIndex
    5. amcharts.getNumberOfMeasures
    6. amcharts.getNumberFormatPattern
Table of contents

getFilter

getFilter(hierarchyName: String): Filter Object

[starting from version: 1.4]

Returns the Filter Object for the specified hierarchy.

Parameters

  • hierarchyName – String. The name of the hierarchy.

Returns

Filter Object that contains filtering information.

Example

flexmonster.setFilter("Category", 
  {
    "members": [
      "category.[bikes]",
      "category.[cars]"
    ]
  }
);
flexmonster.getFilter('Category');

/*
method getFilter() returns the following Object:
{
  "members": [
    "category.[bikes]",
    "category.[cars]"
  ]
}
*/

Try the example on JSFiddle.

See also

clearFilter
setFilter