Interface KeyWindowTutorialStep<T>

The KeyWindowTutorialStep interface provides a way to define a step in a KeyWindowTutorial. Each step can highlight an element and provide a description. The tutorial is a linear sequence of steps that are executed one after the other.

interface KeyWindowTutorialStep<T> {
    activeWindows: DockableEditorWindow[];
    description: string;
    element: UIElementBase;
    onEnterStep?: (() => T);
    onExitStep?: ((options: T) => void);
    title: string;
    windowPlacement?: EnumValue<CalloutPlacement, number>;
}

Type Parameters

  • T = any

Properties

activeWindows description element onEnterStep? onExitStep? title windowPlacement?

Properties

activeWindows

activeWindows: DockableEditorWindow[]

The dockable window that owns the element.

description

description: string

The description of the step.

element

element: UIElementBase

The element to highlight.

OptionalonEnterStep

onEnterStep?: (() => T)

Invoked when the tutorial step begins. Useful to prepare the context for the tutorial.

Note

The return value of the lambda will later be passed to onExitStep to allow for cleanup.

OptionalonExitStep

onExitStep?: ((options: T) => void)

Invoked when the tutorial step concludes, any objects created must be manually removed.

title

title: string

The title of the step.

OptionalwindowPlacement

windowPlacement?: EnumValue<CalloutPlacement, number>

The optional placement of the callout window. If unspecified, a best-fit will be automatically chosen.

Settings

Member Visibility

On This Page

Properties