Interface TourStep

A step in a Tour

interface TourStep {
    content: string;
    id: string;
    layer?: string;
    restricted?: boolean;
    selector?: string;
    sidebarTab?: string;
    title: string;
    tool?: string;
    tooltipDirection?: "UP" | "DOWN" | "LEFT" | "RIGHT" | "CENTER";
}

Properties

content id layer? restricted? selector? sidebarTab? title tool? tooltipDirection?

Properties

content

content: string

Raw HTML content displayed during the step

id

id: string

A machine-friendly id of the Tour Step

Optionallayer

layer?: string

Activates a particular canvas layer and its respective control group. Usable in CanvasTour instances.

Optionalrestricted

restricted?: boolean

Whether the Step is restricted to the GM only. Defaults to false.

Optionalselector

selector?: string

A DOM selector which denotes an element to highlight during this step. If omitted, the step is displayed in the center of the screen.

OptionalsidebarTab

sidebarTab?: string

Activates a particular sidebar tab. Usable in SidebarTour instances.

title

title: string

The title of the step, displayed in the tooltip header

Optionaltool

tool?: string

Activates a particular tool. Usable in CanvasTour instances.

OptionaltooltipDirection

tooltipDirection?: "UP" | "DOWN" | "LEFT" | "RIGHT" | "CENTER"

How the tooltip for the step should be displayed relative to the target element. If omitted, the best direction will be attempted to be auto-selected.

Settings

Member Visibility

On This Page

Properties