Class: PanelRulersExtension
This extension generates ruler data for a panel based on its size and provided BaseDesignRequirements design requirements
Dependencies
[BaseDesignRequirements]
Hierarchy
BaseExtension↳
PanelRulersExtension
Constructors
constructor
• new PanelRulersExtension(designState, designRequirements)
Parameters
| Name | Type |
|---|---|
designState | DesignState |
designRequirements | BaseDesignRequirements |
Overrides
BaseExtension.constructor
Defined in
packages/design-engine-react-components/src/extensions/panelRulers/PanelRulersExtension.ts:50
Properties
designRequirements
• Private designRequirements: BaseDesignRequirements
Defined in
packages/design-engine-react-components/src/extensions/panelRulers/PanelRulersExtension.ts:50
designState
• designState: PanelState
Overrides
BaseExtension.designState
Defined in
packages/design-engine-react-components/src/extensions/panelRulers/PanelRulersExtension.ts:43
inject
▪ Static inject: string[]
Overrides
BaseExtension.inject
Defined in
packages/design-engine-react-components/src/extensions/panelRulers/PanelRulersExtension.ts:49
Accessors
paths
• Private get paths(): Record<string, undefined | Path>
Returns
Record<string, undefined | Path>
Defined in
packages/design-engine-react-components/src/extensions/panelRulers/PanelRulersExtension.ts:54
Methods
getRuler
▸ getRuler(side, maskType?): undefined | Ruler
Returns a ruler object for the panel by side and mask type
Parameters
| Name | Type |
|---|---|
side | RulerSide |
maskType? | MaskType |
Returns
undefined | Ruler
Defined in
packages/design-engine-react-components/src/extensions/panelRulers/PanelRulersExtension.ts:66
supports
▸ Static supports(state): boolean
Parameters
| Name | Type |
|---|---|
state | DesignState |
Returns
boolean
Overrides
BaseExtension.supports
Defined in
packages/design-engine-react-components/src/extensions/panelRulers/PanelRulersExtension.ts:45