@vttforge/types / DocumentSheetV2Members

Interface: DocumentSheetV2Members<TDocument>

What a document sheet adds on top of an application.

TDocument is the document this sheet is for. It defaults to the shared document surface, so a sheet that says nothing still reads name, system and update(). Pass your own type to narrow it further.

Extends

• ApplicationV2Members

Type Parameters

TDocument

TDocument = DocumentMembers

Properties

document

readonly document: TDocument

The document this sheet is for.

---

element

readonly element: HTMLElement | undefined

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

Inherited from

DocumentSheetV2Members.element

---

isEditable

readonly isEditable: boolean

Whether the current user may edit this document.

---

options

readonly options: ApplicationConfiguration

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

ApplicationRenderContext

options

ApplicationRenderOptions

Returns

void

Inherited from

ApplicationV2Members._onFirstRender

---

_onRender()

_onRender(context, options): void

Runs after every render.

Parameters

context

ApplicationRenderContext

options

ApplicationRenderOptions

Returns

void

Inherited from

ApplicationV2Members._onRender

---

_prepareContext()

_prepareContext(options): Promise<ApplicationRenderContext>

Build the render context.

Parameters

options

ApplicationRenderOptions

Returns

Promise<ApplicationRenderContext>

Inherited from

ApplicationV2Members._prepareContext

---

_preRender()

_preRender(context, options): Promise<void>

Runs after _prepareContext and before the frame renders. New in v14.

Parameters

context

ApplicationRenderContext

options

ApplicationRenderOptions

Returns

Promise<void>

Inherited from

ApplicationV2Members._preRender

---

attachWindow()

attachWindow(): void

Returns

void

Inherited from

ApplicationV2Members.attachWindow

---

close()

close(options?): Promise<DocumentSheetV2Members<TDocument>>

Close the window.

Parameters

options?

Record<string, unknown>

Returns

Promise<DocumentSheetV2Members<TDocument>>

Inherited from

ApplicationV2Members.close

---

detachWindow()

detachWindow(): void

Move the window into its own browser window. New in v14.

Returns

void

Inherited from

ApplicationV2Members.detachWindow

---

render()

render(options?, _options?): Promise<DocumentSheetV2Members<TDocument>>

Render the application. Resolves when the render completes.

Parameters

options?

boolean | ApplicationRenderOptions

_options?

ApplicationRenderOptions

Returns

Promise<DocumentSheetV2Members<TDocument>>

Inherited from

ApplicationV2Members.render