Interface InfoFlyoverParams

interface InfoFlyoverParams {
    format?: string;
    maxPrecision?: int;
    selector?: ElSelector;
}

Properties

format? maxPrecision? selector?

Properties

Optionalformat

format?: string

Text patterns supporting '${}' macros.

Supported macros are:

  • storyFrameNr - current render frame within the story.
  • storyElapsedS - number of seconds elapsed within the story.
  • storyElapsedMS - number of milliseconds elapsed within the story.
  • storyElapsedM - number of minutes elapsed within the story.

Example

story-frame: ${storyFrameNr} story-time: ${storyTime}

Default

${storyFrameNr}

OptionalmaxPrecision

maxPrecision?: int

Maximum number of decimal digits for time macros. @default: 4

Optionalselector

selector?: ElSelector

Element selector from the story, it can be DOM or virtual.

Default

.info-flyover

Settings

Member Visibility

On This Page

Properties