Skip to content

Class: Leaf<TInputData> ​

Type parameters ​

NameType
TInputDataILeafInputData

Hierarchy ​

Implements ​

Table of contents ​

Constructors ​

Properties ​

Accessors ​

Methods ​

Constructors ​

constructor ​

• new Leaf<TInputData>(data?): Leaf<TInputData>

Type parameters ​

NameType
TInputDataILeafInputData

Parameters ​

NameType
data?TInputData

Returns ​

Leaf<TInputData>

Defined in ​

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

Properties ​

innerId ​

• Readonly innerId: number

Implementation of ​

ILeaf.innerId

Defined in ​

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


leafer ​

• Optional leafer: ILeaferBase

Implementation of ​

ILeaf.leafer

Defined in ​

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


parent ​

• Optional parent: ILeaf

Implementation of ​

ILeaf.parent

Defined in ​

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


skipJSON ​

• Optional skipJSON: boolean

Implementation of ​

ILeaf.skipJSON

Defined in ​

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


syncEventer ​

• Optional syncEventer: ILeaf

Implementation of ​

ILeaf.syncEventer

Defined in ​

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


lockNormalStyle ​

• Optional lockNormalStyle: boolean

Implementation of ​

ILeaf.lockNormalStyle

Defined in ​

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


__ ​

• __: ILeafData

Implementation of ​

ILeaf.__

Defined in ​

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


__layout ​

• __layout: ILeafLayout

Implementation of ​

ILeaf.__layout

Defined in ​

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


__world ​

• __world: IMatrixWithBoundsScaleData

Implementation of ​

ILeaf.__world

Defined in ​

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


__local ​

• Optional __local: IMatrixWithBoundsData

Implementation of ​

ILeaf.__local

Defined in ​

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


__nowWorld ​

• Optional __nowWorld: IMatrixWithBoundsScaleData

Implementation of ​

ILeaf.__nowWorld

Defined in ​

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


__cameraWorld ​

• Optional __cameraWorld: IMatrixWithBoundsScaleData

Implementation of ​

ILeaf.__cameraWorld

Defined in ​

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


__worldOpacity ​

• __worldOpacity: number

Implementation of ​

ILeaf.__worldOpacity

Defined in ​

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


__scrollWorld ​

• Optional __scrollWorld: IMatrixWithBoundsScaleData

Implementation of ​

ILeaf.__scrollWorld

Defined in ​

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


__level ​

• __level: number

Implementation of ​

ILeaf.__level

Defined in ​

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


__tempNumber ​

• __tempNumber: number

Implementation of ​

ILeaf.__tempNumber

Defined in ​

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


__hasAutoLayout ​

• Optional __hasAutoLayout: boolean

Implementation of ​

ILeaf.__hasAutoLayout

Defined in ​

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


__hasMask ​

• Optional __hasMask: boolean

Implementation of ​

ILeaf.__hasMask

Defined in ​

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


__hasEraser ​

• Optional __hasEraser: boolean

Implementation of ​

ILeaf.__hasEraser

Defined in ​

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


__hitCanvas ​

• Optional __hitCanvas: IHitCanvas

Implementation of ​

ILeaf.__hitCanvas

Defined in ​

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


__captureMap ​

• Optional __captureMap: IEventListenerMap

Implementation of ​

ILeaf.__captureMap

Defined in ​

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


__bubbleMap ​

• Optional __bubbleMap: IEventListenerMap

Implementation of ​

ILeaf.__bubbleMap

Defined in ​

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


__hasLocalEvent ​

• Optional __hasLocalEvent: boolean

Implementation of ​

ILeaf.__hasLocalEvent

Defined in ​

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


__hasWorldEvent ​

• Optional __hasWorldEvent: boolean

Implementation of ​

ILeaf.__hasWorldEvent

Defined in ​

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


children ​

• Optional children: ILeaf[]

Implementation of ​

ILeaf.children

Defined in ​

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


topChildren ​

• Optional topChildren: ILeaf[]

Implementation of ​

ILeaf.topChildren

Defined in ​

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


destroyed ​

• destroyed: boolean

Implementation of ​

ILeaf.destroyed

Defined in ​

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

Accessors ​

tag ​

• get tag(): string

Returns ​

string

Implementation of ​

ILeaf.tag

Defined in ​

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

• set tag(_value): void

Parameters ​

NameType
_valuestring

Returns ​

void

Implementation of ​

ILeaf.tag

Defined in ​

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


__tag ​

• get __tag(): string

Returns ​

string

Implementation of ​

ILeaf.__tag

Defined in ​

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


innerName ​

• get innerName(): string

Returns ​

string

Implementation of ​

ILeaf.innerName

Defined in ​

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


__DataProcessor ​

• get __DataProcessor(): typeof LeafData

Returns ​

typeof LeafData

Implementation of ​

ILeaf.__DataProcessor

Defined in ​

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


__LayoutProcessor ​

• get __LayoutProcessor(): typeof LeafLayout

Returns ​

typeof LeafLayout

Implementation of ​

ILeaf.__LayoutProcessor

Defined in ​

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


leaferIsCreated ​

• get leaferIsCreated(): boolean

Returns ​

boolean

Implementation of ​

ILeaf.leaferIsCreated

Defined in ​

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


leaferIsReady ​

• get leaferIsReady(): boolean

Returns ​

boolean

Implementation of ​

ILeaf.leaferIsReady

Defined in ​

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


isLeafer ​

• get isLeafer(): boolean

Returns ​

boolean

Implementation of ​

ILeaf.isLeafer

Defined in ​

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


isBranch ​

• get isBranch(): boolean

Returns ​

boolean

Implementation of ​

ILeaf.isBranch

Defined in ​

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


isBranchLeaf ​

• get isBranchLeaf(): boolean

Returns ​

boolean

Implementation of ​

ILeaf.isBranchLeaf

Defined in ​

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


__localMatrix ​

• get __localMatrix(): IMatrixData

Returns ​

IMatrixData

Implementation of ​

ILeaf.__localMatrix

Defined in ​

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


__localBoxBounds ​

• get __localBoxBounds(): IBoundsData

Returns ​

IBoundsData

Implementation of ​

ILeaf.__localBoxBounds

Defined in ​

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


worldTransform ​

• get worldTransform(): IMatrixWithScaleData

Returns ​

IMatrixWithScaleData

Implementation of ​

ILeaf.worldTransform

Defined in ​

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


localTransform ​

• get localTransform(): IMatrixData

Returns ​

IMatrixData

Implementation of ​

ILeaf.localTransform

Defined in ​

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


scrollWorldTransform ​

• get scrollWorldTransform(): IMatrixWithScaleData

Returns ​

IMatrixWithScaleData

Implementation of ​

ILeaf.scrollWorldTransform

Defined in ​

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


boxBounds ​

• get boxBounds(): IBoundsData

Returns ​

IBoundsData

Implementation of ​

ILeaf.boxBounds

Defined in ​

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


renderBounds ​

• get renderBounds(): IBoundsData

Returns ​

IBoundsData

Implementation of ​

ILeaf.renderBounds

Defined in ​

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


worldBoxBounds ​

• get worldBoxBounds(): IBoundsData

Returns ​

IBoundsData

Implementation of ​

ILeaf.worldBoxBounds

Defined in ​

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


worldStrokeBounds ​

• get worldStrokeBounds(): IBoundsData

Returns ​

IBoundsData

Implementation of ​

ILeaf.worldStrokeBounds

Defined in ​

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


worldRenderBounds ​

• get worldRenderBounds(): IBoundsData

Returns ​

IBoundsData

Implementation of ​

ILeaf.worldRenderBounds

Defined in ​

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


worldOpacity ​

• get worldOpacity(): number

Returns ​

number

Implementation of ​

ILeaf.worldOpacity

Defined in ​

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


__worldFlipped ​

• get __worldFlipped(): boolean

Returns ​

boolean

Implementation of ​

ILeaf.__worldFlipped

Defined in ​

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


__onlyHitMask ​

• get __onlyHitMask(): boolean

Returns ​

boolean

Implementation of ​

ILeaf.__onlyHitMask

Defined in ​

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


__ignoreHitWorld ​

• get __ignoreHitWorld(): boolean

Returns ​

boolean

Implementation of ​

ILeaf.__ignoreHitWorld

Defined in ​

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


__inLazyBounds ​

• get __inLazyBounds(): boolean

Returns ​

boolean

Implementation of ​

ILeaf.__inLazyBounds

Defined in ​

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


pathInputed ​

• get pathInputed(): boolean

Returns ​

boolean

Implementation of ​

ILeaf.pathInputed

Defined in ​

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


event ​

• set event(map): void

Parameters ​

NameType
mapIEventParamsMap

Returns ​

void

Implementation of ​

ILeaf.event

Defined in ​

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

Methods ​

reset ​

â–¸ reset(data?): void

Parameters ​

NameType
data?ILeafInputData

Returns ​

void

Implementation of ​

ILeaf.reset

Defined in ​

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


resetCustom ​

â–¸ resetCustom(): void

Returns ​

void

Implementation of ​

ILeaf.resetCustom

Defined in ​

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


waitParent ​

â–¸ waitParent(item, bind?): void

Parameters ​

NameType
itemIFunction
bind?IObject

Returns ​

void

Implementation of ​

ILeaf.waitParent

Defined in ​

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


waitLeafer ​

â–¸ waitLeafer(item, bind?): void

Parameters ​

NameType
itemIFunction
bind?IObject

Returns ​

void

Implementation of ​

ILeaf.waitLeafer

Defined in ​

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


nextRender ​

â–¸ nextRender(item, bind?, off?): void

Parameters ​

NameType
itemIFunction
bind?IObject
off?"off"

Returns ​

void

Implementation of ​

ILeaf.nextRender

Defined in ​

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


removeNextRender ​

â–¸ removeNextRender(item): void

Parameters ​

NameType
itemIFunction

Returns ​

void

Implementation of ​

ILeaf.removeNextRender

Defined in ​

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


__bindLeafer ​

â–¸ __bindLeafer(leafer): void

Parameters ​

NameType
leaferILeaferBase

Returns ​

void

Implementation of ​

ILeaf.__bindLeafer

Defined in ​

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


set ​

â–¸ set(_data, _isTemp?): void

Parameters ​

NameType
_dataIObject
_isTemp?boolean

Returns ​

void

Implementation of ​

ILeaf.set

Defined in ​

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


get ​

â–¸ get<K>(_name?): ILeafInputData | Leaf<TInputData>[K]

Type parameters ​

NameType
Kextends keyof Leaf<TInputData>

Parameters ​

NameType
_name?ILeafInputData | K | K[]

Returns ​

ILeafInputData | Leaf<TInputData>[K]

Implementation of ​

ILeaf.get

Defined in ​

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


setAttr ​

â–¸ setAttr(name, value): void

Parameters ​

NameType
namestring
valueany

Returns ​

void

Implementation of ​

ILeaf.setAttr

Defined in ​

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


getAttr ​

â–¸ getAttr(name): any

Parameters ​

NameType
namestring

Returns ​

any

Implementation of ​

ILeaf.getAttr

Defined in ​

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


getComputedAttr ​

â–¸ getComputedAttr(name): any

Parameters ​

NameType
namestring

Returns ​

any

Implementation of ​

ILeaf.getComputedAttr

Defined in ​

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


toJSON ​

â–¸ toJSON(options?): IObject

Parameters ​

NameType
options?IJSONOptions

Returns ​

IObject

Implementation of ​

ILeaf.toJSON

Defined in ​

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


toString ​

â–¸ toString(options?): string

Parameters ​

NameType
options?IJSONOptions

Returns ​

string

Implementation of ​

ILeaf.toString

Defined in ​

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


toSVG ​

â–¸ toSVG(): string

Returns ​

string

Implementation of ​

ILeaf.toSVG

Defined in ​

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


__SVG ​

â–¸ __SVG(_data): void

Parameters ​

NameType
_dataIObject

Returns ​

void

Implementation of ​

ILeaf.__SVG

Defined in ​

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


toHTML ​

â–¸ toHTML(): string

Returns ​

string

Implementation of ​

ILeaf.toHTML

Defined in ​

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


__setAttr ​

â–¸ __setAttr(_attrName, _newValue): boolean

Parameters ​

NameType
_attrNamestring
_newValueIValue

Returns ​

boolean

Implementation of ​

ILeaf.__setAttr

Defined in ​

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


__getAttr ​

â–¸ __getAttr(_attrName): IValue

Parameters ​

NameType
_attrNamestring

Returns ​

IValue

Implementation of ​

ILeaf.__getAttr

Defined in ​

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


setProxyAttr ​

â–¸ setProxyAttr(_attrName, _newValue): void

Parameters ​

NameType
_attrNamestring
_newValueIValue

Returns ​

void

Implementation of ​

ILeaf.setProxyAttr

Defined in ​

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


getProxyAttr ​

â–¸ getProxyAttr(_attrName): IValue

Parameters ​

NameType
_attrNamestring

Returns ​

IValue

Implementation of ​

ILeaf.getProxyAttr

Defined in ​

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


find ​

â–¸ find(_condition, _options?): ILeaf[]

Parameters ​

NameType
_conditionstring | number | IFindMethod
_options?any

Returns ​

ILeaf[]

Implementation of ​

ILeaf.find

Defined in ​

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


findTag ​

â–¸ findTag(_tag): ILeaf[]

Parameters ​

NameType
_tagstring | string[]

Returns ​

ILeaf[]

Implementation of ​

ILeaf.findTag

Defined in ​

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


findOne ​

â–¸ findOne(_condition, _options?): ILeaf

Parameters ​

NameType
_conditionstring | number | IFindMethod
_options?any

Returns ​

ILeaf

Implementation of ​

ILeaf.findOne

Defined in ​

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


findId ​

â–¸ findId(_id): ILeaf

Parameters ​

NameType
_idstring | number

Returns ​

ILeaf

Implementation of ​

ILeaf.findId

Defined in ​

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


focus ​

â–¸ focus(_value?): void

Parameters ​

NameType
_value?boolean

Returns ​

void

Implementation of ​

ILeaf.focus

Defined in ​

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


updateState ​

â–¸ updateState(): void

Returns ​

void

Implementation of ​

ILeaf.updateState

Defined in ​

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


updateLayout ​

â–¸ updateLayout(): void

Returns ​

void

Implementation of ​

ILeaf.updateLayout

Defined in ​

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


forceUpdate ​

â–¸ forceUpdate(attrName?): void

Parameters ​

NameType
attrName?string

Returns ​

void

Implementation of ​

ILeaf.forceUpdate

Defined in ​

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


forceRender ​

â–¸ forceRender(_bounds?, _sync?): void

Parameters ​

NameType
_bounds?IBoundsData
_sync?boolean

Returns ​

void

Implementation of ​

ILeaf.forceRender

Defined in ​

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


__extraUpdate ​

â–¸ __extraUpdate(): void

Returns ​

void

Implementation of ​

ILeaf.__extraUpdate

Defined in ​

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


__updateWorldMatrix ​

â–¸ __updateWorldMatrix(): void

Returns ​

void

Implementation of ​

ILeaf.__updateWorldMatrix

Defined in ​

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


__updateLocalMatrix ​

â–¸ __updateLocalMatrix(): void

Returns ​

void

Implementation of ​

ILeaf.__updateLocalMatrix

Defined in ​

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


__updateWorldBounds ​

â–¸ __updateWorldBounds(): void

Returns ​

void

Implementation of ​

ILeaf.__updateWorldBounds

Defined in ​

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


__updateLocalBounds ​

â–¸ __updateLocalBounds(): void

Returns ​

void

Implementation of ​

ILeaf.__updateLocalBounds

Defined in ​

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


__updateLocalBoxBounds ​

â–¸ __updateLocalBoxBounds(): void

Returns ​

void

Implementation of ​

ILeaf.__updateLocalBoxBounds

Defined in ​

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


__updateLocalStrokeBounds ​

â–¸ __updateLocalStrokeBounds(): void

Returns ​

void

Implementation of ​

ILeaf.__updateLocalStrokeBounds

Defined in ​

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


__updateLocalRenderBounds ​

â–¸ __updateLocalRenderBounds(): void

Returns ​

void

Implementation of ​

ILeaf.__updateLocalRenderBounds

Defined in ​

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


__updateBoxBounds ​

â–¸ __updateBoxBounds(_secondLayout?, _bounds?): void

Parameters ​

NameType
_secondLayout?boolean
_bounds?IBoundsData

Returns ​

void

Implementation of ​

ILeaf.__updateBoxBounds

Defined in ​

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


__updateContentBounds ​

â–¸ __updateContentBounds(): void

Returns ​

void

Implementation of ​

ILeaf.__updateContentBounds

Defined in ​

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


__updateStrokeBounds ​

â–¸ __updateStrokeBounds(_bounds?): void

Parameters ​

NameType
_bounds?IBoundsData

Returns ​

void

Implementation of ​

ILeaf.__updateStrokeBounds

Defined in ​

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


__updateRenderBounds ​

â–¸ __updateRenderBounds(_bounds?): void

Parameters ​

NameType
_bounds?IBoundsData

Returns ​

void

Implementation of ​

ILeaf.__updateRenderBounds

Defined in ​

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


__updateAutoLayout ​

â–¸ __updateAutoLayout(): void

Returns ​

void

Implementation of ​

ILeaf.__updateAutoLayout

Defined in ​

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


__updateFlowLayout ​

â–¸ __updateFlowLayout(): void

Returns ​

void

Implementation of ​

ILeaf.__updateFlowLayout

Defined in ​

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


__updateNaturalSize ​

â–¸ __updateNaturalSize(): void

Returns ​

void

Implementation of ​

ILeaf.__updateNaturalSize

Defined in ​

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


__updateStrokeSpread ​

â–¸ __updateStrokeSpread(): IFourNumber

Returns ​

IFourNumber

Implementation of ​

ILeaf.__updateStrokeSpread

Defined in ​

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


__updateRenderSpread ​

â–¸ __updateRenderSpread(): IFourNumber

Returns ​

IFourNumber

Implementation of ​

ILeaf.__updateRenderSpread

Defined in ​

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


__onUpdateSize ​

â–¸ __onUpdateSize(): void

Returns ​

void

Implementation of ​

ILeaf.__onUpdateSize

Defined in ​

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


__updateEraser ​

â–¸ __updateEraser(value?): void

Parameters ​

NameType
value?boolean

Returns ​

void

Implementation of ​

ILeaf.__updateEraser

Defined in ​

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


__renderEraser ​

â–¸ __renderEraser(canvas, options): void

Parameters ​

NameType
canvasILeaferCanvas
optionsIRenderOptions

Returns ​

void

Implementation of ​

ILeaf.__renderEraser

Defined in ​

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


__updateMask ​

â–¸ __updateMask(_value?): void

Parameters ​

NameType
_value?boolean

Returns ​

void

Implementation of ​

ILeaf.__updateMask

Defined in ​

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


__renderMask ​

â–¸ __renderMask(_canvas, _options): void

Parameters ​

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns ​

void

Implementation of ​

ILeaf.__renderMask

Defined in ​

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


__getNowWorld ​

â–¸ __getNowWorld(options): IMatrixWithBoundsScaleData

Parameters ​

NameType
optionsIRenderOptions

Returns ​

IMatrixWithBoundsScaleData

Implementation of ​

ILeaf.__getNowWorld

Defined in ​

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


getClampRenderScale ​

â–¸ getClampRenderScale(): number

Returns ​

number

Implementation of ​

ILeaf.getClampRenderScale

Defined in ​

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


getRenderScaleData ​

â–¸ getRenderScaleData(abs?, scaleFixed?, unscale?): IScaleData

Parameters ​

NameTypeDefault value
abs?booleanundefined
scaleFixed?IScaleFixedundefined
unscalebooleantrue

Returns ​

IScaleData

Implementation of ​

ILeaf.getRenderScaleData

Defined in ​

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


getTransform ​

â–¸ getTransform(relative?): IMatrixData

Parameters ​

NameType
relative?ILeaf | ILocationType

Returns ​

IMatrixData

Implementation of ​

ILeaf.getTransform

Defined in ​

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


getBounds ​

â–¸ getBounds(type?, relative?): IBoundsData

Parameters ​

NameType
type?IBoundsType
relative?ILeaf | ILocationType

Returns ​

IBoundsData

Implementation of ​

ILeaf.getBounds

Defined in ​

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


getLayoutBounds ​

â–¸ getLayoutBounds(type?, relative?, unscale?): ILayoutBoundsData

Parameters ​

NameType
type?IBoundsType
relative?ILeaf | ILocationType
unscale?boolean

Returns ​

ILayoutBoundsData

Implementation of ​

ILeaf.getLayoutBounds

Defined in ​

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


getLayoutPoints ​

â–¸ getLayoutPoints(type?, relative?): IPointData[]

Parameters ​

NameType
type?IBoundsType
relative?ILeaf | ILocationType

Returns ​

IPointData[]

Implementation of ​

ILeaf.getLayoutPoints

Defined in ​

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


getWorldBounds ​

â–¸ getWorldBounds(inner, relative?, change?): IBoundsData

Parameters ​

NameType
innerIBoundsData
relative?ILeaf
change?boolean

Returns ​

IBoundsData

Implementation of ​

ILeaf.getWorldBounds

Defined in ​

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


worldToLocal ​

â–¸ worldToLocal(world, to?, distance?, relative?): void

Parameters ​

NameType
worldIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns ​

void

Implementation of ​

ILeaf.worldToLocal

Defined in ​

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


localToWorld ​

â–¸ localToWorld(local, to?, distance?, relative?): void

Parameters ​

NameType
localIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns ​

void

Implementation of ​

ILeaf.localToWorld

Defined in ​

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


worldToInner ​

â–¸ worldToInner(world, to?, distance?, relative?): void

Parameters ​

NameType
worldIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns ​

void

Implementation of ​

ILeaf.worldToInner

Defined in ​

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


innerToWorld ​

â–¸ innerToWorld(inner, to?, distance?, relative?): void

Parameters ​

NameType
innerIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns ​

void

Implementation of ​

ILeaf.innerToWorld

Defined in ​

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


getBoxPoint ​

â–¸ getBoxPoint(world, relative?, distance?, change?): IPointData

Parameters ​

NameType
worldIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns ​

IPointData

Implementation of ​

ILeaf.getBoxPoint

Defined in ​

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


getBoxPointByInner ​

â–¸ getBoxPointByInner(inner, _relative?, _distance?, change?): IPointData

Parameters ​

NameType
innerIPointData
_relative?ILeaf
_distance?boolean
change?boolean

Returns ​

IPointData

Implementation of ​

ILeaf.getBoxPointByInner

Defined in ​

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


getInnerPoint ​

â–¸ getInnerPoint(world, relative?, distance?, change?): IPointData

Parameters ​

NameType
worldIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns ​

IPointData

Implementation of ​

ILeaf.getInnerPoint

Defined in ​

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


getInnerPointByBox ​

â–¸ getInnerPointByBox(box, _relative?, _distance?, change?): IPointData

Parameters ​

NameType
boxIPointData
_relative?ILeaf
_distance?boolean
change?boolean

Returns ​

IPointData

Implementation of ​

ILeaf.getInnerPointByBox

Defined in ​

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


getInnerPointByLocal ​

â–¸ getInnerPointByLocal(local, _relative?, distance?, change?): IPointData

Parameters ​

NameType
localIPointData
_relative?ILeaf
distance?boolean
change?boolean

Returns ​

IPointData

Implementation of ​

ILeaf.getInnerPointByLocal

Defined in ​

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


getLocalPoint ​

â–¸ getLocalPoint(world, relative?, distance?, change?): IPointData

Parameters ​

NameType
worldIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns ​

IPointData

Implementation of ​

ILeaf.getLocalPoint

Defined in ​

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


getLocalPointByInner ​

â–¸ getLocalPointByInner(inner, _relative?, distance?, change?): IPointData

Parameters ​

NameType
innerIPointData
_relative?ILeaf
distance?boolean
change?boolean

Returns ​

IPointData

Implementation of ​

ILeaf.getLocalPointByInner

Defined in ​

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


getPagePoint ​

â–¸ getPagePoint(world, relative?, distance?, change?): IPointData

Parameters ​

NameType
worldIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns ​

IPointData

Implementation of ​

ILeaf.getPagePoint

Defined in ​

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


getWorldPoint ​

â–¸ getWorldPoint(inner, relative?, distance?, change?): IPointData

Parameters ​

NameType
innerIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns ​

IPointData

Implementation of ​

ILeaf.getWorldPoint

Defined in ​

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


getWorldPointByBox ​

â–¸ getWorldPointByBox(box, relative?, distance?, change?): IPointData

Parameters ​

NameType
boxIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns ​

IPointData

Implementation of ​

ILeaf.getWorldPointByBox

Defined in ​

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


getWorldPointByLocal ​

â–¸ getWorldPointByLocal(local, relative?, distance?, change?): IPointData

Parameters ​

NameType
localIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns ​

IPointData

Implementation of ​

ILeaf.getWorldPointByLocal

Defined in ​

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


getWorldPointByPage ​

â–¸ getWorldPointByPage(page, relative?, distance?, change?): IPointData

Parameters ​

NameType
pageIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns ​

IPointData

Implementation of ​

ILeaf.getWorldPointByPage

Defined in ​

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


setTransform ​

â–¸ setTransform(matrix, resize?, transition?): void

Parameters ​

NameType
matrixIMatrixData
resize?boolean
transition?ITransition

Returns ​

void

Implementation of ​

ILeaf.setTransform

Defined in ​

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


transform ​

â–¸ transform(matrix, resize?, transition?): void

Parameters ​

NameType
matrixIMatrixData
resize?boolean
transition?ITransition

Returns ​

void

Implementation of ​

ILeaf.transform

Defined in ​

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


move ​

â–¸ move(x, y?, transition?): void

Parameters ​

NameType
xnumber | IPointData
y?number
transition?ITransition

Returns ​

void

Implementation of ​

ILeaf.move

Defined in ​

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


moveInner ​

â–¸ moveInner(x, y?, transition?): void

Parameters ​

NameType
xnumber | IPointData
y?number
transition?ITransition

Returns ​

void

Implementation of ​

ILeaf.moveInner

Defined in ​

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


scaleOf ​

â–¸ scaleOf(origin, scaleX, scaleY?, resize?, transition?): void

Parameters ​

NameType
originIPointData | IDirection
scaleXnumber
scaleY?ITransition
resize?boolean
transition?ITransition

Returns ​

void

Implementation of ​

ILeaf.scaleOf

Defined in ​

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


rotateOf ​

â–¸ rotateOf(origin, rotation, transition?): void

Parameters ​

NameType
originIPointData | IDirection
rotationnumber
transition?ITransition

Returns ​

void

Implementation of ​

ILeaf.rotateOf

Defined in ​

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


skewOf ​

â–¸ skewOf(origin, skewX, skewY?, resize?, transition?): void

Parameters ​

NameType
originIPointData | IDirection
skewXnumber
skewY?number
resize?boolean
transition?ITransition

Returns ​

void

Implementation of ​

ILeaf.skewOf

Defined in ​

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


transformWorld ​

â–¸ transformWorld(worldTransform?, resize?, transition?): void

Parameters ​

NameType
worldTransform?IMatrixData
resize?boolean
transition?ITransition

Returns ​

void

Implementation of ​

ILeaf.transformWorld

Defined in ​

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


moveWorld ​

â–¸ moveWorld(x, y?, transition?): void

Parameters ​

NameType
xnumber | IPointData
y?number
transition?ITransition

Returns ​

void

Implementation of ​

ILeaf.moveWorld

Defined in ​

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


scaleOfWorld ​

â–¸ scaleOfWorld(worldOrigin, scaleX, scaleY?, resize?, transition?): void

Parameters ​

NameType
worldOriginIPointData
scaleXnumber
scaleY?ITransition
resize?boolean
transition?ITransition

Returns ​

void

Implementation of ​

ILeaf.scaleOfWorld

Defined in ​

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


rotateOfWorld ​

â–¸ rotateOfWorld(worldOrigin, rotation): void

Parameters ​

NameType
worldOriginIPointData
rotationnumber

Returns ​

void

Implementation of ​

ILeaf.rotateOfWorld

Defined in ​

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


skewOfWorld ​

â–¸ skewOfWorld(worldOrigin, skewX, skewY?, resize?, transition?): void

Parameters ​

NameType
worldOriginIPointData
skewXnumber
skewY?number
resize?boolean
transition?ITransition

Returns ​

void

Implementation of ​

ILeaf.skewOfWorld

Defined in ​

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


flip ​

â–¸ flip(axis, transition?): void

Parameters ​

NameType
axisIAxis
transition?ITransition

Returns ​

void

Implementation of ​

ILeaf.flip

Defined in ​

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


scaleResize ​

â–¸ scaleResize(scaleX, scaleY?, _noResize?): void

Parameters ​

NameTypeDefault value
scaleXnumberundefined
scaleYnumberscaleX
_noResize?booleanundefined

Returns ​

void

Implementation of ​

ILeaf.scaleResize

Defined in ​

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


__scaleResize ​

â–¸ __scaleResize(_scaleX, _scaleY): void

Parameters ​

NameType
_scaleXnumber
_scaleYnumber

Returns ​

void

Implementation of ​

ILeaf.__scaleResize

Defined in ​

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


resizeWidth ​

â–¸ resizeWidth(_width): void

Parameters ​

NameType
_widthnumber

Returns ​

void

Implementation of ​

ILeaf.resizeWidth

Defined in ​

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


resizeHeight ​

â–¸ resizeHeight(_height): void

Parameters ​

NameType
_heightnumber

Returns ​

void

Implementation of ​

ILeaf.resizeHeight

Defined in ​

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


hit ​

â–¸ hit(_world, _hitRadius?): boolean

Parameters ​

NameType
_worldIPointData
_hitRadius?number

Returns ​

boolean

Implementation of ​

ILeaf.hit

Defined in ​

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


__hitWorld ​

â–¸ __hitWorld(_point, _forceHitFill?): boolean

Parameters ​

NameType
_pointIRadiusPointData
_forceHitFill?boolean

Returns ​

boolean

Implementation of ​

ILeaf.__hitWorld

Defined in ​

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


__hit ​

â–¸ __hit(_local, _forceHitFill?): boolean

Parameters ​

NameType
_localIRadiusPointData
_forceHitFill?boolean

Returns ​

boolean

Implementation of ​

ILeaf.__hit

Defined in ​

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


__hitFill ​

â–¸ __hitFill(_inner): boolean

Parameters ​

NameType
_innerIRadiusPointData

Returns ​

boolean

Implementation of ​

ILeaf.__hitFill

Defined in ​

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


__hitStroke ​

â–¸ __hitStroke(_inner, _strokeWidth): boolean

Parameters ​

NameType
_innerIRadiusPointData
_strokeWidthnumber

Returns ​

boolean

Implementation of ​

ILeaf.__hitStroke

Defined in ​

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


__hitPixel ​

â–¸ __hitPixel(_inner): boolean

Parameters ​

NameType
_innerIRadiusPointData

Returns ​

boolean

Implementation of ​

ILeaf.__hitPixel

Defined in ​

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


__drawHitPath ​

â–¸ __drawHitPath(_canvas): void

Parameters ​

NameType
_canvasILeaferCanvas

Returns ​

void

Implementation of ​

ILeaf.__drawHitPath

Defined in ​

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


__updateHitCanvas ​

â–¸ __updateHitCanvas(): void

Returns ​

void

Implementation of ​

ILeaf.__updateHitCanvas

Defined in ​

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


__render ​

â–¸ __render(_canvas, _options): void

Parameters ​

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns ​

void

Implementation of ​

ILeaf.__render

Defined in ​

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


__drawFast ​

â–¸ __drawFast(_canvas, _options): void

Parameters ​

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns ​

void

Implementation of ​

ILeaf.__drawFast

Defined in ​

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


__draw ​

â–¸ __draw(_canvas, _options, _originCanvas?): void

Parameters ​

NameType
_canvasILeaferCanvas
_optionsIRenderOptions
_originCanvas?ILeaferCanvas

Returns ​

void

Implementation of ​

ILeaf.__draw

Defined in ​

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


__clip ​

â–¸ __clip(_canvas, _options): void

Parameters ​

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns ​

void

Implementation of ​

ILeaf.__clip

Defined in ​

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


__renderShape ​

â–¸ __renderShape(_canvas, _options): void

Parameters ​

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns ​

void

Implementation of ​

ILeaf.__renderShape

Defined in ​

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


__drawShape ​

â–¸ __drawShape(_canvas, _options): void

Parameters ​

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns ​

void

Implementation of ​

ILeaf.__drawShape

Defined in ​

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


__updateWorldOpacity ​

â–¸ __updateWorldOpacity(): void

Returns ​

void

Implementation of ​

ILeaf.__updateWorldOpacity

Defined in ​

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


__updateChange ​

â–¸ __updateChange(): void

Returns ​

void

Implementation of ​

ILeaf.__updateChange

Defined in ​

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


__drawPath ​

â–¸ __drawPath(_canvas): void

Parameters ​

NameType
_canvasILeaferCanvas

Returns ​

void

Implementation of ​

ILeaf.__drawPath

Defined in ​

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


__drawRenderPath ​

â–¸ __drawRenderPath(_canvas): void

Parameters ​

NameType
_canvasILeaferCanvas

Returns ​

void

Implementation of ​

ILeaf.__drawRenderPath

Defined in ​

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


__updatePath ​

â–¸ __updatePath(): void

Returns ​

void

Implementation of ​

ILeaf.__updatePath

Defined in ​

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


__updateRenderPath ​

â–¸ __updateRenderPath(_updateCache?): void

Parameters ​

NameType
_updateCache?boolean

Returns ​

void

Implementation of ​

ILeaf.__updateRenderPath

Defined in ​

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


getMotionPathData ​

â–¸ getMotionPathData(): IMotionPathData

Returns ​

IMotionPathData

Implementation of ​

ILeaf.getMotionPathData

Defined in ​

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


getMotionPoint ​

â–¸ getMotionPoint(_motionDistance): IRotationPointData

Parameters ​

NameType
_motionDistancenumber | IUnitData

Returns ​

IRotationPointData

Implementation of ​

ILeaf.getMotionPoint

Defined in ​

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


getMotionTotal ​

â–¸ getMotionTotal(): number

Returns ​

number

Implementation of ​

ILeaf.getMotionTotal

Defined in ​

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


__updateMotionPath ​

â–¸ __updateMotionPath(): void

Returns ​

void

Implementation of ​

ILeaf.__updateMotionPath

Defined in ​

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


__runAnimation ​

â–¸ __runAnimation(_type, _complete?): void

Parameters ​

NameType
_type"in" | "out"
_complete?IFunction

Returns ​

void

Implementation of ​

ILeaf.__runAnimation

Defined in ​

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


__updateSortChildren ​

â–¸ __updateSortChildren(): void

Returns ​

void

Implementation of ​

ILeaf.__updateSortChildren

Defined in ​

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


add ​

â–¸ add(_child, _index?): void

Parameters ​

NameType
_childILeaf | ILeaf[] | ILeafInputData | ILeafInputData[]
_index?number

Returns ​

void

Implementation of ​

ILeaf.add

Defined in ​

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


remove ​

â–¸ remove(_child?, destroy?): void

Parameters ​

NameType
_child?string | number | ILeaf | IFindMethod
destroy?boolean

Returns ​

void

Implementation of ​

ILeaf.remove

Defined in ​

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


dropTo ​

â–¸ dropTo(parent, index?, resize?): void

Parameters ​

NameType
parentILeaf
index?number
resize?boolean

Returns ​

void

Implementation of ​

ILeaf.dropTo

Defined in ​

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


on ​

â–¸ on(_type, _listener?, _options?): void

Parameters ​

NameType
_typestring | string[] | IEventParamsMap | IEventParams[]
_listener?IFunction
_options?IEventOption

Returns ​

void

Implementation of ​

ILeaf.on

Defined in ​

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


off ​

â–¸ off(_type?, _listener?, _options?): void

Parameters ​

NameType
_type?string | string[]
_listener?IFunction
_options?IEventOption

Returns ​

void

Implementation of ​

ILeaf.off

Defined in ​

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


on_ ​

â–¸ on_(_type, _listener?, _bind?, _options?): IEventListenerId

Parameters ​

NameType
_typestring | string[] | IEventParams[]
_listener?IFunction
_bind?IObject
_options?IEventOption

Returns ​

IEventListenerId

Implementation of ​

ILeaf.on_

Defined in ​

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


off_ ​

â–¸ off_(_id): void

Parameters ​

NameType
_idIEventListenerId | IEventListenerId[]

Returns ​

void

Implementation of ​

ILeaf.off_

Defined in ​

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


once ​

â–¸ once(_type, _listener?, _captureOrBind?, _capture?): void

Parameters ​

NameType
_typestring | string[] | IEventParams[]
_listener?IFunction
_captureOrBind?boolean | IObject
_capture?boolean

Returns ​

void

Implementation of ​

ILeaf.once

Defined in ​

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


emit ​

â–¸ emit(_type, _event?, _capture?): void

Parameters ​

NameType
_typestring
_event?IObject | IEvent
_capture?boolean

Returns ​

void

Implementation of ​

ILeaf.emit

Defined in ​

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


emitEvent ​

â–¸ emitEvent(_event?, _capture?): void

Parameters ​

NameType
_event?IEvent
_capture?boolean

Returns ​

void

Implementation of ​

ILeaf.emitEvent

Defined in ​

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


hasEvent ​

â–¸ hasEvent(_type, _capture?): boolean

Parameters ​

NameType
_typestring
_capture?boolean

Returns ​

boolean

Implementation of ​

ILeaf.hasEvent

Defined in ​

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


changeAttr ​

â–¸ changeAttr(attrName, defaultValue, fn?): void

Parameters ​

NameType
attrNamestring
defaultValueIValueFunction | IValue
fn?IAttrDecorator

Returns ​

void

Defined in ​

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


addAttr ​

â–¸ addAttr(attrName, defaultValue, fn?, helpValue?): void

Parameters ​

NameType
attrNamestring
defaultValueIValueFunction | IValue
fn?IAttrDecorator
helpValue?IValue

Returns ​

void

Defined in ​

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


__emitLifeEvent ​

â–¸ __emitLifeEvent(type): void

Parameters ​

NameType
typestring

Returns ​

void

Implementation of ​

ILeaf.__emitLifeEvent

Defined in ​

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


destroy ​

â–¸ destroy(): void

Returns ​

void

Implementation of ​

ILeaf.destroy

Defined in ​

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

Released under the MIT License.