Skip to content

Class: UI

Hierarchy

Implements

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new UI(data?)

Parameters

NameType
data?IUIInputData

Overrides

Leaf.constructor

Defined in

ui/packages/display/src/UI.ts:293

Properties

innerId

Readonly innerId: number

Implementation of

IUI.innerId

Inherited from

Leaf.innerId

Defined in

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


__layout

__layout: ILeafLayout

Implementation of

IUI.__layout

Inherited from

Leaf.__layout

Defined in

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


__world

__world: IMatrixWithBoundsScaleData

Implementation of

IUI.__world

Inherited from

Leaf.__world

Defined in

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


__local

Optional __local: IMatrixWithBoundsData

Implementation of

IUI.__local

Inherited from

Leaf.__local

Defined in

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


__nowWorld

Optional __nowWorld: IMatrixWithBoundsScaleData

Implementation of

IUI.__nowWorld

Inherited from

Leaf.__nowWorld

Defined in

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


__cameraWorld

Optional __cameraWorld: IMatrixWithBoundsScaleData

Implementation of

IUI.__cameraWorld

Inherited from

Leaf.__cameraWorld

Defined in

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


__worldOpacity

__worldOpacity: number

Implementation of

IUI.__worldOpacity

Inherited from

Leaf.__worldOpacity

Defined in

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


__level

__level: number

Implementation of

IUI.__level

Inherited from

Leaf.__level

Defined in

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


__tempNumber

__tempNumber: number

Implementation of

IUI.__tempNumber

Inherited from

Leaf.__tempNumber

Defined in

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


__hasAutoLayout

Optional __hasAutoLayout: boolean

Implementation of

IUI.__hasAutoLayout

Inherited from

Leaf.__hasAutoLayout

Defined in

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


__hasMask

Optional __hasMask: boolean

Implementation of

IUI.__hasMask

Inherited from

Leaf.__hasMask

Defined in

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


__hasEraser

Optional __hasEraser: boolean

Implementation of

IUI.__hasEraser

Inherited from

Leaf.__hasEraser

Defined in

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


__hitCanvas

Optional __hitCanvas: IHitCanvas

Implementation of

IUI.__hitCanvas

Inherited from

Leaf.__hitCanvas

Defined in

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


__captureMap

Optional __captureMap: IEventListenerMap

Implementation of

IUI.__captureMap

Inherited from

Leaf.__captureMap

Defined in

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


__bubbleMap

Optional __bubbleMap: IEventListenerMap

Implementation of

IUI.__bubbleMap

Inherited from

Leaf.__bubbleMap

Defined in

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


__parentWait

Optional __parentWait: IFunction[]

Implementation of

IUI.__parentWait

Inherited from

Leaf.__parentWait

Defined in

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


__leaferWait

Optional __leaferWait: IFunction[]

Implementation of

IUI.__leaferWait

Inherited from

Leaf.__leaferWait

Defined in

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


noBounds

Optional noBounds: boolean

Implementation of

IUI.noBounds

Inherited from

Leaf.noBounds

Defined in

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


destroyed

destroyed: boolean

Implementation of

IUI.destroyed

Inherited from

Leaf.destroyed

Defined in

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


__

__: IUIData

Implementation of

IUI.__

Overrides

Leaf.__

Defined in

ui/packages/display/src/UI.ts:19


proxyData

proxyData: IUIInputData

Implementation of

IUI.proxyData

Defined in

ui/packages/display/src/UI.ts:21


__proxyData

Optional __proxyData: IUIInputData

Implementation of

IUI.__proxyData

Defined in

ui/packages/display/src/UI.ts:22


leafer

Optional leafer: ILeafer

Implementation of

IUI.leafer

Overrides

Leaf.leafer

Defined in

ui/packages/display/src/UI.ts:26


parent

Optional parent: IGroup

Implementation of

IUI.parent

Overrides

Leaf.parent

Defined in

ui/packages/display/src/UI.ts:27


zoomLayer

zoomLayer: IGroup

Implementation of

IUI.zoomLayer

Defined in

ui/packages/display/src/UI.ts:30


children

Optional children: IUI[]

Implementation of

IUI.children

Overrides

Leaf.children

Defined in

ui/packages/display/src/UI.ts:34


id

id: string

Implementation of

IUI.id

Defined in

ui/packages/display/src/UI.ts:40


name

name: string

Implementation of

IUI.name

Defined in

ui/packages/display/src/UI.ts:43


className

className: string

Implementation of

IUI.className

Defined in

ui/packages/display/src/UI.ts:46


blendMode

blendMode: IBlendMode

Implementation of

IUI.blendMode

Defined in

ui/packages/display/src/UI.ts:51


opacity

opacity: number

Implementation of

IUI.opacity

Defined in

ui/packages/display/src/UI.ts:54


visible

visible: boolean

Implementation of

IUI.visible

Defined in

ui/packages/display/src/UI.ts:57


selected

selected: boolean

Implementation of

IUI.selected

Defined in

ui/packages/display/src/UI.ts:61


disabled

disabled: boolean

Implementation of

IUI.disabled

Defined in

ui/packages/display/src/UI.ts:64


locked

locked: boolean

Implementation of

IUI.locked

Defined in

ui/packages/display/src/UI.ts:67


zIndex

zIndex: number

Implementation of

IUI.zIndex

Defined in

ui/packages/display/src/UI.ts:71


mask

mask: boolean

Implementation of

IUI.mask

Defined in

ui/packages/display/src/UI.ts:75


maskType

maskType: IMaskType

Implementation of

IUI.maskType

Defined in

ui/packages/display/src/UI.ts:78


eraser

eraser: boolean

Implementation of

IUI.eraser

Defined in

ui/packages/display/src/UI.ts:81


x

x: number

Implementation of

IUI.x

Defined in

ui/packages/display/src/UI.ts:86


y

y: number

Implementation of

IUI.y

Defined in

ui/packages/display/src/UI.ts:89


width

width: number

Implementation of

IUI.width

Defined in

ui/packages/display/src/UI.ts:93


height

height: number

Implementation of

IUI.height

Defined in

ui/packages/display/src/UI.ts:96


scaleX

scaleX: number

Implementation of

IUI.scaleX

Defined in

ui/packages/display/src/UI.ts:100


scaleY

scaleY: number

Implementation of

IUI.scaleY

Defined in

ui/packages/display/src/UI.ts:103


rotation

rotation: number

Implementation of

IUI.rotation

Defined in

ui/packages/display/src/UI.ts:107


skewX

skewX: number

Implementation of

IUI.skewX

Defined in

ui/packages/display/src/UI.ts:111


skewY

skewY: number

Implementation of

IUI.skewY

Defined in

ui/packages/display/src/UI.ts:114


around

around: IAround

Implementation of

IUI.around

Defined in

ui/packages/display/src/UI.ts:118


draggable

draggable: boolean

Implementation of

IUI.draggable

Defined in

ui/packages/display/src/UI.ts:122


editable

editable: boolean

Implementation of

IUI.editable

Defined in

ui/packages/display/src/UI.ts:126


editSize

Optional editSize: IEditSize

Implementation of

IUI.editSize

Defined in

ui/packages/display/src/UI.ts:129


editorStyle

editorStyle: IEditorConfig

Implementation of

IUI.editorStyle

Defined in

ui/packages/display/src/UI.ts:132


hittable

hittable: boolean

Implementation of

IUI.hittable

Defined in

ui/packages/display/src/UI.ts:137


hitFill

hitFill: IHitType

Implementation of

IUI.hitFill

Defined in

ui/packages/display/src/UI.ts:140


hitStroke

hitStroke: IHitType

Implementation of

IUI.hitStroke

Defined in

ui/packages/display/src/UI.ts:143


hitBox

hitBox: boolean

Implementation of

IUI.hitBox

Defined in

ui/packages/display/src/UI.ts:146


hitChildren

hitChildren: boolean

Implementation of

IUI.hitChildren

Defined in

ui/packages/display/src/UI.ts:149


hitSelf

hitSelf: boolean

Implementation of

IUI.hitSelf

Defined in

ui/packages/display/src/UI.ts:152


hitRadius

hitRadius: number

Implementation of

IUI.hitRadius

Defined in

ui/packages/display/src/UI.ts:155


cursor

cursor: ICursorType | ICursorType[]

Implementation of

IUI.cursor

Defined in

ui/packages/display/src/UI.ts:158


fill

fill: IFill

Implementation of

IUI.fill

Defined in

ui/packages/display/src/UI.ts:166


stroke

stroke: IStroke

Implementation of

IUI.stroke

Defined in

ui/packages/display/src/UI.ts:171


strokeAlign

strokeAlign: IStrokeAlign

Implementation of

IUI.strokeAlign

Defined in

ui/packages/display/src/UI.ts:174


strokeWidth

strokeWidth: string | number | number[]

Implementation of

IUI.strokeWidth

Defined in

ui/packages/display/src/UI.ts:177


strokeWidthFixed

strokeWidthFixed: boolean

Implementation of

IUI.strokeWidthFixed

Defined in

ui/packages/display/src/UI.ts:180


strokeCap

strokeCap: IStrokeCap

Implementation of

IUI.strokeCap

Defined in

ui/packages/display/src/UI.ts:183


strokeJoin

strokeJoin: IStrokeJoin

Implementation of

IUI.strokeJoin

Defined in

ui/packages/display/src/UI.ts:186


dashPattern

dashPattern: string | number[]

Implementation of

IUI.dashPattern

Defined in

ui/packages/display/src/UI.ts:189


dashOffset

dashOffset: number

Implementation of

IUI.dashOffset

Defined in

ui/packages/display/src/UI.ts:192


miterLimit

miterLimit: number

Implementation of

IUI.miterLimit

Defined in

ui/packages/display/src/UI.ts:195


lazy

lazy: boolean

Implementation of

IUI.lazy

Defined in

ui/packages/display/src/UI.ts:200


pixelRatio

pixelRatio: number

Implementation of

IUI.pixelRatio

Defined in

ui/packages/display/src/UI.ts:203


path

path: string | IPathCommandData

Implementation of

IUI.path

Defined in

ui/packages/display/src/UI.ts:208


windingRule

windingRule: IWindingRule

Implementation of

IUI.windingRule

Defined in

ui/packages/display/src/UI.ts:211


closed

closed: boolean

Implementation of

IUI.closed

Defined in

ui/packages/display/src/UI.ts:214


startArrow

startArrow: IArrowType

Implementation of

IUI.startArrow

Defined in

ui/packages/display/src/UI.ts:220


endArrow

endArrow: IArrowType

Implementation of

IUI.endArrow

Defined in

ui/packages/display/src/UI.ts:223


cornerRadius

cornerRadius: string | number | number[]

Implementation of

IUI.cornerRadius

Defined in

ui/packages/display/src/UI.ts:228


cornerSmoothing

cornerSmoothing: number

Implementation of

IUI.cornerSmoothing

Defined in

ui/packages/display/src/UI.ts:231


shadow

shadow: string | IShadowEffect | IShadowEffect[]

Implementation of

IUI.shadow

Defined in

ui/packages/display/src/UI.ts:236


innerShadow

innerShadow: string | IShadowEffect | IShadowEffect[]

Implementation of

IUI.innerShadow

Defined in

ui/packages/display/src/UI.ts:239


blur

blur: number | IBlurEffect

Implementation of

IUI.blur

Defined in

ui/packages/display/src/UI.ts:242


backgroundBlur

backgroundBlur: number | IBlurEffect

Implementation of

IUI.backgroundBlur

Defined in

ui/packages/display/src/UI.ts:245


grayscale

grayscale: number | IGrayscaleEffect

Implementation of

IUI.grayscale

Defined in

ui/packages/display/src/UI.ts:248


normalStyle

normalStyle: IUIInputData

Implementation of

IUI.normalStyle

Defined in

ui/packages/display/src/UI.ts:254


hoverStyle

hoverStyle: IUIInputData

Implementation of

IUI.hoverStyle

Defined in

ui/packages/display/src/UI.ts:257


pressStyle

pressStyle: IUIInputData

Implementation of

IUI.pressStyle

Defined in

ui/packages/display/src/UI.ts:260


focusStyle

focusStyle: IUIInputData

Implementation of

IUI.focusStyle

Defined in

ui/packages/display/src/UI.ts:263


selectedStyle

selectedStyle: IUIInputData

Implementation of

IUI.selectedStyle

Defined in

ui/packages/display/src/UI.ts:266


disabledStyle

disabledStyle: IUIInputData

Implementation of

IUI.disabledStyle

Defined in

ui/packages/display/src/UI.ts:269

Accessors

tag

get tag(): string

Returns

string

Implementation of

IUI.tag

Inherited from

Leaf.tag

Defined in

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

set tag(_value): void

Parameters

NameType
_valuestring

Returns

void

Implementation of

IUI.tag

Inherited from

Leaf.tag

Defined in

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


__tag

get __tag(): string

Returns

string

Implementation of

IUI.__tag

Inherited from

Leaf.__tag

Defined in

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


innerName

get innerName(): string

Returns

string

Implementation of

IUI.innerName

Inherited from

Leaf.innerName

Defined in

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


__DataProcessor

get __DataProcessor(): typeof LeafData

Returns

typeof LeafData

Implementation of

IUI.__DataProcessor

Inherited from

Leaf.__DataProcessor

Defined in

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


__LayoutProcessor

get __LayoutProcessor(): typeof LeafLayout

Returns

typeof LeafLayout

Implementation of

IUI.__LayoutProcessor

Inherited from

Leaf.__LayoutProcessor

Defined in

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


isLeafer

get isLeafer(): boolean

Returns

boolean

Implementation of

IUI.isLeafer

Inherited from

Leaf.isLeafer

Defined in

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


isBranch

get isBranch(): boolean

Returns

boolean

Implementation of

IUI.isBranch

Inherited from

Leaf.isBranch

Defined in

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


isBranchLeaf

get isBranchLeaf(): boolean

Returns

boolean

Implementation of

IUI.isBranchLeaf

Inherited from

Leaf.isBranchLeaf

Defined in

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


__localMatrix

get __localMatrix(): IMatrixData

Returns

IMatrixData

Implementation of

IUI.__localMatrix

Inherited from

Leaf.__localMatrix

Defined in

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


__localBoxBounds

get __localBoxBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IUI.__localBoxBounds

Inherited from

Leaf.__localBoxBounds

Defined in

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


worldTransform

get worldTransform(): IMatrixWithScaleData

Returns

IMatrixWithScaleData

Implementation of

IUI.worldTransform

Inherited from

Leaf.worldTransform

Defined in

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


localTransform

get localTransform(): IMatrixData

Returns

IMatrixData

Implementation of

IUI.localTransform

Inherited from

Leaf.localTransform

Defined in

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


boxBounds

get boxBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IUI.boxBounds

Inherited from

Leaf.boxBounds

Defined in

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


renderBounds

get renderBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IUI.renderBounds

Inherited from

Leaf.renderBounds

Defined in

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


worldBoxBounds

get worldBoxBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IUI.worldBoxBounds

Inherited from

Leaf.worldBoxBounds

Defined in

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


worldStrokeBounds

get worldStrokeBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IUI.worldStrokeBounds

Inherited from

Leaf.worldStrokeBounds

Defined in

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


worldRenderBounds

get worldRenderBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IUI.worldRenderBounds

Inherited from

Leaf.worldRenderBounds

Defined in

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


worldOpacity

get worldOpacity(): number

Returns

number

Implementation of

IUI.worldOpacity

Inherited from

Leaf.worldOpacity

Defined in

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


__worldFlipped

get __worldFlipped(): boolean

Returns

boolean

Implementation of

IUI.__worldFlipped

Inherited from

Leaf.__worldFlipped

Defined in

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


__onlyHitMask

get __onlyHitMask(): boolean

Returns

boolean

Implementation of

IUI.__onlyHitMask

Inherited from

Leaf.__onlyHitMask

Defined in

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


__ignoreHitWorld

get __ignoreHitWorld(): boolean

Returns

boolean

Implementation of

IUI.__ignoreHitWorld

Inherited from

Leaf.__ignoreHitWorld

Defined in

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


pathInputed

get pathInputed(): boolean

Returns

boolean

Implementation of

IUI.pathInputed

Inherited from

Leaf.pathInputed

Defined in

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


app

get app(): ILeafer

Returns

ILeafer

Implementation of

IUI.app

Defined in

ui/packages/display/src/UI.ts:24


isFrame

get isFrame(): boolean

Returns

boolean

Implementation of

IUI.isFrame

Defined in

ui/packages/display/src/UI.ts:32


scale

get scale(): number | IPointData

Returns

number | IPointData

Implementation of

IUI.scale

Defined in

ui/packages/display/src/UI.ts:281

set scale(value): void

Parameters

NameType
valuenumber | IPointData

Returns

void

Implementation of

IUI.scale

Defined in

ui/packages/display/src/UI.ts:272


pen

get pen(): IPathCreator

Returns

IPathCreator

Defined in

ui/packages/display/src/UI.ts:287

Methods

resetCustom

resetCustom(): void

Returns

void

Implementation of

IUI.resetCustom

Inherited from

Leaf.resetCustom

Defined in

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


waitParent

waitParent(item, bind?): void

Parameters

NameType
itemIFunction
bind?IObject

Returns

void

Implementation of

IUI.waitParent

Inherited from

Leaf.waitParent

Defined in

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


waitLeafer

waitLeafer(item, bind?): void

Parameters

NameType
itemIFunction
bind?IObject

Returns

void

Implementation of

IUI.waitLeafer

Inherited from

Leaf.waitLeafer

Defined in

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


nextRender

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

Parameters

NameType
itemIFunction
bind?IObject
off?"off"

Returns

void

Implementation of

IUI.nextRender

Inherited from

Leaf.nextRender

Defined in

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


removeNextRender

removeNextRender(item): void

Parameters

NameType
itemIFunction

Returns

void

Implementation of

IUI.removeNextRender

Inherited from

Leaf.removeNextRender

Defined in

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


__bindLeafer

__bindLeafer(leafer): void

Parameters

NameType
leaferILeaferBase

Returns

void

Implementation of

IUI.__bindLeafer

Inherited from

Leaf.__bindLeafer

Defined in

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


toJSON

toJSON(): IObject

Returns

IObject

Implementation of

IUI.toJSON

Inherited from

Leaf.toJSON

Defined in

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


toString

toString(): string

Returns

string

Implementation of

IUI.toString

Inherited from

Leaf.toString

Defined in

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


__setAttr

__setAttr(_attrName, _newValue): boolean

Parameters

NameType
_attrNamestring
_newValueIValue

Returns

boolean

Implementation of

IUI.__setAttr

Inherited from

Leaf.__setAttr

Defined in

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


__getAttr

__getAttr(_attrName): IValue

Parameters

NameType
_attrNamestring

Returns

IValue

Implementation of

IUI.__getAttr

Inherited from

Leaf.__getAttr

Defined in

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


setProxyAttr

setProxyAttr(_attrName, _newValue): void

Parameters

NameType
_attrNamestring
_newValueIValue

Returns

void

Implementation of

IUI.setProxyAttr

Inherited from

Leaf.setProxyAttr

Defined in

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


getProxyAttr

getProxyAttr(_attrName): IValue

Parameters

NameType
_attrNamestring

Returns

IValue

Implementation of

IUI.getProxyAttr

Inherited from

Leaf.getProxyAttr

Defined in

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


focus

focus(_value?): void

Parameters

NameType
_value?boolean

Returns

void

Implementation of

IUI.focus

Inherited from

Leaf.focus

Defined in

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


forceUpdate

forceUpdate(attrName?): void

Parameters

NameType
attrName?string

Returns

void

Implementation of

IUI.forceUpdate

Inherited from

Leaf.forceUpdate

Defined in

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


updateLayout

updateLayout(): void

Returns

void

Implementation of

IUI.updateLayout

Inherited from

Leaf.updateLayout

Defined in

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


__updateWorldMatrix

__updateWorldMatrix(): void

Returns

void

Implementation of

IUI.__updateWorldMatrix

Inherited from

Leaf.__updateWorldMatrix

Defined in

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


__updateLocalMatrix

__updateLocalMatrix(): void

Returns

void

Implementation of

IUI.__updateLocalMatrix

Inherited from

Leaf.__updateLocalMatrix

Defined in

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


__updateWorldBounds

__updateWorldBounds(): void

Returns

void

Implementation of

IUI.__updateWorldBounds

Inherited from

Leaf.__updateWorldBounds

Defined in

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


__updateLocalBounds

__updateLocalBounds(): void

Returns

void

Implementation of

IUI.__updateLocalBounds

Inherited from

Leaf.__updateLocalBounds

Defined in

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


__updateLocalBoxBounds

__updateLocalBoxBounds(): void

Returns

void

Implementation of

IUI.__updateLocalBoxBounds

Inherited from

Leaf.__updateLocalBoxBounds

Defined in

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


__updateLocalStrokeBounds

__updateLocalStrokeBounds(): void

Returns

void

Implementation of

IUI.__updateLocalStrokeBounds

Inherited from

Leaf.__updateLocalStrokeBounds

Defined in

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


__updateLocalRenderBounds

__updateLocalRenderBounds(): void

Returns

void

Implementation of

IUI.__updateLocalRenderBounds

Inherited from

Leaf.__updateLocalRenderBounds

Defined in

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


__updateBoxBounds

__updateBoxBounds(): void

Returns

void

Implementation of

IUI.__updateBoxBounds

Inherited from

Leaf.__updateBoxBounds

Defined in

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


__updateStrokeBounds

__updateStrokeBounds(): void

Returns

void

Implementation of

IUI.__updateStrokeBounds

Inherited from

Leaf.__updateStrokeBounds

Defined in

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


__updateRenderBounds

__updateRenderBounds(): void

Returns

void

Implementation of

IUI.__updateRenderBounds

Inherited from

Leaf.__updateRenderBounds

Defined in

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


__updateAutoLayout

__updateAutoLayout(): void

Returns

void

Implementation of

IUI.__updateAutoLayout

Inherited from

Leaf.__updateAutoLayout

Defined in

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


__updateNaturalSize

__updateNaturalSize(): void

Returns

void

Implementation of

IUI.__updateNaturalSize

Inherited from

Leaf.__updateNaturalSize

Defined in

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


__updateStrokeSpread

__updateStrokeSpread(): number

Returns

number

Implementation of

IUI.__updateStrokeSpread

Inherited from

Leaf.__updateStrokeSpread

Defined in

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


__updateRenderSpread

__updateRenderSpread(): number

Returns

number

Implementation of

IUI.__updateRenderSpread

Inherited from

Leaf.__updateRenderSpread

Defined in

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


__updateEraser

__updateEraser(value?): void

Parameters

NameType
value?boolean

Returns

void

Implementation of

IUI.__updateEraser

Inherited from

Leaf.__updateEraser

Defined in

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


__updateMask

__updateMask(value?): void

Parameters

NameType
value?boolean

Returns

void

Implementation of

IUI.__updateMask

Inherited from

Leaf.__updateMask

Defined in

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


__renderMask

__renderMask(_canvas, _options): void

Parameters

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns

void

Implementation of

IUI.__renderMask

Inherited from

Leaf.__renderMask

Defined in

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


__getNowWorld

__getNowWorld(options): IMatrixWithBoundsScaleData

Parameters

NameType
optionsIRenderOptions

Returns

IMatrixWithBoundsScaleData

Implementation of

IUI.__getNowWorld

Inherited from

Leaf.__getNowWorld

Defined in

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


getWorld

getWorld(attrName): number

Parameters

NameType
attrNameILayoutAttr

Returns

number

Implementation of

IUI.getWorld

Inherited from

Leaf.getWorld

Defined in

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


getTransform

getTransform(relative?): IMatrixData

Parameters

NameType
relative?ILeaf | ILocationType

Returns

IMatrixData

Implementation of

IUI.getTransform

Inherited from

Leaf.getTransform

Defined in

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


getBounds

getBounds(type?, relative?): IBoundsData

Parameters

NameType
type?IBoundsType
relative?ILeaf | ILocationType

Returns

IBoundsData

Implementation of

IUI.getBounds

Inherited from

Leaf.getBounds

Defined in

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


getLayoutBounds

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

Parameters

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

Returns

ILayoutBoundsData

Implementation of

IUI.getLayoutBounds

Inherited from

Leaf.getLayoutBounds

Defined in

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


getLayoutPoints

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

Parameters

NameType
type?IBoundsType
relative?ILeaf | ILocationType

Returns

IPointData[]

Inherited from

Leaf.getLayoutPoints

Defined in

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


getWorldBounds

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

Parameters

NameType
innerIBoundsData
relative?ILeaf
change?boolean

Returns

IBoundsData

Implementation of

IUI.getWorldBounds

Inherited from

Leaf.getWorldBounds

Defined in

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


worldToLocal

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

Parameters

NameType
worldIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns

void

Implementation of

IUI.worldToLocal

Inherited from

Leaf.worldToLocal

Defined in

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


localToWorld

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

Parameters

NameType
localIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns

void

Implementation of

IUI.localToWorld

Inherited from

Leaf.localToWorld

Defined in

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


worldToInner

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

Parameters

NameType
worldIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns

void

Implementation of

IUI.worldToInner

Inherited from

Leaf.worldToInner

Defined in

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


innerToWorld

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

Parameters

NameType
innerIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns

void

Implementation of

IUI.innerToWorld

Inherited from

Leaf.innerToWorld

Defined in

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


getInnerPoint

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

Parameters

NameType
worldIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IUI.getInnerPoint

Inherited from

Leaf.getInnerPoint

Defined in

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


getInnerPointByLocal

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

Parameters

NameType
localIPointData
_relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IUI.getInnerPointByLocal

Inherited from

Leaf.getInnerPointByLocal

Defined in

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


getLocalPoint

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

Parameters

NameType
worldIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IUI.getLocalPoint

Inherited from

Leaf.getLocalPoint

Defined in

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


getLocalPointByInner

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

Parameters

NameType
innerIPointData
_relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IUI.getLocalPointByInner

Inherited from

Leaf.getLocalPointByInner

Defined in

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


getWorldPoint

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

Parameters

NameType
innerIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IUI.getWorldPoint

Inherited from

Leaf.getWorldPoint

Defined in

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


getWorldPointByLocal

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

Parameters

NameType
localIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IUI.getWorldPointByLocal

Inherited from

Leaf.getWorldPointByLocal

Defined in

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


getPagePoint

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

Parameters

NameType
worldIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IUI.getPagePoint

Inherited from

Leaf.getPagePoint

Defined in

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


getWorldPointByPage

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

Parameters

NameType
pageIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IUI.getWorldPointByPage

Inherited from

Leaf.getWorldPointByPage

Defined in

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


setTransform

setTransform(matrix, resize?): void

Parameters

NameType
matrixIMatrixData
resize?boolean

Returns

void

Implementation of

IUI.setTransform

Inherited from

Leaf.setTransform

Defined in

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


transform

transform(matrix, resize?): void

Parameters

NameType
matrixIMatrixData
resize?boolean

Returns

void

Implementation of

IUI.transform

Inherited from

Leaf.transform

Defined in

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


move

move(x, y?): void

Parameters

NameType
xnumber
y?number

Returns

void

Implementation of

IUI.move

Inherited from

Leaf.move

Defined in

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


scaleOf

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

Parameters

NameType
originIPointData
scaleXnumber
scaleY?number
resize?boolean

Returns

void

Implementation of

IUI.scaleOf

Inherited from

Leaf.scaleOf

Defined in

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


rotateOf

rotateOf(origin, rotation): void

Parameters

NameType
originIPointData
rotationnumber

Returns

void

Implementation of

IUI.rotateOf

Inherited from

Leaf.rotateOf

Defined in

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


skewOf

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

Parameters

NameType
originIPointData
skewXnumber
skewY?number
resize?boolean

Returns

void

Implementation of

IUI.skewOf

Inherited from

Leaf.skewOf

Defined in

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


transformWorld

transformWorld(worldTransform?, resize?): void

Parameters

NameType
worldTransform?IMatrixData
resize?boolean

Returns

void

Implementation of

IUI.transformWorld

Inherited from

Leaf.transformWorld

Defined in

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


moveWorld

moveWorld(x, y?): void

Parameters

NameType
xnumber
y?number

Returns

void

Implementation of

IUI.moveWorld

Inherited from

Leaf.moveWorld

Defined in

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


scaleOfWorld

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

Parameters

NameType
worldOriginIPointData
scaleXnumber
scaleY?number
resize?boolean

Returns

void

Implementation of

IUI.scaleOfWorld

Inherited from

Leaf.scaleOfWorld

Defined in

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


rotateOfWorld

rotateOfWorld(worldOrigin, rotation): void

Parameters

NameType
worldOriginIPointData
rotationnumber

Returns

void

Implementation of

IUI.rotateOfWorld

Inherited from

Leaf.rotateOfWorld

Defined in

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


skewOfWorld

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

Parameters

NameType
worldOriginIPointData
skewXnumber
skewY?number
resize?boolean

Returns

void

Implementation of

IUI.skewOfWorld

Inherited from

Leaf.skewOfWorld

Defined in

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


scaleResize

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

Parameters

NameTypeDefault value
scaleXnumberundefined
scaleYnumberscaleX
_noResize?booleanundefined

Returns

void

Implementation of

IUI.scaleResize

Inherited from

Leaf.scaleResize

Defined in

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


__scaleResize

__scaleResize(_scaleX, _scaleY): void

Parameters

NameType
_scaleXnumber
_scaleYnumber

Returns

void

Implementation of

IUI.__scaleResize

Inherited from

Leaf.__scaleResize

Defined in

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


__hitWorld

__hitWorld(_point): boolean

Parameters

NameType
_pointIRadiusPointData

Returns

boolean

Implementation of

IUI.__hitWorld

Inherited from

Leaf.__hitWorld

Defined in

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


__hit

__hit(_local): boolean

Parameters

NameType
_localIRadiusPointData

Returns

boolean

Implementation of

IUI.__hit

Inherited from

Leaf.__hit

Defined in

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


__hitFill

__hitFill(_inner): boolean

Parameters

NameType
_innerIRadiusPointData

Returns

boolean

Implementation of

IUI.__hitFill

Inherited from

Leaf.__hitFill

Defined in

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


__hitStroke

__hitStroke(_inner, _strokeWidth): boolean

Parameters

NameType
_innerIRadiusPointData
_strokeWidthnumber

Returns

boolean

Implementation of

IUI.__hitStroke

Inherited from

Leaf.__hitStroke

Defined in

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


__hitPixel

__hitPixel(_inner): boolean

Parameters

NameType
_innerIRadiusPointData

Returns

boolean

Implementation of

IUI.__hitPixel

Inherited from

Leaf.__hitPixel

Defined in

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


__drawHitPath

__drawHitPath(_canvas): void

Parameters

NameType
_canvasILeaferCanvas

Returns

void

Implementation of

IUI.__drawHitPath

Inherited from

Leaf.__drawHitPath

Defined in

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


__updateHitCanvas

__updateHitCanvas(): void

Returns

void

Implementation of

IUI.__updateHitCanvas

Inherited from

Leaf.__updateHitCanvas

Defined in

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


__render

__render(_canvas, _options): void

Parameters

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns

void

Implementation of

IUI.__render

Inherited from

Leaf.__render

Defined in

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


__drawFast

__drawFast(_canvas, _options): void

Parameters

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns

void

Implementation of

IUI.__drawFast

Inherited from

Leaf.__drawFast

Defined in

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


__draw

__draw(_canvas, _options): void

Parameters

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns

void

Implementation of

IUI.__draw

Inherited from

Leaf.__draw

Defined in

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


__clip

__clip(_canvas, _options): void

Parameters

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns

void

Implementation of

IUI.__clip

Inherited from

Leaf.__clip

Defined in

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


__renderShape

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

Parameters

NameType
_canvasILeaferCanvas
_optionsIRenderOptions
_ignoreFill?boolean
_ignoreStroke?boolean

Returns

void

Implementation of

IUI.__renderShape

Inherited from

Leaf.__renderShape

Defined in

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


__updateWorldOpacity

__updateWorldOpacity(): void

Returns

void

Implementation of

IUI.__updateWorldOpacity

Inherited from

Leaf.__updateWorldOpacity

Defined in

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


__updateChange

__updateChange(): void

Returns

void

Implementation of

IUI.__updateChange

Inherited from

Leaf.__updateChange

Defined in

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


__updatePath

__updatePath(): void

Returns

void

Implementation of

IUI.__updatePath

Inherited from

Leaf.__updatePath

Defined in

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


__updateSortChildren

__updateSortChildren(): void

Returns

void

Implementation of

IUI.__updateSortChildren

Inherited from

Leaf.__updateSortChildren

Defined in

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


add

add(_child, _index?): void

Parameters

NameType
_childILeaf
_index?number

Returns

void

Implementation of

IUI.add

Inherited from

Leaf.add

Defined in

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


remove

remove(_child?, destroy?): void

Parameters

NameType
_child?ILeaf
destroy?boolean

Returns

void

Implementation of

IUI.remove

Inherited from

Leaf.remove

Defined in

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


dropTo

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

Parameters

NameType
parentILeaf
index?number
resize?boolean

Returns

void

Implementation of

IUI.dropTo

Inherited from

Leaf.dropTo

Defined in

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


on

on(_type, _listener, _options?): void

Parameters

NameType
_typestring | string[]
_listenerIFunction
_options?boolean | IEventListenerOptions

Returns

void

Implementation of

IUI.on

Inherited from

Leaf.on

Defined in

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


off

off(_type, _listener, _options?): void

Parameters

NameType
_typestring | string[]
_listenerIFunction
_options?boolean | IEventListenerOptions

Returns

void

Implementation of

IUI.off

Inherited from

Leaf.off

Defined in

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


on_

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

Parameters

NameType
_typestring | string[]
_listenerIFunction
_bind?IObject
_options?boolean | IEventListenerOptions

Returns

IEventListenerId

Implementation of

IUI.on_

Inherited from

Leaf.on_

Defined in

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


off_

off_(_id): void

Parameters

NameType
_idIEventListenerId | IEventListenerId[]

Returns

void

Implementation of

IUI.off_

Inherited from

Leaf.off_

Defined in

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


once

once(_type, _listener, _capture?): void

Parameters

NameType
_typestring | string[]
_listenerIFunction
_capture?boolean

Returns

void

Implementation of

IUI.once

Inherited from

Leaf.once

Defined in

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


emit

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

Parameters

NameType
_typestring
_event?IObject | IEvent
_capture?boolean

Returns

void

Implementation of

IUI.emit

Inherited from

Leaf.emit

Defined in

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


emitEvent

emitEvent(_event?, _capture?): void

Parameters

NameType
_event?IEvent
_capture?boolean

Returns

void

Implementation of

IUI.emitEvent

Inherited from

Leaf.emitEvent

Defined in

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


hasEvent

hasEvent(_type, _capture?): boolean

Parameters

NameType
_typestring
_capture?boolean

Returns

boolean

Implementation of

IUI.hasEvent

Inherited from

Leaf.hasEvent

Defined in

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


changeAttr

Static changeAttr(attrName, defaultValue): void

Parameters

NameType
attrNamestring
defaultValueIValue

Returns

void

Inherited from

Leaf.changeAttr

Defined in

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


addAttr

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

Parameters

NameType
attrNamestring
defaultValueIValue
fn?IAttrDecorator

Returns

void

Inherited from

Leaf.addAttr

Defined in

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


reset

reset(_data?): void

Parameters

NameType
_data?IUIInputData

Returns

void

Implementation of

IUI.reset

Overrides

Leaf.reset

Defined in

ui/packages/display/src/UI.ts:301


set

set(data): void

Parameters

NameType
dataIUIInputData

Returns

void

Implementation of

IUI.set

Overrides

Leaf.set

Defined in

ui/packages/display/src/UI.ts:304


get

get(name?): IValue | IUIInputData

Parameters

NameType
name?string | string[] | IUIInputData

Returns

IValue | IUIInputData

Implementation of

IUI.get

Overrides

Leaf.get

Defined in

ui/packages/display/src/UI.ts:308


createProxyData

createProxyData(): IUIInputData

Returns

IUIInputData

Implementation of

IUI.createProxyData

Defined in

ui/packages/display/src/UI.ts:312


find

find(_condition, _options?): IUI[]

Parameters

NameType
_conditionstring | number | IFindUIMethod
_options?any

Returns

IUI[]

Implementation of

IUI.find

Overrides

Leaf.find

Defined in

ui/packages/display/src/UI.ts:317


findOne

findOne(_condition, _options?): IUI

Parameters

NameType
_conditionstring | number | IFindUIMethod
_options?any

Returns

IUI

Implementation of

IUI.findOne

Overrides

Leaf.findOne

Defined in

ui/packages/display/src/UI.ts:319


getPath

getPath(curve?, pathForRender?): IPathCommandData

Parameters

NameType
curve?boolean
pathForRender?boolean

Returns

IPathCommandData

Implementation of

IUI.getPath

Defined in

ui/packages/display/src/UI.ts:324


getPathString

getPathString(curve?, pathForRender?): string

Parameters

NameType
curve?boolean
pathForRender?boolean

Returns

string

Implementation of

IUI.getPathString

Defined in

ui/packages/display/src/UI.ts:337


__onUpdateSize

__onUpdateSize(): void

Returns

void

Implementation of

IUI.__onUpdateSize

Overrides

Leaf.__onUpdateSize

Defined in

ui/packages/display/src/UI.ts:342


__updateRenderPath

__updateRenderPath(): void

Returns

void

Implementation of

IUI.__updateRenderPath

Overrides

Leaf.__updateRenderPath

Defined in

ui/packages/display/src/UI.ts:349


__drawRenderPath

__drawRenderPath(canvas): void

Parameters

NameType
canvasILeaferCanvas

Returns

void

Implementation of

IUI.__drawRenderPath

Overrides

Leaf.__drawRenderPath

Defined in

ui/packages/display/src/UI.ts:357


__drawPath

__drawPath(canvas): void

Parameters

NameType
canvasILeaferCanvas

Returns

void

Implementation of

IUI.__drawPath

Overrides

Leaf.__drawPath

Defined in

ui/packages/display/src/UI.ts:362


__drawPathByData

__drawPathByData(drawer, data): void

Parameters

NameType
drawerIPathDrawer
dataIPathCommandData

Returns

void

Implementation of

IUI.__drawPathByData

Defined in

ui/packages/display/src/UI.ts:367


__drawPathByBox

__drawPathByBox(drawer): void

Parameters

NameType
drawerIPathDrawer

Returns

void

Implementation of

IUI.__drawPathByBox

Defined in

ui/packages/display/src/UI.ts:375


export

export(filename, options?): Promise<IExportResult>

Parameters

NameType
filenamestring
options?number | boolean | IExportOptions

Returns

Promise<IExportResult>

Implementation of

IUI.export

Defined in

ui/packages/display/src/UI.ts:387


clone

clone(): IUI

Returns

IUI

Implementation of

IUI.clone

Defined in

ui/packages/display/src/UI.ts:391


one

Static one(data, x?, y?, width?, height?): IUI

Parameters

NameType
dataIUIInputData
x?number
y?number
width?number
height?number

Returns

IUI

Defined in

ui/packages/display/src/UI.ts:395


registerUI

Static registerUI(): void

Returns

void

Defined in

ui/packages/display/src/UI.ts:399


registerData

Static registerData(data): void

Parameters

NameType
dataIUIData

Returns

void

Defined in

ui/packages/display/src/UI.ts:403


destroy

destroy(): void

Returns

void

Implementation of

IUI.destroy

Overrides

Leaf.destroy

Defined in

ui/packages/display/src/UI.ts:407

Released under the MIT License.