Class NumberRangeFilter

A filter that allows the user to input a minimum and maximum value.

Hierarchy

BaseFilter
- NumberRangeFilter
  - ItemPriceFilter
  - ItemCasterLevelFilter

Index

Constructors

constructor

new NumberRangeFilter(compendiumBrowser): NumberRangeFilter
Parameters
- compendiumBrowser: CompendiumBrowser
  The compendium browser this filter is used in.
Returns NumberRangeFilter
Inherited from BaseFilter.constructor
- Defined in module/applications/compendium-browser/filters/base.mjs:106

Properties

choices

choices: null | Collection<FilterChoice>

A Collection of FilterChoices for this filter.

compendiumBrowser

compendiumBrowser: null | CompendiumBrowser = null

A reference to the CompendiumBrowser this filter is used in.

id

id: string

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

`Static` TEMPLATE

TEMPLATE: string = "systems/pf1/templates/apps/compendium-browser/minmax-filter.hbs"

The handlebars template used to render this filter.

`Static` indexField

indexField: string = ""

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

Abstract

`Static` label

label: string = ""

The label for this filter visible to the user.

Abstract

`Static` localizeChoices

localizeChoices: boolean = false

Auto-localize choices.

Defaults to false due to pre-translation.

`Static` localizeLabel

localizeLabel: boolean = true

Auto-localize filter label

`Static` localizePrefix

localizePrefix: string = ""

Prefix to add to choices before localization.

`Static` type

type: string = ""

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

See

`Static` types

types: string[] = []

The types of document this filter applies to.

See

-

handledTypes

Accessors

active

get active(): boolean
Whether this filter has any active choices.

Returns boolean
Inherited from BaseFilter.active
- Defined in module/applications/compendium-browser/filters/base.mjs:126

activeChoiceCount

get activeChoiceCount(): number
The number of active choices.

Returns number
Inherited from BaseFilter.activeChoiceCount
- Defined in module/applications/compendium-browser/filters/base.mjs:135

`Static` handledTypes

get handledTypes(): Set<string>
The authoritative Set of types this filter applies to.

Returns Set<string>
Inherited from BaseFilter.handledTypes
- Defined in module/applications/compendium-browser/filters/base.mjs:117

Methods

activateListeners

activateListeners(html): void
Activate event listeners for this filter.
Parameters
- html: any
  The rendered HTML element for this filter only
Returns void
Abstract
Overrides BaseFilter.activateListeners
- Defined in module/applications/compendium-browser/filters/number-range.mjs:29

applyFilter

applyFilter(entry): boolean
Check whether an entry matches this filter. If the filter is not active, this will always return true.
Parameters
- entry: any
  The entry to check against this filter
Returns boolean
- Whether the entry matches this filter
Abstract
Overrides BaseFilter.applyFilter
- Defined in module/applications/compendium-browser/filters/number-range.mjs:44

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
Inherited from BaseFilter.getData
- Defined in module/applications/compendium-browser/filters/base.mjs:211

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
Inherited from BaseFilter.hasChoices
- Defined in module/applications/compendium-browser/filters/base.mjs:183

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
Overrides BaseFilter.prepareChoices
- Defined in module/applications/compendium-browser/filters/number-range.mjs:10

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
Inherited from BaseFilter.registerIndexFields
- Defined in module/applications/compendium-browser/filters/base.mjs:143

reset

reset(): void
Reset all choices and controls to their default state (inactive)

Returns void
Abstract
Overrides BaseFilter.reset
- Defined in module/applications/compendium-browser/filters/number-range.mjs:21

setup

setup(): Promise<void>
Prepare the filter for use. This step expects the compendium browser to have gathered its entries.

Returns Promise<void>
Inherited from BaseFilter.setup
- Defined in module/applications/compendium-browser/filters/base.mjs:164

Class NumberRangeFilter

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

compendiumBrowser: CompendiumBrowser

Returns NumberRangeFilter

Properties

choices

compendiumBrowser

id

Static TEMPLATE

Static indexField

Abstract

Static label

Abstract

Static localizeChoices

Static localizeLabel

Static localizePrefix

Static type

See

Static types

See

-

Accessors

active

Returns boolean

activeChoiceCount

Returns number

Static handledTypes

Returns Set<string>

Methods

activateListeners

Parameters

html: any

Returns void

Abstract

applyFilter

Parameters

entry: any

Returns boolean

Abstract

getData

Returns object

hasChoices

Parameters

Optional number: number = 1

Returns boolean

prepareChoices

Returns void

registerIndexFields

Returns void

reset

Returns void

Abstract

setup

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Static` TEMPLATE

`Static` indexField

`Static` label

`Static` localizeChoices

`Static` localizeLabel

`Static` localizePrefix

`Static` type

`Static` types

`Static` handledTypes

`Optional` number: number = 1