Class RegionLegend

Scene Region Legend.

Mixes

HandlebarsApplication

Alias

RegionLegend

Hierarchy (view full)

ApplicationV2<any, any, this>
- RegionLegend

Index

Constructors

constructor

new RegionLegend(options?): RegionLegend
Applications are constructed by providing an object of configuration options.
Parameters
- Optional options: Partial<any> = {}
  Options used to configure the Application instance
Returns RegionLegend
Inherited from ApplicationV2.constructor

Properties

elevation

elevation: {
bottom: number;
top: number;
} = ...

The currently viewed elevation range.

Type declaration

bottom: number
top: number

options

options: any

Application instance configuration options.

tabGroups

tabGroups: Record<string, string> = {}

If this Application uses tabbed navigation groups, this mapping is updated whenever the changeTab method is called. Reports the active tab for each group. Subclasses may override this property to define default tabs for each group.

position

position: ApplicationPosition = ...

The current position of the application with respect to the window.document.body.

`Private` #visibleRegions

#visibleRegions: {
bottom: number;
top: number;
} = ...

The currently filtered Regions.

Type declaration

bottom: number
top: number

`Private` #searchFilter

#searchFilter: SearchFilter = ...

`Private` #hoveredRegion

#hoveredRegion: any = null

Record a reference to the currently highlighted Region.

`Private` #id

#id: string

`Private` #renderable

#renderable: boolean = true

Flag that this Application instance is renderable. Applications are not renderable unless a subclass defines the _renderHTML and _replaceHTML methods.

`Private` #element

#element: HTMLDivElement

The outermost HTMLElement of this rendered Application. For window applications this is ApplicationV2##frame. For non-window applications this ApplicationV2##content.

`Private` #content

#content: HTMLElement

The HTMLElement within which inner HTML is rendered. For non-window applications this is the same as ApplicationV2##element.

`Private` #minimization

#minimization: {
active: boolean;
} = ...

Data pertaining to the minimization status of the Application.

Type declaration

active: boolean

`Private` #position

#position: ApplicationPosition = ...

The rendered position of the Application.

`Private` #state

#state: Readonly<{
    ERROR: -3;
    CLOSING: -2;
    CLOSED: -1;
    NONE: 0;
    RENDERING: 1;
    RENDERED: 2;
}> = ApplicationV2.RENDER_STATES.NONE

Type declaration

ERROR: -3
CLOSING: -2
CLOSED: -1
NONE: 0
RENDERING: 1
RENDERED: 2

`Private` #semaphore

#semaphore: Semaphore = ...

A Semaphore used to enqueue asynchronous operations.

`Private` #controlsExpanded

#controlsExpanded: boolean = false

Is the window control buttons menu currently expanded?

`Private` #events

#events: Record<string, Map<EmittedEventListener, {
fn: EmittedEventListener;
once: boolean;
}>> = {}

A mapping of registered events.

`Static` DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    id: string;
    tag: string;
    position: {
        width: number;
        height: string;
    };
    window: {
        title: string;
        icon: string;
        minimizable: boolean;
    };
    actions: {
        config: ((event) => void);
        control: ((event) => void);
        create: ((event) => Promise<void>);
        delete: ((event) => Promise<void>);
        lock: ((event) => Promise<void>);
    };
} = ...

The default configuration options which are assigned to every instance of this Application class.

Type declaration

id: string
tag: string
position: {
width: number;
height: string;
}
- width: number
- height: string
window: {
    title: string;
    icon: string;
    minimizable: boolean;
}
- title: string
- icon: string
- minimizable: boolean
actions: {
    config: ((event) => void);
    control: ((event) => void);
    create: ((event) => Promise<void>);
    delete: ((event) => Promise<void>);
    lock: ((event) => Promise<void>);
}
- config: ((event) => void)
  - - (event): void
    - Handle clicks to configure a Region.
      Parameters
      event: PointerEvent
      Returns void
- control: ((event) => void)
  - - (event): void
    - Handle clicks to assume control over a Region.
      Parameters
      event: PointerEvent
      Returns void
- create: ((event) => Promise<void>)
  - - (event): Promise<void>
    - Handle button clicks to create a new Region.
      Parameters
      event: PointerEvent
      Returns Promise<void>
- delete: ((event) => Promise<void>)
  - - (event): Promise<void>
    - Handle clicks to delete a Region.
      Parameters
      event: PointerEvent
      Returns Promise<void>
- lock: ((event) => Promise<void>)
  - - (event): Promise<void>
    - Handle clicks to toggle the locked state of a Region.
      Parameters
      event: PointerEvent
      Returns Promise<void>

`Static` PARTS

PARTS: {
    list: {
        id: string;
        template: string;
        scrollable: string[];
    };
} = ...

Type declaration

list: {
    id: string;
    template: string;
    scrollable: string[];
}
- id: string
- template: string
- scrollable: string[]

`Static` BASE_APPLICATION

BASE_APPLICATION: typeof ApplicationV2 = ApplicationV2

Designates which upstream Application class in this class' inheritance chain is the base application. Any DEFAULT_OPTIONS of super-classes further upstream of the BASE_APPLICATION are ignored. Hook events for super-classes further upstream of the BASE_APPLICATION are not dispatched.

`Static` RENDER_STATES

RENDER_STATES: Readonly<{
    ERROR: -3;
    CLOSING: -2;
    CLOSED: -1;
    NONE: 0;
    RENDERING: 1;
    RENDERED: 2;
}> = ...

The sequence of rendering states that describe the Application life-cycle.

Type declaration

ERROR: -3
CLOSING: -2
CLOSED: -1
NONE: 0
RENDERING: 1
RENDERED: 2

`Static` emittedEvents

emittedEvents: readonly string[] = ...

Accessors

window

get window(): {
    header: HTMLElement;
    resize: HTMLElement;
    title: HTMLHeadingElement;
    icon: HTMLElement;
    close: HTMLButtonElement;
    controls: HTMLButtonElement;
    controlsDropdown: HTMLDivElement;
    onDrag: Function;
    onResize: Function;
    pointerStartPosition: ApplicationPosition;
    pointerMoveThrottle: boolean;
}
Convenience references to window header elements.

Returns {
    header: HTMLElement;
    resize: HTMLElement;
    title: HTMLHeadingElement;
    icon: HTMLElement;
    close: HTMLButtonElement;
    controls: HTMLButtonElement;
    controlsDropdown: HTMLDivElement;
    onDrag: Function;
    onResize: Function;
    pointerStartPosition: ApplicationPosition;
    pointerMoveThrottle: boolean;
}
- header: HTMLElement
- resize: HTMLElement
- title: HTMLHeadingElement
- icon: HTMLElement
- close: HTMLButtonElement
- controls: HTMLButtonElement
- controlsDropdown: HTMLDivElement
- onDrag: Function
- onResize: Function
- pointerStartPosition: ApplicationPosition
- pointerMoveThrottle: boolean
Inherited from HandlebarsApplicationMixin(ApplicationV2).window

classList

get classList(): DOMTokenList
The CSS class list of this Application instance

Returns DOMTokenList
Inherited from HandlebarsApplicationMixin(ApplicationV2).classList

id

get id(): string
The HTML element ID of this Application instance.

Returns string
Inherited from HandlebarsApplicationMixin(ApplicationV2).id

title

get title(): string
A convenience reference to the title of the Application window.

Returns string
Inherited from HandlebarsApplicationMixin(ApplicationV2).title

element

get element(): HTMLElement
The HTMLElement which renders this Application into the DOM.

Returns HTMLElement
Inherited from HandlebarsApplicationMixin(ApplicationV2).element

minimized

get minimized(): boolean
Is this Application instance currently minimized?

Returns boolean
Inherited from HandlebarsApplicationMixin(ApplicationV2).minimized

rendered

get rendered(): boolean
Is this Application instance currently rendered?

Returns boolean
Inherited from HandlebarsApplicationMixin(ApplicationV2).rendered

state

get state(): Readonly<{
    ERROR: -3;
    CLOSING: -2;
    CLOSED: -1;
    NONE: 0;
    RENDERING: 1;
    RENDERED: 2;
}>
The current render state of the Application.

Returns Readonly<{
    ERROR: -3;
    CLOSING: -2;
    CLOSED: -1;
    NONE: 0;
    RENDERING: 1;
    RENDERED: 2;
}>
Inherited from HandlebarsApplicationMixin(ApplicationV2).state

hasFrame

get hasFrame(): boolean
Does this Application instance render within an outer window frame?

Returns boolean
Inherited from HandlebarsApplicationMixin(ApplicationV2).hasFrame

Methods

_configureRenderOptions

_configureRenderOptions(options): void
Parameters
- options: any
Returns void
Overrides ApplicationV2._configureRenderOptions

_canRender

_canRender(options): boolean
Parameters
- options: any
Returns boolean
Overrides ApplicationV2._canRender

_renderFrame

_renderFrame(options): Promise<HTMLElement>
Render the outer framing HTMLElement which wraps the inner HTML of the Application.
Parameters
- options: any
  Options which configure application rendering behavior
Returns Promise<HTMLElement>
Overrides ApplicationV2._renderFrame

close

close(options?): Promise<ApplicationV2<any, any> | RegionLegend>
Close the Application, removing it from the DOM.
Parameters
- options: {} = {}
  Options which modify how the application is closed.
Returns Promise<ApplicationV2<any, any> | RegionLegend>
A Promise which resolves to the closed Application instance

Overrides ApplicationV2.close

_onFirstRender

_onFirstRender(context, options): void
Actions performed after a first render of the Application. Post-render steps are not awaited by the render process.
Parameters
- context: any
  Prepared context data
- options: any
  Provided render options
Returns void
Overrides ApplicationV2._onFirstRender

_onRender

_onRender(context, options): void
Actions performed after any render of the Application. Post-render steps are not awaited by the render process.
Parameters
- context: any
  Prepared context data
- options: any
  Provided render options
Returns void
Overrides ApplicationV2._onRender

_onClose

_onClose(options): void
Parameters
- options: any
Returns void
Overrides ApplicationV2._onClose

_prepareContext

_prepareContext(_options): Promise<{
    regions: any;
    elevation: {
        bottom: string | number;
        top: string | number;
    };
}>
Parameters
- _options: any
Returns Promise<{
    regions: any;
    elevation: {
        bottom: string | number;
        top: string | number;
    };
}>
Overrides ApplicationV2._prepareContext

_isRegionVisible

_isRegionVisible(region): boolean
Internal
Is this Region visible in this RegionLegend?
Parameters
- region: Region
  The region
Returns boolean

_hoverRegion

_hoverRegion(region, hover): void
Internal
Highlight a hovered region in the legend.
Parameters
- region: Region
  The Region
- hover: boolean
  Whether they are being hovered in or out.
Returns void

render

render(options?, _options?): Promise<ApplicationV2<any, any>>
Render the Application, creating its HTMLElement and replacing its innerHTML. Add it to the DOM if it is not currently rendered and rendering is forced. Otherwise, re-render its contents.
Parameters
- Optional options: any = {}
  Options which configure application rendering behavior. A boolean is interpreted as the "force" option.
- Optional _options: any = {}
  Legacy options for backwards-compatibility with the original ApplicationV1#render signature.
Returns Promise<ApplicationV2<any, any>>
A Promise which resolves to the rendered Application instance

Inherited from ApplicationV2.render

_renderHTML

_renderHTML(context, options): Promise<any>
Render an HTMLElement for the Application. An Application subclass must implement this method in order for the Application to be renderable.
Parameters
- context: Object
  Context data for the render operation
- options: any
  Options which configure application rendering behavior
Returns Promise<any>
The result of HTML rendering may be implementation specific. Whatever value is returned here is passed to _replaceHTML

Abstract
Inherited from ApplicationV2._renderHTML

setPosition

setPosition(position?): ApplicationPosition
Update the Application element position using provided data which is merged with the prior position.
Parameters
- Optional position: Partial<ApplicationPosition>
  New Application positioning data
Returns ApplicationPosition
The updated application position

Inherited from ApplicationV2.setPosition

toggleControls

toggleControls(expanded?): void
Toggle display of the Application controls menu. Only applicable to window Applications.
Parameters
- Optional expanded: boolean
  Set the controls visibility to a specific state. Otherwise, the visible state is toggled from its current value
Returns void
Inherited from ApplicationV2.toggleControls

minimize

minimize(): Promise<void>
Minimize the Application, collapsing it to a minimal header.

Returns Promise<void>
Inherited from ApplicationV2.minimize

maximize

maximize(): Promise<void>
Restore the Application to its original dimensions.

Returns Promise<void>
Inherited from ApplicationV2.maximize

bringToFront

bringToFront(): void
Bring this Application window to the front of the rendering stack by increasing its z-index. Once ApplicationV1 is deprecated we should switch from _maxZ to ApplicationV2#maxZ We should also eliminate ui.activeWindow in favor of only ApplicationV2#frontApp

Returns void
Inherited from ApplicationV2.bringToFront

changeTab

changeTab(tab, group, options?): void
Change the active tab within a tab group in this Application instance.
Parameters
- tab: string
  The name of the tab which should become active
- group: string
  The name of the tab group which defines the set of tabs
- Optional options: {
      event: Event;
      navElement: HTMLElement;
      force: boolean;
      updatePosition: boolean;
  } = {}
  Additional options which affect tab navigation
  - event: Event
    An interaction event which caused the tab change, if any
  - navElement: HTMLElement
    An explicit navigation element being modified
  - force: boolean
    Force changing the tab even if the new tab is already active
  - updatePosition: boolean
    Update application position after changing the tab?
Returns void
Inherited from ApplicationV2.changeTab

_onChangeForm

_onChangeForm(formConfig, event): void
Handle changes to an input element within the form.
Parameters
- formConfig: ApplicationFormConfiguration
  The form configuration for which this handler is bound
- event: Event
  An input change event within the form
Returns void
Inherited from ApplicationV2._onChangeForm

_awaitTransition

_awaitTransition(element, timeout): Promise<void>
Internal
Wait for a CSS transition to complete for an element.
Parameters
- element: HTMLElement
  The element which is transitioning
- timeout: number
  A timeout in milliseconds in case the transitionend event does not occur
Returns Promise<void>
Inherited from ApplicationV2._awaitTransition

addEventListener

addEventListener(type, listener, options?): void
Add a new event listener for a certain type of event.
Parameters
- type: string
  The type of event being registered for
- listener: EmittedEventListener
  The listener function called when the event occurs
- Optional options: {
  once: boolean;
  } = {}
  Options which configure the event listener
  - once: boolean
    Should the event only be responded to once and then removed
Returns void
See
https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener

Inherited from ApplicationV2.addEventListener

removeEventListener

removeEventListener(type, listener): void
Remove an event listener for a certain type of event.
Parameters
- type: string
  The type of event being removed
- listener: EmittedEventListener
  The listener function being removed
Returns void
See
https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener

Inherited from ApplicationV2.removeEventListener

dispatchEvent

dispatchEvent(event): boolean
Dispatch an event on this target.
Parameters
- event: Event
  The Event to dispatch
Returns boolean
Was default behavior for the event prevented?

See
https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/dispatchEvent

Inherited from ApplicationV2.dispatchEvent

`Protected` _initializeApplicationOptions

_initializeApplicationOptions(options): applications.types.ApplicationConfiguration
Protected
Initialize configuration options for the Application instance. The default behavior of this method is to intelligently merge options for each class with those of their parents.
- Array-based options are concatenated
- Inner objects are merged
- Otherwise, properties in the subclass replace those defined by a parent
Parameters
- options: Partial<applications.types.ApplicationConfiguration>
  Options provided directly to the constructor
Returns applications.types.ApplicationConfiguration
Configured options for the application instance

Inherited from ApplicationV2._initializeApplicationOptions

`Protected` _getHeaderControls

_getHeaderControls(): ApplicationHeaderControlsEntry[]
Protected
Configure the array of header control menu options

Returns ApplicationHeaderControlsEntry[]
Inherited from ApplicationV2._getHeaderControls

`Protected` _headerControlButtons

_headerControlButtons(): Generator<ApplicationHeaderControlsEntry, any, any>
Protected
Iterate over header control buttons, filtering for controls which are visible for the current client.

Returns Generator<ApplicationHeaderControlsEntry, any, any>
Yields
Inherited from ApplicationV2._headerControlButtons

`Protected` _replaceHTML

_replaceHTML(result, content, options): void
Protected
Replace the HTML of the application with the result provided by the rendering backend. An Application subclass should implement this method in order for the Application to be renderable.
Parameters
- result: any
  The result returned by the application rendering backend
- content: HTMLElement
  The content element into which the rendered result must be inserted
- options: any
  Options which configure application rendering behavior
Returns void
Inherited from ApplicationV2._replaceHTML

`Protected` _renderHeaderControl

_renderHeaderControl(control): HTMLLIElement
Protected
Render a header control button.
Parameters
- control: ApplicationHeaderControlsEntry
Returns HTMLLIElement
Inherited from ApplicationV2._renderHeaderControl

`Protected` _updateFrame

_updateFrame(options): void
Protected
When the Application is rendered, optionally update aspects of the window frame.
Parameters
- options: any
  Options provided at render-time
Returns void
Inherited from ApplicationV2._updateFrame

`Protected` _insertElement

_insertElement(element): void
Protected
Insert the application HTML element into the DOM. Subclasses may override this method to customize how the application is inserted.
Parameters
- element: HTMLElement
  The element to insert
Returns void
Inherited from ApplicationV2._insertElement

`Protected` _removeElement

_removeElement(element): void
Protected
Remove the application HTML element from the DOM. Subclasses may override this method to customize how the application element is removed.
Parameters
- element: HTMLElement
  The element to be removed
Returns void
Inherited from ApplicationV2._removeElement

`Protected` _updatePosition

_updatePosition(position): ApplicationPosition
Protected
Translate a requested application position updated into a resolved allowed position for the Application. Subclasses may override this method to implement more advanced positioning behavior.
Parameters
- position: ApplicationPosition
  Requested Application positioning data
Returns ApplicationPosition
Resolved Application positioning data

Inherited from ApplicationV2._updatePosition

`Protected` _preFirstRender

_preFirstRender(context, options): Promise<void>
Protected
Actions performed before a first render of the Application.
Parameters
- context: Object
  Prepared context data
- options: any
  Provided render options
Returns Promise<void>
Inherited from ApplicationV2._preFirstRender

`Protected` _preRender

_preRender(context, options): Promise<void>
Protected
Actions performed before any render of the Application. Pre-render steps are awaited by the render process.
Parameters
- context: Object
  Prepared context data
- options: any
  Provided render options
Returns Promise<void>
Inherited from ApplicationV2._preRender

`Protected` _preClose

_preClose(options): Promise<void>
Protected
Actions performed before closing the Application. Pre-close steps are awaited by the close process.
Parameters
- options: any
  Provided render options
Returns Promise<void>
Inherited from ApplicationV2._preClose

`Protected` _prePosition

_prePosition(position): void
Protected
Actions performed before the Application is re-positioned. Pre-position steps are not awaited because setPosition is synchronous.
Parameters
- position: ApplicationPosition
  The requested application position
Returns void
Inherited from ApplicationV2._prePosition

`Protected` _onPosition

_onPosition(position): void
Protected
Actions performed after the Application is re-positioned.
Parameters
- position: ApplicationPosition
  The requested application position
Returns void
Inherited from ApplicationV2._onPosition

`Protected` _attachFrameListeners

_attachFrameListeners(): void
Protected
Attach event listeners to the Application frame.

Returns void
Inherited from ApplicationV2._attachFrameListeners

`Protected` _onClickAction

_onClickAction(event, target): void
Protected
A generic event handler for action clicks which can be extended by subclasses. Action handlers defined in DEFAULT_OPTIONS are called first. This method is only called for actions which have no defined handler.
Parameters
- event: PointerEvent
  The originating click event
- target: HTMLElement
  The capturing HTML element which defined a [data-action]
Returns void
Inherited from ApplicationV2._onClickAction

`Protected` _onSubmitForm

_onSubmitForm(formConfig, event): Promise<void>
Protected
Handle submission for an Application which uses the form element.
Parameters
- formConfig: ApplicationFormConfiguration
  The form configuration for which this handler is bound
- event: Event | SubmitEvent
  The form submission event
Returns Promise<void>
Inherited from ApplicationV2._onSubmitForm

`Private` #prepareRegion

#prepareRegion(region): object
Prepare each Region for rendering in the legend.
Parameters
- region: Region
Returns object

`Private` #updateVisibleRegions

#updateVisibleRegions(): void
Update the region list and hide regions that are not visible.

Returns void

`Private` #onSearchFilter

#onSearchFilter(event, query, rgx, html): void
Filter regions.
Parameters
- event: KeyboardEvent
  The key-up event from keyboard input
- query: string
  The raw string input to the search field
- rgx: RegExp
  The regular expression to test against
- html: HTMLElement
  The HTML element which should be filtered
Returns void

`Private` #onElevationBottomChange

#onElevationBottomChange(event): void
Handle change events of the elevation range (bottom) input.
Parameters
- event: KeyboardEvent
Returns void

`Private` #onElevationTopChange

#onElevationTopChange(event): void
Handle change events of the elevation range (top) input.
Parameters
- event: KeyboardEvent
Returns void

`Private` #onRegionHoverIn

#onRegionHoverIn(event): void
Handle mouse-in events on a region in the legend.
Parameters
- event: PointerEvent
Returns void

`Private` #onRegionHoverOut

#onRegionHoverOut(event): void
Handle mouse-out events for a region in the legend.
Parameters
- event: PointerEvent
Returns void

`Private` #render

#render(options?): Promise<ApplicationV2<any, any>>
Manage the rendering step of the Application life-cycle. This private method delegates out to several protected methods which can be defined by the subclass.
Parameters
- Optional options: any
  Options which configure application rendering behavior
Returns Promise<ApplicationV2<any, any>>
A Promise which resolves to the rendered Application instance

Inherited from ApplicationV2.#render

`Private` #close

#close(options?): Promise<ApplicationV2<any, any>>
Manage the closing step of the Application life-cycle. This private method delegates out to several protected methods which can be defined by the subclass.
Parameters
- Optional options: ApplicationClosingOptions
  Options which modify how the application is closed
Returns Promise<ApplicationV2<any, any>>
A Promise which resolves to the rendered Application instance

Inherited from ApplicationV2.#close

`Private` #applyPosition

#applyPosition(position): void
Apply validated position changes to the element.
Parameters
- position: ApplicationPosition
  The new position data to apply.
Returns void
Inherited from ApplicationV2.#applyPosition

`Private` #doEvent

#doEvent(handler, options?): Promise<void>
Perform an event in the application life-cycle. Await an internal life-cycle method defined by the class. Optionally dispatch an event for any registered listeners.
Parameters
- handler: Function
  A handler function to call
- options: {
      async: boolean;
      handlerArgs: any[];
      debugText: string;
      eventName: string;
      hookName: string;
      hookArgs: any[];
  } = {}
  Options which configure event handling
  - async: boolean
    Await the result of the handler function?
  - handlerArgs: any[]
    Arguments passed to the handler function
  - debugText: string
    Debugging text to log for the event
  - eventName: string
    An event name to dispatch for registered listeners
  - hookName: string
    A hook name to dispatch for this and all parent classes
  - hookArgs: any[]
    Arguments passed to the requested hook function
Returns Promise<void>
A promise which resoles once the handler is complete

Inherited from ApplicationV2.#doEvent

`Private` #onPointerDown

#onPointerDown(event): Promise<void>
Handle initial pointerdown events inside a rendered Application.
Parameters
- event: PointerEvent
Returns Promise<void>
Inherited from ApplicationV2.#onPointerDown

`Private` #onClick

#onClick(event): Promise<void>
Centralized handling of click events which occur on or within the Application frame.
Parameters
- event: PointerEvent
Returns Promise<void>
Inherited from ApplicationV2.#onClick

`Private` #onClickAction

#onClickAction(event, target): void
Handle a click event on an element which defines a [data-action] handler.
Parameters
- event: PointerEvent
  The originating click event
- target: HTMLElement
  The capturing HTML element which defined a [data-action]
Returns void
Inherited from ApplicationV2.#onClickAction

`Private` #onClickTab

#onClickTab(event): void
Handle click events on a tab within the Application.
Parameters
- event: PointerEvent
Returns void
Inherited from ApplicationV2.#onClickTab

`Private` #startPointerCapture

#startPointerCapture(event, callback): void
Begin capturing pointer events on the application frame.
Parameters
- event: PointerEvent
  The triggering event.
- callback: Function
  The callback to attach to pointer move events.
Returns void
Inherited from ApplicationV2.#startPointerCapture

`Private` #endPointerCapture

#endPointerCapture(event, callback): void
End capturing pointer events on the application frame.
Parameters
- event: PointerEvent
  The triggering event.
- callback: Function
  The callback to remove from pointer move events.
Returns void
Inherited from ApplicationV2.#endPointerCapture

`Private` #onPointerMove

#onPointerMove(event): void | {
dx: number;
dy: number;
}
Handle a pointer move event while dragging or resizing the window frame.
Parameters
- event: PointerEvent
Returns void | {
dx: number;
dy: number;
}
The amount the cursor has moved since the last frame, or undefined if the movement occurred between frames.

Inherited from ApplicationV2.#onPointerMove

`Private` #onWindowDragStart

#onWindowDragStart(event): void
Begin dragging the Application position.
Parameters
- event: PointerEvent
Returns void
Inherited from ApplicationV2.#onWindowDragStart

`Private` #onWindowResizeStart

#onWindowResizeStart(event): void
Begin resizing the Application.
Parameters
- event: PointerEvent
Returns void
Inherited from ApplicationV2.#onWindowResizeStart

`Private` #onWindowDragMove

#onWindowDragMove(event): void
Drag the Application position during mouse movement.
Parameters
- event: PointerEvent
Returns void
Inherited from ApplicationV2.#onWindowDragMove

`Private` #onWindowResizeMove

#onWindowResizeMove(event): void
Resize the Application during mouse movement.
Parameters
- event: PointerEvent
Returns void
Inherited from ApplicationV2.#onWindowResizeMove

`Private` #onWindowDoubleClick

#onWindowDoubleClick(event): void
Double-click events on the window title are used to minimize or maximize the application.
Parameters
- event: PointerEvent
Returns void
Inherited from ApplicationV2.#onWindowDoubleClick

`Static` inheritanceChain

inheritanceChain(): Generator<typeof ApplicationV2, void, unknown>
Iterate over the inheritance chain of this Application. The chain includes this Application itself and all parents until the base application is encountered.

Returns Generator<typeof ApplicationV2, void, unknown>
See
ApplicationV2.BASE_APPLICATION

Generator
Yields
Inherited from ApplicationV2.inheritanceChain

`Static` parseCSSDimension

parseCSSDimension(style, parentDimension): number
Parse a CSS style rule into a number of pixels which apply to that dimension.
Parameters
- style: string
  The CSS style rule
- parentDimension: number
  The relevant dimension of the parent element
Returns number
The parsed style dimension in pixels

Inherited from ApplicationV2.parseCSSDimension

`Static` `Private` #onConfig

#onConfig(event): void
Handle clicks to configure a Region.
Parameters
- event: PointerEvent
Returns void

`Static` `Private` #onControl

#onControl(event): void
Handle clicks to assume control over a Region.
Parameters
- event: PointerEvent
Returns void

`Static` `Private` #onCreate

#onCreate(event): Promise<void>
Handle button clicks to create a new Region.
Parameters
- event: PointerEvent
Returns Promise<void>

`Static` `Private` #onDelete

#onDelete(event): Promise<void>
Handle clicks to delete a Region.
Parameters
- event: PointerEvent
Returns Promise<void>

`Static` `Private` #onLock

#onLock(event): Promise<void>
Handle clicks to toggle the locked state of a Region.
Parameters
- event: PointerEvent
Returns Promise<void>

Class RegionLegend

Mixes

Alias

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RegionLegend

Properties

elevation

Type declaration

bottom: number

top: number

options

tabGroups

position

Private #visibleRegions

Type declaration

bottom: number

top: number

Private #searchFilter

Private #hoveredRegion

Private #id

Private #renderable

Private #element

Private #content

Private #minimization

Type declaration

active: boolean

Private #position

Private #state

Type declaration

ERROR: -3

CLOSING: -2

CLOSED: -1

NONE: 0

RENDERING: 1

RENDERED: 2

Private #semaphore

Private #controlsExpanded

Private #events

Static DEFAULT_OPTIONS

Type declaration

id: string

tag: string

position: { width: number; height: string; }

width: number

height: string

window: { title: string; icon: string; minimizable: boolean; }

title: string

icon: string

minimizable: boolean

actions: { config: ((event) => void); control: ((event) => void); create: ((event) => Promise<void>); delete: ((event) => Promise<void>); lock: ((event) => Promise<void>); }

config: ((event) => void)

Parameters

Returns void

control: ((event) => void)

Parameters

Returns void

create: ((event) => Promise<void>)

Parameters

Returns Promise<void>

delete: ((event) => Promise<void>)

Parameters

Returns Promise<void>

lock: ((event) => Promise<void>)

Parameters

Returns Promise<void>

Static PARTS

Type declaration

list: { id: string; template: string; scrollable: string[]; }

id: string

template: string

scrollable: string[]

Static BASE_APPLICATION

`Private` #visibleRegions

`Private` #searchFilter

`Private` #hoveredRegion

`Private` #id

`Private` #renderable

`Private` #element

`Private` #content

`Private` #minimization

`Private` #position

`Private` #state

`Private` #semaphore

`Private` #controlsExpanded

`Private` #events

`Static` DEFAULT_OPTIONS

position: {
width: number;
height: string;
}

window: {
title: string;
icon: string;
minimizable: boolean;
}

actions: {
config: ((event) => void);
control: ((event) => void);
create: ((event) => Promise<void>);
delete: ((event) => Promise<void>);
lock: ((event) => Promise<void>);
}

`Static` PARTS

list: {
id: string;
template: string;
scrollable: string[];
}

`Static` BASE_APPLICATION

`Static` RENDER_STATES

`Static` emittedEvents

Returns {
header: HTMLElement;
resize: HTMLElement;
title: HTMLHeadingElement;
icon: HTMLElement;
close: HTMLButtonElement;
controls: HTMLButtonElement;
controlsDropdown: HTMLDivElement;
onDrag: Function;
onResize: Function;
pointerStartPosition: ApplicationPosition;
pointerMoveThrottle: boolean;
}

Returns Readonly<{
ERROR: -3;
CLOSING: -2;
CLOSED: -1;
NONE: 0;
RENDERING: 1;
RENDERED: 2;
}>

Returns Promise<{
regions: any;
elevation: {
bottom: string | number;
top: string | number;
};
}>