Skip to main content

Interface: Layout

LayoutApiModel.Layout

A Layout represents a container for multiple layers.

Properties​

id​

• id: string

internal ID for the layout

width​

• width: number

width of the layout in pixels

height​

• height: number

height of the layout in pixels

metadata​

• Optional metadata: any

Custom value for the layer. This is freeform.

projectId​

• Optional projectId: string

collectionId​

• Optional collectionId: string

type​

• Optional type: LayoutType

transitions​

• transitions: Transition[]

Transitions to apply when switching to this scene from another note: this is only available for layouts of type LAYOUT_TYPE_SCENE.

requestMetadata​

• Optional requestMetadata: any

Metadata sent with the request