AboutSupportDeveloper GuideVersion 47.154.100.2
OpenFin JavaScript API
    Preparing search index...

    Interface ApplySnapshotOptions

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

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

    false
    
    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