AboutSupportDeveloper GuideVersion 16.1.5

Interface ApplySnapshotOptions

Options used within the applyWorkspace method.

Inherit Doc

Hierarchy

  • ApplySnapshotOptions
    • ApplySnapshotOptions

Properties

closeExistingWindows? closeSnapshotWindows? skipOutOfBoundsCheck?

Properties

Optional closeExistingWindows

closeExistingWindows?: boolean

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

Default

true

Optional closeSnapshotWindows

closeSnapshotWindows?: boolean

Default Value

false

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

Optional skipOutOfBoundsCheck

skipOutOfBoundsCheck?: boolean

Default Value

false

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 PlatformProvider.positionOutOfBoundsWindows.

Settings

Theme

On This Page