Class: ItemLayoutExtension
Provides relevant item layout information for direct children of root panels. All properties are in the physical unit space.
Hierarchy
BaseExtension↳
ItemLayoutExtension
Constructors
constructor
• new ItemLayoutExtension(designState, designExtensionSystem)
Parameters
| Name | Type |
|---|---|
designState | DesignState |
designExtensionSystem | DesignExtensionSystem |
Overrides
BaseExtension.constructor
Defined in
packages/design-engine-react-components/src/extensions/itemLayout/ItemLayoutExtension.ts:21
Properties
designExtensionSystem
• Protected designExtensionSystem: DesignExtensionSystem
Defined in
packages/design-engine-react-components/src/extensions/itemLayout/ItemLayoutExtension.ts:21
designState
• designState: SubpanelState | ItemState<Item>
Overrides
BaseExtension.designState
Defined in
packages/design-engine-react-components/src/extensions/itemLayout/ItemLayoutExtension.ts:18
layoutModel
• Private layoutModel: LayoutModel
Defined in
packages/design-engine-react-components/src/extensions/itemLayout/ItemLayoutExtension.ts:19
inject
▪ Static inject: string[]
Overrides
BaseExtension.inject
Defined in
packages/design-engine-react-components/src/extensions/itemLayout/ItemLayoutExtension.ts:17
Accessors
dimensions
• get dimensions(): LayoutDimensions
Item's Layout dimensions
Remarks
For a subpanel, its layout dimensions are the sum of its childrens layout dimensions.
Returns
LayoutDimensions
Defined in
packages/design-engine-react-components/src/extensions/itemLayout/ItemLayoutExtension.ts:45
position
• get position(): LayoutPosition
Item's layout position in x and y offset relative to its parent's container position
Returns
LayoutPosition
Defined in
packages/design-engine-react-components/src/extensions/itemLayout/ItemLayoutExtension.ts:34
previewBox
• get previewBox(): undefined | LayoutPreviewBox
PreviewBox position and size relative to position
Returns
undefined | LayoutPreviewBox
Defined in
packages/design-engine-react-components/src/extensions/itemLayout/ItemLayoutExtension.ts:58
renderingPreviewBox
• Private get renderingPreviewBox(): undefined | {}
Returns
undefined | {}
Defined in
packages/design-engine-react-components/src/extensions/itemLayout/ItemLayoutExtension.ts:63
rotation
• get rotation(): number
Returns
number
Defined in
packages/design-engine-react-components/src/extensions/itemLayout/ItemLayoutExtension.ts:50
Methods
supports
▸ Static supports(state): boolean
Parameters
| Name | Type |
|---|---|
state | DesignState |
Returns
boolean
Overrides
BaseExtension.supports
Defined in
packages/design-engine-react-components/src/extensions/itemLayout/ItemLayoutExtension.ts:27