Class Sequence

constructor

• new Sequence(canvas: HTMLCanvasElement, ignoreDelays?: boolean): Sequence

  Parameters

  • canvas: HTMLCanvasElement
  • ignoreDelays: boolean = false

  Returns Sequence

Readonlyconfig

addImageDataConsumer

• addImageDataConsumer(consumer: FrameConsumerFn): void

  Registers a function to receive image data after every drawn frame.

  Parameters

  • consumer: FrameConsumerFn

  Returns void

setLayout

• setLayout(layout: Layout): void

  Parameters

  • layout: Layout

  Returns void

capture

• capture(delayScale?: number): Promise<unknown>

  This should be called in sequence functions to request a frame to be drawn.

  Parameters

  • delayScale: number = 1

  Returns Promise<unknown>

  See

  SequenceFn

getModelNames

• getModelNames(): string[]

  Retrieves a list of all registered Models' names.

  Returns string[]

registerModel

• registerModel(name: string, ctor: () => Model): void

  Registers a factory function as a Model.

  Parameters

  • name: string
  • ctor: () => Model

  Returns void

  See

  createModel

createModel

• createModel(name: string): Model | undefined

  Instantiates a registered Model based on its name.

  Parameters

  • name: string

  Returns Model | undefined

  See

  getModelNames

redraw

• redraw(): Drawer

  Returns Drawer