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

    Interface ApplicationV1Options

    Configuration options which control how the application is rendered. Application subclasses may add additional supported options, but these base configurations are supported for all Applications. The values passed to the constructor are combined with the defaultOptions defined at the class level.

    interface ApplicationV1Options {
        baseApplication?: string | null;
        classes?: string[];
        dragDrop: DragDropConfiguration[];
        filters: SearchFilterConfiguration[];
        height?: string | number | null;
        id?: string;
        left?: number | null;
        minimizable?: boolean;
        popOut?: boolean;
        resizable?: boolean;
        scale?: number | null;
        scrollY?: string[];
        tabs?: TabsConfiguration[];
        template?: string | null;
        title?: string;
        top?: number | null;
        width?: number | null;
    }
    Index

    Properties

    baseApplication? classes? dragDrop filters height? id? left? minimizable? popOut? resizable? scale? scrollY? tabs? template? title? top? width?

    Properties

    baseApplication?: string | null

    A named "base application" which generates an additional hook

    classes?: string[]

    An array of CSS string classes to apply to the rendered HTML

    dragDrop: DragDropConfiguration[]

    An array of CSS selectors for configuring the application's foundry.applications.ux.DragDrop behaviour.

    filters: SearchFilterConfiguration[]

    An array of foundry.applications.ux.SearchFilter configuration objects.

    height?: string | number | null

    The default pixel height for the rendered HTML

    id?: string

    The default CSS id to assign to the rendered HTML

    left?: number | null

    The default offset-left position for the rendered HTML

    minimizable?: boolean

    Whether the rendered application can be minimized (popOut only)

    popOut?: boolean

    Whether to display the application as a pop-out container

    resizable?: boolean

    Whether the rendered application can be drag-resized (popOut only)

    scale?: number | null

    A transformation scale for the rendered HTML

    scrollY?: string[]

    A list of unique CSS selectors which target containers that should have their vertical scroll positions preserved during a re-render.

    tabs?: TabsConfiguration[]

    An array of tabbed container configurations which should be enabled for the application.

    template?: string | null

    The default HTML template path to render for this Application

    title?: string

    A default window title string (popOut only)

    top?: number | null

    The default offset-top position for the rendered HTML

    width?: number | null

    The default pixel width for the rendered HTML

    Settings

    Member Visibility

    On This Page

    Properties