Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines how to filter items.

Hierarchy

  • FilterConfiguration

Index

Constructors

constructor

  • Creates a FilterConfiguration instance that describes how to filter categories.

    Parameters

    Returns FilterConfiguration

Properties

Optional enabled

enabled: boolean

Enables or disables the feature. Default: false

Optional match

match: RegExp

The current regex match filter, applied on the Name or DisplayName (see matchMode). Default: "" (empty - no matches)

Optional matchMode

matchMode: MatchMode

The current match-mode for the regex filter. Default: DisplayName

Optional maxMatchCount

maxMatchCount: number

The maximum no of matches for the category to be included. Default: -1 (disabled)

Optional uiHintShowFilterInputThreshold

uiHintShowFilterInputThreshold: number

Hints the UI to show an input box when the number of hits exceeds a given number. Default: 20

Generated using TypeDoc