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

    Interface DocumentHTMLEmbedConfig

    interface DocumentHTMLEmbedConfig {
        caption?: boolean;
        captionPosition?: string;
        cite?: boolean;
        classes?: string;
        inline?: boolean;
        label?: string;
        values: string[];
    }
    Index

    Properties

    caption?: boolean

    Whether to include a caption. The caption will depend on the Document being embedded, but if an explicit label is provided, that will always be used as the caption. This option is ignored if the Document is inlined.

    captionPosition?: string

    Controls whether the caption is rendered above or below the embedded content.

    cite?: boolean

    Whether to include a content link to the original Document as a citation. This options is ignored if the Document is inlined.

    classes?: string

    Classes to attach to the outermost element.

    inline?: boolean

    By default Documents are embedded inside a figure element. If this option is passed, the embed content will instead be included as part of the rest of the content flow, but still wrapped in a section tag for styling purposes.

    label?: string

    The label.

    values: string[]

    Any strings that did not have a key name associated with them.