Class: ItemOpacityExtension
An extension that helps in interactive state management for Opacity by holding the current opacityMultiplier and overriding the previewModel for preview updates before commiting changes to Cimdoc. Also gives an action to commit changes to Cimdoc.
Hierarchy
BaseExtension↳
ItemOpacityExtension
Implements
Constructors
constructor
• new ItemOpacityExtension(designState, executeCommand)
Parameters
| Name | Type |
|---|---|
designState | DesignState |
executeCommand | ExecuteCommand |
Overrides
BaseExtension.constructor
Defined in
packages/design-engine-react-components/src/extensions/itemOpacity/ItemOpacityExtension.ts:31
Properties
designState
• designState: ItemState<Item>
Overrides
BaseExtension.designState
Defined in
packages/design-engine-react-components/src/extensions/itemOpacity/ItemOpacityExtension.ts:19
executeCommand
• Private executeCommand: ExecuteCommand
Defined in
packages/design-engine-react-components/src/extensions/itemOpacity/ItemOpacityExtension.ts:31
temporaryOpacityMultiplier
• temporaryOpacityMultiplier: undefined | number
Defined in
packages/design-engine-react-components/src/extensions/itemOpacity/ItemOpacityExtension.ts:21
inject
▪ Static inject: string[]
Overrides
BaseExtension.inject
Defined in
packages/design-engine-react-components/src/extensions/itemOpacity/ItemOpacityExtension.ts:18
Accessors
currentOpacityMultiplier
• get currentOpacityMultiplier(): number
Returns
the temporaryOpacityMultiplier if it is actively being changed or the value on the Cimdoc otherwise. Defaults to 1
Returns
number
Defined in
packages/design-engine-react-components/src/extensions/itemOpacity/ItemOpacityExtension.ts:49
Methods
[decorateItemPreviewModel]
▸ [decorateItemPreviewModel](previewModel): void
Parameters
| Name | Type |
|---|---|
previewModel | Item |
Returns
void
Implementation of
ItemPreviewModelDecorator.__@decorateItemPreviewModel@41120
Defined in
packages/design-engine-react-components/src/extensions/itemOpacity/ItemOpacityExtension.ts:36
commitOpacityMultiplier
▸ commitOpacityMultiplier(): void
Commits the temporary opacity value to the Cimdoc
Returns
void
Defined in
packages/design-engine-react-components/src/extensions/itemOpacity/ItemOpacityExtension.ts:86
setTemporaryOpacityMultiplier
▸ setTemporaryOpacityMultiplier(value): void
Sets a temporary opacity multiplier on the item that will update preview
Parameters
| Name | Type | Description |
|---|---|---|
value | number | a value between 0 and 1. Sets undefined if the value given is out of bounds. |
Returns
void
Defined in
packages/design-engine-react-components/src/extensions/itemOpacity/ItemOpacityExtension.ts:61
supports
▸ Static supports(state): boolean
Supports only items at present, and not subpanels because opacity mulipliers will have stacking effect on nested items and its not always clear what should happen when you ungroup
Parameters
| Name | Type |
|---|---|
state | DesignState |
Returns
boolean
Overrides
BaseExtension.supports
Defined in
packages/design-engine-react-components/src/extensions/itemOpacity/ItemOpacityExtension.ts:27