Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface DocumentSheetRenderOptions

    interface DocumentSheetRenderOptions {
        force?: boolean;
        isFirstRender?: boolean;
        parts?: string[];
        position?: ApplicationPosition;
        renderContext: string;
        renderData: object;
        tab?: string | Record<string, string>;
        window?: ApplicationWindowRenderOptions;
    }
    Index

    Properties

    force? isFirstRender? parts? position? renderContext renderData tab? window?

    Properties

    force?: boolean

    Force application rendering. If true, an application which does not yet exist in the DOM is added. If false, only applications which already exist are rendered.

    isFirstRender?: boolean

    Is this render the first one for the application? This property is populated automatically.

    parts?: string[]

    Some Application classes, for example the HandlebarsApplication, support re-rendering a subset of application parts instead of the full Application HTML.

    position?: ApplicationPosition

    A specific position at which to render the Application

    renderContext: string

    A string with the format "{operation}{documentName}" providing context

    renderData: object

    Data describing the document modification that occurred

    tab?: string | Record<string, string>

    A tab to activate. Either the tab's ID for applications with only one tab group, or an object of tab groups to tab IDs. Re-rendering an Application with this option will not trigger changeTab.

    window?: ApplicationWindowRenderOptions

    Updates to the Application window frame

    Settings

    Member Visibility

    On This Page

    Properties