AbstractThe 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 AbstractindexThe field this filter checks against its choices.
Will also be added to the compendiumIndexFields of the document's CONFIG object.
Static AbstractlabelThe label for this filter visible to the user.
StaticlocalizeAuto-localize choices.
Defaults to false due to pre-translation.
StaticlocalizeAuto-localize filter label
StaticlocalizePrefix to add to choices before localization.
StaticTEMPLATEThe handlebars template used to render this filter.
StatictypeA convenience property to define a single type this filter applies to.
StatictypesThe types of document this filter applies to.
Whether this filter has any active choices.
The number of active choices.
StatichandledThe authoritative Set of types this filter applies to.
AbstractactivateActivate event listeners for this filter.
The rendered HTML element for this filter only
AbstractapplyCheck whether an entry matches this filter. If the filter is not active, this will always return true.
The entry to check against this filter
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.
} 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.
Optionalnumber: number = 1The number of choices to check for
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.
Adds the index fields checked by this filter to the document's CONFIG object,
so that CompendiumCollection#getIndex will include them.
AbstractresetReset all choices and controls to their default state (inactive)
Prepare the filter for use. This step expects the compendium browser to have gathered its entries.
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.