Component

A container of storyboard objects.

Example:

const component = new Component({
  children: [
    new Sprite({
      path: 'anim.png',
      layer: 'Background',
      origin: 'Centre',
      position: [320, 240],
    }),
  ],
})

Constructor details

Overloads:

new Component()

new Component({ children })

• Parameters:
  • children (Component | Graphic | Sample)[] | undefined (Component, Graphic, Sample) : List of child storyboard objects. Defaults to undefined.

Properties

children

List of child storyboard objects.

• Type: (Component | Graphic | Sample)[] (Graphic, Sample)

Methods

toFlatten()

Returns the flattened container tree.

• Returns: (Graphic | Sample)[] (Graphic, Sample)

toString()

Returns the string representation of this component.

• Returns: string