Class CompendiumBrowser`Abstract`

The basic compendium browser class allowing the browsing of compendiums by utilising their indexes.

Extending classes must define the following static properties if the browser is not meant to browse Item documents: documentName. Extending classes should define the following static properties: typeName, filterClasses.

Hierarchy (View Summary)

Application
- CompendiumBrowser

Constructors

constructor

new CompendiumBrowser(options?: {}): CompendiumBrowser
Parameters
- options: {} = {}
Returns CompendiumBrowser
Overrides Application.constructor
- Defined in module/applications/compendium-browser/compendium-browser.mjs:112

Properties

_debouncedRender

_debouncedRender: (
...args: [force?: boolean, options?: RenderOptions<ApplicationOptions>],
) => void

_entries

_entries: undefined | IndexEntry[]

_refocus

_refocus: boolean = true

`Readonly`entries

entries: Collection<IndexEntry>

The Collection of index entries this browser is aware of.

expandedFilters

expandedFilters: Set<string> = ...

A set of filters that were expanded by the user, and should stay expanded upon re-render.

filters

filters: Collection<BaseFilter> = ...

The set of filters to apply to the compendium index.

handledTypes

handledTypes: Set<string> = ...

The types of entries this browser handles, as per a document's type property.

packs

packs: CompendiumCollection<any>[] = []

Compendium packs this browser gets entries from.

`Static` `Internal`BROWSERS

BROWSERS: {} = {}

Known browsers.

Initialized in initializeBrowsers

`Static` `Abstract`documentName

documentName: "Actor" | "Item" = "Item"

The document name of entries this browser displays.

`Static`ENTRY_TEMPLATE

ENTRY_TEMPLATE: string = "systems/pf1/templates/apps/compendium-browser/entries.hbs"

The template used to render individual entries in the browser.

`Static`filterClasses

filterClasses: typeof BaseFilter[] = []

An array of classes extending BaseFilter that should be used for this browser.

`Static` `Abstract`typeName

typeName: string

A localisation string used in the browser's title.

Accessors

title

get title(): string
Returns string
Inherit Doc
Overrides Application.title
- Defined in module/applications/compendium-browser/compendium-browser.mjs:236

`Static`defaultOptions

get defaultOptions(): InsertKeys<
    {},
    OmitByValue<
        {
            classes: string[];
            dragDrop: { dragSelector: string; dropSelector: null }[];
            height: number;
            id: string;
            left: number;
            resizable: boolean;
            scrollY: string[];
            template: string;
            top: number;
            width: number;
        },
        never,
    >,
>
Assign the default options configuration which is used by this Application class. The options and values defined in this object are merged with any provided option values which are passed to the constructor upon initialization. Application subclasses may include additional options which are specific to their usage.

Returns InsertKeys<
    {},
    OmitByValue<
        {
            classes: string[];
            dragDrop: { dragSelector: string; dropSelector: null }[];
            height: number;
            id: string;
            left: number;
            resizable: boolean;
            scrollY: string[];
            template: string;
            top: number;
            width: number;
        },
        never,
    >,
>
Overrides Application.defaultOptions
- Defined in module/applications/compendium-browser/compendium-browser.mjs:124

Methods

_activateFilterQueue

_activateFilterQueue(): void
Internal Experimental
Enable queued filters

Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:273

_canDragStart

_canDragStart(selector: any): boolean
Parameters
- selector: any
Returns boolean
Inherit Doc
Overrides Application._canDragStart
- Defined in module/applications/compendium-browser/compendium-browser.mjs:583

`Protected`_getEntryContextOptions

_getEntryContextOptions(): object[]
Protected
Get the set of ContextMenu options which should be used for the compendium browser's entries.

Returns object[]
- The Array of ContextMenu options
- Defined in module/applications/compendium-browser/compendium-browser.mjs:556

_onDragStart

_onDragStart(event: any): void
Parameters
- event: any
Returns void
Inherit Doc
Overrides Application._onDragStart
- Defined in module/applications/compendium-browser/compendium-browser.mjs:588

_queueFilters

_queueFilters(filters: object): void
Internal Experimental
Queue filters to be processed by _activateFilterQueue

Only one filter bundle is ever queued.
Parameters
- filters: object
Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:321

_render

_render(force: any, options: any): Promise<void>
Parameters
- force: any
- options: any
Returns Promise<void>
Inherit Doc
Overrides Application._render
- Defined in module/applications/compendium-browser/compendium-browser.mjs:423

activateListeners

activateListeners(html: any): void
Parameters
- html: any
Returns void
Inherit Doc
Overrides Application.activateListeners
- Defined in module/applications/compendium-browser/compendium-browser.mjs:470

getData

getData(): Promise<object>
Returns Promise<object>
Inherit Doc
Overrides Application.getData
- Defined in module/applications/compendium-browser/compendium-browser.mjs:440

getFilteredEntries

getFilteredEntries(): IndexEntry[]
Get the current set of entries allowed by the filters.

Returns IndexEntry[]
The filtered entries
- Defined in module/applications/compendium-browser/compendium-browser.mjs:397

`Protected`initialize

initialize(): void
Protected
Perform minimal preparation steps to initialize the compendium browser. Add filters and determine which compendiums include data relevant to this browser.

Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:246

isPackIncluded

isPackIncluded(pack: CompendiumCollection<any>): boolean
Check whether a compendium should be included in the browser.
Parameters
- pack: CompendiumCollection<any>
  The compendium to test
Returns boolean
Whether the compendium should be included
- Defined in module/applications/compendium-browser/compendium-browser.mjs:331

loadPackIndex

loadPackIndex(pack: CompendiumCollection<any>): Promise<IndexEntry[]>
Load a compendium's index to prepare it for browsing.
Parameters
- pack: CompendiumCollection<any>
  The compendium to load
Returns Promise<IndexEntry[]>
The loaded index entries
- Defined in module/applications/compendium-browser/compendium-browser.mjs:371

setup

setup(): Promise<void>
Perform the initial setup of the compendium browser. This includes requesting the index of all relevant compendiums if necessary and preparing the filters.

Returns Promise<void>
- Defined in module/applications/compendium-browser/compendium-browser.mjs:353

`Static`_mapEntry

_mapEntry(entry: object, pack: CompendiumCollection<any>): IndexEntry
Map an entry from a compendium to the format used by the browser.
Parameters
- entry: object
  The entry to map
- pack: CompendiumCollection<any>
  The compendium the entry is from
Returns IndexEntry
The mapped entry
- Defined in module/applications/compendium-browser/compendium-browser.mjs:207

`Static`getIndexes

getIndexes(packNames?: string[]): Promise<void>
Request indexes of all packs of a document type to be loaded. This method should only ever be called as CompendiumBrowser.getIndexes to ensure Promises are properly bundled.
Parameters
- packNames: string[] = []
  The names of the packs to load indexes for
Returns Promise<void>
A Promise that resolves once all indexes have been loaded

See
CompendiumBrowser.#indexingPromise
- Defined in module/applications/compendium-browser/compendium-browser.mjs:184

`Static`initializeBrowsers

initializeBrowsers(): void
Initialize all CompendiumBrowsers found in pf1.applications.compendiumBrowser and register them in pf1.applications.compendiums.

Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:169

`Static`registerDefault

registerDefault(): void
Internal
Fill BROWSERS

Called in init hook.

Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:155

Class CompendiumBrowserAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CompendiumBrowser

Properties

_debouncedRender

_entries

_refocus

Readonlyentries

expandedFilters

filters

handledTypes

packs

Static InternalBROWSERS

Static AbstractdocumentName

StaticENTRY_TEMPLATE

StaticfilterClasses

Static AbstracttypeName

Accessors

title

Returns string

Inherit Doc

StaticdefaultOptions

Returns InsertKeys< {}, OmitByValue< { classes: string[]; dragDrop: { dragSelector: string; dropSelector: null }[]; height: number; id: string; left: number; resizable: boolean; scrollY: string[]; template: string; top: number; width: number; }, never, >,>

Methods

_activateFilterQueue

Returns void

_canDragStart

Parameters

Returns boolean

Inherit Doc

Protected_getEntryContextOptions

Returns object[]

_onDragStart

Parameters

Returns void

Inherit Doc

_queueFilters

Parameters

Returns void

_render

Parameters

Returns Promise<void>

Inherit Doc

activateListeners

Parameters

Returns void

Inherit Doc

getData

Returns Promise<object>

Inherit Doc

getFilteredEntries

Returns IndexEntry[]

Protectedinitialize

Returns void

isPackIncluded

Parameters

Returns boolean

loadPackIndex

Parameters

Returns Promise<IndexEntry[]>

setup

Returns Promise<void>

Static_mapEntry

Parameters

Returns IndexEntry

StaticgetIndexes

Parameters

Returns Promise<void>

See

StaticinitializeBrowsers

Returns void

StaticregisterDefault

Class CompendiumBrowser`Abstract`

`Readonly`entries

`Static` `Internal`BROWSERS

`Static` `Abstract`documentName

`Static`ENTRY_TEMPLATE

`Static`filterClasses

`Static` `Abstract`typeName

`Static`defaultOptions

Returns InsertKeys<
{},
OmitByValue<
{
classes: string[];
dragDrop: { dragSelector: string; dropSelector: null }[];
height: number;
id: string;
left: number;
resizable: boolean;
scrollY: string[];
template: string;
top: number;
width: number;
},
never,
>,
>

`Protected`_getEntryContextOptions

`Protected`initialize

`Static`_mapEntry

`Static`getIndexes

`Static`initializeBrowsers

`Static`registerDefault