Rest ...args: any[]Wrap a callback in a debounced timeout. Delay execution of the callback function until the function has not been called for delay milliseconds
Rest ...args: [event: Event, html: HTMLElement]A wrapped function which can be called to debounce execution
The boolean operator used to combine choices of this filter. If "OR", an entry will be included if at least one active choice matches. If "AND", an entry will only be included if all active choices match.
A Collection of FilterChoices for this filter.
A reference to the CompendiumBrowser this filter is used in.
The ID of this filter used to identify it in its browser's filters.
Static MIN_The minimum number of choices that must be present before the filter will show a search box. Booleans can be used to override this check.
Static TEMPLATEThe handlebars template used to render this filter.
Static indexThe field this filter checks against its choices.
Will also be added to the compendiumIndexFields of the document's CONFIG object.
Static labelThe label for this filter visible to the user.
Static localizeAuto-localize choices.
Defaults to false due to pre-translation.
Static localizeAuto-localize filter label
Static localizePrefix to add to choices before localization.
Static typeA convenience property to define a single type this filter applies to.
Static typesThe types of document this filter applies to.
Whether this filter has any active choices.
The number of active choices.
Whether this filter provides controls in addition to its choices.
Static handledThe authoritative Set of types this filter applies to.
Protected _onProvide 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.
} The data object for 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.
Optional number: number = 1The number of choices to check for
Toggle the active state of a choice, or set it to a specific state.
The key of the choice to toggle
Optional state: null | boolean = nullThe state to set the choice to. If null, the choice will be toggled.
Static getGenerate a Collection of FilterChoices from a CONFIG object.
The object to generate choices from; can be a Record<string, string> or
Optional options: { Options determining how the choices are generated.
Whether choices should be generated from direct properties of the configObject, or from the properties of the inner objects.
The key to use to determine the label if the configObject is a Record<string, object>; will be ignored if the configObject is a Record<string, string>.
Generated using TypeDoc
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.
Abstract