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

    Interface DocumentSheetConfiguration

    interface DocumentSheetConfiguration {
        actions: Record<
            string,
            | ApplicationClickAction
            | { buttons: number[]; handler: ApplicationClickAction },
        >;
        canCreate: boolean;
        canImport: boolean;
        classes: string[];
        document: Document;
        editPermission: number;
        form?: ApplicationFormConfiguration;
        id: string;
        ownershipConfig: boolean;
        position: Partial<ApplicationPosition>;
        sheetConfig: boolean;
        tag: string;
        uniqueId: string;
        viewPermission: number;
        window: ApplicationWindowConfiguration;
    }
    Index

    Properties

    actions: Record<
        string,
        | ApplicationClickAction
        | { buttons: number[]; handler: ApplicationClickAction },
    >

    Click actions supported by the Application and their event handler functions. A handler function can be defined directly which only responds to left-click events. Otherwise, an object can be declared containing both a handler function and an array of buttons which are matched against the PointerEvent#button property.

    canCreate: boolean

    Can this sheet class be used to create a new Document?

    canImport: boolean

    Can the Document be imported into the World from a Compendium Collection?

    classes: string[]

    An array of CSS classes to apply to the Application

    document: Document

    The Document instance associated with this sheet

    editPermission: number

    A permission level in CONST.DOCUMENT_OWNERSHIP_LEVELS

    Configuration used if the application top-level element is a form or dialog

    id: string

    An HTML element identifier used for this Application instance

    ownershipConfig: boolean

    Allow ownership configuration as a header button

    position: Partial<ApplicationPosition>

    Default positioning data for the application

    sheetConfig: boolean

    Allow sheet configuration as a header button

    tag: string

    The HTMLElement tag type used for the outer Application frame

    uniqueId: string

    A string discriminator substituted for {id} in the default HTML element identifier for the class

    viewPermission: number

    A permission level in CONST.DOCUMENT_OWNERSHIP_LEVELS

    Configuration of the window behaviors for this Application