Class FormulaEditor

An application that provides improved formula editing capabilities.

Hierarchy (View Summary)

ApplicationV2
- FormulaEditor

Index

Properties

options position tabGroups _appId _maxZ BASE_APPLICATION DEFAULT_OPTIONS emittedEvents IDENTIFIER RENDER_STATES TABS

Accessors

children classList context element form formula hasFrame id labels minimized parent rendered state title window schema

Properties

options

options: Readonly<ApplicationConfiguration & FormulaEditorConfiguration>

Application instance configuration options.

position

position: ApplicationPosition = ...

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

tabGroups

tabGroups: Record<string, string | null> = ...

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

`Static` `Internal`_appId

_appId: number = 0

An incrementing integer Application ID.

`Static` `Internal`_maxZ

_maxZ: number = ...

The current maximum z-index of any displayed Application.

`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`DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    classes: string[];
    context: string;
    formula: string;
    id: string;
    position: { height: number; width: number };
    tag: string;
    window: {
        contentClasses: string[];
        icon: string;
        minimizable: boolean;
        resizable: boolean;
    };
} = ...

`Static`emittedEvents

emittedEvents: readonly ["prerender", "render", "close", "position"] = ...

`Static`IDENTIFIER

IDENTIFIER: RegExp = ...

The regular expression to match formula data identifiers.

`Static`RENDER_STATES

RENDER_STATES: Record<string, number> = ...

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

`Static`TABS

TABS: Record<string, ApplicationTabsConfiguration> = {}

Configuration of application tabs, with an entry per tab group.

Accessors

children

get children(): Map<
string,
ApplicationV2<ApplicationConfiguration, ApplicationRenderOptions>,
>
The child Applications registered under this one via renderChild.

Returns Map<string, ApplicationV2<ApplicationConfiguration, ApplicationRenderOptions>>
Inherited from foundry.children

classList

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

Returns DOMTokenList
Inherited from ApplicationV2.classList

context

get context(): FormulaEditorContext
Get the configured context for this formula editor.

Returns FormulaEditorContext

element

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

Returns HTMLElement
Inherited from ApplicationV2.element

form

get form(): HTMLFormElement | null
Does this Application have a top-level form element?

Returns HTMLFormElement | null
Inherited from ApplicationV2.form

formula

get formula(): string
The current formula value.

Returns string

hasFrame

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

Returns boolean
Inherited from ApplicationV2.hasFrame

id

get id(): string
The HTML element ID of this Application instance. This provides a readonly view into the internal ID used by this application. This getter should not be overridden by subclasses, which should instead configure the ID in DEFAULT_OPTIONS or by defining a uniqueId during _initializeApplicationOptions.

Returns string
Inherited from ApplicationV2.id

labels

get labels(): Record<string, string>
Get the labels mapping for this context.

Returns Record<string, string>

minimized

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

Returns boolean
Inherited from ApplicationV2.minimized

parent

get parent(): | ApplicationV2<
ApplicationConfiguration,
ApplicationRenderOptions,
>
| null
The parent Application of this Application, if registered via renderChild.

Returns ApplicationV2<ApplicationConfiguration, ApplicationRenderOptions> | null
Inherited from foundry.parent

rendered

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

Returns boolean
Inherited from ApplicationV2.rendered

state

get state(): number
The current render state of the Application.

Returns number
Inherited from ApplicationV2.state

title

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

Returns string
Inherited from ApplicationV2.title

window

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

Returns {
    close: HTMLButtonElement;
    content: HTMLElement;
    controls: HTMLButtonElement;
    header: HTMLElement;
    icon: HTMLElement;
    onDrag: Function;
    onResize: Function;
    pointerMoveThrottle: boolean;
    pointerStartPosition: ApplicationPosition;
    resize: HTMLElement;
    title: HTMLHeadingElement;
    windowId: string;
}
Inherited from foundry.window

`Static`schema

get schema(): Schema
The ProseMirror schema.

Returns Schema

Methods

_awaitTransition

_awaitTransition(element: HTMLElement, timeout: number): 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

_canAttach

_canAttach(): boolean
Returns boolean
Overrides ApplicationV2._canAttach

_canDetach

_canDetach(): boolean
Returns boolean
Overrides ApplicationV2._canDetach

_canRender

_canRender(options: any): false | undefined
Parameters
- options: any
Returns false | undefined
Overrides ApplicationV2._canRender

_doEvent

_doEvent(
    handler: Function,
    options?: {
        async?: boolean;
        debugText?: string;
        eventName?: string;
        handlerArgs?: any[];
        hookArgs?: any[];
        hookName?: string;
        hookResponse?: boolean;
        parentClassHooks?: boolean;
    },
): void
| Promise<void>
Internal
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;
      debugText?: string;
      eventName?: string;
      handlerArgs?: any[];
      hookArgs?: any[];
      hookName?: string;
      hookResponse?: boolean;
      parentClassHooks?: boolean;
  } = {}
  Options which configure event handling
  - Optionalasync?: boolean
    Await the result of the handler function?
  - OptionaldebugText?: string
    Debugging text to log for the event
  - OptionaleventName?: string
    An event name to dispatch for registered listeners
  - OptionalhandlerArgs?: any[]
    Arguments passed to the handler function
  - OptionalhookArgs?: any[]
    Arguments passed to the requested hook function
  - OptionalhookName?: string
    A hook name to dispatch for this and all parent classes
  - OptionalhookResponse?: boolean
    Add the handler response to hookArgs
  - OptionalparentClassHooks?: boolean
    Call hooks for parent classes in the inheritance chain?
Returns void | Promise<void>
A promise which resoles once the handler is complete if async is true

Inherited from ApplicationV2._doEvent

_onFirstRender

_onFirstRender(context: any, options: any): Promise<void>
Parameters
- context: any
- options: any
Returns Promise<void>
Overrides ApplicationV2._onFirstRender

_renderFrame

_renderFrame(options: any): Promise<HTMLElement>
Parameters
- options: any
Returns Promise<HTMLElement>
Inherit Doc
Overrides ApplicationV2._renderFrame

_renderHTML

_renderHTML(context: any, options: any): Promise<HTMLDivElement>
Parameters
- context: any
- options: any
Returns Promise<HTMLDivElement>
Overrides ApplicationV2._renderHTML

_replaceHTML

_replaceHTML(result: any, content: any, options: any): void
Parameters
- result: any
- content: any
- options: any
Returns void
Overrides ApplicationV2._replaceHTML

addEventListener

addEventListener(
    type: string,
    listener: EmittedEventListener,
    options?: { once?: boolean },
): 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
- Optionaloptions: { once?: boolean } = {}
  Options which configure the event listener
  - Optionalonce?: 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

attachWindow

attachWindow(
options?: ApplicationRenderOptions,
): Promise<
ApplicationV2<ApplicationConfiguration, ApplicationRenderOptions>,
>
Re-attach a detached application to the main workspace. If this application was previously a child and was manually detached, breaking its parent link, this method first attempts to re-join the prior parent's window before falling back to the main workspace.
Parameters
- Optionaloptions: ApplicationRenderOptions = {}
  Render options.
Returns Promise<ApplicationV2<ApplicationConfiguration, ApplicationRenderOptions>>
Inherited from ApplicationV2.attachWindow

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: string,
    group: string,
    options?: {
        event?: Event;
        force?: boolean;
        navElement?: HTMLElement;
        updatePosition?: boolean;
    },
): 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
- Optionaloptions: {
      event?: Event;
      force?: boolean;
      navElement?: HTMLElement;
      updatePosition?: boolean;
  } = {}
  Additional options which affect tab navigation
  - Optionalevent?: Event
    An interaction event which caused the tab change, if any
  - Optionalforce?: boolean
    Force changing the tab even if the new tab is already active
  - OptionalnavElement?: HTMLElement
    An explicit navigation element being modified
  - OptionalupdatePosition?: boolean
    Update application position after changing the tab?
Returns void
Inherited from ApplicationV2.changeTab

close

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

Inherited from ApplicationV2.close

detachWindow

detachWindow(options?: ApplicationRenderOptions): Promise<FormulaEditor>
Detach an application from the main workspace, and render it in a separate browser window. If this application is a registered child, detaching it breaks the parent link and gives it its own window.
Parameters
- Optionaloptions: ApplicationRenderOptions = {}
  Render options.
Returns Promise<FormulaEditor>
Inherited from ApplicationV2.detachWindow

dispatchEvent

dispatchEvent(event: 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

maximize

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

Returns Promise<void>
Inherited from ApplicationV2.maximize

minimize

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

Returns Promise<void>
Inherited from ApplicationV2.minimize

removeEventListener

removeEventListener(type: string, listener: EmittedEventListener): 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

render

render(
options?: boolean | ApplicationRenderOptions,
_options?: ApplicationRenderOptions,
): Promise<FormulaEditor>
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
- Optionaloptions: boolean | ApplicationRenderOptions = {}
  Options which configure application rendering behavior. A boolean is interpreted as the "force" option.
- Optional_options: ApplicationRenderOptions = {}
  Legacy options for backwards-compatibility with the original ApplicationV1#render signature.
Returns Promise<FormulaEditor>
A Promise which resolves to the rendered Application instance

Inherited from ApplicationV2.render

renderChild

renderChild(
    app: ApplicationV2<ApplicationConfiguration, ApplicationRenderOptions>,
    options?: ApplicationRenderOptions,
): Promise<
    ApplicationV2<ApplicationConfiguration, ApplicationRenderOptions>,
>
Render another Application as a child of this one. The child is rendered in the same window as this application and moves with it when it is detached or re-attached. Closing this application will also close the child. If the child was previously registered under a different parent, that link is replaced.
Parameters
- app: ApplicationV2<ApplicationConfiguration, ApplicationRenderOptions>
  The child application to render.
- Optionaloptions: ApplicationRenderOptions = {}
  Render options passed to the child's render method.
Returns Promise<ApplicationV2<ApplicationConfiguration, ApplicationRenderOptions>>
A Promise which resolves to the rendered child Application.

Inherited from ApplicationV2.renderChild

setPosition

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

Inherited from ApplicationV2.setPosition

submit

submit(submitOptions?: object): Promise<any>
Programmatically submit an ApplicationV2 instance which implements a single top-level form.
Parameters
- OptionalsubmitOptions: object = {}
  Arbitrary options which are supported by and provided to the configured form submission handler.
Returns Promise<any>
A promise that resolves to the returned result of the form submission handler, if any.

Inherited from ApplicationV2.submit

`Protected`_attachFrameListeners

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

Returns void
Inherited from ApplicationV2._attachFrameListeners

`Protected`_configureRenderOptions

_configureRenderOptions(options: ApplicationRenderOptions): void
Protected
Modify the provided options passed to a render request.
Parameters
- options: ApplicationRenderOptions
  Options which configure application rendering behavior
Returns void
Inherited from ApplicationV2._configureRenderOptions

`Protected`_createContextMenu

_createContextMenu(
    handler: () => ContextMenuEntry[],
    selector: string,
    options?: {
        container?: HTMLElement;
        hookName?: string;
        parentClassHooks?: boolean;
    },
): ContextMenu
| null
Protected
Create a ContextMenu instance used in this Application.
Parameters
- handler: () => ContextMenuEntry[]
  A handler function that provides initial context options
- selector: string
  A CSS selector to which the ContextMenu will be bound
- Optionaloptions: { container?: HTMLElement; hookName?: string; parentClassHooks?: boolean } = {}
  Additional options which affect ContextMenu construction
  - Optionalcontainer?: HTMLElement
    A parent HTMLElement which contains the selector target
  - OptionalhookName?: string
    The hook name
  - OptionalparentClassHooks?: boolean
    Whether to call hooks for the parent classes in the inheritance chain.
Returns ContextMenu | null
A created ContextMenu or null if no menu items were defined

Inherited from ApplicationV2._createContextMenu

`Protected`_getHeaderControls

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

Returns ApplicationHeaderControlsEntry[]
Inherited from ApplicationV2._getHeaderControls

`Protected`_getTabsConfig

_getTabsConfig(group: string): ApplicationTabsConfiguration | null
Protected
Get the configuration for a tabs group.
Parameters
- group: string
  The ID of a tabs group
Returns ApplicationTabsConfiguration | null
Inherited from ApplicationV2._getTabsConfig

`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`_headerControlContextEntries

_headerControlContextEntries(): Generator<ContextMenuEntry, void, any>
Protected
Generate context menu entries based on the header control specification.

Returns Generator<ContextMenuEntry, void, any>
Yields
Inherited from ApplicationV2._headerControlContextEntries

`Protected`_initializeApplicationOptions

_initializeApplicationOptions(
options: Partial<ApplicationConfiguration>,
): 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<ApplicationConfiguration>
  Options provided directly to the constructor
Returns ApplicationConfiguration
Configured options for the application instance

Inherited from ApplicationV2._initializeApplicationOptions

`Protected`_insertElement

_insertElement(
element: HTMLElement,
options?: ApplicationRenderOptions,
): Promise<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
- Optionaloptions: ApplicationRenderOptions = {}
  Render options.
Returns Promise<void>
Inherited from ApplicationV2._insertElement

`Protected`_onAttach

_onAttach(from: Document, to: Document): void
Protected
Actions performed after the Application has been re-attached to the main workspace. Registered child Applications are re-attached automatically after this method returns.
Parameters
- from: Document
  The Application's former host document. This document's window may have been closed.
- to: Document
  The main workspace document.
Returns void
Inherited from ApplicationV2._onAttach

`Protected`_onChangeForm

_onChangeForm(formConfig: ApplicationFormConfiguration, event: Event): void
Protected
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

`Protected`_onClickAction

_onClickAction(event: PointerEvent, target: HTMLElement): 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`_onClickTab

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

`Protected`_onClose

_onClose(options: ApplicationRenderOptions): void
Protected
Actions performed after closing the Application. Post-close steps are not awaited by the close process.
Parameters
- options: ApplicationRenderOptions
  Provided render options
Returns void
Inherited from ApplicationV2._onClose

`Protected`_onDetach

_onDetach(from: Document, to: Document): void
Protected
Actions performed after the Application has been detached from the main workspace. Registered child Applications are moved into the same detached window automatically after this method returns.
Parameters
- from: Document
  The main workspace document.
- to: Document
  The Application's new host document.
Returns void
Inherited from ApplicationV2._onDetach

`Protected`_onPosition

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

`Protected`_onRender

_onRender(
context: ApplicationRenderContext,
options: ApplicationRenderOptions,
): Promise<void>
Protected
Actions performed after any render of the Application.
Parameters
- context: ApplicationRenderContext
  Prepared context data
- options: ApplicationRenderOptions
  Provided render options
Returns Promise<void>
Inherited from ApplicationV2._onRender

`Protected`_onSubmitForm

_onSubmitForm(
formConfig: ApplicationFormConfiguration,
event: Event | SubmitEvent,
): 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

`Protected`_postRender

_postRender(
context: ApplicationRenderContext,
options: ApplicationRenderOptions,
): Promise<void>
Protected
Perform post-render finalization actions.
Parameters
- context: ApplicationRenderContext
  Prepared context data.
- options: ApplicationRenderOptions
  Provided render options.
Returns Promise<void>
Inherited from ApplicationV2._postRender

`Protected`_preClose

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

`Protected`_preFirstRender

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

`Protected`_prepareContext

_prepareContext(
options: ApplicationRenderOptions,
): Promise<ApplicationRenderContext>
Protected
Prepare application rendering context data for a given render request. If exactly one tab group is configured for this application, it will be prepared automatically.
Parameters
- options: ApplicationRenderOptions
  Options which configure application rendering behavior
Returns Promise<ApplicationRenderContext>
Context data for the render operation

Inherited from ApplicationV2._prepareContext

`Protected`_prepareTabs

_prepareTabs(group: string): Record<string, ApplicationTab>
Protected
Prepare application tab data for a single tab group.
Parameters
- group: string
  The ID of the tab group to prepare
Returns Record<string, ApplicationTab>
Inherited from ApplicationV2._prepareTabs

`Protected`_prePosition

_prePosition(position: ApplicationPosition): 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`_preRender

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

`Protected`_removeElement

_removeElement(element: HTMLElement): 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`_renderHeaderControl

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

`Protected`_replaceTerms

_replaceTerms(tr: Transaction, schema: Schema): Transaction
Protected
Parse the given ProseMirror document state and replace data terms with human-readable labels.
Parameters
- tr: Transaction
  The state transaction.
- schema: Schema
  The ProseMirror document schema.
Returns Transaction

`Protected`_tearDown

_tearDown(options: ApplicationClosingOptions): void
Protected
Remove elements from the DOM and trigger garbage collection as part of application closure.
Parameters
- options: ApplicationClosingOptions
Returns void
Inherited from ApplicationV2._tearDown

`Protected`_updateFrame

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

`Protected`_updatePosition

_updatePosition(position: ApplicationPosition): 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

`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

Yields
Inherited from ApplicationV2.inheritanceChain

`Static`instances

instances(): Generator<typeof ApplicationV2, any, any>
Iterate over the instances of this Application.

Returns Generator<typeof ApplicationV2, any, any>
Yields
Inherited from ApplicationV2.instances

`Static`parseCSSDimension

parseCSSDimension(style: string, parentDimension: number): number | void
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 | void
The parsed style dimension in pixels

Inherited from ApplicationV2.parseCSSDimension

`Static`toFormula

toFormula(state: EditorState): string
Convert a ProseMirror document back into a formula string.
Parameters
- state: EditorState
  The ProseMirror document state.
Returns string

`Static`waitForImages

waitForImages(element: HTMLElement): Promise<void>
Wait for any images in the given element to load.
Parameters
- element: HTMLElement
  The element.
Returns Promise<void>
Inherited from ApplicationV2.waitForImages

Class FormulaEditor

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

options

position

tabGroups

Static Internal_appId

Static Internal_maxZ

StaticBASE_APPLICATION

StaticDEFAULT_OPTIONS

StaticemittedEvents

StaticIDENTIFIER

StaticRENDER_STATES

StaticTABS

Accessors

children

Returns Map<string, ApplicationV2<ApplicationConfiguration, ApplicationRenderOptions>>

classList

Returns DOMTokenList

context

Returns FormulaEditorContext

element

Returns HTMLElement

form

Returns HTMLFormElement | null

formula

Returns string

hasFrame

Returns boolean

id

Returns string

labels

Returns Record<string, string>

minimized

Returns boolean

parent

Returns ApplicationV2<ApplicationConfiguration, ApplicationRenderOptions> | null

rendered

Returns boolean

state

Returns number

title

Returns string

window

Staticschema

Returns Schema

Methods

_awaitTransition

Parameters

Returns Promise<void>

_canAttach

Returns boolean

_canDetach

Returns boolean

_canRender

Parameters

Returns false | undefined

_doEvent

Parameters

Optionalasync?: boolean

OptionaldebugText?: string

OptionaleventName?: string

OptionalhandlerArgs?: any[]

OptionalhookArgs?: any[]

OptionalhookName?: string

OptionalhookResponse?: boolean

OptionalparentClassHooks?: boolean

Returns void | Promise<void>

_onFirstRender

Parameters

Returns Promise<void>

_renderFrame

Parameters

Returns Promise<HTMLElement>

Inherit Doc

_renderHTML

`Static` `Internal`_appId

`Static` `Internal`_maxZ

`Static`BASE_APPLICATION

`Static`DEFAULT_OPTIONS

`Static`emittedEvents

`Static`IDENTIFIER

`Static`RENDER_STATES

`Static`TABS

`Static`schema

`Optional`async?: boolean

`Optional`debugText?: string

`Optional`eventName?: string

`Optional`handlerArgs?: any[]

`Optional`hookArgs?: any[]

`Optional`hookName?: string

`Optional`hookResponse?: boolean

`Optional`parentClassHooks?: boolean

`Optional`once?: boolean

`Optional`event?: Event

`Optional`force?: boolean

`Optional`navElement?: HTMLElement

`Optional`updatePosition?: boolean

`Protected`_attachFrameListeners

`Protected`_configureRenderOptions

`Protected`_createContextMenu

`Optional`container?: HTMLElement

`Optional`hookName?: string

`Optional`parentClassHooks?: boolean

`Protected`_getHeaderControls

`Protected`_getTabsConfig

`Protected`_headerControlButtons