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

    Interface DataModelUpdateState

    interface DataModelUpdateState {
        cleanOptions?: boolean;
        creation?: boolean;
        documentId?: string;
        documentType?: string;
        expanded?: boolean;
        model?: any;
        modelSource?: object;
        modifiedTime?: number;
        sanitization?: object;
        source?: any;
        user?: any;
    }
    Index

    Properties

    cleanOptions?: boolean

    Have the DataModelCleaningOptions been fully populated?

    creation?: boolean

    Are we in the context of a new model creation?

    documentId?: string

    In a Document context, records its _id

    documentType?: string

    In a Document context, records its base type

    expanded?: boolean

    Has source data already been expanded?

    model?: any

    The DataModel instance being cleaned

    modelSource?: object

    Prior source data at the nearest DataModel root being cleaned

    modifiedTime?: number

    In a ServerDocument context, records the timestamp of modification

    sanitization?: object

    Metadata resulting from sanitization workflows

    source?: any

    Prior source data at the current node

    user?: any

    In a ServerDocument context, records the user performing the operation