Class: EyeDropperPreviewExtension
Extension that uses Client Side Rendering libraries, also collectively known as "Fusion", to generate panel previews for eye dropper functionality.
Dependencies
[CimDocStore, designExtensionSystem]
Hierarchy
BaseExtension↳
EyeDropperPreviewExtension
Constructors
constructor
• new EyeDropperPreviewExtension(designState, cimDocStore, designExtensionSystem, experimentalFusionOptions?, fusionTextOptions?, fusionReferrer?)
Parameters
| Name | Type |
|---|---|
designState | DesignState |
cimDocStore | CimDocStore |
designExtensionSystem | DesignExtensionSystem |
experimentalFusionOptions? | ExperimentalOptions |
fusionTextOptions? | Pick<TextOptions, "rtextEnabled"> |
fusionReferrer? | string |
Overrides
BaseExtension.constructor
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:70
Properties
canvas
• canvas: undefined | HTMLCanvasElement
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:48
cimDocStore
• Private cimDocStore: CimDocStore
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:72
designExtensionSystem
• Private designExtensionSystem: DesignExtensionSystem
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:73
designState
• Protected designState: PanelState
Overrides
BaseExtension.designState
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:46
experimentalFusionOptions
• Private Optional experimentalFusionOptions: ExperimentalOptions
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:74
fusionReferrer
• Private Optional fusionReferrer: string
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:76
fusionTextOptions
• Private Optional fusionTextOptions: Pick<TextOptions, "rtextEnabled">
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:75
isPreviewReady
• isPreviewReady: boolean = false
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:49
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/EyeDropperPreviewExtension.ts:54
unsubscribed$
• Private unsubscribed$: Subject<void>
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:68
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/EyeDropperPreviewExtension.ts:60
Accessors
itemPreviewModels
• Private get itemPreviewModels(): Object
Returns
Object
| Name | Type |
|---|---|
images | ImageItem[] |
itemReferences | ItemReference<any>[] |
shapes | ShapeItem[] |
subpanels | Subpanel[] |
textAreas | TextAreaItem[] |
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:120
renderingInputs
• Private get renderingInputs(): undefined | RenderingInputs
Returns
undefined | RenderingInputs
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:144
whiteBackgroundShapeItem
• Private get whiteBackgroundShapeItem(): ShapeItem
Returns
ShapeItem
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:90
Methods
dispose
▸ dispose(): void
Returns
void
Overrides
BaseExtension.dispose
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:214
itemPreviewExtension
▸ Private itemPreviewExtension(itemState): undefined | ItemPreviewExtension
Parameters
| Name | Type |
|---|---|
itemState | DesignState |
Returns
undefined | ItemPreviewExtension
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:210
setCanvas
▸ setCanvas(canvas): void
Parameters
| Name | Type |
|---|---|
canvas | undefined | HTMLCanvasElement |
Returns
void
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:196
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/EyeDropperPreviewExtension.ts:191
setPreviewReadyState
▸ Protected setPreviewReadyState(isPreviewReady): void
Parameters
| Name | Type |
|---|---|
isPreviewReady | boolean |
Returns
void
Defined in
packages/design-engine-react-components/src/extensions/preview/EyeDropperPreviewExtension.ts:205
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/EyeDropperPreviewExtension.ts:56