Class BaseFilter

constructor

• new BaseFilter(compendiumBrowser): BaseFilter

• Parameters

  • compendiumBrowser: CompendiumBrowser

    The compendium browser this filter is used in.

  Returns BaseFilter

choices

compendiumBrowser

id

Static TEMPLATE

Static indexField

Static label

Static localizeChoices

Static localizeLabel

Static localizePrefix

Static type

Static types

active

• get active(): boolean

• Whether this filter has any active choices.

  Returns boolean

activeChoiceCount

• get activeChoiceCount(): number

• The number of active choices.

  Returns number

Static handledTypes

• get handledTypes(): Set<string>

• The authoritative Set of types this filter applies to.

  Returns Set<string>

activateListeners

• activateListeners(html): void

• Activate event listeners for this filter.

  Parameters

  • html: HTMLElement

    The rendered HTML element for this filter only

  Returns void

  Abstract

applyFilter

• applyFilter(entry): boolean

• 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

  Abstract

getData

• getData(): object

• Provide data necessary to render this filter. The data object generated by BaseFilter#getData contains the minimum data not only required by the filter itself, but also by the rendering CompendiumBrowser.

  Returns object

  } The data object for this filter

hasChoices

• hasChoices(number?): boolean

• 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

  • Optional number: number = 1

    The number of choices to check for

  Returns boolean

  • Whether this filter has more than the given number of choices

prepareChoices

• prepareChoices(): void

• 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

registerIndexFields

• registerIndexFields(): void

• Adds the index fields checked by this filter to the document's CONFIG object, so that CompendiumCollection#getIndex will include them.

  Returns void

reset

• reset(): void

• Reset all choices and controls to their default state (inactive)

  Returns void

  Abstract

setup

• setup(): Promise<void>

• Prepare the filter for use. This step expects the compendium browser to have gathered its entries.

  Returns Promise<void>