OpenFin Workspace Platform API
    Preparing search index...

    Interface ApplySnapshotOptions

    Options used within the applyWorkspace method.

    interface ApplySnapshotOptions {
        closeExistingWindows?: boolean;
        closeSnapshotWindows?: boolean;
        skipOutOfBoundsCheck?: boolean;
    }

    Hierarchy

    • ApplySnapshotOptions
      • ApplySnapshotOptions
    Index
    closeExistingWindows? closeSnapshotWindows? skipOutOfBoundsCheck?
    closeExistingWindows?: boolean

    When true, applyWorkspace will close all existing windows, replacing current Platform state with the given snapshot.

    true
    closeSnapshotWindows?: boolean

    When true, applySnapshot will close existing includeInSnapshots: true windows, replacing current Platform state with the given snapshot.

    false
    skipOutOfBoundsCheck?: boolean

    When true, applySnapshot will not check whether any windows in a snapshot are off-screen. By default, such windows will be repositioned to be on-screen, as defined by PlatformProvider.positionOutOfBoundsWindows.

    false

    Settings

    On This Page
    Properties