@vttforge/core / DocumentSheetV2Members

Interface: DocumentSheetV2Members

What a document sheet adds on top of an application.

Extends

• ApplicationV2Members

Properties

document

readonly document: unknown

The document this sheet is for.

Typed loosely on purpose: which document, and what its system holds, is the consumer's to know. Narrow it with a getter on your subclass.

---

element

readonly element: HTMLElement | undefined

The window's root element once rendered. undefined before that.

Inherited from

ApplicationV2Members.element

---

isEditable

readonly isEditable: boolean

Whether the current user may edit this document.

---

options

readonly options: Record<string, unknown>

The resolved options this instance was constructed with.

Inherited from

ApplicationV2Members.options

---

rendered

readonly rendered: boolean

Whether the window is currently rendered.

Inherited from

ApplicationV2Members.rendered

---

title

readonly title: string

The window title, from options.window.title.

Inherited from

ApplicationV2Members.title

Methods

_onFirstRender()

_onFirstRender(context, options): void

Runs after the first render only.

Parameters

context

unknown

options

unknown

Returns

void

Inherited from

ApplicationV2Members._onFirstRender

---

_onRender()

_onRender(context, options): void

Runs after every render.

Parameters

context

unknown

options

unknown

Returns

void

Inherited from

ApplicationV2Members._onRender

---

_prepareContext()

_prepareContext(options): Promise<Record<string, unknown>>

Build the render context.

Parameters

options

unknown

Returns

Promise<Record<string, unknown>>

Inherited from

ApplicationV2Members._prepareContext

---

close()

close(options?): Promise<unknown>

Close the window.

Parameters

options?

unknown

Returns

Promise<unknown>

Inherited from

ApplicationV2Members.close

---

render()

render(options?, _options?): Promise<unknown>

Render the application. Resolves when the render completes.

Parameters

options?

unknown

_options?

unknown

Returns

Promise<unknown>

Inherited from

ApplicationV2Members.render