Skip to main content

Class: ExperimentalCurvedTextEffectExtension

An extension that provides interactive state management for Curved Text Effects if they exist on an item.

Warning

This is an experimental extension and its use may result in some bugs.

Hierarchy​

  • BaseExtension

    ↳ ExperimentalCurvedTextEffectExtension

Implements​

Constructors​

constructor​

• new ExperimentalCurvedTextEffectExtension(designState, executeCommand)

Parameters​

NameType
designStateDesignState
executeCommandExecuteCommand

Overrides​

BaseExtension.constructor

Defined in​

packages/design-engine-react-components/src/extensions/curvedText/CurvedTextEffectExtension.ts:38

Properties​

designState​

• designState: ItemState<TextAreaItem>

Overrides​

BaseExtension.designState

Defined in​

packages/design-engine-react-components/src/extensions/curvedText/CurvedTextEffectExtension.ts:29


executeCommand​

• Private executeCommand: ExecuteCommand

Defined in​

packages/design-engine-react-components/src/extensions/curvedText/CurvedTextEffectExtension.ts:38


temporaryCurveHeight​

• temporaryCurveHeight: undefined | number

Height in mm

Defined in​

packages/design-engine-react-components/src/extensions/curvedText/CurvedTextEffectExtension.ts:32


inject​

▪ Static inject: string[]

Overrides​

BaseExtension.inject

Defined in​

packages/design-engine-react-components/src/extensions/curvedText/CurvedTextEffectExtension.ts:28

Accessors​

currentCurveHeight​

• get currentCurveHeight(): undefined | number

Returns

The temporaryCurveHeight if it is set, or the height of the Curved Text Effect on the item if one is present. Returns undefined otherwise.

Returns​

undefined | number

Defined in​

packages/design-engine-react-components/src/extensions/curvedText/CurvedTextEffectExtension.ts:64


isCurvedTextEffect​

• Private get isCurvedTextEffect(): boolean

Returns​

boolean

Defined in​

packages/design-engine-react-components/src/extensions/curvedText/CurvedTextEffectExtension.ts:51

Methods​

[decorateItemPreviewModel]​

▸ [decorateItemPreviewModel](previewModel): void

Parameters​

NameType
previewModelTextAreaItem

Returns​

void

Implementation of​

ItemPreviewModelDecorator.__@decorateItemPreviewModel@41120

Defined in​

packages/design-engine-react-components/src/extensions/curvedText/CurvedTextEffectExtension.ts:43


commitCurrentCurveHeight​

▸ commitCurrentCurveHeight(): void

Commits the temporary curve height to the item, creating a history step

Returns​

void

Defined in​

packages/design-engine-react-components/src/extensions/curvedText/CurvedTextEffectExtension.ts:89


setTemporaryCurveHeight​

▸ setTemporaryCurveHeight(height): void

Sets a temporary height value on the item that will affect the current item preview. Use the commitCurrentCurveHeight method to save this value to the item.

Parameters​

NameType
heightnumber

Returns​

void

Defined in​

packages/design-engine-react-components/src/extensions/curvedText/CurvedTextEffectExtension.ts:82


supports​

▸ Static supports(state): boolean

Parameters​

NameType
stateDesignState

Returns​

boolean

Overrides​

BaseExtension.supports

Defined in​

packages/design-engine-react-components/src/extensions/curvedText/CurvedTextEffectExtension.ts:34