Class: LeafLayout

Implements

• ILeafLayout

Table of contents

Constructors

• constructor

Properties

• leaf
• proxyZoom
• boxBounds
• _contentBounds
• _strokeBounds
• _renderBounds
• _localContentBounds
• _localStrokeBounds
• _localRenderBounds
• _worldContentBounds
• _worldBoxBounds
• _worldStrokeBounds
• resized
• waitAutoLayout
• matrixChanged
• scaleChanged
• rotationChanged
• boundsChanged
• boxChanged
• strokeChanged
• renderChanged
• localBoxChanged
• surfaceChanged
• opacityChanged
• hitCanvasChanged
• childrenSortChanged
• affectScaleOrRotation
• affectRotation
• affectChildrenSort
• strokeSpread
• strokeBoxSpread
• renderSpread
• renderShapeSpread

Accessors

• contentBounds
• strokeBounds
• renderBounds
• localContentBounds
• localStrokeBounds
• localRenderBounds
• worldContentBounds
• worldBoxBounds
• worldStrokeBounds
• a
• b
• c
• d
• e
• f
• x
• y
• width
• height

Methods

• createLocal
• update
• getTransform
• getBounds
• getInnerBounds
• getLocalBounds
• getWorldBounds
• getLayoutBounds
• getLayoutPoints
• shrinkContent
• spreadStroke
• spreadRender
• shrinkContentCancel
• spreadStrokeCancel
• spreadRenderCancel
• boxChange
• localBoxChange
• strokeChange
• renderChange
• scaleChange
• rotationChange
• _scaleOrRotationChange
• matrixChange
• surfaceChange
• opacityChange
• childrenSortChange
• destroy

Constructors

constructor

• new LeafLayout(leaf): LeafLayout

Parameters

Name	Type
leaf	ILeaf

Returns

LeafLayout

Defined in

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

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

---

affectScaleOrRotation

• affectScaleOrRotation: boolean

Implementation of

ILeafLayout.affectScaleOrRotation

Defined in

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

---

affectRotation

• affectRotation: boolean

Implementation of

ILeafLayout.affectRotation

Defined in

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

---

affectChildrenSort

• Optional affectChildrenSort: boolean

Implementation of

ILeafLayout.affectChildrenSort

Defined in

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

---

strokeSpread

• strokeSpread: number

Implementation of

ILeafLayout.strokeSpread

Defined in

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

---

strokeBoxSpread

• strokeBoxSpread: number

Implementation of

ILeafLayout.strokeBoxSpread

Defined in

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

---

renderSpread

• renderSpread: number

Implementation of

ILeafLayout.renderSpread

Defined in

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

---

renderShapeSpread

• renderShapeSpread: number

Implementation of

ILeafLayout.renderShapeSpread

Defined in

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

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

Name	Type
bounds	IBoundsData

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:90

---

b

• get b(): number

Returns

number

Implementation of

ILeafLayout.b

Defined in

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

---

c

• get c(): number

Returns

number

Implementation of

ILeafLayout.c

Defined in

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

---

d

• get d(): number

Returns

number

Implementation of

ILeafLayout.d

Defined in

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

---

e

• get e(): number

Returns

number

Implementation of

ILeafLayout.e

Defined in

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

---

f

• get f(): number

Returns

number

Implementation of

ILeafLayout.f

Defined in

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

---

x

• get x(): number

Returns

number

Implementation of

ILeafLayout.x

Defined in

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

---

y

• get y(): number

Returns

number

Implementation of

ILeafLayout.y

Defined in

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

---

width

• get width(): number

Returns

number

Implementation of

ILeafLayout.width

Defined in

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

---

height

• get height(): number

Returns

number

Implementation of

ILeafLayout.height

Defined in

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

Methods

createLocal

▸ createLocal(): void

Returns

void

Implementation of

ILeafLayout.createLocal

Defined in

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

---

update

▸ update(): void

Returns

void

Implementation of

ILeafLayout.update

Defined in

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

---

getTransform

▸ getTransform(relative?): IMatrixData

Parameters

Name	Type	Default value
relative	ILeaf | ILocationType	'world'

Returns

IMatrixData

Implementation of

ILeafLayout.getTransform

Defined in

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

---

getBounds

▸ getBounds(type?, relative?): IBoundsData

Parameters

Name	Type	Default value
type?	IBoundsType	undefined
relative	ILeaf | ILocationType	'world'

Returns

IBoundsData

Implementation of

ILeafLayout.getBounds

Defined in

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

---

getInnerBounds

▸ getInnerBounds(type?): IBoundsData

Parameters

Name	Type	Default value
type	IBoundsType	'box'

Returns

IBoundsData

Defined in

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

---

getLocalBounds

▸ getLocalBounds(type?): IBoundsData

Parameters

Name	Type	Default value
type	IBoundsType	'box'

Returns

IBoundsData

Defined in

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

---

getWorldBounds

▸ getWorldBounds(type?): IBoundsData

Parameters

Name	Type	Default value
type	IBoundsType	'box'

Returns

IBoundsData

Defined in

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

---

getLayoutBounds

▸ getLayoutBounds(type?, relative?, unscale?): ILayoutBoundsData

Parameters

Name	Type	Default value
type?	IBoundsType	undefined
relative	ILeaf | ILocationType	'world'
unscale?	boolean	undefined

Returns

ILayoutBoundsData

Implementation of

ILeafLayout.getLayoutBounds

Defined in

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

---

getLayoutPoints

▸ getLayoutPoints(type?, relative?): IPointData[]

Parameters

Name	Type	Default value
type?	IBoundsType	undefined
relative	ILeaf | ILocationType	'world'

Returns

IPointData[]

Implementation of

ILeafLayout.getLayoutPoints

Defined in

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

---

shrinkContent

▸ shrinkContent(): void

Returns

void

Implementation of

ILeafLayout.shrinkContent

Defined in

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

---

spreadStroke

▸ spreadStroke(): void

Returns

void

Implementation of

ILeafLayout.spreadStroke

Defined in

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

---

spreadRender

▸ spreadRender(): void

Returns

void

Implementation of

ILeafLayout.spreadRender

Defined in

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

---

shrinkContentCancel

▸ shrinkContentCancel(): void

Returns

void

Implementation of

ILeafLayout.shrinkContentCancel

Defined in

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

---

spreadStrokeCancel

▸ spreadStrokeCancel(): void

Returns

void

Implementation of

ILeafLayout.spreadStrokeCancel

Defined in

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

---

spreadRenderCancel

▸ spreadRenderCancel(): void

Returns

void

Implementation of

ILeafLayout.spreadRenderCancel

Defined in

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

---

boxChange

▸ boxChange(): void

Returns

void

Implementation of

ILeafLayout.boxChange

Defined in

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

---

localBoxChange

▸ localBoxChange(): void

Returns

void

Implementation of

ILeafLayout.localBoxChange

Defined in

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

---

strokeChange

▸ strokeChange(): void

Returns

void

Implementation of

ILeafLayout.strokeChange

Defined in

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

---

renderChange

▸ renderChange(): void

Returns

void

Implementation of

ILeafLayout.renderChange

Defined in

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

---

scaleChange

▸ scaleChange(): void

Returns

void

Implementation of

ILeafLayout.scaleChange

Defined in

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

---

rotationChange

▸ rotationChange(): void

Returns

void

Implementation of

ILeafLayout.rotationChange

Defined in

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

---

_scaleOrRotationChange

▸ _scaleOrRotationChange(): void

Returns

void

Defined in

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

---

matrixChange

▸ matrixChange(): void

Returns

void

Implementation of

ILeafLayout.matrixChange

Defined in

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

---

surfaceChange

▸ surfaceChange(): void

Returns

void

Implementation of

ILeafLayout.surfaceChange

Defined in

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

---

opacityChange

▸ opacityChange(): void

Returns

void

Implementation of

ILeafLayout.opacityChange

Defined in

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

---

childrenSortChange

▸ childrenSortChange(): void

Returns

void

Implementation of

ILeafLayout.childrenSortChange

Defined in

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

---

destroy

▸ destroy(): void

Returns

void

Implementation of

ILeafLayout.destroy

Defined in

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