AboutSupportDeveloper GuideVersion 22.3.18

Interface ApplySnapshotOptions

Options used within the applyWorkspace method.

Inherit Doc: OpenFin.ApplySnapshotOptions

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

Hierarchy

  • ApplySnapshotOptions
    • ApplySnapshotOptions

Properties

closeExistingWindows? closeSnapshotWindows? skipOutOfBoundsCheck?

Properties

OptionalcloseExistingWindows

closeExistingWindows?: boolean

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

Default

true

OptionalcloseSnapshotWindows

closeSnapshotWindows?: boolean

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

Default

false

OptionalskipOutOfBoundsCheck

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.

Default

false

Settings

On This Page

Properties