Skip to main content

Interface: PartialLayout

LayoutApiModel.PartialLayout

Partial layout

Properties​

width​

• Optional width: number

width of the layer in pixels

height​

• Optional height: number

height of the layer in pixels

metadata​

• Optional metadata: any

Metadata associated with a layout. This is freeform JSON.

projectId​

• Optional projectId: string

Project ID from the Live API for the layout note: this cannot be changed for existing layouts.

collectionId​

• Optional collectionId: string

Collection ID from the Live API for the layout note: this cannot be changed once set.

type​

• Optional type: LayoutType

The type of layout to use. Typically you should use LAYOUT_TYPE_SCENE to manage layouts via the API. This automatically creates a "root" layer for all layers to be under. LAYOUT_TYPE_SCENELESS is used for layouts managed by the Studio SDK.

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 associated with the publishing of the event