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

    Interface ToCompendiumOptions

    interface ToCompendiumOptions {
        clearFlags?: boolean;
        clearFolder?: boolean;
        clearOwnership?: boolean;
        clearSort?: boolean;
        clearSource?: boolean;
        clearState?: boolean;
        dialog?: boolean;
        keepId?: boolean;
    }
    Index

    Properties

    clearFlags? clearFolder? clearOwnership? clearSort? clearSource? clearState? dialog? keepId?

    Properties

    clearFlags?: boolean

    Clear the flags object

    clearFolder?: boolean

    Clear the currently assigned folder

    clearOwnership?: boolean

    Clear document ownership (recursive)

    clearSort?: boolean

    Clear the currently assigned sort order

    clearSource?: boolean

    Clear any prior source information

    clearState?: boolean

    Clear fields which store document state (recursive)

    dialog?: boolean

    In cases where necessary, prompt the user with a confirmation dialog

    keepId?: boolean

    Retain the current Document id

    Settings

    Member Visibility

    On This Page

    Properties