Abstract
The compendium browser this filter is used in.
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
Abstract
indexThe field this filter checks against its choices.
Will also be added to the compendiumIndexFields
of the document's CONFIG
object.
Static
Abstract
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
TEMPLATEThe handlebars template used to render this filter.
Static
typeA convenience property to define a single type
this filter applies to.
Static
typesThe type
s of document this filter applies to.
Whether this filter has any active choices.
The number of active choices.
Static
handledThe authoritative Set
of type
s this filter applies to.
Abstract
activateAbstract
applyProvide 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
Abstract
reset
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.