Search Docs
Loading...
Skip to content

Type Alias: SceneCreateOptions

type SceneCreateOptions = object &
| {
page?: PageSpec;
pageCount?: number;
pages?: never;
}
| {
pages: PageSpec[];
page?: never;
pageCount?: never;
};

Options for creating a new scene.

Type Declaration#

Name Type Description
mode? AddImageOptions Scene mode. Defaults to null (unified mode with all features enabled). Deprecated Scene mode is deprecated. New scenes should use the default null mode.
layout? AddImageOptions Scene layout. Defaults to ‘VerticalStack’ for Design, ignored for Video.