AboutSupportDeveloper GuideVersion 38.126.82.64

Interface ApplySnapshotOptions

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

Properties

closeExistingWindows? closeSnapshotWindows? skipOutOfBoundsCheck?

Properties

Optional closeExistingWindows

closeExistingWindows?: boolean

Default Value

false

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

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

Settings

Theme

On This Page

closeExistingWindowscloseSnapshotWindowsskipOutOfBoundsCheck