Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HierarchicalFilter

A Hierarchical Filter Hierarchical Filters are used when a hierarchical field is used as a filter on a cube database. As an example, assume a hierarchical field in Product, named ByCategory. ByCategory has the following five levels: Family, Category, Subcategory, Brand, Sku.

Hierarchy

Index

Properties

Methods

Properties

appliedValues

appliedValues: Array<HierarchicalFilterDataValue>
returns

A list of values applied to this hierarchical filter.

dimensionName

dimensionName: string
returns

The dimension name associated with the filter. In the ByCategory filter example, this would be 'Product'

fieldId

fieldId: string
returns

The id of the field being filtered.

fieldName

fieldName: string
returns

The name of the field being filtered. Note that this is the caption as shown in the UI, and not the actual database field name.

filterType

filterType: FilterType
returns

The type of the filter.

hierarchyCaption

hierarchyCaption: string
returns

The hierarchy caption associated with the filter. In the ByCategory filter example, this would be '[Product].[ByCategory]'

isAllSelected

isAllSelected: boolean
returns

True if all the values are selected for this filter. When 'All' is selected, appliedValues returns an empty list.

levelDetails

levelDetails: Array<HierarchicalLevelDetail>
returns

Details about each level in the hierarchical filter.

numberOfLevels

numberOfLevels: number
returns

The number of levels in the hierarchical filter. In the ByCategory filter example, this would be 5

worksheetName

worksheetName: string
returns

The parent worksheet.

Methods

getAppliedWorksheetsAsync

  • getAppliedWorksheetsAsync(): Promise<Array<string>>

  • Returns Promise<Array<string>>

    the list of worksheet names that have the filter applied.

getFieldAsync

  • getFieldAsync(): Promise<Field>

  • Returns Promise<Field>

    a promise containing the field for the filter.

setAppliedWorksheetsAsync

  • setAppliedWorksheetsAsync(applyToWorksheets: Array<string>): Promise<Array<string>>

  • Applies the filter to the specified list of worksheets. If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.

    Parameters

    • applyToWorksheets: Array<string>

      list of worksheets to apply the filter on

    Returns Promise<Array<string>>

    the list of worksheet names that have the filter applied