Class Storyboard

constructor

• new Storyboard(): Storyboard

• Returns Storyboard

colors

fileFormat

minimumLayerDepth

useSkinSprites

variables

earliestEventTime

• get earliestEventTime(): null | number

• Across all layers, find the earliest point in time that a storyboard element exists at. Will return null if there are no elements. This iterates all elements and as such should be used sparingly or stored locally.

  Returns null | number

hasDrawable

• get hasDrawable(): boolean

• Returns boolean

hasVariables

• get hasVariables(): boolean

• Returns boolean

latestEventTime

• get latestEventTime(): null | number

• Across all layers, find the latest point in time that a storyboard element ends at. Will return null if there are no elements. This iterates all elements and as such should be used sparingly or stored locally. Videos and samples return start time as their end time.

  Returns null | number

layers

• get layers(): Map<string, StoryboardLayer>

• Returns Map<string, StoryboardLayer>

addLayer

• addLayer(layer): void

• Adds a new storyboard layer.

  Parameters

  • layer: StoryboardLayer

    A storyboard layer.

  Returns void

getLayerByName

• getLayerByName(name): StoryboardLayer

• Finds a storyboard layer by its name. Otherwise will create a new storyboard layer with this name.

  Parameters

  • name: string

    The name of the storyboard layer.

  Returns StoryboardLayer

  The storyboard layer.

getLayerByType

• getLayerByType(type): StoryboardLayer

• Finds a storyboard layer by its type. Returns background layer if type doesn't exist.

  Parameters

  • type: LayerType

    The type of the storyboard layer.

  Returns StoryboardLayer

  The storyboard layer.