A basic filter class containing common functionality for all filters.

Inheriting classes should define the following static properties: label, indexField. Inheriting classes may define the following static properties: type.

Hierarchy (view full)

Constructors

Properties

choices: null | Collection<FilterChoice> = null

A Collection of FilterChoices for this filter.

compendiumBrowser: null | CompendiumBrowser = null

A reference to the CompendiumBrowser this filter is used in.

id: string

The ID of this filter used to identify it in its browser's filters.

indexField: string = ""

The field this filter checks against its choices. Will also be added to the compendiumIndexFields of the document's CONFIG object.

label: string = ""

The label for this filter visible to the user.

localizeChoices: boolean = false

Auto-localize choices.

Defaults to false due to pre-translation.

localizeLabel: boolean = true

Auto-localize filter label

localizePrefix: string = ""

Prefix to add to choices before localization.

TEMPLATE: string = ""

The handlebars template used to render this filter.

type: string = ""

A convenience property to define a single type this filter applies to.

types: string[] = []

The types of document this filter applies to.

Accessors

Methods

  • Check whether an entry matches this filter. If the filter is not active, this will always return true.

    Parameters

    • entry: object

      The entry to check against this filter

    Returns boolean

    • Whether the entry matches this filter
  • Returns whether this filter has more than the given number of choices. Defaults to 1, as a single choice allows for no real filtering.

    Parameters

    • Optionalnumber: number = 1

      The number of choices to check for

    Returns boolean

    • Whether this filter has more than the given number of choices
  • Prepare the choices for this filter. This is called after the compendium browser has gathered its entries. By default, this will generate a list of choices from the index field of all entries in the compendium.

    Returns void