Class: UI<TInputData>

Type parameters

Name	Type
TInputData	IUIInputData

Hierarchy

• Leaf<TInputData>

  ↳ UI

  ↳↳ Group

  ↳↳ Rect

  ↳↳ Ellipse

  ↳↳ Polygon

  ↳↳ Star

  ↳↳ Line

  ↳↳ Text

  ↳↳ Path

  ↳↳ Stroker

  ↳↳ Robot

Implements

• IUI

Table of contents

Constructors

• constructor

Properties

• innerId
• skipJSON
• syncEventer
• lockNormalStyle
• __layout
• __world
• __local
• __nowWorld
• __cameraWorld
• __worldOpacity
• __scrollWorld
• __level
• __tempNumber
• __hasAutoLayout
• __hasMask
• __hasEraser
• __hitCanvas
• __captureMap
• __bubbleMap
• __hasLocalEvent
• __hasWorldEvent
• topChildren
• destroyed
• __
• proxyData
• __proxyData
• leafer
• parent
• zoomLayer
• children
• startLinker
• endLinker
• id
• name
• className
• blendMode
• opacity
• visible
• locked
• dim
• dimskip
• bright
• zIndex
• mask
• eraser
• x
• y
• width
• height
• scaleX
• scaleY
• scaleFixed
• rotation
• skewX
• skewY
• offsetX
• offsetY
• scrollX
• scrollY
• origin
• around
• lazy
• pixelRatio
• renderSpread
• path
• windingRule
• closed
• flow
• padding
• gap
• flowAlign
• flowWrap
• itemBox
• inFlow
• autoWidth
• autoHeight
• lockRatio
• autoBox
• widthRange
• heightRange
• draggable
• dragBounds
• dragBoundsType
• editable
• hittable
• hitFill
• hitStroke
• hitBox
• hitChildren
• hitSelf
• hitRadius
• cursor
• fill
• stroke
• strokeAlign
• strokeWidth
• strokeScaleFixed
• strokeCap
• strokeJoin
• dashPattern
• dashOffset
• miterLimit
• startArrow
• endArrow
• cornerRadius
• cornerSmoothing
• shadow
• innerShadow
• blur
• backgroundBlur
• grayscale
• filter
• complex
• animation
• animationOut
• transition
• transitionOut
• motionPath
• motionPrecision
• motion
• motionRotation
• states
• state
• selected
• disabled
• normalStyle
• hoverStyle
• pressStyle
• focusStyle
• selectedStyle
• disabledStyle
• placeholderStyle
• placeholderColor
• placeholderDelay
• button
• editConfig
• editOuter
• editInner
• data
• useFastShadow
• __box
• __animate

Accessors

• tag
• __tag
• innerName
• __DataProcessor
• __LayoutProcessor
• leaferIsCreated
• leaferIsReady
• isLeafer
• isBranch
• isBranchLeaf
• __localMatrix
• __localBoxBounds
• worldTransform
• localTransform
• scrollWorldTransform
• boxBounds
• renderBounds
• worldBoxBounds
• worldStrokeBounds
• worldRenderBounds
• worldOpacity
• __worldFlipped
• __onlyHitMask
• __ignoreHitWorld
• __inLazyBounds
• pathInputed
• event
• app
• isFrame
• strokeWidthFixed
• scale
• isAutoWidth
• isAutoHeight
• pen

Methods

• resetCustom
• waitParent
• waitLeafer
• nextRender
• removeNextRender
• __bindLeafer
• setAttr
• getAttr
• getComputedAttr
• toJSON
• toString
• toSVG
• __SVG
• toHTML
• __setAttr
• __getAttr
• setProxyAttr
• getProxyAttr
• focus
• updateState
• updateLayout
• forceUpdate
• forceRender
• __extraUpdate
• __updateWorldMatrix
• __updateLocalMatrix
• __updateWorldBounds
• __updateLocalBounds
• __updateLocalBoxBounds
• __updateLocalStrokeBounds
• __updateLocalRenderBounds
• __updateBoxBounds
• __updateContentBounds
• __updateStrokeBounds
• __updateRenderBounds
• __updateAutoLayout
• __updateFlowLayout
• __updateNaturalSize
• __updateStrokeSpread
• __updateRenderSpread
• __updateEraser
• __renderEraser
• __updateMask
• __renderMask
• __getNowWorld
• getClampRenderScale
• getRenderScaleData
• getTransform
• getBounds
• getLayoutBounds
• getLayoutPoints
• getWorldBounds
• worldToLocal
• localToWorld
• worldToInner
• innerToWorld
• getBoxPoint
• getBoxPointByInner
• getInnerPoint
• getInnerPointByBox
• getInnerPointByLocal
• getLocalPoint
• getLocalPointByInner
• getPagePoint
• getWorldPoint
• getWorldPointByBox
• getWorldPointByLocal
• getWorldPointByPage
• setTransform
• transform
• move
• moveInner
• scaleOf
• rotateOf
• skewOf
• transformWorld
• moveWorld
• scaleOfWorld
• rotateOfWorld
• skewOfWorld
• flip
• scaleResize
• __scaleResize
• resizeWidth
• resizeHeight
• hit
• __hitWorld
• __hit
• __hitFill
• __hitStroke
• __hitPixel
• __drawHitPath
• __updateHitCanvas
• __render
• __drawFast
• __draw
• __clip
• __renderShape
• __drawShape
• __updateWorldOpacity
• __updateChange
• __updatePath
• getMotionPathData
• getMotionPoint
• getMotionTotal
• __updateMotionPath
• __runAnimation
• __updateSortChildren
• add
• remove
• dropTo
• on
• off
• on_
• off_
• once
• emit
• emitEvent
• hasEvent
• changeAttr
• addAttr
• __emitLifeEvent
• reset
• set
• get
• createProxyData
• clearProxyData
• find
• findTag
• findOne
• findId
• getPath
• getPathString
• asPath
• load
• __onUpdateSize
• __updateRenderPath
• __drawRenderPath
• __drawPath
• __drawPathByData
• __drawPathByBox
• drawImagePlaceholder
• animate
• killAnimate
• export
• syncExport
• clone
• one
• registerUI
• registerData
• setEditConfig
• setEditOuter
• setEditInner
• destroy

Constructors

constructor

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

Type parameters

Name	Type
TInputData	IUIInputData

Parameters

Name	Type
data?	TInputData

Returns

UI<TInputData>

Inherited from

Leaf.constructor

Defined in

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

Properties

innerId

• Readonly innerId: number

Implementation of

IUI.innerId

Inherited from

Leaf.innerId

Defined in

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

---

skipJSON

• Optional skipJSON: boolean

Implementation of

IUI.skipJSON

Inherited from

Leaf.skipJSON

Defined in

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

---

syncEventer

• Optional syncEventer: ILeaf

Implementation of

IUI.syncEventer

Inherited from

Leaf.syncEventer

Defined in

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

---

lockNormalStyle

• Optional lockNormalStyle: boolean

Implementation of

IUI.lockNormalStyle

Inherited from

Leaf.lockNormalStyle

Defined in

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

---

__layout

• __layout: ILeafLayout

Implementation of

IUI.__layout

Inherited from

Leaf.__layout

Defined in

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

---

__world

• __world: IMatrixWithBoundsScaleData

Implementation of

IUI.__world

Inherited from

Leaf.__world

Defined in

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

---

__local

• Optional __local: IMatrixWithBoundsData

Implementation of

IUI.__local

Inherited from

Leaf.__local

Defined in

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

---

__nowWorld

• Optional __nowWorld: IMatrixWithBoundsScaleData

Implementation of

IUI.__nowWorld

Inherited from

Leaf.__nowWorld

Defined in

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

---

__cameraWorld

• Optional __cameraWorld: IMatrixWithBoundsScaleData

Implementation of

IUI.__cameraWorld

Inherited from

Leaf.__cameraWorld

Defined in

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

---

__worldOpacity

• __worldOpacity: number

Implementation of

IUI.__worldOpacity

Inherited from

Leaf.__worldOpacity

Defined in

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

---

__scrollWorld

• Optional __scrollWorld: IMatrixWithBoundsScaleData

Implementation of

IUI.__scrollWorld

Inherited from

Leaf.__scrollWorld

Defined in

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

---

__level

• __level: number

Implementation of

IUI.__level

Inherited from

Leaf.__level

Defined in

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

---

__tempNumber

• __tempNumber: number

Implementation of

IUI.__tempNumber

Inherited from

Leaf.__tempNumber

Defined in

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

---

__hasAutoLayout

• Optional __hasAutoLayout: boolean

Implementation of

IUI.__hasAutoLayout

Inherited from

Leaf.__hasAutoLayout

Defined in

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

---

__hasMask

• Optional __hasMask: boolean

Implementation of

IUI.__hasMask

Inherited from

Leaf.__hasMask

Defined in

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

---

__hasEraser

• Optional __hasEraser: boolean

Implementation of

IUI.__hasEraser

Inherited from

Leaf.__hasEraser

Defined in

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

---

__hitCanvas

• Optional __hitCanvas: IHitCanvas

Implementation of

IUI.__hitCanvas

Inherited from

Leaf.__hitCanvas

Defined in

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

---

__captureMap

• Optional __captureMap: IEventListenerMap

Implementation of

IUI.__captureMap

Inherited from

Leaf.__captureMap

Defined in

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

---

__bubbleMap

• Optional __bubbleMap: IEventListenerMap

Implementation of

IUI.__bubbleMap

Inherited from

Leaf.__bubbleMap

Defined in

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

---

__hasLocalEvent

• Optional __hasLocalEvent: boolean

Implementation of

IUI.__hasLocalEvent

Inherited from

Leaf.__hasLocalEvent

Defined in

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

---

__hasWorldEvent

• Optional __hasWorldEvent: boolean

Implementation of

IUI.__hasWorldEvent

Inherited from

Leaf.__hasWorldEvent

Defined in

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

---

topChildren

• Optional topChildren: ILeaf[]

Implementation of

IUI.topChildren

Inherited from

Leaf.topChildren

Defined in

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

---

destroyed

• destroyed: boolean

Implementation of

IUI.destroyed

Inherited from

Leaf.destroyed

Defined in

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

---

__

• __: IUIData

Implementation of

IUI.__

Overrides

Leaf.__

Defined in

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

---

proxyData

• Optional proxyData: IUIInputData

Implementation of

IUI.proxyData

Defined in

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

---

__proxyData

• Optional __proxyData: IUIInputData

Implementation of

IUI.__proxyData

Defined in

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

---

leafer

• Optional leafer: ILeafer

Implementation of

IUI.leafer

Overrides

Leaf.leafer

Defined in

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

---

parent

• Optional parent: IGroup

Implementation of

IUI.parent

Overrides

Leaf.parent

Defined in

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

---

zoomLayer

• zoomLayer: IGroup

Implementation of

IUI.zoomLayer

Defined in

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

---

children

• Optional children: IUI[]

Implementation of

IUI.children

Overrides

Leaf.children

Defined in

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

---

startLinker

• Optional startLinker: ILinker[]

Implementation of

IUI.startLinker

Defined in

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

---

endLinker

• Optional endLinker: ILinker[]

Implementation of

IUI.endLinker

Defined in

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

---

id

• Optional id: string

Implementation of

IUI.id

Defined in

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

---

name

• Optional name: string

Implementation of

IUI.name

Defined in

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

---

className

• Optional className: string

Implementation of

IUI.className

Defined in

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

---

blendMode

• Optional blendMode: IBlendMode

Implementation of

IUI.blendMode

Defined in

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

---

opacity

• Optional opacity: number

Implementation of

IUI.opacity

Defined in

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

---

visible

• Optional visible: boolean | 0

Implementation of

IUI.visible

Defined in

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

---

locked

• Optional locked: boolean

Implementation of

IUI.locked

Defined in

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

---

dim

• Optional dim: number | boolean

Implementation of

IUI.dim

Defined in

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

---

dimskip

• Optional dimskip: boolean

Implementation of

IUI.dimskip

Defined in

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

---

bright

• Optional bright: boolean

Implementation of

IUI.bright

Defined in

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

---

zIndex

• Optional zIndex: number

Implementation of

IUI.zIndex

Defined in

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

---

mask

• Optional mask: boolean | IMaskType

Implementation of

IUI.mask

Defined in

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

---

eraser

• Optional eraser: boolean | IEraserType

Implementation of

IUI.eraser

Defined in

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

---

x

• Optional x: number

Implementation of

IUI.x

Defined in

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

---

y

• Optional y: number

Implementation of

IUI.y

Defined in

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

---

width

• Optional width: number

Implementation of

IUI.width

Defined in

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

---

height

• Optional height: number

Implementation of

IUI.height

Defined in

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

---

scaleX

• Optional scaleX: number

Implementation of

IUI.scaleX

Defined in

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

---

scaleY

• Optional scaleY: number

Implementation of

IUI.scaleY

Defined in

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

---

scaleFixed

• Optional scaleFixed: IScaleFixed

Implementation of

IUI.scaleFixed

Defined in

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

---

rotation

• Optional rotation: number

Implementation of

IUI.rotation

Defined in

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

---

skewX

• Optional skewX: number

Implementation of

IUI.skewX

Defined in

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

---

skewY

• Optional skewY: number

Implementation of

IUI.skewY

Defined in

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

---

offsetX

• Optional offsetX: number

Implementation of

IUI.offsetX

Defined in

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

---

offsetY

• Optional offsetY: number

Implementation of

IUI.offsetY

Defined in

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

---

scrollX

• Optional scrollX: number

Implementation of

IUI.scrollX

Defined in

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

---

scrollY

• Optional scrollY: number

Implementation of

IUI.scrollY

Defined in

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

---

origin

• Optional origin: IUnitPointData | IDirection

Implementation of

IUI.origin

Defined in

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

---

around

• Optional around: IUnitPointData | IDirection

Implementation of

IUI.around

Defined in

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

---

lazy

• Optional lazy: boolean

Implementation of

IUI.lazy

Defined in

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

---

pixelRatio

• Optional pixelRatio: number

Implementation of

IUI.pixelRatio

Defined in

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

---

renderSpread

• Optional renderSpread: IFourNumber

Implementation of

IUI.renderSpread

Defined in

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

---

path

• Optional path: string | IPathCommandData | IPathCommandNode[] | IPathCommandObject[]

Implementation of

IUI.path

Defined in

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

---

windingRule

• Optional windingRule: IWindingRule

Implementation of

IUI.windingRule

Defined in

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

---

closed

• Optional closed: boolean

Implementation of

IUI.closed

Defined in

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

---

flow

• Optional flow: IFlowType

Implementation of

IUI.flow

Defined in

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

---

padding

• Optional padding: IFourNumber

Implementation of

IUI.padding

Defined in

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

---

gap

• Optional gap: IGap | IPointGap

Implementation of

IUI.gap

Defined in

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

---

flowAlign

• Optional flowAlign: IFlowAxisAlign | IFlowAlign

Implementation of

IUI.flowAlign

Defined in

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

---

flowWrap

• Optional flowWrap: IFlowWrap

Implementation of

IUI.flowWrap

Defined in

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

---

itemBox

• Optional itemBox: IFlowBoxType

Implementation of

IUI.itemBox

Defined in

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

---

inFlow

• Optional inFlow: boolean

Implementation of

IUI.inFlow

Defined in

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

---

autoWidth

• Optional autoWidth: IAutoSize

Implementation of

IUI.autoWidth

Defined in

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

---

autoHeight

• Optional autoHeight: IAutoSize

Implementation of

IUI.autoHeight

Defined in

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

---

lockRatio

• Optional lockRatio: boolean

Implementation of

IUI.lockRatio

Defined in

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

---

autoBox

• Optional autoBox: IAutoBoxData | IConstraint

Implementation of

IUI.autoBox

Defined in

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

---

widthRange

• Optional widthRange: IRangeSize

Implementation of

IUI.widthRange

Defined in

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

---

heightRange

• Optional heightRange: IRangeSize

Implementation of

IUI.heightRange

Defined in

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

---

draggable

• Optional draggable: boolean | IAxis

Implementation of

IUI.draggable

Defined in

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

---

dragBounds

• Optional dragBounds: "parent" | IBoundsData

Implementation of

IUI.dragBounds

Defined in

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

---

dragBoundsType

• Optional dragBoundsType: IDragBoundsType

Implementation of

IUI.dragBoundsType

Defined in

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

---

editable

• Optional editable: boolean

Implementation of

IUI.editable

Defined in

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

---

hittable

• Optional hittable: boolean

Implementation of

IUI.hittable

Defined in

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

---

hitFill

• Optional hitFill: IHitType

Implementation of

IUI.hitFill

Defined in

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

---

hitStroke

• Optional hitStroke: IHitType

Implementation of

IUI.hitStroke

Defined in

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

---

hitBox

• Optional hitBox: boolean

Implementation of

IUI.hitBox

Defined in

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

---

hitChildren

• Optional hitChildren: boolean

Implementation of

IUI.hitChildren

Defined in

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

---

hitSelf

• Optional hitSelf: boolean

Implementation of

IUI.hitSelf

Defined in

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

---

hitRadius

• Optional hitRadius: number

Implementation of

IUI.hitRadius

Defined in

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

---

cursor

• Optional cursor: ICursorType | ICursorType[]

Implementation of

IUI.cursor

Defined in

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

---

fill

• Optional fill: IFill

Implementation of

IUI.fill

Defined in

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

---

stroke

• Optional stroke: IStroke

Implementation of

IUI.stroke

Defined in

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

---

strokeAlign

• Optional strokeAlign: IStrokeAlign

Implementation of

IUI.strokeAlign

Defined in

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

---

strokeWidth

• Optional strokeWidth: string | IFourNumber

Implementation of

IUI.strokeWidth

Defined in

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

---

strokeScaleFixed

• Optional strokeScaleFixed: IScaleFixed

Implementation of

IUI.strokeScaleFixed

Defined in

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

---

strokeCap

• Optional strokeCap: IStrokeCap

Implementation of

IUI.strokeCap

Defined in

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

---

strokeJoin

• Optional strokeJoin: IStrokeJoin

Implementation of

IUI.strokeJoin

Defined in

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

---

dashPattern

• Optional dashPattern: string | number[]

Implementation of

IUI.dashPattern

Defined in

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

---

dashOffset

• Optional dashOffset: number

Implementation of

IUI.dashOffset

Defined in

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

---

miterLimit

• Optional miterLimit: number

Implementation of

IUI.miterLimit

Defined in

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

---

startArrow

• Optional startArrow: IArrowStyle

Implementation of

IUI.startArrow

Defined in

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

---

endArrow

• Optional endArrow: IArrowStyle

Implementation of

IUI.endArrow

Defined in

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

---

cornerRadius

• Optional cornerRadius: string | IFourNumber

Implementation of

IUI.cornerRadius

Defined in

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

---

cornerSmoothing

• Optional cornerSmoothing: number

Implementation of

IUI.cornerSmoothing

Defined in

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

---

shadow

• Optional shadow: string | IShadowEffect | IShadowEffect[]

Implementation of

IUI.shadow

Defined in

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

---

innerShadow

• Optional innerShadow: string | IShadowEffect | IShadowEffect[]

Implementation of

IUI.innerShadow

Defined in

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

---

blur

• Optional blur: number | IBlurEffect

Implementation of

IUI.blur

Defined in

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

---

backgroundBlur

• Optional backgroundBlur: number | IBlurEffect

Implementation of

IUI.backgroundBlur

Defined in

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

---

grayscale

• Optional grayscale: number | IGrayscaleEffect

Implementation of

IUI.grayscale

Defined in

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

---

filter

• Optional filter: IFilter | IFilter[]

Implementation of

IUI.filter

Defined in

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

---

complex

• Optional complex: boolean

Implementation of

IUI.complex

Defined in

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

---

animation

• Optional animation: IAnimation | IAnimation[]

Implementation of

IUI.animation

Defined in

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

---

animationOut

• Optional animationOut: IAnimation | IAnimation[]

Implementation of

IUI.animationOut

Defined in

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

---

transition

• Optional transition: ITransition

Implementation of

IUI.transition

Defined in

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

---

transitionOut

• Optional transitionOut: ITransition

Implementation of

IUI.transitionOut

Defined in

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

---

motionPath

• Optional motionPath: boolean

Implementation of

IUI.motionPath

Defined in

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

---

motionPrecision

• Optional motionPrecision: number

Implementation of

IUI.motionPrecision

Defined in

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

---

motion

• Optional motion: number | IUnitData

Implementation of

IUI.motion

Defined in

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

---

motionRotation

• Optional motionRotation: number | boolean

Implementation of

IUI.motionRotation

Defined in

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

---

states

• Optional states: IStates

Implementation of

IUI.states

Defined in

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

---

state

• Optional state: string

Implementation of

IUI.state

Defined in

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

---

selected

• Optional selected: boolean

Implementation of

IUI.selected

Defined in

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

---

disabled

• Optional disabled: boolean

Implementation of

IUI.disabled

Defined in

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

---

normalStyle

• Optional normalStyle: IStateStyle

Implementation of

IUI.normalStyle

Defined in

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

---

hoverStyle

• Optional hoverStyle: IStateStyle

Implementation of

IUI.hoverStyle

Defined in

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

---

pressStyle

• Optional pressStyle: IStateStyle

Implementation of

IUI.pressStyle

Defined in

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

---

focusStyle

• Optional focusStyle: IStateStyle

Implementation of

IUI.focusStyle

Defined in

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

---

selectedStyle

• Optional selectedStyle: IStateStyle

Implementation of

IUI.selectedStyle

Defined in

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

---

disabledStyle

• Optional disabledStyle: IStateStyle

Implementation of

IUI.disabledStyle

Defined in

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

---

placeholderStyle

• Optional placeholderStyle: IStateStyle

Implementation of

IUI.placeholderStyle

Defined in

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

---

placeholderColor

• Optional placeholderColor: string

Implementation of

IUI.placeholderColor

Defined in

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

---

placeholderDelay

• Optional placeholderDelay: number

Implementation of

IUI.placeholderDelay

Defined in

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

---

button

• Optional button: boolean

Implementation of

IUI.button

Defined in

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

---

editConfig

• editConfig: IEditorConfig

Implementation of

IUI.editConfig

Defined in

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

---

editOuter

• editOuter: string

Implementation of

IUI.editOuter

Defined in

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

---

editInner

• editInner: string

Implementation of

IUI.editInner

Defined in

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

---

data

• data: IObject

Implementation of

IUI.data

Defined in

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

---

useFastShadow

• Optional useFastShadow: boolean

Implementation of

IUI.useFastShadow

Defined in

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

---

__box

• Optional __box: IUI

Implementation of

IUI.__box

Defined in

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

---

__animate

• Optional __animate: IAnimate | IAnimateList

Implementation of

IUI.__animate

Defined in

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

Accessors

tag

• get tag(): string

Returns

string

Implementation of

IUI.tag

Inherited from

Leaf.tag

Defined in

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

• set tag(_value): void

Parameters

Name	Type
_value	string

Returns

void

Implementation of

IUI.tag

Inherited from

Leaf.tag

Defined in

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

---

__tag

• get __tag(): string

Returns

string

Implementation of

IUI.__tag

Inherited from

Leaf.__tag

Defined in

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

---

innerName

• get innerName(): string

Returns

string

Implementation of

IUI.innerName

Inherited from

Leaf.innerName

Defined in

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

---

__DataProcessor

• get __DataProcessor(): typeof LeafData

Returns

typeof LeafData

Implementation of

IUI.__DataProcessor

Inherited from

Leaf.__DataProcessor

Defined in

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

---

__LayoutProcessor

• get __LayoutProcessor(): typeof LeafLayout

Returns

typeof LeafLayout

Implementation of

IUI.__LayoutProcessor

Inherited from

Leaf.__LayoutProcessor

Defined in

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

---

leaferIsCreated

• get leaferIsCreated(): boolean

Returns

boolean

Implementation of

IUI.leaferIsCreated

Inherited from

Leaf.leaferIsCreated

Defined in

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

---

leaferIsReady

• get leaferIsReady(): boolean

Returns

boolean

Implementation of

IUI.leaferIsReady

Inherited from

Leaf.leaferIsReady

Defined in

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

---

isLeafer

• get isLeafer(): boolean

Returns

boolean

Implementation of

IUI.isLeafer

Inherited from

Leaf.isLeafer

Defined in

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

---

isBranch

• get isBranch(): boolean

Returns

boolean

Implementation of

IUI.isBranch

Inherited from

Leaf.isBranch

Defined in

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

---

isBranchLeaf

• get isBranchLeaf(): boolean

Returns

boolean

Implementation of

IUI.isBranchLeaf

Inherited from

Leaf.isBranchLeaf

Defined in

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

---

__localMatrix

• get __localMatrix(): IMatrixData

Returns

IMatrixData

Implementation of

IUI.__localMatrix

Inherited from

Leaf.__localMatrix

Defined in

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

---

__localBoxBounds

• get __localBoxBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IUI.__localBoxBounds

Inherited from

Leaf.__localBoxBounds

Defined in

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

---

worldTransform

• get worldTransform(): IMatrixWithScaleData

Returns

IMatrixWithScaleData

Implementation of

IUI.worldTransform

Inherited from

Leaf.worldTransform

Defined in

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

---

localTransform

• get localTransform(): IMatrixData

Returns

IMatrixData

Implementation of

IUI.localTransform

Inherited from

Leaf.localTransform

Defined in

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

---

scrollWorldTransform

• get scrollWorldTransform(): IMatrixWithScaleData

Returns

IMatrixWithScaleData

Implementation of

IUI.scrollWorldTransform

Inherited from

Leaf.scrollWorldTransform

Defined in

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

---

boxBounds

• get boxBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IUI.boxBounds

Inherited from

Leaf.boxBounds

Defined in

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

---

renderBounds

• get renderBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IUI.renderBounds

Inherited from

Leaf.renderBounds

Defined in

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

---

worldBoxBounds

• get worldBoxBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IUI.worldBoxBounds

Inherited from

Leaf.worldBoxBounds

Defined in

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

---

worldStrokeBounds

• get worldStrokeBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IUI.worldStrokeBounds

Inherited from

Leaf.worldStrokeBounds

Defined in

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

---

worldRenderBounds

• get worldRenderBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IUI.worldRenderBounds

Inherited from

Leaf.worldRenderBounds

Defined in

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

---

worldOpacity

• get worldOpacity(): number

Returns

number

Implementation of

IUI.worldOpacity

Inherited from

Leaf.worldOpacity

Defined in

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

---

__worldFlipped

• get __worldFlipped(): boolean

Returns

boolean

Implementation of

IUI.__worldFlipped

Inherited from

Leaf.__worldFlipped

Defined in

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

---

__onlyHitMask

• get __onlyHitMask(): boolean

Returns

boolean

Implementation of

IUI.__onlyHitMask

Inherited from

Leaf.__onlyHitMask

Defined in

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

---

__ignoreHitWorld

• get __ignoreHitWorld(): boolean

Returns

boolean

Implementation of

IUI.__ignoreHitWorld

Inherited from

Leaf.__ignoreHitWorld

Defined in

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

---

__inLazyBounds

• get __inLazyBounds(): boolean

Returns

boolean

Implementation of

IUI.__inLazyBounds

Inherited from

Leaf.__inLazyBounds

Defined in

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

---

pathInputed

• get pathInputed(): boolean

Returns

boolean

Implementation of

IUI.pathInputed

Inherited from

Leaf.pathInputed

Defined in

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

---

event

• set event(map): void

Parameters

Name	Type
map	IEventParamsMap

Returns

void

Implementation of

IUI.event

Inherited from

Leaf.event

Defined in

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

---

app

• get app(): ILeafer

Returns

ILeafer

Implementation of

IUI.app

Defined in

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

---

isFrame

• get isFrame(): boolean

Returns

boolean

Implementation of

IUI.isFrame

Defined in

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

---

strokeWidthFixed

• get strokeWidthFixed(): IScaleFixed

Returns

IScaleFixed

Defined in

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

• set strokeWidthFixed(value): void

Parameters

Name	Type
value	IScaleFixed

Returns

void

Defined in

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

---

scale

• get scale(): number | IPointData

Returns

number | IPointData

Implementation of

IUI.scale

Defined in

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

• set scale(value): void

Parameters

Name	Type
value	number | IPointData

Returns

void

Implementation of

IUI.scale

Defined in

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

---

isAutoWidth

• get isAutoWidth(): boolean

Returns

boolean

Implementation of

IUI.isAutoWidth

Defined in

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

---

isAutoHeight

• get isAutoHeight(): boolean

Returns

boolean

Implementation of

IUI.isAutoHeight

Defined in

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

---

pen

• get pen(): IPathCreator

Returns

IPathCreator

Implementation of

IUI.pen

Defined in

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

Methods

resetCustom

▸ resetCustom(): void

Returns

void

Implementation of

IUI.resetCustom

Inherited from

Leaf.resetCustom

Defined in

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

---

waitParent

▸ waitParent(item, bind?): void

Parameters

Name	Type
item	IFunction
bind?	IObject

Returns

void

Implementation of

IUI.waitParent

Inherited from

Leaf.waitParent

Defined in

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

---

waitLeafer

▸ waitLeafer(item, bind?): void

Parameters

Name	Type
item	IFunction
bind?	IObject

Returns

void

Implementation of

IUI.waitLeafer

Inherited from

Leaf.waitLeafer

Defined in

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

---

nextRender

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

Parameters

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

Returns

void

Implementation of

IUI.nextRender

Inherited from

Leaf.nextRender

Defined in

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

---

removeNextRender

▸ removeNextRender(item): void

Parameters

Name	Type
item	IFunction

Returns

void

Implementation of

IUI.removeNextRender

Inherited from

Leaf.removeNextRender

Defined in

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

---

__bindLeafer

▸ __bindLeafer(leafer): void

Parameters

Name	Type
leafer	ILeaferBase

Returns

void

Implementation of

IUI.__bindLeafer

Inherited from

Leaf.__bindLeafer

Defined in

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

---

setAttr

▸ setAttr(name, value): void

Parameters

Name	Type
name	string
value	any

Returns

void

Implementation of

IUI.setAttr

Inherited from

Leaf.setAttr

Defined in

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

---

getAttr

▸ getAttr(name): any

Parameters

Name	Type
name	string

Returns

any

Implementation of

IUI.getAttr

Inherited from

Leaf.getAttr

Defined in

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

---

getComputedAttr

▸ getComputedAttr(name): any

Parameters

Name	Type
name	string

Returns

any

Implementation of

IUI.getComputedAttr

Inherited from

Leaf.getComputedAttr

Defined in

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

---

toJSON

▸ toJSON(options?): IObject

Parameters

Name	Type
options?	IJSONOptions

Returns

IObject

Implementation of

IUI.toJSON

Inherited from

Leaf.toJSON

Defined in

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

---

toString

▸ toString(options?): string

Parameters

Name	Type
options?	IJSONOptions

Returns

string

Implementation of

IUI.toString

Inherited from

Leaf.toString

Defined in

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

---

toSVG

▸ toSVG(): string

Returns

string

Implementation of

IUI.toSVG

Inherited from

Leaf.toSVG

Defined in

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

---

__SVG

▸ __SVG(_data): void

Parameters

Name	Type
_data	IObject

Returns

void

Implementation of

IUI.__SVG

Inherited from

Leaf.__SVG

Defined in

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

---

toHTML

▸ toHTML(): string

Returns

string

Implementation of

IUI.toHTML

Inherited from

Leaf.toHTML

Defined in

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

---

__setAttr

▸ __setAttr(_attrName, _newValue): boolean

Parameters

Name	Type
_attrName	string
_newValue	IValue

Returns

boolean

Implementation of

IUI.__setAttr

Inherited from

Leaf.__setAttr

Defined in

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

---

__getAttr

▸ __getAttr(_attrName): IValue

Parameters

Name	Type
_attrName	string

Returns

IValue

Implementation of

IUI.__getAttr

Inherited from

Leaf.__getAttr

Defined in

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

---

setProxyAttr

▸ setProxyAttr(_attrName, _newValue): void

Parameters

Name	Type
_attrName	string
_newValue	IValue

Returns

void

Implementation of

IUI.setProxyAttr

Inherited from

Leaf.setProxyAttr

Defined in

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

---

getProxyAttr

▸ getProxyAttr(_attrName): IValue

Parameters

Name	Type
_attrName	string

Returns

IValue

Implementation of

IUI.getProxyAttr

Inherited from

Leaf.getProxyAttr

Defined in

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

---

focus

▸ focus(_value?): void

Parameters

Name	Type
_value?	boolean

Returns

void

Implementation of

IUI.focus

Inherited from

Leaf.focus

Defined in

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

---

updateState

▸ updateState(): void

Returns

void

Implementation of

IUI.updateState

Inherited from

Leaf.updateState

Defined in

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

---

updateLayout

▸ updateLayout(): void

Returns

void

Implementation of

IUI.updateLayout

Inherited from

Leaf.updateLayout

Defined in

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

---

forceUpdate

▸ forceUpdate(attrName?): void

Parameters

Name	Type
attrName?	string

Returns

void

Implementation of

IUI.forceUpdate

Inherited from

Leaf.forceUpdate

Defined in

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

---

forceRender

▸ forceRender(_bounds?, _sync?): void

Parameters

Name	Type
_bounds?	IBoundsData
_sync?	boolean

Returns

void

Implementation of

IUI.forceRender

Inherited from

Leaf.forceRender

Defined in

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

---

__extraUpdate

▸ __extraUpdate(): void

Returns

void

Implementation of

IUI.__extraUpdate

Inherited from

Leaf.__extraUpdate

Defined in

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

---

__updateWorldMatrix

▸ __updateWorldMatrix(): void

Returns

void

Implementation of

IUI.__updateWorldMatrix

Inherited from

Leaf.__updateWorldMatrix

Defined in

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

---

__updateLocalMatrix

▸ __updateLocalMatrix(): void

Returns

void

Implementation of

IUI.__updateLocalMatrix

Inherited from

Leaf.__updateLocalMatrix

Defined in

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

---

__updateWorldBounds

▸ __updateWorldBounds(): void

Returns

void

Implementation of

IUI.__updateWorldBounds

Inherited from

Leaf.__updateWorldBounds

Defined in

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

---

__updateLocalBounds

▸ __updateLocalBounds(): void

Returns

void

Implementation of

IUI.__updateLocalBounds

Inherited from

Leaf.__updateLocalBounds

Defined in

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

---

__updateLocalBoxBounds

▸ __updateLocalBoxBounds(): void

Returns

void

Implementation of

IUI.__updateLocalBoxBounds

Inherited from

Leaf.__updateLocalBoxBounds

Defined in

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

---

__updateLocalStrokeBounds

▸ __updateLocalStrokeBounds(): void

Returns

void

Implementation of

IUI.__updateLocalStrokeBounds

Inherited from

Leaf.__updateLocalStrokeBounds

Defined in

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

---

__updateLocalRenderBounds

▸ __updateLocalRenderBounds(): void

Returns

void

Implementation of

IUI.__updateLocalRenderBounds

Inherited from

Leaf.__updateLocalRenderBounds

Defined in

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

---

__updateBoxBounds

▸ __updateBoxBounds(_secondLayout?, _bounds?): void

Parameters

Name	Type
_secondLayout?	boolean
_bounds?	IBoundsData

Returns

void

Implementation of

IUI.__updateBoxBounds

Inherited from

Leaf.__updateBoxBounds

Defined in

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

---

__updateContentBounds

▸ __updateContentBounds(): void

Returns

void

Implementation of

IUI.__updateContentBounds

Inherited from

Leaf.__updateContentBounds

Defined in

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

---

__updateStrokeBounds

▸ __updateStrokeBounds(_bounds?): void

Parameters

Name	Type
_bounds?	IBoundsData

Returns

void

Implementation of

IUI.__updateStrokeBounds

Inherited from

Leaf.__updateStrokeBounds

Defined in

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

---

__updateRenderBounds

▸ __updateRenderBounds(_bounds?): void

Parameters

Name	Type
_bounds?	IBoundsData

Returns

void

Implementation of

IUI.__updateRenderBounds

Inherited from

Leaf.__updateRenderBounds

Defined in

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

---

__updateAutoLayout

▸ __updateAutoLayout(): void

Returns

void

Implementation of

IUI.__updateAutoLayout

Inherited from

Leaf.__updateAutoLayout

Defined in

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

---

__updateFlowLayout

▸ __updateFlowLayout(): void

Returns

void

Implementation of

IUI.__updateFlowLayout

Inherited from

Leaf.__updateFlowLayout

Defined in

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

---

__updateNaturalSize

▸ __updateNaturalSize(): void

Returns

void

Implementation of

IUI.__updateNaturalSize

Inherited from

Leaf.__updateNaturalSize

Defined in

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

---

__updateStrokeSpread

▸ __updateStrokeSpread(): IFourNumber

Returns

IFourNumber

Implementation of

IUI.__updateStrokeSpread

Inherited from

Leaf.__updateStrokeSpread

Defined in

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

---

__updateRenderSpread

▸ __updateRenderSpread(): IFourNumber

Returns

IFourNumber

Implementation of

IUI.__updateRenderSpread

Inherited from

Leaf.__updateRenderSpread

Defined in

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

---

__updateEraser

▸ __updateEraser(value?): void

Parameters

Name	Type
value?	boolean

Returns

void

Implementation of

IUI.__updateEraser

Inherited from

Leaf.__updateEraser

Defined in

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

---

__renderEraser

▸ __renderEraser(canvas, options): void

Parameters

Name	Type
canvas	ILeaferCanvas
options	IRenderOptions

Returns

void

Implementation of

IUI.__renderEraser

Inherited from

Leaf.__renderEraser

Defined in

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

---

__updateMask

▸ __updateMask(_value?): void

Parameters

Name	Type
_value?	boolean

Returns

void

Implementation of

IUI.__updateMask

Inherited from

Leaf.__updateMask

Defined in

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

---

__renderMask

▸ __renderMask(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Implementation of

IUI.__renderMask

Inherited from

Leaf.__renderMask

Defined in

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

---

__getNowWorld

▸ __getNowWorld(options): IMatrixWithBoundsScaleData

Parameters

Name	Type
options	IRenderOptions

Returns

IMatrixWithBoundsScaleData

Implementation of

IUI.__getNowWorld

Inherited from

Leaf.__getNowWorld

Defined in

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

---

getClampRenderScale

▸ getClampRenderScale(): number

Returns

number

Implementation of

IUI.getClampRenderScale

Inherited from

Leaf.getClampRenderScale

Defined in

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

---

getRenderScaleData

▸ getRenderScaleData(abs?, scaleFixed?, unscale?): IScaleData

Parameters

Name	Type	Default value
abs?	boolean	undefined
scaleFixed?	IScaleFixed	undefined
unscale	boolean	true

Returns

IScaleData

Implementation of

IUI.getRenderScaleData

Inherited from

Leaf.getRenderScaleData

Defined in

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

---

getTransform

▸ getTransform(relative?): IMatrixData

Parameters

Name	Type
relative?	ILeaf | ILocationType

Returns

IMatrixData

Implementation of

IUI.getTransform

Inherited from

Leaf.getTransform

Defined in

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

---

getBounds

▸ getBounds(type?, relative?): IBoundsData

Parameters

Name	Type
type?	IBoundsType
relative?	ILeaf | ILocationType

Returns

IBoundsData

Implementation of

IUI.getBounds

Inherited from

Leaf.getBounds

Defined in

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

---

getLayoutBounds

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

Parameters

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

Returns

ILayoutBoundsData

Implementation of

IUI.getLayoutBounds

Inherited from

Leaf.getLayoutBounds

Defined in

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

---

getLayoutPoints

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

Parameters

Name	Type
type?	IBoundsType
relative?	ILeaf | ILocationType

Returns

IPointData[]

Implementation of

IUI.getLayoutPoints

Inherited from

Leaf.getLayoutPoints

Defined in

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

---

getWorldBounds

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

Parameters

Name	Type
inner	IBoundsData
relative?	ILeaf
change?	boolean

Returns

IBoundsData

Implementation of

IUI.getWorldBounds

Inherited from

Leaf.getWorldBounds

Defined in

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

---

worldToLocal

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

Parameters

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

Returns

void

Implementation of

IUI.worldToLocal

Inherited from

Leaf.worldToLocal

Defined in

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

---

localToWorld

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

Parameters

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

Returns

void

Implementation of

IUI.localToWorld

Inherited from

Leaf.localToWorld

Defined in

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

---

worldToInner

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

Parameters

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

Returns

void

Implementation of

IUI.worldToInner

Inherited from

Leaf.worldToInner

Defined in

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

---

innerToWorld

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

Parameters

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

Returns

void

Implementation of

IUI.innerToWorld

Inherited from

Leaf.innerToWorld

Defined in

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

---

getBoxPoint

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

Parameters

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

Returns

IPointData

Implementation of

IUI.getBoxPoint

Inherited from

Leaf.getBoxPoint

Defined in

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

---

getBoxPointByInner

▸ getBoxPointByInner(inner, _relative?, _distance?, change?): IPointData

Parameters

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

Returns

IPointData

Implementation of

IUI.getBoxPointByInner

Inherited from

Leaf.getBoxPointByInner

Defined in

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

---

getInnerPoint

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

Parameters

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

Returns

IPointData

Implementation of

IUI.getInnerPoint

Inherited from

Leaf.getInnerPoint

Defined in

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

---

getInnerPointByBox

▸ getInnerPointByBox(box, _relative?, _distance?, change?): IPointData

Parameters

Name	Type
box	IPointData
_relative?	ILeaf
_distance?	boolean
change?	boolean

Returns

IPointData

Implementation of

IUI.getInnerPointByBox

Inherited from

Leaf.getInnerPointByBox

Defined in

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

---

getInnerPointByLocal

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

Parameters

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

Returns

IPointData

Implementation of

IUI.getInnerPointByLocal

Inherited from

Leaf.getInnerPointByLocal

Defined in

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

---

getLocalPoint

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

Parameters

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

Returns

IPointData

Implementation of

IUI.getLocalPoint

Inherited from

Leaf.getLocalPoint

Defined in

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

---

getLocalPointByInner

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

Parameters

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

Returns

IPointData

Implementation of

IUI.getLocalPointByInner

Inherited from

Leaf.getLocalPointByInner

Defined in

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

---

getPagePoint

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

Parameters

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

Returns

IPointData

Implementation of

IUI.getPagePoint

Inherited from

Leaf.getPagePoint

Defined in

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

---

getWorldPoint

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

Parameters

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

Returns

IPointData

Implementation of

IUI.getWorldPoint

Inherited from

Leaf.getWorldPoint

Defined in

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

---

getWorldPointByBox

▸ getWorldPointByBox(box, relative?, distance?, change?): IPointData

Parameters

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

Returns

IPointData

Implementation of

IUI.getWorldPointByBox

Inherited from

Leaf.getWorldPointByBox

Defined in

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

---

getWorldPointByLocal

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

Parameters

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

Returns

IPointData

Implementation of

IUI.getWorldPointByLocal

Inherited from

Leaf.getWorldPointByLocal

Defined in

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

---

getWorldPointByPage

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

Parameters

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

Returns

IPointData

Implementation of

IUI.getWorldPointByPage

Inherited from

Leaf.getWorldPointByPage

Defined in

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

---

setTransform

▸ setTransform(matrix, resize?, transition?): void

Parameters

Name	Type
matrix	IMatrixData
resize?	boolean
transition?	ITransition

Returns

void

Implementation of

IUI.setTransform

Inherited from

Leaf.setTransform

Defined in

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

---

transform

▸ transform(matrix, resize?, transition?): void

Parameters

Name	Type
matrix	IMatrixData
resize?	boolean
transition?	ITransition

Returns

void

Implementation of

IUI.transform

Inherited from

Leaf.transform

Defined in

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

---

move

▸ move(x, y?, transition?): void

Parameters

Name	Type
x	number | IPointData
y?	number
transition?	ITransition

Returns

void

Implementation of

IUI.move

Inherited from

Leaf.move

Defined in

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

---

moveInner

▸ moveInner(x, y?, transition?): void

Parameters

Name	Type
x	number | IPointData
y?	number
transition?	ITransition

Returns

void

Implementation of

IUI.moveInner

Inherited from

Leaf.moveInner

Defined in

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

---

scaleOf

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

Parameters

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

Returns

void

Implementation of

IUI.scaleOf

Inherited from

Leaf.scaleOf

Defined in

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

---

rotateOf

▸ rotateOf(origin, rotation, transition?): void

Parameters

Name	Type
origin	IPointData | IDirection
rotation	number
transition?	ITransition

Returns

void

Implementation of

IUI.rotateOf

Inherited from

Leaf.rotateOf

Defined in

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

---

skewOf

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

Parameters

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

Returns

void

Implementation of

IUI.skewOf

Inherited from

Leaf.skewOf

Defined in

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

---

transformWorld

▸ transformWorld(worldTransform?, resize?, transition?): void

Parameters

Name	Type
worldTransform?	IMatrixData
resize?	boolean
transition?	ITransition

Returns

void

Implementation of

IUI.transformWorld

Inherited from

Leaf.transformWorld

Defined in

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

---

moveWorld

▸ moveWorld(x, y?, transition?): void

Parameters

Name	Type
x	number | IPointData
y?	number
transition?	ITransition

Returns

void

Implementation of

IUI.moveWorld

Inherited from

Leaf.moveWorld

Defined in

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

---

scaleOfWorld

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

Parameters

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

Returns

void

Implementation of

IUI.scaleOfWorld

Inherited from

Leaf.scaleOfWorld

Defined in

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

---

rotateOfWorld

▸ rotateOfWorld(worldOrigin, rotation): void

Parameters

Name	Type
worldOrigin	IPointData
rotation	number

Returns

void

Implementation of

IUI.rotateOfWorld

Inherited from

Leaf.rotateOfWorld

Defined in

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

---

skewOfWorld

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

Parameters

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

Returns

void

Implementation of

IUI.skewOfWorld

Inherited from

Leaf.skewOfWorld

Defined in

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

---

flip

▸ flip(axis, transition?): void

Parameters

Name	Type
axis	IAxis
transition?	ITransition

Returns

void

Implementation of

IUI.flip

Inherited from

Leaf.flip

Defined in

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

---

scaleResize

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

Parameters

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

Returns

void

Implementation of

IUI.scaleResize

Inherited from

Leaf.scaleResize

Defined in

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

---

__scaleResize

▸ __scaleResize(_scaleX, _scaleY): void

Parameters

Name	Type
_scaleX	number
_scaleY	number

Returns

void

Implementation of

IUI.__scaleResize

Inherited from

Leaf.__scaleResize

Defined in

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

---

resizeWidth

▸ resizeWidth(_width): void

Parameters

Name	Type
_width	number

Returns

void

Implementation of

IUI.resizeWidth

Inherited from

Leaf.resizeWidth

Defined in

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

---

resizeHeight

▸ resizeHeight(_height): void

Parameters

Name	Type
_height	number

Returns

void

Implementation of

IUI.resizeHeight

Inherited from

Leaf.resizeHeight

Defined in

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

---

hit

▸ hit(_world, _hitRadius?): boolean

Parameters

Name	Type
_world	IPointData
_hitRadius?	number

Returns

boolean

Implementation of

IUI.hit

Inherited from

Leaf.hit

Defined in

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

---

__hitWorld

▸ __hitWorld(_point, _forceHitFill?): boolean

Parameters

Name	Type
_point	IRadiusPointData
_forceHitFill?	boolean

Returns

boolean

Implementation of

IUI.__hitWorld

Inherited from

Leaf.__hitWorld

Defined in

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

---

__hit

▸ __hit(_local, _forceHitFill?): boolean

Parameters

Name	Type
_local	IRadiusPointData
_forceHitFill?	boolean

Returns

boolean

Implementation of

IUI.__hit

Inherited from

Leaf.__hit

Defined in

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

---

__hitFill

▸ __hitFill(_inner): boolean

Parameters

Name	Type
_inner	IRadiusPointData

Returns

boolean

Implementation of

IUI.__hitFill

Inherited from

Leaf.__hitFill

Defined in

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

---

__hitStroke

▸ __hitStroke(_inner, _strokeWidth): boolean

Parameters

Name	Type
_inner	IRadiusPointData
_strokeWidth	number

Returns

boolean

Implementation of

IUI.__hitStroke

Inherited from

Leaf.__hitStroke

Defined in

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

---

__hitPixel

▸ __hitPixel(_inner): boolean

Parameters

Name	Type
_inner	IRadiusPointData

Returns

boolean

Implementation of

IUI.__hitPixel

Inherited from

Leaf.__hitPixel

Defined in

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

---

__drawHitPath

▸ __drawHitPath(_canvas): void

Parameters

Name	Type
_canvas	ILeaferCanvas

Returns

void

Implementation of

IUI.__drawHitPath

Inherited from

Leaf.__drawHitPath

Defined in

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

---

__updateHitCanvas

▸ __updateHitCanvas(): void

Returns

void

Implementation of

IUI.__updateHitCanvas

Inherited from

Leaf.__updateHitCanvas

Defined in

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

---

__render

▸ __render(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Implementation of

IUI.__render

Inherited from

Leaf.__render

Defined in

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

---

__drawFast

▸ __drawFast(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Implementation of

IUI.__drawFast

Inherited from

Leaf.__drawFast

Defined in

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

---

__draw

▸ __draw(_canvas, _options, _originCanvas?): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions
_originCanvas?	ILeaferCanvas

Returns

void

Implementation of

IUI.__draw

Inherited from

Leaf.__draw

Defined in

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

---

__clip

▸ __clip(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Implementation of

IUI.__clip

Inherited from

Leaf.__clip

Defined in

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

---

__renderShape

▸ __renderShape(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Implementation of

IUI.__renderShape

Inherited from

Leaf.__renderShape

Defined in

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

---

__drawShape

▸ __drawShape(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Implementation of

IUI.__drawShape

Inherited from

Leaf.__drawShape

Defined in

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

---

__updateWorldOpacity

▸ __updateWorldOpacity(): void

Returns

void

Implementation of

IUI.__updateWorldOpacity

Inherited from

Leaf.__updateWorldOpacity

Defined in

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

---

__updateChange

▸ __updateChange(): void

Returns

void

Implementation of

IUI.__updateChange

Inherited from

Leaf.__updateChange

Defined in

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

---

__updatePath

▸ __updatePath(): void

Returns

void

Implementation of

IUI.__updatePath

Inherited from

Leaf.__updatePath

Defined in

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

---

getMotionPathData

▸ getMotionPathData(): IMotionPathData

Returns

IMotionPathData

Implementation of

IUI.getMotionPathData

Inherited from

Leaf.getMotionPathData

Defined in

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

---

getMotionPoint

▸ getMotionPoint(_motionDistance): IRotationPointData

Parameters

Name	Type
_motionDistance	number | IUnitData

Returns

IRotationPointData

Implementation of

IUI.getMotionPoint

Inherited from

Leaf.getMotionPoint

Defined in

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

---

getMotionTotal

▸ getMotionTotal(): number

Returns

number

Implementation of

IUI.getMotionTotal

Inherited from

Leaf.getMotionTotal

Defined in

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

---

__updateMotionPath

▸ __updateMotionPath(): void

Returns

void

Implementation of

IUI.__updateMotionPath

Inherited from

Leaf.__updateMotionPath

Defined in

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

---

__runAnimation

▸ __runAnimation(_type, _complete?): void

Parameters

Name	Type
_type	"in" | "out"
_complete?	IFunction

Returns

void

Implementation of

IUI.__runAnimation

Inherited from

Leaf.__runAnimation

Defined in

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

---

__updateSortChildren

▸ __updateSortChildren(): void

Returns

void

Implementation of

IUI.__updateSortChildren

Inherited from

Leaf.__updateSortChildren

Defined in

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

---

add

▸ add(_child, _index?): void

Parameters

Name	Type
_child	ILeaf | ILeaf[] | ILeafInputData | ILeafInputData[]
_index?	number

Returns

void

Implementation of

IUI.add

Inherited from

Leaf.add

Defined in

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

---

remove

▸ remove(_child?, destroy?): void

Parameters

Name	Type
_child?	string | number | ILeaf | IFindMethod
destroy?	boolean

Returns

void

Implementation of

IUI.remove

Inherited from

Leaf.remove

Defined in

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

---

dropTo

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

Parameters

Name	Type
parent	ILeaf
index?	number
resize?	boolean

Returns

void

Implementation of

IUI.dropTo

Inherited from

Leaf.dropTo

Defined in

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

---

on

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

Parameters

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

Returns

void

Implementation of

IUI.on

Inherited from

Leaf.on

Defined in

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

---

off

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

Parameters

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

Returns

void

Implementation of

IUI.off

Inherited from

Leaf.off

Defined in

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

---

on_

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

Parameters

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

Returns

IEventListenerId

Implementation of

IUI.on_

Inherited from

Leaf.on_

Defined in

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

---

off_

▸ off_(_id): void

Parameters

Name	Type
_id	IEventListenerId | IEventListenerId[]

Returns

void

Implementation of

IUI.off_

Inherited from

Leaf.off_

Defined in

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

---

once

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

Parameters

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

Returns

void

Implementation of

IUI.once

Inherited from

Leaf.once

Defined in

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

---

emit

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

Parameters

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

Returns

void

Implementation of

IUI.emit

Inherited from

Leaf.emit

Defined in

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

---

emitEvent

▸ emitEvent(_event?, _capture?): void

Parameters

Name	Type
_event?	IEvent
_capture?	boolean

Returns

void

Implementation of

IUI.emitEvent

Inherited from

Leaf.emitEvent

Defined in

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

---

hasEvent

▸ hasEvent(_type, _capture?): boolean

Parameters

Name	Type
_type	string
_capture?	boolean

Returns

boolean

Implementation of

IUI.hasEvent

Inherited from

Leaf.hasEvent

Defined in

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

---

changeAttr

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

Parameters

Name	Type
attrName	string
defaultValue	IValueFunction | IValue
fn?	IAttrDecorator

Returns

void

Inherited from

Leaf.changeAttr

Defined in

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

---

addAttr

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

Parameters

Name	Type
attrName	string
defaultValue	IValueFunction | IValue
fn?	IAttrDecorator
helpValue?	IValue

Returns

void

Inherited from

Leaf.addAttr

Defined in

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

---

__emitLifeEvent

▸ __emitLifeEvent(type): void

Parameters

Name	Type
type	string

Returns

void

Implementation of

IUI.__emitLifeEvent

Inherited from

Leaf.__emitLifeEvent

Defined in

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

---

reset

▸ reset(_data?): void

Parameters

Name	Type
_data?	IUIInputData

Returns

void

Implementation of

IUI.reset

Overrides

Leaf.reset

Defined in

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

---

set

▸ set(data, _transition?): void

Parameters

Name	Type
data	IUIInputData
_transition?	ITransition | "temp"

Returns

void

Implementation of

IUI.set

Overrides

Leaf.set

Defined in

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

---

get

▸ get<K>(name?): IUIInputData | UI<TInputData>[K]

Type parameters

Name	Type
K	extends keyof UI<TInputData>

Parameters

Name	Type
name?	IUIInputData | K | K[]

Returns

IUIInputData | UI<TInputData>[K]

Implementation of

IUI.get

Overrides

Leaf.get

Defined in

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

---

createProxyData

▸ createProxyData(): IUIInputData

Returns

IUIInputData

Implementation of

IUI.createProxyData

Defined in

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

---

clearProxyData

▸ clearProxyData(): void

Returns

void

Implementation of

IUI.clearProxyData

Defined in

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

---

find

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

Parameters

Name	Type
_condition	string | number | IFindCondition | IFindUIMethod
_options?	any

Returns

IUI[]

Implementation of

IUI.find

Overrides

Leaf.find

Defined in

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

---

findTag

▸ findTag(tag): IUI[]

Parameters

Name	Type
tag	string | string[]

Returns

IUI[]

Implementation of

IUI.findTag

Overrides

Leaf.findTag

Defined in

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

---

findOne

▸ findOne(_condition, _options?): IUI

Parameters

Name	Type
_condition	string | number | IFindCondition | IFindUIMethod
_options?	any

Returns

IUI

Implementation of

IUI.findOne

Overrides

Leaf.findOne

Defined in

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

---

findId

▸ findId(id): IUI

Parameters

Name	Type
id	string | number

Returns

IUI

Implementation of

IUI.findId

Overrides

Leaf.findId

Defined in

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

---

getPath

▸ getPath(curve?, pathForRender?): IPathCommandData

Parameters

Name	Type
curve?	boolean
pathForRender?	boolean

Returns

IPathCommandData

Implementation of

IUI.getPath

Defined in

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

---

getPathString

▸ getPathString(curve?, pathForRender?, floatLength?): string

Parameters

Name	Type
curve?	boolean
pathForRender?	boolean
floatLength?	number

Returns

string

Implementation of

IUI.getPathString

Defined in

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

---

asPath

▸ asPath(curve?, pathForRender?): void

Parameters

Name	Type
curve?	boolean
pathForRender?	boolean

Returns

void

Implementation of

IUI.asPath

Defined in

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

---

load

▸ load(): void

Returns

void

Implementation of

IUI.load

Defined in

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

---

__onUpdateSize

▸ __onUpdateSize(): void

Returns

void

Implementation of

IUI.__onUpdateSize

Overrides

Leaf.__onUpdateSize

Defined in

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

---

__updateRenderPath

▸ __updateRenderPath(updateCache?): void

Parameters

Name	Type
updateCache?	boolean

Returns

void

Implementation of

IUI.__updateRenderPath

Overrides

Leaf.__updateRenderPath

Defined in

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

---

__drawRenderPath

▸ __drawRenderPath(canvas): void

Parameters

Name	Type
canvas	ILeaferCanvas

Returns

void

Implementation of

IUI.__drawRenderPath

Overrides

Leaf.__drawRenderPath

Defined in

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

---

__drawPath

▸ __drawPath(canvas): void

Parameters

Name	Type
canvas	ILeaferCanvas

Returns

void

Implementation of

IUI.__drawPath

Overrides

Leaf.__drawPath

Defined in

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

---

__drawPathByData

▸ __drawPathByData(drawer, data, ignoreCornerRadius?): void

Parameters

Name	Type
drawer	IPathDrawer
data	IPathCommandData
ignoreCornerRadius?	boolean

Returns

void

Implementation of

IUI.__drawPathByData

Defined in

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

---

__drawPathByBox

▸ __drawPathByBox(drawer, ignoreCornerRadius?): void

Parameters

Name	Type
drawer	IPathDrawer
ignoreCornerRadius?	boolean

Returns

void

Implementation of

IUI.__drawPathByBox

Defined in

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

---

drawImagePlaceholder

▸ drawImagePlaceholder(_paint, canvas, renderOptions): void

Parameters

Name	Type
_paint	ILeafPaint
canvas	ILeaferCanvas
renderOptions	IRenderOptions

Returns

void

Implementation of

IUI.drawImagePlaceholder

Defined in

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

---

animate

▸ animate(keyframe?, _options?, _type?, _isTemp?): IAnimate

Parameters

Name	Type
keyframe?	IAnimation | IUIInputData | IKeyframe[] | IAnimation[]
_options?	ITransition
_type?	IAnimateType
_isTemp?	boolean

Returns

IAnimate

Implementation of

IUI.animate

Defined in

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

---

killAnimate

▸ killAnimate(_type?, _nextStyle?): void

Parameters

Name	Type
_type?	IAnimateType
_nextStyle?	IUIInputData

Returns

void

Implementation of

IUI.killAnimate

Defined in

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

---

export

▸ export(_filename, _options?): Promise<IExportResult>

Parameters

Name	Type
_filename	string
_options?	number | boolean | IExportOptions

Returns

Promise<IExportResult>

Implementation of

IUI.export

Defined in

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

---

syncExport

▸ syncExport(_filename, _options?): IExportResult

Parameters

Name	Type
_filename	string
_options?	number | boolean | IExportOptions

Returns

IExportResult

Implementation of

IUI.syncExport

Defined in

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

---

clone

▸ clone(data?): this

Parameters

Name	Type
data?	IUIInputData

Returns

this

Implementation of

IUI.clone

Defined in

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

---

one

▸ one<T>(this, data, x?, y?, width?, height?): T

Type parameters

Name	Type
T	extends UI<IUIInputData>

Parameters

Name	Type
this	(...args: any[]) => T
data	IUIInputData
x?	number
y?	number
width?	number
height?	number

Returns

T

Defined in

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

---

registerUI

▸ registerUI(): void

Returns

void

Defined in

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

---

registerData

▸ registerData(data): void

Parameters

Name	Type
data	IUIData

Returns

void

Defined in

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

---

setEditConfig

▸ setEditConfig(_config): void

Parameters

Name	Type
_config	IEditorConfig | IEditorConfigFunction

Returns

void

Defined in

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

---

setEditOuter

▸ setEditOuter(_toolName): void

Parameters

Name	Type
_toolName	string | IEditToolFunction

Returns

void

Defined in

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

---

setEditInner

▸ setEditInner(_editorName): void

Parameters

Name	Type
_editorName	string | IEditToolFunction

Returns

void

Defined in

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

---

destroy

▸ destroy(): void

Returns

void

Implementation of

IUI.destroy

Overrides

Leaf.destroy

Defined in

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