Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FilterApi

Provides run-time access to Filter section of Adaptable State.

Hierarchy

  • FilterApi

Index

Methods

clearAllColumnFilter

  • clearAllColumnFilter(): void

clearAndSetColumnFilter

  • clearAndSetColumnFilter(columnFilters: ColumnFilter[]): void
  • Clears all existing Column Filters and then sets the new ones

    Parameters

    Returns void

clearColumnFilter

clearColumnFilterByColumn

  • clearColumnFilterByColumn(column: string): void
  • Clears the Column Filter for a given Column

    Parameters

    • column: string

      the Column for which the Column Filter should be cleared

    Returns void

clearColumnFilterByColumns

  • clearColumnFilterByColumns(columns: string[]): void
  • Clears the Column Filters for a given set of Columns

    Parameters

    • columns: string[]

      the Columns for which the Column Filter should be cleared

    Returns void

clearSystemFilters

  • clearSystemFilters(): void

columnFilterToString

columnFiltersToString

  • columnFiltersToString(columnFilters: ColumnFilter[]): string

createColumnFilterForCell

  • createColumnFilterForCell(column: string, primarykeyValues: any[]): void

evaluateColumnFilter

  • evaluateColumnFilter(columnFilter: ColumnFilter, node: any): boolean

findPredicateDefByShortcut

getAllColumnFilter

getAllColumnFilterForColumn

  • getAllColumnFilterForColumn(column: string): ColumnFilter[]
  • Retrieves all the Column Filters for a given Column

    Parameters

    • column: string

      the column to retrieve the Column Filters for

    Returns ColumnFilter[]

getAllSystemFilterIds

getFilterPredicateDefsForColumn

getFilterPredicateDefsForColumnId

getFilterState

hideQuickFilterBar

  • hideQuickFilterBar(): void

isQuickFilterAvailable

  • isQuickFilterAvailable(): boolean

isQuickFilterVisible

  • isQuickFilterVisible(): boolean

setColumnFilter

  • Sets Column Filters - will replace filters for existing column and leave other column filters in place

    Parameters

    Returns void

setSystemFilters

  • setSystemFilters(systemFilters: string[]): void
  • Sets the System Filters to be used

    Parameters

    • systemFilters: string[]

      SystemFilters to use

    Returns void

showQuickFilterBar

  • showQuickFilterBar(): void

Generated using TypeDoc