Home > @activeviam/activeui-sdk > MdxFiltersApi

MdxFiltersApi interface

Contains functions to manipulate filters of an MDX query.

Signature:

export interface MdxFiltersApi 

Properties

Property	Type	Description
addFilter	(snd: StatementAndDiscovery, position: number, key: string, hierarchy: HierarchyUniqueName, value: FilterValue) => StatementAndDiscovery
explicitFilterKey	PluginKey
getPosition	(snd: StatementAndDiscovery, activeFilter: AugmentedActiveFilter<FilterValue>) => number
getSlicerFilters	(snd: StatementAndDiscovery, selector: MdxFilterSelectorImplementationProperties) => AugmentedActiveFilter<FilterValue>[]
LAST_POSITION	-1
moveAllSlicersToSubSelect	(snd: StatementAndDiscovery) => StatementAndDiscovery
remove	(snd: StatementAndDiscovery, selector: SerializablePluginImplementation<MdxFilterSelectorFactoryProperties>) => StatementAndDiscovery
removeAll	(snd: StatementAndDiscovery, selector: MdxFilterSelectorImplementationProperties) => StatementAndDiscovery
replaceFilter	(statement: SelectNode, discovery: Discovery, shouldReplace: boolean, hierarchy: string, addPosition: number, key: string, mdx: FilterValue) => StatementAndDiscovery
selectFilters	(snd: StatementAndDiscovery, selector: MdxFilterSelectorImplementationProperties) => AugmentedActiveFilter<FilterValue>[]
selectors	FiltersSelectors
source	FilterSource

Remarks

The main object used to manipulate the filters of an MDX statement is called ActiveFilter. Active here means that this filter is currently in use in a statement, as opposed to the class Filter which describes a type of filter, outside of any statement context.