Class: Branch

Hierarchy

• Leaf

  ↳ Branch

Table of contents

Constructors

• constructor

Properties

• innerId
• leafer
• parent
• __
• __layout
• __world
• __local
• __nowWorld
• __cameraWorld
• __worldOpacity
• __level
• __tempNumber
• __hasAutoLayout
• __hasMask
• __hasEraser
• __hitCanvas
• __captureMap
• __bubbleMap
• __parentWait
• __leaferWait
• children
• noBounds
• destroyed

Accessors

• tag
• __tag
• innerName
• __DataProcessor
• __LayoutProcessor
• isLeafer
• isBranch
• isBranchLeaf
• __localMatrix
• __localBoxBounds
• worldTransform
• localTransform
• boxBounds
• renderBounds
• worldBoxBounds
• worldStrokeBounds
• worldRenderBounds
• worldOpacity
• __worldFlipped
• __onlyHitMask
• __ignoreHitWorld
• __inLazyBounds
• pathInputed
• event

Methods

• __updateStrokeSpread
• __updateRenderSpread
• __updateBoxBounds
• __updateStrokeBounds
• __updateRenderBounds
• __updateSortChildren
• add
• addMany
• remove
• removeAll
• clear
• __preRemove
• __realRemoveChild
• __emitChildEvent
• reset
• resetCustom
• waitParent
• waitLeafer
• nextRender
• removeNextRender
• __bindLeafer
• set
• get
• setAttr
• getAttr
• getComputedAttr
• toJSON
• toString
• toSVG
• __SVG
• toHTML
• __setAttr
• __getAttr
• setProxyAttr
• getProxyAttr
• find
• findTag
• findOne
• findId
• focus
• updateLayout
• forceUpdate
• forceRender
• __updateWorldMatrix
• __updateLocalMatrix
• __updateWorldBounds
• __updateLocalBounds
• __updateLocalBoxBounds
• __updateLocalStrokeBounds
• __updateLocalRenderBounds
• __updateContentBounds
• __updateAutoLayout
• __updateFlowLayout
• __updateNaturalSize
• __onUpdateSize
• __updateEraser
• __renderEraser
• __updateMask
• __renderMask
• __getNowWorld
• getTransform
• getBounds
• getLayoutBounds
• getLayoutPoints
• getWorldBounds
• worldToLocal
• localToWorld
• worldToInner
• innerToWorld
• getInnerPoint
• getInnerPointByLocal
• getLocalPoint
• getLocalPointByInner
• getWorldPoint
• getWorldPointByLocal
• getPagePoint
• getWorldPointByPage
• setTransform
• transform
• move
• moveInner
• scaleOf
• rotateOf
• skewOf
• transformWorld
• moveWorld
• scaleOfWorld
• rotateOfWorld
• skewOfWorld
• flip
• scaleResize
• __scaleResize
• resizeWidth
• resizeHeight
• __hitWorld
• __hit
• __hitFill
• __hitStroke
• __hitPixel
• __drawHitPath
• __updateHitCanvas
• __render
• __drawFast
• __draw
• __clip
• __renderShape
• __updateWorldOpacity
• __updateChange
• __drawPath
• __drawRenderPath
• __updatePath
• __updateRenderPath
• dropTo
• on
• off
• on_
• off_
• once
• emit
• emitEvent
• hasEvent
• changeAttr
• addAttr
• destroy

Constructors

constructor

• new Branch(data?): Branch

Parameters

Name	Type
data?	ILeafInputData

Returns

Branch

Inherited from

Leaf.constructor

Defined in

leafer/packages/display/src/Leaf.ts:104

Properties

innerId

• Readonly innerId: number

Inherited from

Leaf.innerId

Defined in

leafer/packages/display/src/Leaf.ts:29

---

leafer

• Optional leafer: ILeaferBase

Inherited from

Leaf.leafer

Defined in

leafer/packages/display/src/Leaf.ts:35

---

parent

• Optional parent: ILeaf

Inherited from

Leaf.parent

Defined in

leafer/packages/display/src/Leaf.ts:36

---

__

• __: ILeafData

Inherited from

Leaf.__

Defined in

leafer/packages/display/src/Leaf.ts:42

---

__layout

• __layout: ILeafLayout

Inherited from

Leaf.__layout

Defined in

leafer/packages/display/src/Leaf.ts:43

---

__world

• __world: IMatrixWithBoundsScaleData

Inherited from

Leaf.__world

Defined in

leafer/packages/display/src/Leaf.ts:45

---

__local

• Optional __local: IMatrixWithBoundsData

Inherited from

Leaf.__local

Defined in

leafer/packages/display/src/Leaf.ts:46

---

__nowWorld

• Optional __nowWorld: IMatrixWithBoundsScaleData

Inherited from

Leaf.__nowWorld

Defined in

leafer/packages/display/src/Leaf.ts:48

---

__cameraWorld

• Optional __cameraWorld: IMatrixWithBoundsScaleData

Inherited from

Leaf.__cameraWorld

Defined in

leafer/packages/display/src/Leaf.ts:49

---

__worldOpacity

• __worldOpacity: number

Inherited from

Leaf.__worldOpacity

Defined in

leafer/packages/display/src/Leaf.ts:54

---

__level

• __level: number

Inherited from

Leaf.__level

Defined in

leafer/packages/display/src/Leaf.ts:70

---

__tempNumber

• __tempNumber: number

Inherited from

Leaf.__tempNumber

Defined in

leafer/packages/display/src/Leaf.ts:71

---

__hasAutoLayout

• Optional __hasAutoLayout: boolean

Inherited from

Leaf.__hasAutoLayout

Defined in

leafer/packages/display/src/Leaf.ts:75

---

__hasMask

• Optional __hasMask: boolean

Inherited from

Leaf.__hasMask

Defined in

leafer/packages/display/src/Leaf.ts:76

---

__hasEraser

• Optional __hasEraser: boolean

Inherited from

Leaf.__hasEraser

Defined in

leafer/packages/display/src/Leaf.ts:77

---

__hitCanvas

• Optional __hitCanvas: IHitCanvas

Inherited from

Leaf.__hitCanvas

Defined in

leafer/packages/display/src/Leaf.ts:78

---

__captureMap

• Optional __captureMap: IEventListenerMap

Inherited from

Leaf.__captureMap

Defined in

leafer/packages/display/src/Leaf.ts:89

---

__bubbleMap

• Optional __bubbleMap: IEventListenerMap

Inherited from

Leaf.__bubbleMap

Defined in

leafer/packages/display/src/Leaf.ts:90

---

__parentWait

• Optional __parentWait: IFunction[]

Inherited from

Leaf.__parentWait

Defined in

leafer/packages/display/src/Leaf.ts:92

---

__leaferWait

• Optional __leaferWait: IFunction[]

Inherited from

Leaf.__leaferWait

Defined in

leafer/packages/display/src/Leaf.ts:93

---

children

• Optional children: ILeaf[]

Inherited from

Leaf.children

Defined in

leafer/packages/display/src/Leaf.ts:96

---

noBounds

• Optional noBounds: boolean

Inherited from

Leaf.noBounds

Defined in

leafer/packages/display/src/Leaf.ts:99

---

destroyed

• destroyed: boolean

Inherited from

Leaf.destroyed

Defined in

leafer/packages/display/src/Leaf.ts:101

Accessors

tag

• get tag(): string

Returns

string

Inherited from

Leaf.tag

Defined in

leafer/packages/display/src/Leaf.ts:24

• set tag(_value): void

Parameters

Name	Type
_value	string

Returns

void

Inherited from

Leaf.tag

Defined in

leafer/packages/display/src/Leaf.ts:25

---

__tag

• get __tag(): string

Returns

string

Inherited from

Leaf.__tag

Defined in

leafer/packages/display/src/Leaf.ts:27

---

innerName

• get innerName(): string

Returns

string

Inherited from

Leaf.innerName

Defined in

leafer/packages/display/src/Leaf.ts:30

---

__DataProcessor

• get __DataProcessor(): typeof LeafData

Returns

typeof LeafData

Inherited from

Leaf.__DataProcessor

Defined in

leafer/packages/display/src/Leaf.ts:32

---

__LayoutProcessor

• get __LayoutProcessor(): typeof LeafLayout

Returns

typeof LeafLayout

Inherited from

Leaf.__LayoutProcessor

Defined in

leafer/packages/display/src/Leaf.ts:33

---

isLeafer

• get isLeafer(): boolean

Returns

boolean

Inherited from

Leaf.isLeafer

Defined in

leafer/packages/display/src/Leaf.ts:38

---

isBranch

• get isBranch(): boolean

Returns

boolean

Inherited from

Leaf.isBranch

Defined in

leafer/packages/display/src/Leaf.ts:39

---

isBranchLeaf

• get isBranchLeaf(): boolean

Returns

boolean

Inherited from

Leaf.isBranchLeaf

Defined in

leafer/packages/display/src/Leaf.ts:40

---

__localMatrix

• get __localMatrix(): IMatrixData

Returns

IMatrixData

Inherited from

Leaf.__localMatrix

Defined in

leafer/packages/display/src/Leaf.ts:51

---

__localBoxBounds

• get __localBoxBounds(): IBoundsData

Returns

IBoundsData

Inherited from

Leaf.__localBoxBounds

Defined in

leafer/packages/display/src/Leaf.ts:52

---

worldTransform

• get worldTransform(): IMatrixWithScaleData

Returns

IMatrixWithScaleData

Inherited from

Leaf.worldTransform

Defined in

leafer/packages/display/src/Leaf.ts:57

---

localTransform

• get localTransform(): IMatrixData

Returns

IMatrixData

Inherited from

Leaf.localTransform

Defined in

leafer/packages/display/src/Leaf.ts:58

---

boxBounds

• get boxBounds(): IBoundsData

Returns

IBoundsData

Inherited from

Leaf.boxBounds

Defined in

leafer/packages/display/src/Leaf.ts:61

---

renderBounds

• get renderBounds(): IBoundsData

Returns

IBoundsData

Inherited from

Leaf.renderBounds

Defined in

leafer/packages/display/src/Leaf.ts:62

---

worldBoxBounds

• get worldBoxBounds(): IBoundsData

Returns

IBoundsData

Inherited from

Leaf.worldBoxBounds

Defined in

leafer/packages/display/src/Leaf.ts:63

---

worldStrokeBounds

• get worldStrokeBounds(): IBoundsData

Returns

IBoundsData

Inherited from

Leaf.worldStrokeBounds

Defined in

leafer/packages/display/src/Leaf.ts:64

---

worldRenderBounds

• get worldRenderBounds(): IBoundsData

Returns

IBoundsData

Inherited from

Leaf.worldRenderBounds

Defined in

leafer/packages/display/src/Leaf.ts:65

---

worldOpacity

• get worldOpacity(): number

Returns

number

Inherited from

Leaf.worldOpacity

Defined in

leafer/packages/display/src/Leaf.ts:68

---

__worldFlipped

• get __worldFlipped(): boolean

Returns

boolean

Inherited from

Leaf.__worldFlipped

Defined in

leafer/packages/display/src/Leaf.ts:73

---

__onlyHitMask

• get __onlyHitMask(): boolean

Returns

boolean

Inherited from

Leaf.__onlyHitMask

Defined in

leafer/packages/display/src/Leaf.ts:80

---

__ignoreHitWorld

• get __ignoreHitWorld(): boolean

Returns

boolean

Inherited from

Leaf.__ignoreHitWorld

Defined in

leafer/packages/display/src/Leaf.ts:81

---

__inLazyBounds

• get __inLazyBounds(): boolean

Returns

boolean

Inherited from

Leaf.__inLazyBounds

Defined in

leafer/packages/display/src/Leaf.ts:82

---

pathInputed

• get pathInputed(): boolean

Returns

boolean

Inherited from

Leaf.pathInputed

Defined in

leafer/packages/display/src/Leaf.ts:84

---

event

• set event(map): void

Parameters

Name	Type
map	IEventMap

Returns

void

Inherited from

Leaf.event

Defined in

leafer/packages/display/src/Leaf.ts:87

Methods

__updateStrokeSpread

▸ __updateStrokeSpread(): number

Returns

number

Overrides

Leaf.__updateStrokeSpread

Defined in

leafer/packages/display/src/Branch.ts:21

---

__updateRenderSpread

▸ __updateRenderSpread(): number

Returns

number

Overrides

Leaf.__updateRenderSpread

Defined in

leafer/packages/display/src/Branch.ts:29

---

__updateBoxBounds

▸ __updateBoxBounds(): void

Returns

void

Overrides

Leaf.__updateBoxBounds

Defined in

leafer/packages/display/src/Branch.ts:37

---

__updateStrokeBounds

▸ __updateStrokeBounds(): void

Returns

void

Overrides

Leaf.__updateStrokeBounds

Defined in

leafer/packages/display/src/Branch.ts:41

---

__updateRenderBounds

▸ __updateRenderBounds(): void

Returns

void

Overrides

Leaf.__updateRenderBounds

Defined in

leafer/packages/display/src/Branch.ts:45

---

__updateSortChildren

▸ __updateSortChildren(): void

Returns

void

Overrides

Leaf.__updateSortChildren

Defined in

leafer/packages/display/src/Branch.ts:52

---

add

▸ add(child, index?): void

Parameters

Name	Type
child	ILeaf
index?	number

Returns

void

Overrides

Leaf.add

Defined in

leafer/packages/display/src/Branch.ts:65

---

addMany

▸ addMany(...children): void

Parameters

Name	Type
...children	ILeaf[]

Returns

void

Defined in

leafer/packages/display/src/Branch.ts:87

---

remove

▸ remove(child?, destroy?): void

Parameters

Name	Type
child?	ILeaf
destroy?	boolean

Returns

void

Overrides

Leaf.remove

Defined in

leafer/packages/display/src/Branch.ts:91

---

removeAll

▸ removeAll(destroy?): void

Parameters

Name	Type
destroy?	boolean

Returns

void

Defined in

leafer/packages/display/src/Branch.ts:106

---

clear

▸ clear(): void

Returns

void

Defined in

leafer/packages/display/src/Branch.ts:119

---

__preRemove

▸ __preRemove(): void

Returns

void

Defined in

leafer/packages/display/src/Branch.ts:123

---

__realRemoveChild

▸ __realRemoveChild(child): void

Parameters

Name	Type
child	ILeaf

Returns

void

Defined in

leafer/packages/display/src/Branch.ts:130

---

__emitChildEvent

▸ __emitChildEvent(type, child): void

Parameters

Name	Type
type	string
child	ILeaf

Returns

void

Defined in

leafer/packages/display/src/Branch.ts:141

---

reset

▸ reset(data?): void

Parameters

Name	Type
data?	ILeafInputData

Returns

void

Inherited from

Leaf.reset

Defined in

leafer/packages/display/src/Leaf.ts:110

---

resetCustom

▸ resetCustom(): void

Returns

void

Inherited from

Leaf.resetCustom

Defined in

leafer/packages/display/src/Leaf.ts:127

---

waitParent

▸ waitParent(item, bind?): void

Parameters

Name	Type
item	IFunction
bind?	IObject

Returns

void

Inherited from

Leaf.waitParent

Defined in

leafer/packages/display/src/Leaf.ts:133

---

waitLeafer

▸ waitLeafer(item, bind?): void

Parameters

Name	Type
item	IFunction
bind?	IObject

Returns

void

Inherited from

Leaf.waitLeafer

Defined in

leafer/packages/display/src/Leaf.ts:138

---

nextRender

▸ nextRender(item, bind?, off?): void

Parameters

Name	Type
item	IFunction
bind?	IObject
off?	"off"

Returns

void

Inherited from

Leaf.nextRender

Defined in

leafer/packages/display/src/Leaf.ts:143

---

removeNextRender

▸ removeNextRender(item): void

Parameters

Name	Type
item	IFunction

Returns

void

Inherited from

Leaf.removeNextRender

Defined in

leafer/packages/display/src/Leaf.ts:147

---

__bindLeafer

▸ __bindLeafer(leafer): void

Parameters

Name	Type
leafer	ILeaferBase

Returns

void

Inherited from

Leaf.__bindLeafer

Defined in

leafer/packages/display/src/Leaf.ts:151

---

set

▸ set(_data): void

Parameters

Name	Type
_data	IObject

Returns

void

Inherited from

Leaf.set

Defined in

leafer/packages/display/src/Leaf.ts:176

---

get

▸ get(_name?): IValue | ILeafInputData

Parameters

Name	Type
_name?	string

Returns

IValue | ILeafInputData

Inherited from

Leaf.get

Defined in

leafer/packages/display/src/Leaf.ts:177

---

setAttr

▸ setAttr(name, value): void

Parameters

Name	Type
name	string
value	any

Returns

void

Inherited from

Leaf.setAttr

Defined in

leafer/packages/display/src/Leaf.ts:179

---

getAttr

▸ getAttr(name): any

Parameters

Name	Type
name	string

Returns

any

Inherited from

Leaf.getAttr

Defined in

leafer/packages/display/src/Leaf.ts:180

---

getComputedAttr

▸ getComputedAttr(name): any

Parameters

Name	Type
name	string

Returns

any

Inherited from

Leaf.getComputedAttr

Defined in

leafer/packages/display/src/Leaf.ts:182

---

toJSON

▸ toJSON(options?): IObject

Parameters

Name	Type
options?	IJSONOptions

Returns

IObject

Inherited from

Leaf.toJSON

Defined in

leafer/packages/display/src/Leaf.ts:184

---

toString

▸ toString(options?): string

Parameters

Name	Type
options?	IJSONOptions

Returns

string

Inherited from

Leaf.toString

Defined in

leafer/packages/display/src/Leaf.ts:189

---

toSVG

▸ toSVG(): string

Returns

string

Inherited from

Leaf.toSVG

Defined in

leafer/packages/display/src/Leaf.ts:193

---

__SVG

▸ __SVG(_data): void

Parameters

Name	Type
_data	IObject

Returns

void

Inherited from

Leaf.__SVG

Defined in

leafer/packages/display/src/Leaf.ts:195

---

toHTML

▸ toHTML(): string

Returns

string

Inherited from

Leaf.toHTML

Defined in

leafer/packages/display/src/Leaf.ts:197

---

__setAttr

▸ __setAttr(_attrName, _newValue): boolean

Parameters

Name	Type
_attrName	string
_newValue	IValue

Returns

boolean

Inherited from

Leaf.__setAttr

Defined in

leafer/packages/display/src/Leaf.ts:201

---

__getAttr

▸ __getAttr(_attrName): IValue

Parameters

Name	Type
_attrName	string

Returns

IValue

Inherited from

Leaf.__getAttr

Defined in

leafer/packages/display/src/Leaf.ts:203

---

setProxyAttr

▸ setProxyAttr(_attrName, _newValue): void

Parameters

Name	Type
_attrName	string
_newValue	IValue

Returns

void

Inherited from

Leaf.setProxyAttr

Defined in

leafer/packages/display/src/Leaf.ts:205

---

getProxyAttr

▸ getProxyAttr(_attrName): IValue

Parameters

Name	Type
_attrName	string

Returns

IValue

Inherited from

Leaf.getProxyAttr

Defined in

leafer/packages/display/src/Leaf.ts:207

---

find

▸ find(_condition, _options?): ILeaf[]

Parameters

Name	Type
_condition	string | number | IFindMethod
_options?	any

Returns

ILeaf[]

Inherited from

Leaf.find

Defined in

leafer/packages/display/src/Leaf.ts:214

---

findTag

▸ findTag(_tag): ILeaf[]

Parameters

Name	Type
_tag	string | string[]

Returns

ILeaf[]

Inherited from

Leaf.findTag

Defined in

leafer/packages/display/src/Leaf.ts:216

---

findOne

▸ findOne(_condition, _options?): ILeaf

Parameters

Name	Type
_condition	string | number | IFindMethod
_options?	any

Returns

ILeaf

Inherited from

Leaf.findOne

Defined in

leafer/packages/display/src/Leaf.ts:218

---

findId

▸ findId(_id): ILeaf

Parameters

Name	Type
_id	string | number

Returns

ILeaf

Inherited from

Leaf.findId

Defined in

leafer/packages/display/src/Leaf.ts:220

---

focus

▸ focus(_value?): void

Parameters

Name	Type
_value?	boolean

Returns

void

Inherited from

Leaf.focus

Defined in

leafer/packages/display/src/Leaf.ts:227

---

updateLayout

▸ updateLayout(): void

Returns

void

Inherited from

Leaf.updateLayout

Defined in

leafer/packages/display/src/Leaf.ts:231

---

forceUpdate

▸ forceUpdate(attrName?): void

Parameters

Name	Type
attrName?	string

Returns

void

Inherited from

Leaf.forceUpdate

Defined in

leafer/packages/display/src/Leaf.ts:235

---

forceRender

▸ forceRender(_bounds?): void

Parameters

Name	Type
_bounds?	IBoundsData

Returns

void

Inherited from

Leaf.forceRender

Defined in

leafer/packages/display/src/Leaf.ts:243

---

__updateWorldMatrix

▸ __updateWorldMatrix(): void

Returns

void

Inherited from

Leaf.__updateWorldMatrix

Defined in

leafer/packages/display/src/Leaf.ts:249

---

__updateLocalMatrix

▸ __updateLocalMatrix(): void

Returns

void

Inherited from

Leaf.__updateLocalMatrix

Defined in

leafer/packages/display/src/Leaf.ts:251

---

__updateWorldBounds

▸ __updateWorldBounds(): void

Returns

void

Inherited from

Leaf.__updateWorldBounds

Defined in

leafer/packages/display/src/Leaf.ts:257

---

__updateLocalBounds

▸ __updateLocalBounds(): void

Returns

void

Inherited from

Leaf.__updateLocalBounds

Defined in

leafer/packages/display/src/Leaf.ts:259

---

__updateLocalBoxBounds

▸ __updateLocalBoxBounds(): void

Returns

void

Inherited from

Leaf.__updateLocalBoxBounds

Defined in

leafer/packages/display/src/Leaf.ts:262

---

__updateLocalStrokeBounds

▸ __updateLocalStrokeBounds(): void

Returns

void

Inherited from

Leaf.__updateLocalStrokeBounds

Defined in

leafer/packages/display/src/Leaf.ts:264

---

__updateLocalRenderBounds

▸ __updateLocalRenderBounds(): void

Returns

void

Inherited from

Leaf.__updateLocalRenderBounds

Defined in

leafer/packages/display/src/Leaf.ts:266

---

__updateContentBounds

▸ __updateContentBounds(): void

Returns

void

Inherited from

Leaf.__updateContentBounds

Defined in

leafer/packages/display/src/Leaf.ts:272

---

__updateAutoLayout

▸ __updateAutoLayout(): void

Returns

void

Inherited from

Leaf.__updateAutoLayout

Defined in

leafer/packages/display/src/Leaf.ts:279

---

__updateFlowLayout

▸ __updateFlowLayout(): void

Returns

void

Inherited from

Leaf.__updateFlowLayout

Defined in

leafer/packages/display/src/Leaf.ts:281

---

__updateNaturalSize

▸ __updateNaturalSize(): void

Returns

void

Inherited from

Leaf.__updateNaturalSize

Defined in

leafer/packages/display/src/Leaf.ts:283

---

__onUpdateSize

▸ __onUpdateSize(): void

Returns

void

Inherited from

Leaf.__onUpdateSize

Defined in

leafer/packages/display/src/Leaf.ts:290

---

__updateEraser

▸ __updateEraser(value?): void

Parameters

Name	Type
value?	boolean

Returns

void

Inherited from

Leaf.__updateEraser

Defined in

leafer/packages/display/src/Leaf.ts:295

---

__renderEraser

▸ __renderEraser(canvas, options): void

Parameters

Name	Type
canvas	ILeaferCanvas
options	IRenderOptions

Returns

void

Inherited from

Leaf.__renderEraser

Defined in

leafer/packages/display/src/Leaf.ts:299

---

__updateMask

▸ __updateMask(value?): void

Parameters

Name	Type
value?	boolean

Returns

void

Inherited from

Leaf.__updateMask

Defined in

leafer/packages/display/src/Leaf.ts:307

---

__renderMask

▸ __renderMask(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Inherited from

Leaf.__renderMask

Defined in

leafer/packages/display/src/Leaf.ts:313

---

__getNowWorld

▸ __getNowWorld(options): IMatrixWithBoundsScaleData

Parameters

Name	Type
options	IRenderOptions

Returns

IMatrixWithBoundsScaleData

Inherited from

Leaf.__getNowWorld

Defined in

leafer/packages/display/src/Leaf.ts:321

---

getTransform

▸ getTransform(relative?): IMatrixData

Parameters

Name	Type
relative?	ILeaf | ILocationType

Returns

IMatrixData

Inherited from

Leaf.getTransform

Defined in

leafer/packages/display/src/Leaf.ts:333

---

getBounds

▸ getBounds(type?, relative?): IBoundsData

Parameters

Name	Type
type?	IBoundsType
relative?	ILeaf | ILocationType

Returns

IBoundsData

Inherited from

Leaf.getBounds

Defined in

leafer/packages/display/src/Leaf.ts:338

---

getLayoutBounds

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

Parameters

Name	Type
type?	IBoundsType
relative?	ILeaf | ILocationType
unscale?	boolean

Returns

ILayoutBoundsData

Inherited from

Leaf.getLayoutBounds

Defined in

leafer/packages/display/src/Leaf.ts:342

---

getLayoutPoints

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

Parameters

Name	Type
type?	IBoundsType
relative?	ILeaf | ILocationType

Returns

IPointData[]

Inherited from

Leaf.getLayoutPoints

Defined in

leafer/packages/display/src/Leaf.ts:346

---

getWorldBounds

▸ getWorldBounds(inner, relative?, change?): IBoundsData

Parameters

Name	Type
inner	IBoundsData
relative?	ILeaf
change?	boolean

Returns

IBoundsData

Inherited from

Leaf.getWorldBounds

Defined in

leafer/packages/display/src/Leaf.ts:351

---

worldToLocal

▸ worldToLocal(world, to?, distance?, relative?): void

Parameters

Name	Type
world	IPointData
to?	IPointData
distance?	boolean
relative?	ILeaf

Returns

void

Inherited from

Leaf.worldToLocal

Defined in

leafer/packages/display/src/Leaf.ts:359

---

localToWorld

▸ localToWorld(local, to?, distance?, relative?): void

Parameters

Name	Type
local	IPointData
to?	IPointData
distance?	boolean
relative?	ILeaf

Returns

void

Inherited from

Leaf.localToWorld

Defined in

leafer/packages/display/src/Leaf.ts:367

---

worldToInner

▸ worldToInner(world, to?, distance?, relative?): void

Parameters

Name	Type
world	IPointData
to?	IPointData
distance?	boolean
relative?	ILeaf

Returns

void

Inherited from

Leaf.worldToInner

Defined in

leafer/packages/display/src/Leaf.ts:375

---

innerToWorld

▸ innerToWorld(inner, to?, distance?, relative?): void

Parameters

Name	Type
inner	IPointData
to?	IPointData
distance?	boolean
relative?	ILeaf

Returns

void

Inherited from

Leaf.innerToWorld

Defined in

leafer/packages/display/src/Leaf.ts:383

---

getInnerPoint

▸ getInnerPoint(world, relative?, distance?, change?): IPointData

Parameters

Name	Type
world	IPointData
relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Inherited from

Leaf.getInnerPoint

Defined in

leafer/packages/display/src/Leaf.ts:390

---

getInnerPointByLocal

▸ getInnerPointByLocal(local, _relative?, distance?, change?): IPointData

Parameters

Name	Type
local	IPointData
_relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Inherited from

Leaf.getInnerPointByLocal

Defined in

leafer/packages/display/src/Leaf.ts:396

---

getLocalPoint

▸ getLocalPoint(world, relative?, distance?, change?): IPointData

Parameters

Name	Type
world	IPointData
relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Inherited from

Leaf.getLocalPoint

Defined in

leafer/packages/display/src/Leaf.ts:400

---

getLocalPointByInner

▸ getLocalPointByInner(inner, _relative?, distance?, change?): IPointData

Parameters

Name	Type
inner	IPointData
_relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Inherited from

Leaf.getLocalPointByInner

Defined in

leafer/packages/display/src/Leaf.ts:406

---

getWorldPoint

▸ getWorldPoint(inner, relative?, distance?, change?): IPointData

Parameters

Name	Type
inner	IPointData
relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Inherited from

Leaf.getWorldPoint

Defined in

leafer/packages/display/src/Leaf.ts:410

---

getWorldPointByLocal

▸ getWorldPointByLocal(local, relative?, distance?, change?): IPointData

Parameters

Name	Type
local	IPointData
relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Inherited from

Leaf.getWorldPointByLocal

Defined in

leafer/packages/display/src/Leaf.ts:416

---

getPagePoint

▸ getPagePoint(world, relative?, distance?, change?): IPointData

Parameters

Name	Type
world	IPointData
relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Inherited from

Leaf.getPagePoint

Defined in

leafer/packages/display/src/Leaf.ts:422

---

getWorldPointByPage

▸ getWorldPointByPage(page, relative?, distance?, change?): IPointData

Parameters

Name	Type
page	IPointData
relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Inherited from

Leaf.getWorldPointByPage

Defined in

leafer/packages/display/src/Leaf.ts:427

---

setTransform

▸ setTransform(matrix, resize?): void

Parameters

Name	Type
matrix	IMatrixData
resize?	boolean

Returns

void

Inherited from

Leaf.setTransform

Defined in

leafer/packages/display/src/Leaf.ts:435

---

transform

▸ transform(matrix, resize?): void

Parameters

Name	Type
matrix	IMatrixData
resize?	boolean

Returns

void

Inherited from

Leaf.transform

Defined in

leafer/packages/display/src/Leaf.ts:439

---

move

▸ move(x, y?): void

Parameters

Name	Type
x	number | IPointData
y?	number

Returns

void

Inherited from

Leaf.move

Defined in

leafer/packages/display/src/Leaf.ts:443

---

moveInner

▸ moveInner(x, y?): void

Parameters

Name	Type
x	number | IPointData
y?	number

Returns

void

Inherited from

Leaf.moveInner

Defined in

leafer/packages/display/src/Leaf.ts:448

---

scaleOf

▸ scaleOf(origin, scaleX, scaleY?, resize?): void

Parameters

Name	Type
origin	IPointData | IDirection
scaleX	number
scaleY?	number
resize?	boolean

Returns

void

Inherited from

Leaf.scaleOf

Defined in

leafer/packages/display/src/Leaf.ts:452

---

rotateOf

▸ rotateOf(origin, rotation): void

Parameters

Name	Type
origin	IPointData | IDirection
rotation	number

Returns

void

Inherited from

Leaf.rotateOf

Defined in

leafer/packages/display/src/Leaf.ts:456

---

skewOf

▸ skewOf(origin, skewX, skewY?, resize?): void

Parameters

Name	Type
origin	IPointData | IDirection
skewX	number
skewY?	number
resize?	boolean

Returns

void

Inherited from

Leaf.skewOf

Defined in

leafer/packages/display/src/Leaf.ts:460

---

transformWorld

▸ transformWorld(worldTransform?, resize?): void

Parameters

Name	Type
worldTransform?	IMatrixData
resize?	boolean

Returns

void

Inherited from

Leaf.transformWorld

Defined in

leafer/packages/display/src/Leaf.ts:465

---

moveWorld

▸ moveWorld(x, y?): void

Parameters

Name	Type
x	number | IPointData
y?	number

Returns

void

Inherited from

Leaf.moveWorld

Defined in

leafer/packages/display/src/Leaf.ts:469

---

scaleOfWorld

▸ scaleOfWorld(worldOrigin, scaleX, scaleY?, resize?): void

Parameters

Name	Type
worldOrigin	IPointData
scaleX	number
scaleY?	number
resize?	boolean

Returns

void

Inherited from

Leaf.scaleOfWorld

Defined in

leafer/packages/display/src/Leaf.ts:473

---

rotateOfWorld

▸ rotateOfWorld(worldOrigin, rotation): void

Parameters

Name	Type
worldOrigin	IPointData
rotation	number

Returns

void

Inherited from

Leaf.rotateOfWorld

Defined in

leafer/packages/display/src/Leaf.ts:477

---

skewOfWorld

▸ skewOfWorld(worldOrigin, skewX, skewY?, resize?): void

Parameters

Name	Type
worldOrigin	IPointData
skewX	number
skewY?	number
resize?	boolean

Returns

void

Inherited from

Leaf.skewOfWorld

Defined in

leafer/packages/display/src/Leaf.ts:481

---

flip

▸ flip(axis): void

Parameters

Name	Type
axis	IAxis

Returns

void

Inherited from

Leaf.flip

Defined in

leafer/packages/display/src/Leaf.ts:485

---

scaleResize

▸ scaleResize(scaleX, scaleY?, _noResize?): void

Parameters

Name	Type	Default value
scaleX	number	undefined
scaleY	number	scaleX
_noResize?	boolean	undefined

Returns

void

Inherited from

Leaf.scaleResize

Defined in

leafer/packages/display/src/Leaf.ts:492

---

__scaleResize

▸ __scaleResize(_scaleX, _scaleY): void

Parameters

Name	Type
_scaleX	number
_scaleY	number

Returns

void

Inherited from

Leaf.__scaleResize

Defined in

leafer/packages/display/src/Leaf.ts:497

---

resizeWidth

▸ resizeWidth(_width): void

Parameters

Name	Type
_width	number

Returns

void

Inherited from

Leaf.resizeWidth

Defined in

leafer/packages/display/src/Leaf.ts:500

---

resizeHeight

▸ resizeHeight(_height): void

Parameters

Name	Type
_height	number

Returns

void

Inherited from

Leaf.resizeHeight

Defined in

leafer/packages/display/src/Leaf.ts:502

---

__hitWorld

▸ __hitWorld(_point): boolean

Parameters

Name	Type
_point	IRadiusPointData

Returns

boolean

Inherited from

Leaf.__hitWorld

Defined in

leafer/packages/display/src/Leaf.ts:507

---

__hit

▸ __hit(_local): boolean

Parameters

Name	Type
_local	IRadiusPointData

Returns

boolean

Inherited from

Leaf.__hit

Defined in

leafer/packages/display/src/Leaf.ts:509

---

__hitFill

▸ __hitFill(_inner): boolean

Parameters

Name	Type
_inner	IRadiusPointData

Returns

boolean

Inherited from

Leaf.__hitFill

Defined in

leafer/packages/display/src/Leaf.ts:511

---

__hitStroke

▸ __hitStroke(_inner, _strokeWidth): boolean

Parameters

Name	Type
_inner	IRadiusPointData
_strokeWidth	number

Returns

boolean

Inherited from

Leaf.__hitStroke

Defined in

leafer/packages/display/src/Leaf.ts:513

---

__hitPixel

▸ __hitPixel(_inner): boolean

Parameters

Name	Type
_inner	IRadiusPointData

Returns

boolean

Inherited from

Leaf.__hitPixel

Defined in

leafer/packages/display/src/Leaf.ts:515

---

__drawHitPath

▸ __drawHitPath(_canvas): void

Parameters

Name	Type
_canvas	ILeaferCanvas

Returns

void

Inherited from

Leaf.__drawHitPath

Defined in

leafer/packages/display/src/Leaf.ts:517

---

__updateHitCanvas

▸ __updateHitCanvas(): void

Returns

void

Inherited from

Leaf.__updateHitCanvas

Defined in

leafer/packages/display/src/Leaf.ts:519

---

__render

▸ __render(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Inherited from

Leaf.__render

Defined in

leafer/packages/display/src/Leaf.ts:526

---

__drawFast

▸ __drawFast(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Inherited from

Leaf.__drawFast

Defined in

leafer/packages/display/src/Leaf.ts:528

---

__draw

▸ __draw(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Inherited from

Leaf.__draw

Defined in

leafer/packages/display/src/Leaf.ts:530

---

__clip

▸ __clip(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Inherited from

Leaf.__clip

Defined in

leafer/packages/display/src/Leaf.ts:533

---

__renderShape

▸ __renderShape(_canvas, _options, _ignoreFill?, _ignoreStroke?): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions
_ignoreFill?	boolean
_ignoreStroke?	boolean

Returns

void

Inherited from

Leaf.__renderShape

Defined in

leafer/packages/display/src/Leaf.ts:535

---

__updateWorldOpacity

▸ __updateWorldOpacity(): void

Returns

void

Inherited from

Leaf.__updateWorldOpacity

Defined in

leafer/packages/display/src/Leaf.ts:538

---

__updateChange

▸ __updateChange(): void

Returns

void

Inherited from

Leaf.__updateChange

Defined in

leafer/packages/display/src/Leaf.ts:540

---

__drawPath

▸ __drawPath(_canvas): void

Parameters

Name	Type
_canvas	ILeaferCanvas

Returns

void

Inherited from

Leaf.__drawPath

Defined in

leafer/packages/display/src/Leaf.ts:547

---

__drawRenderPath

▸ __drawRenderPath(_canvas): void

Parameters

Name	Type
_canvas	ILeaferCanvas

Returns

void

Inherited from

Leaf.__drawRenderPath

Defined in

leafer/packages/display/src/Leaf.ts:549

---

__updatePath

▸ __updatePath(): void

Returns

void

Inherited from

Leaf.__updatePath

Defined in

leafer/packages/display/src/Leaf.ts:551

---

__updateRenderPath

▸ __updateRenderPath(): void

Returns

void

Inherited from

Leaf.__updateRenderPath

Defined in

leafer/packages/display/src/Leaf.ts:553

---

dropTo

▸ dropTo(parent, index?, resize?): void

Parameters

Name	Type
parent	ILeaf
index?	number
resize?	boolean

Returns

void

Inherited from

Leaf.dropTo

Defined in

leafer/packages/display/src/Leaf.ts:566

---

on

▸ on(_type, _listener, _options?): void

Parameters

Name	Type
_type	string | string[]
_listener	IFunction
_options?	IEventOption

Returns

void

Inherited from

Leaf.on

Defined in

leafer/packages/display/src/Leaf.ts:575

---

off

▸ off(_type?, _listener?, _options?): void

Parameters

Name	Type
_type?	string | string[]
_listener?	IFunction
_options?	IEventOption

Returns

void

Inherited from

Leaf.off

Defined in

leafer/packages/display/src/Leaf.ts:577

---

on_

▸ on_(_type, _listener, _bind?, _options?): IEventListenerId

Parameters

Name	Type
_type	string | string[]
_listener	IFunction
_bind?	IObject
_options?	IEventOption

Returns

IEventListenerId

Inherited from

Leaf.on_

Defined in

leafer/packages/display/src/Leaf.ts:579

---

off_

▸ off_(_id): void

Parameters

Name	Type
_id	IEventListenerId | IEventListenerId[]

Returns

void

Inherited from

Leaf.off_

Defined in

leafer/packages/display/src/Leaf.ts:581

---

once

▸ once(_type, _listener, _capture?): void

Parameters

Name	Type
_type	string | string[]
_listener	IFunction
_capture?	boolean

Returns

void

Inherited from

Leaf.once

Defined in

leafer/packages/display/src/Leaf.ts:583

---

emit

▸ emit(_type, _event?, _capture?): void

Parameters

Name	Type
_type	string
_event?	IObject | IEvent
_capture?	boolean

Returns

void

Inherited from

Leaf.emit

Defined in

leafer/packages/display/src/Leaf.ts:585

---

emitEvent

▸ emitEvent(_event?, _capture?): void

Parameters

Name	Type
_event?	IEvent
_capture?	boolean

Returns

void

Inherited from

Leaf.emitEvent

Defined in

leafer/packages/display/src/Leaf.ts:587

---

hasEvent

▸ hasEvent(_type, _capture?): boolean

Parameters

Name	Type
_type	string
_capture?	boolean

Returns

boolean

Inherited from

Leaf.hasEvent

Defined in

leafer/packages/display/src/Leaf.ts:589

---

changeAttr

▸ changeAttr(attrName, defaultValue, fn?): void

Parameters

Name	Type
attrName	string
defaultValue	IValue
fn?	IAttrDecorator

Returns

void

Inherited from

Leaf.changeAttr

Defined in

leafer/packages/display/src/Leaf.ts:593

---

addAttr

▸ addAttr(attrName, defaultValue, fn?): void

Parameters

Name	Type
attrName	string
defaultValue	IValue
fn?	IAttrDecorator

Returns

void

Inherited from

Leaf.addAttr

Defined in

leafer/packages/display/src/Leaf.ts:597

---

destroy

▸ destroy(): void

Returns

void

Inherited from

Leaf.destroy

Defined in

leafer/packages/display/src/Leaf.ts:603