Skip to content

Class: LeafLayout โ€‹

Implements โ€‹

Table of contents โ€‹

Constructors โ€‹

Properties โ€‹

Accessors โ€‹

Methods โ€‹

Constructors โ€‹

constructor โ€‹

โ€ข new LeafLayout(leaf): LeafLayout

Parameters โ€‹

NameType
leafILeaf

Returns โ€‹

LeafLayout

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:103

Properties โ€‹

leaf โ€‹

โ€ข leaf: ILeaf

Implementation of โ€‹

ILeafLayout.leaf

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:14


proxyZoom โ€‹

โ€ข proxyZoom: boolean

Implementation of โ€‹

ILeafLayout.proxyZoom

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:16


boxBounds โ€‹

โ€ข boxBounds: IBoundsData

Implementation of โ€‹

ILeafLayout.boxBounds

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:22


_contentBounds โ€‹

โ€ข _contentBounds: IBoundsData

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:26


_strokeBounds โ€‹

โ€ข _strokeBounds: IBoundsData

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:27


_renderBounds โ€‹

โ€ข _renderBounds: IBoundsData

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:28


_localContentBounds โ€‹

โ€ข Protected Optional _localContentBounds: IBoundsData

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:37


_localStrokeBounds โ€‹

โ€ข Protected Optional _localStrokeBounds: IBoundsData

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:38


_localRenderBounds โ€‹

โ€ข Protected Optional _localRenderBounds: IBoundsData

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:39


_worldContentBounds โ€‹

โ€ข Protected _worldContentBounds: IBoundsData

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:48


_worldBoxBounds โ€‹

โ€ข Protected _worldBoxBounds: IBoundsData

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:49


_worldStrokeBounds โ€‹

โ€ข Protected _worldStrokeBounds: IBoundsData

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:50


resized โ€‹

โ€ข resized: boolean

Implementation of โ€‹

ILeafLayout.resized

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:54


waitAutoLayout โ€‹

โ€ข waitAutoLayout: boolean

Implementation of โ€‹

ILeafLayout.waitAutoLayout

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:55


matrixChanged โ€‹

โ€ข matrixChanged: boolean

Implementation of โ€‹

ILeafLayout.matrixChanged

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:58


scaleChanged โ€‹

โ€ข scaleChanged: boolean

Implementation of โ€‹

ILeafLayout.scaleChanged

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:59


rotationChanged โ€‹

โ€ข rotationChanged: boolean

Implementation of โ€‹

ILeafLayout.rotationChanged

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:60


boundsChanged โ€‹

โ€ข boundsChanged: boolean

Implementation of โ€‹

ILeafLayout.boundsChanged

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:63


boxChanged โ€‹

โ€ข boxChanged: boolean

Implementation of โ€‹

ILeafLayout.boxChanged

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:65


strokeChanged โ€‹

โ€ข strokeChanged: boolean

Implementation of โ€‹

ILeafLayout.strokeChanged

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:66


renderChanged โ€‹

โ€ข renderChanged: boolean

Implementation of โ€‹

ILeafLayout.renderChanged

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:67


localBoxChanged โ€‹

โ€ข localBoxChanged: boolean

Implementation of โ€‹

ILeafLayout.localBoxChanged

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:69


surfaceChanged โ€‹

โ€ข surfaceChanged: boolean

Implementation of โ€‹

ILeafLayout.surfaceChanged

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:72


opacityChanged โ€‹

โ€ข opacityChanged: boolean

Implementation of โ€‹

ILeafLayout.opacityChanged

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:73


hitCanvasChanged โ€‹

โ€ข hitCanvasChanged: boolean

Implementation of โ€‹

ILeafLayout.hitCanvasChanged

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:75


childrenSortChanged โ€‹

โ€ข Optional childrenSortChanged: boolean

Implementation of โ€‹

ILeafLayout.childrenSortChanged

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:77


stateStyleChanged โ€‹

โ€ข Optional stateStyleChanged: boolean

Implementation of โ€‹

ILeafLayout.stateStyleChanged

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:78


affectScaleOrRotation โ€‹

โ€ข affectScaleOrRotation: boolean

Implementation of โ€‹

ILeafLayout.affectScaleOrRotation

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:81


affectRotation โ€‹

โ€ข affectRotation: boolean

Implementation of โ€‹

ILeafLayout.affectRotation

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:82


affectChildrenSort โ€‹

โ€ข Optional affectChildrenSort: boolean

Implementation of โ€‹

ILeafLayout.affectChildrenSort

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:83


strokeSpread โ€‹

โ€ข strokeSpread: number

Implementation of โ€‹

ILeafLayout.strokeSpread

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:85


strokeBoxSpread โ€‹

โ€ข strokeBoxSpread: number

Implementation of โ€‹

ILeafLayout.strokeBoxSpread

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:86


renderSpread โ€‹

โ€ข renderSpread: number

Implementation of โ€‹

ILeafLayout.renderSpread

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:87


renderShapeSpread โ€‹

โ€ข renderShapeSpread: number

Implementation of โ€‹

ILeafLayout.renderShapeSpread

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:88

Accessors โ€‹

contentBounds โ€‹

โ€ข get contentBounds(): IBoundsData

Returns โ€‹

IBoundsData

Implementation of โ€‹

ILeafLayout.contentBounds

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:20

โ€ข set contentBounds(bounds): void

Parameters โ€‹

NameType
boundsIBoundsData

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.contentBounds

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:21


strokeBounds โ€‹

โ€ข get strokeBounds(): IBoundsData

Returns โ€‹

IBoundsData

Implementation of โ€‹

ILeafLayout.strokeBounds

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:23


renderBounds โ€‹

โ€ข get renderBounds(): IBoundsData

Returns โ€‹

IBoundsData

Implementation of โ€‹

ILeafLayout.renderBounds

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:24


localContentBounds โ€‹

โ€ข get localContentBounds(): IBoundsData

Returns โ€‹

IBoundsData

Implementation of โ€‹

ILeafLayout.localContentBounds

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:32


localStrokeBounds โ€‹

โ€ข get localStrokeBounds(): IBoundsData

Returns โ€‹

IBoundsData

Implementation of โ€‹

ILeafLayout.localStrokeBounds

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:34


localRenderBounds โ€‹

โ€ข get localRenderBounds(): IBoundsData

Returns โ€‹

IBoundsData

Implementation of โ€‹

ILeafLayout.localRenderBounds

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:35


worldContentBounds โ€‹

โ€ข get worldContentBounds(): IBoundsData

Returns โ€‹

IBoundsData

Implementation of โ€‹

ILeafLayout.worldContentBounds

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:43


worldBoxBounds โ€‹

โ€ข get worldBoxBounds(): IBoundsData

Returns โ€‹

IBoundsData

Implementation of โ€‹

ILeafLayout.worldBoxBounds

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:44


worldStrokeBounds โ€‹

โ€ข get worldStrokeBounds(): IBoundsData

Returns โ€‹

IBoundsData

Implementation of โ€‹

ILeafLayout.worldStrokeBounds

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:45


a โ€‹

โ€ข get a(): number

Returns โ€‹

number

Implementation of โ€‹

ILeafLayout.a

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:91


b โ€‹

โ€ข get b(): number

Returns โ€‹

number

Implementation of โ€‹

ILeafLayout.b

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:92


c โ€‹

โ€ข get c(): number

Returns โ€‹

number

Implementation of โ€‹

ILeafLayout.c

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:93


d โ€‹

โ€ข get d(): number

Returns โ€‹

number

Implementation of โ€‹

ILeafLayout.d

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:94


e โ€‹

โ€ข get e(): number

Returns โ€‹

number

Implementation of โ€‹

ILeafLayout.e

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:95


f โ€‹

โ€ข get f(): number

Returns โ€‹

number

Implementation of โ€‹

ILeafLayout.f

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:96


x โ€‹

โ€ข get x(): number

Returns โ€‹

number

Implementation of โ€‹

ILeafLayout.x

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:97


y โ€‹

โ€ข get y(): number

Returns โ€‹

number

Implementation of โ€‹

ILeafLayout.y

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:98


width โ€‹

โ€ข get width(): number

Returns โ€‹

number

Implementation of โ€‹

ILeafLayout.width

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:99


height โ€‹

โ€ข get height(): number

Returns โ€‹

number

Implementation of โ€‹

ILeafLayout.height

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:100

Methods โ€‹

createLocal โ€‹

โ–ธ createLocal(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.createLocal

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:111


update โ€‹

โ–ธ update(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.update

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:117


getTransform โ€‹

โ–ธ getTransform(relative?): IMatrixData

Parameters โ€‹

NameTypeDefault value
relativeILeaf | ILocationType'world'

Returns โ€‹

IMatrixData

Implementation of โ€‹

ILeafLayout.getTransform

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:129


getBounds โ€‹

โ–ธ getBounds(type?, relative?): IBoundsData

Parameters โ€‹

NameTypeDefault value
type?IBoundsTypeundefined
relativeILeaf | ILocationType'world'

Returns โ€‹

IBoundsData

Implementation of โ€‹

ILeafLayout.getBounds

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:146


getInnerBounds โ€‹

โ–ธ getInnerBounds(type?): IBoundsData

Parameters โ€‹

NameTypeDefault value
typeIBoundsType'box'

Returns โ€‹

IBoundsData

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:162


getLocalBounds โ€‹

โ–ธ getLocalBounds(type?): IBoundsData

Parameters โ€‹

NameTypeDefault value
typeIBoundsType'box'

Returns โ€‹

IBoundsData

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:175


getWorldBounds โ€‹

โ–ธ getWorldBounds(type?): IBoundsData

Parameters โ€‹

NameTypeDefault value
typeIBoundsType'box'

Returns โ€‹

IBoundsData

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:188


getLayoutBounds โ€‹

โ–ธ getLayoutBounds(type?, relative?, unscale?): ILayoutBoundsData

Parameters โ€‹

NameTypeDefault value
type?IBoundsTypeundefined
relativeILeaf | ILocationType'world'
unscale?booleanundefined

Returns โ€‹

ILayoutBoundsData

Implementation of โ€‹

ILeafLayout.getLayoutBounds

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:201


getLayoutPoints โ€‹

โ–ธ getLayoutPoints(type?, relative?): IPointData[]

Parameters โ€‹

NameTypeDefault value
type?IBoundsTypeundefined
relativeILeaf | ILocationType'world'

Returns โ€‹

IPointData[]

Implementation of โ€‹

ILeafLayout.getLayoutPoints

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:245


shrinkContent โ€‹

โ–ธ shrinkContent(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.shrinkContent

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:269


spreadStroke โ€‹

โ–ธ spreadStroke(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.spreadStroke

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:274


spreadRender โ€‹

โ–ธ spreadRender(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.spreadRender

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:280


shrinkContentCancel โ€‹

โ–ธ shrinkContentCancel(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.shrinkContentCancel

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:286


spreadStrokeCancel โ€‹

โ–ธ spreadStrokeCancel(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.spreadStrokeCancel

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:290


spreadRenderCancel โ€‹

โ–ธ spreadRenderCancel(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.spreadRenderCancel

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:296


boxChange โ€‹

โ–ธ boxChange(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.boxChange

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:304


localBoxChange โ€‹

โ–ธ localBoxChange(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.localBoxChange

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:310


strokeChange โ€‹

โ–ธ strokeChange(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.strokeChange

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:315


renderChange โ€‹

โ–ธ renderChange(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.renderChange

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:322


scaleChange โ€‹

โ–ธ scaleChange(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.scaleChange

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:331


rotationChange โ€‹

โ–ธ rotationChange(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.rotationChange

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:336


_scaleOrRotationChange โ€‹

โ–ธ _scaleOrRotationChange(): void

Returns โ€‹

void

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:342


matrixChange โ€‹

โ–ธ matrixChange(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.matrixChange

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:348


surfaceChange โ€‹

โ–ธ surfaceChange(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.surfaceChange

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:356


opacityChange โ€‹

โ–ธ opacityChange(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.opacityChange

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:360


childrenSortChange โ€‹

โ–ธ childrenSortChange(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.childrenSortChange

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:365


destroy โ€‹

โ–ธ destroy(): void

Returns โ€‹

void

Implementation of โ€‹

ILeafLayout.destroy

Defined in โ€‹

leafer/packages/display-module/layout/src/LeafLayout.ts:372

Released under the MIT License.