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

    Interface FolderData

    interface FolderData {
        _id: string | null;
        _stats: DocumentStats;
        color?: string | null;
        description: string;
        flags: DocumentFlags;
        folder?: string | null;
        name: string;
        sort?: number;
        sorting?: string;
        type: string;
    }
    Index

    Properties

    _id _stats color? description flags folder? name sort? sorting? type

    Properties

    _id

    _id: string | null

    The _id which uniquely identifies this Folder document

    _stats

    _stats: DocumentStats

    An object of creation and access information

    color?: string | null

    A color string used for the background color of this Folder

    description: string

    An HTML description of the contents of this folder

    flags: DocumentFlags

    An object of optional key/value flags

    folder?: string | null

    The _id of a parent Folder which contains this Folder

    name: string

    The name of this Folder

    sort?: number

    The numeric sort value which orders this Folder relative to its siblings

    sorting?: string

    The sorting mode used to organize documents within this Folder, in ["a", "m"]

    type: string

    The document type which this Folder contains, from CONST.FOLDER_DOCUMENT_TYPES

    Settings

    Member Visibility

    On This Page

    Properties