Class: ItemPreviewExtension
Extension that uses Client Side Rendering libraries, also collectively known as "Fusion", to generate item previews
Dependencies
[CimDocStore, LayoutStore, DesignExtensionSystem]
Hierarchy
BaseExtension↳
ItemPreviewExtension
Constructors
constructor
• new ItemPreviewExtension(designState, cimDocStore, layoutStore, designExtensionSystem, idaStore, experimentalFusionOptions?, fusionTextOptions?, fusionReferrer?)
Parameters
| Name | Type |
|---|---|
designState | DesignState |
cimDocStore | CimDocStore |
layoutStore | LayoutStore |
designExtensionSystem | DesignExtensionSystem |
idaStore | IdaStore |
experimentalFusionOptions? | ExperimentalOptions |
fusionTextOptions? | Pick<TextOptions, "rtextEnabled"> |
fusionReferrer? | string |
Overrides
BaseExtension.constructor
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:94
Properties
asyncUiMetadata
• asyncUiMetadata: undefined | AsyncUiMetadata
Metadata specific to user interactions.
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:68
canvas
• canvas: undefined | HTMLCanvasElement
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:63
cimDocStore
• Private cimDocStore: CimDocStore
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:96
designExtensionSystem
• Private designExtensionSystem: DesignExtensionSystem
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:98
designState
• Protected designState: SubpanelState | ItemState<Item>
Overrides
BaseExtension.designState
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:61
experimentalFusionOptions
• Private Optional experimentalFusionOptions: ExperimentalOptions
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:100
fusionReferrer
• Private Optional fusionReferrer: string
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:102
fusionTextOptions
• Private Optional fusionTextOptions: Pick<TextOptions, "rtextEnabled">
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:101
idaStore
• Private idaStore: IdaStore
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:99
layoutStore
• Private layoutStore: LayoutStore
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:97
renderingMetadata
• renderingMetadata: undefined | RenderingMetadata
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:64
renderingResults
• Private Optional renderingResults: RenderingResults
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:72
renderingStatus
• renderingStatus: RenderingStatus
Reflects status of any ongoing rendering requests.
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:76
unsubscribed$
• Private unsubscribed$: Subject<void>
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:70
inject
▪ Static inject: (string | { isOptional: boolean = true; token: string = EXPERIMENTAL_FUSION_OPTIONS_TOKEN })[]
Overrides
BaseExtension.inject
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:84
Accessors
isSelected
• Private get isSelected(): undefined | boolean
Returns
undefined | boolean
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:249
previewModel
• get previewModel(): Item | Subpanel
This method creates a copy of the item's CDIF model and manipulates it for use in requesting previewBoxes that are visually correct accounting for ongoing user input (via the idaStore's temporary position/size deltas).
Being only intended for that purpose, the manipulation this method performs is innacurate in relation to the item's actual position on its parent and should not be used in that way.
Returns
Item | Subpanel
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:179
renderingBoundItemExtension
• Private get renderingBoundItemExtension(): undefined | RenderingBoundItemExtension
Returns
undefined | RenderingBoundItemExtension
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:253
renderingInputs
• Private get renderingInputs(): undefined | RenderingInputs
Returns
undefined | RenderingInputs
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:134
Methods
dispose
▸ dispose(): void
Returns
void
Overrides
BaseExtension.dispose
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:257
setCanvas
▸ setCanvas(canvas): void
Parameters
| Name | Type |
|---|---|
canvas | HTMLCanvasElement |
Returns
void
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:217
setRenderingStatus
▸ setRenderingStatus(status): void
Parameters
| Name | Type |
|---|---|
status | RenderingStatus |
Returns
void
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:222
setStaleMetadata
▸ Protected setStaleMetadata(): void
Returns
void
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:227
updateMetadata
▸ Protected updateMetadata(metadata): void
Parameters
| Name | Type |
|---|---|
metadata | FullRenderingMetadata |
Returns
void
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:235
supports
▸ Static supports(state): boolean
Only generate item previews for children of panels
Parameters
| Name | Type |
|---|---|
state | DesignState |
Returns
boolean
Overrides
BaseExtension.supports
Defined in
packages/design-engine-react-components/src/extensions/preview/ItemPreviewExtension.ts:80