Class: PanelPreviewExtension
Extension that uses Client Side Rendering libraries, also collectively known as "Fusion", to generate panel previews.
Dependencies
[CimDocStore, LayoutStore]
Hierarchy
BaseExtension↳
PanelPreviewExtension
Constructors
constructor
• new PanelPreviewExtension(designState, cimDocStore, experimentalFusionOptions?, fusionTextOptions?, fusionReferrer?)
Parameters
| Name | Type |
|---|---|
designState | DesignState |
cimDocStore | CimDocStore |
experimentalFusionOptions? | ExperimentalOptions |
fusionTextOptions? | Pick<TextOptions, "rtextEnabled"> |
fusionReferrer? | string |
Overrides
BaseExtension.constructor
Defined in
packages/design-engine-react-components/src/extensions/preview/PanelPreviewExtension.ts:49
Properties
canvas
• canvas: undefined | HTMLCanvasElement
Defined in
packages/design-engine-react-components/src/extensions/preview/PanelPreviewExtension.ts:29
cimDocStore
• Private cimDocStore: CimDocStore
Defined in
packages/design-engine-react-components/src/extensions/preview/PanelPreviewExtension.ts:51
designState
• Protected designState: PanelState
Overrides
BaseExtension.designState
Defined in
packages/design-engine-react-components/src/extensions/preview/PanelPreviewExtension.ts:27
experimentalFusionOptions
• Private Optional experimentalFusionOptions: ExperimentalOptions
Defined in
packages/design-engine-react-components/src/extensions/preview/PanelPreviewExtension.ts:52
fusionReferrer
• Private Optional fusionReferrer: string
Defined in
packages/design-engine-react-components/src/extensions/preview/PanelPreviewExtension.ts:54
fusionTextOptions
• Private Optional fusionTextOptions: Pick<TextOptions, "rtextEnabled">
Defined in
packages/design-engine-react-components/src/extensions/preview/PanelPreviewExtension.ts:53
pixelSize
• Private pixelSize: number = 1
Scale multiplier for determining the pixel resolution of the canvas. Should be set higher if previews any larger than a thumbnail will be needed.
Defined in
packages/design-engine-react-components/src/extensions/preview/PanelPreviewExtension.ts:34
unsubscribed$
• Private unsubscribed$: Subject<void>
Defined in
packages/design-engine-react-components/src/extensions/preview/PanelPreviewExtension.ts:47
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/PanelPreviewExtension.ts:40
Accessors
renderingInputs
• Private get renderingInputs(): undefined | RenderingInputs
Returns
undefined | RenderingInputs
Defined in
packages/design-engine-react-components/src/extensions/preview/PanelPreviewExtension.ts:68
Methods
dispose
▸ dispose(): void
Returns
void
Overrides
BaseExtension.dispose
Defined in
packages/design-engine-react-components/src/extensions/preview/PanelPreviewExtension.ts:115
setCanvas
▸ setCanvas(canvas): void
Parameters
| Name | Type |
|---|---|
canvas | HTMLCanvasElement |
Returns
void
Defined in
packages/design-engine-react-components/src/extensions/preview/PanelPreviewExtension.ts:110
setPixelSize
▸ setPixelSize(pixelSize): void
Updates the pixelSize to be used by fusion for the panel preview.
Parameters
| Name | Type |
|---|---|
pixelSize | number |
Returns
void
Defined in
packages/design-engine-react-components/src/extensions/preview/PanelPreviewExtension.ts:105
supports
▸ Static supports(state): boolean
Parameters
| Name | Type |
|---|---|
state | DesignState |
Returns
boolean
Overrides
BaseExtension.supports
Defined in
packages/design-engine-react-components/src/extensions/preview/PanelPreviewExtension.ts:36