Skip to main content

Class: ItemAspectRatioLockExtension

An extension to be used when working with a aspect ratio locking behavior

Dependencies

[DesignExtensionSystem, ItemMetadataExtension]

Hierarchy​

  • BaseExtension

    ↳ ItemAspectRatioLockExtension

Constructors​

constructor​

• new ItemAspectRatioLockExtension(designState, designExtensionSystem)

Parameters​

NameType
designStateDesignState
designExtensionSystemDesignExtensionSystem

Overrides​

BaseExtension.constructor

Defined in​

packages/design-engine-react-components/src/extensions/itemAspectRatioLock/ItemAspectRatioLockExtension.ts:20

Properties​

designExtensionSystem​

• Private designExtensionSystem: DesignExtensionSystem

Defined in​

packages/design-engine-react-components/src/extensions/itemAspectRatioLock/ItemAspectRatioLockExtension.ts:20


designState​

• designState: ItemState<Item>

Overrides​

BaseExtension.designState

Defined in​

packages/design-engine-react-components/src/extensions/itemAspectRatioLock/ItemAspectRatioLockExtension.ts:17


inject​

▪ Static inject: string[]

Overrides​

BaseExtension.inject

Defined in​

packages/design-engine-react-components/src/extensions/itemAspectRatioLock/ItemAspectRatioLockExtension.ts:19

Accessors​

canBeAspectRatioLocked​

• get canBeAspectRatioLocked(): boolean

Reflects whether the item can have it's aspect ratio locked

Returns​

boolean

Defined in​

packages/design-engine-react-components/src/extensions/itemAspectRatioLock/ItemAspectRatioLockExtension.ts:32


isAspectRatioLocked​

• get isAspectRatioLocked(): boolean

Reflects whether the item currently has it's aspect ratio locked

Remarks

This property is a computed attribute that is dependent on metadata retrieved from the ItemMetadataExtension

Returns​

boolean

Defined in​

packages/design-engine-react-components/src/extensions/itemAspectRatioLock/ItemAspectRatioLockExtension.ts:44

Methods​

supports​

▸ Static supports(state): boolean

Parameters​

NameType
stateDesignState

Returns​

boolean

Overrides​

BaseExtension.supports

Defined in​

packages/design-engine-react-components/src/extensions/itemAspectRatioLock/ItemAspectRatioLockExtension.ts:25