StepControllerOptions

What a StepController is built from.

@internote/canvas-sdkInterface
On this page
import { StepControllerOptions } from '@internote/canvas-sdk';

#Fields

clock
The clock the controller reads, in milliseconds. A test passes a manual one.
() => number
DefaultDate.now
continues
A controller whose timeline this one carries on: its step, its entries, its scene clock and its pause, so the scene goes on exactly where it was. A host rebuilt for the same document passes the scene's old controller, so an uploaded file arriving does not restart the reader's animation. Ignored when its step count differs.
StepController
holds
Whether entering a step waits for the reader: when true for a step, it arrives paused at its start, to play when the reader presses play. Absent means no step holds.
(step: number) => boolean
initialStep
The step to start on. Earlier steps start settled, so their content renders finished.
number
Default0
stepCountRequired
How many step markers the scene body has. Valid steps run from 0 to this.
number

Declared in packages/canvas-sdk/src/animation/StepController.ts:24.

Last updated