Options
All
  • Public
  • Public/Protected
  • All
Menu

Options used within the applyWorkspace method.

inheritdoc OpenFin.ApplySnapshotOptions

Hierarchy

  • ApplySnapshotOptions
    • ApplySnapshotOptions

Index

Properties

closeExistingWindows?: boolean

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

default

true

closeSnapshotWindows?: boolean
defaultvalue

false

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

skipOutOfBoundsCheck?: boolean
defaultvalue

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 {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.

Generated using TypeDoc