Skip to main content

Interface: ConnectedSceneLayerProps

Properties​

allowUnsafePositioning​

• Optional allowUnsafePositioning: boolean

An optional prop to allow unsafe positioning of the scene when no slot information is available. When set to true and no slot information is available the dimensions of the panel will be used.

Default

false

Defined in​

packages/design-engine-react-components/src/components/sceneLayer/ConnectedSceneLayer.tsx:45

backgroundColor​

• Optional backgroundColor: string

An optional background color to use for the Scene preview. Will only be used with transparent scenes.

Defined in​

packages/design-engine-react-components/src/components/sceneLayer/ConnectedSceneLayer.tsx:39

className​

• Optional className: string

Custom class name for component

Defined in​

packages/design-engine-react-components/src/components/sceneLayer/ConnectedSceneLayer.tsx:31

defaultToFirstSlot​

• Optional defaultToFirstSlot: boolean

If a matching slot isn't found for the given scene URL and panel ID, then default to the first slot.

Default

false

Defined in​

packages/design-engine-react-components/src/components/sceneLayer/ConnectedSceneLayer.tsx:50

name​

• Optional name: string

Name to embed within bem class name template (dec-${name}-scene-preview) for differentiating SceneLayer by css selector

Defined in​

packages/design-engine-react-components/src/components/sceneLayer/ConnectedSceneLayer.tsx:21

panelId​

• panelId: string

Id of panel which is represented by scene (and for look up of slot number within scene)

Defined in​

packages/design-engine-react-components/src/components/sceneLayer/ConnectedSceneLayer.tsx:13

renderingTenant​

• Optional renderingTenant: string

The renderTenant used for requests. Defaults to dsc.

Defined in​

packages/design-engine-react-components/src/components/sceneLayer/ConnectedSceneLayer.tsx:35

sceneUrl​

• Optional sceneUrl: string

Url to scene which should be used. Will be inspected for slots to ensure compatibility with provided panelId

Defined in​

packages/design-engine-react-components/src/components/sceneLayer/ConnectedSceneLayer.tsx:17

transparent​

• Optional transparent: boolean

Whether the resulting preview should contain transparency Warning: This will result in a larger payload size for customers as the image will be a png

Default

false

Defined in​

packages/design-engine-react-components/src/components/sceneLayer/ConnectedSceneLayer.tsx:27