Skip to content

Class: Group

Hierarchy

Implements

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new Group(data?): Group

Parameters

NameType
data?IGroupInputData

Returns

Group

Overrides

UI.constructor

Defined in

ui/packages/display/src/Group.ts:23

Properties

innerId

Readonly innerId: number

Implementation of

IGroup.innerId

Inherited from

UI.innerId

Defined in

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


syncEventer

Optional syncEventer: ILeaf

Implementation of

IGroup.syncEventer

Inherited from

UI.syncEventer

Defined in

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


lockNormalStyle

Optional lockNormalStyle: boolean

Implementation of

IGroup.lockNormalStyle

Inherited from

UI.lockNormalStyle

Defined in

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


__layout

__layout: ILeafLayout

Implementation of

IGroup.__layout

Inherited from

UI.__layout

Defined in

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


__world

__world: IMatrixWithBoundsScaleData

Implementation of

IGroup.__world

Inherited from

UI.__world

Defined in

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


__local

Optional __local: IMatrixWithBoundsData

Implementation of

IGroup.__local

Inherited from

UI.__local

Defined in

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


__nowWorld

Optional __nowWorld: IMatrixWithBoundsScaleData

Implementation of

IGroup.__nowWorld

Inherited from

UI.__nowWorld

Defined in

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


__cameraWorld

Optional __cameraWorld: IMatrixWithBoundsScaleData

Implementation of

IGroup.__cameraWorld

Inherited from

UI.__cameraWorld

Defined in

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


__worldOpacity

__worldOpacity: number

Implementation of

IGroup.__worldOpacity

Inherited from

UI.__worldOpacity

Defined in

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


__level

__level: number

Implementation of

IGroup.__level

Inherited from

UI.__level

Defined in

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


__tempNumber

__tempNumber: number

Implementation of

IGroup.__tempNumber

Inherited from

UI.__tempNumber

Defined in

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


__hasAutoLayout

Optional __hasAutoLayout: boolean

Implementation of

IGroup.__hasAutoLayout

Inherited from

UI.__hasAutoLayout

Defined in

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


__hasMask

Optional __hasMask: boolean

Implementation of

IGroup.__hasMask

Inherited from

UI.__hasMask

Defined in

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


__hasEraser

Optional __hasEraser: boolean

Implementation of

IGroup.__hasEraser

Inherited from

UI.__hasEraser

Defined in

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


__hitCanvas

Optional __hitCanvas: IHitCanvas

Implementation of

IGroup.__hitCanvas

Inherited from

UI.__hitCanvas

Defined in

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


__captureMap

Optional __captureMap: IEventListenerMap

Implementation of

IGroup.__captureMap

Inherited from

UI.__captureMap

Defined in

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


__bubbleMap

Optional __bubbleMap: IEventListenerMap

Implementation of

IGroup.__bubbleMap

Inherited from

UI.__bubbleMap

Defined in

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


noBounds

Optional noBounds: boolean

Implementation of

IGroup.noBounds

Inherited from

UI.noBounds

Defined in

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


destroyed

destroyed: boolean

Implementation of

IGroup.destroyed

Inherited from

UI.destroyed

Defined in

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


__

__: IGroupData

Implementation of

IGroup.__

Overrides

UI.__

Defined in

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


children

children: IUI[]

Implementation of

IGroup.children

Overrides

UI.children

Defined in

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


proxyData

Optional proxyData: IUIInputData

Implementation of

IGroup.proxyData

Inherited from

UI.proxyData

Defined in

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


__proxyData

Optional __proxyData: IUIInputData

Implementation of

IGroup.__proxyData

Inherited from

UI.__proxyData

Defined in

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


leafer

Optional leafer: ILeafer

Implementation of

IGroup.leafer

Inherited from

UI.leafer

Defined in

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


parent

Optional parent: IGroup

Implementation of

IGroup.parent

Inherited from

UI.parent

Defined in

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


zoomLayer

zoomLayer: IGroup

Implementation of

IGroup.zoomLayer

Inherited from

UI.zoomLayer

Defined in

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


id

Optional id: string

Implementation of

IGroup.id

Inherited from

UI.id

Defined in

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


name

Optional name: string

Implementation of

IGroup.name

Inherited from

UI.name

Defined in

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


className

Optional className: string

Implementation of

IGroup.className

Inherited from

UI.className

Defined in

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


blendMode

Optional blendMode: IBlendMode

Implementation of

IGroup.blendMode

Inherited from

UI.blendMode

Defined in

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


opacity

Optional opacity: number

Implementation of

IGroup.opacity

Inherited from

UI.opacity

Defined in

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


visible

Optional visible: boolean | 0

Implementation of

IGroup.visible

Inherited from

UI.visible

Defined in

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


locked

Optional locked: boolean

Implementation of

IGroup.locked

Inherited from

UI.locked

Defined in

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


zIndex

Optional zIndex: number

Implementation of

IGroup.zIndex

Inherited from

UI.zIndex

Defined in

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


mask

Optional mask: boolean | IMaskType

Implementation of

IGroup.mask

Inherited from

UI.mask

Defined in

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


eraser

Optional eraser: boolean | IEraserType

Implementation of

IGroup.eraser

Inherited from

UI.eraser

Defined in

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


x

Optional x: number

Implementation of

IGroup.x

Inherited from

UI.x

Defined in

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


y

Optional y: number

Implementation of

IGroup.y

Inherited from

UI.y

Defined in

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


width

Optional width: number

Implementation of

IGroup.width

Inherited from

UI.width

Defined in

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


height

Optional height: number

Implementation of

IGroup.height

Inherited from

UI.height

Defined in

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


scaleX

Optional scaleX: number

Implementation of

IGroup.scaleX

Inherited from

UI.scaleX

Defined in

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


scaleY

Optional scaleY: number

Implementation of

IGroup.scaleY

Inherited from

UI.scaleY

Defined in

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


rotation

Optional rotation: number

Implementation of

IGroup.rotation

Inherited from

UI.rotation

Defined in

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


skewX

Optional skewX: number

Implementation of

IGroup.skewX

Inherited from

UI.skewX

Defined in

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


skewY

Optional skewY: number

Implementation of

IGroup.skewY

Inherited from

UI.skewY

Defined in

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


offsetX

Optional offsetX: number

Implementation of

IGroup.offsetX

Inherited from

UI.offsetX

Defined in

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


offsetY

Optional offsetY: number

Implementation of

IGroup.offsetY

Inherited from

UI.offsetY

Defined in

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


scrollX

Optional scrollX: number

Implementation of

IGroup.scrollX

Inherited from

UI.scrollX

Defined in

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


scrollY

Optional scrollY: number

Implementation of

IGroup.scrollY

Inherited from

UI.scrollY

Defined in

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


origin

Optional origin: IUnitPointData | IDirection

Implementation of

IGroup.origin

Inherited from

UI.origin

Defined in

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


around

Optional around: IUnitPointData | IDirection

Implementation of

IGroup.around

Inherited from

UI.around

Defined in

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


lazy

Optional lazy: boolean

Implementation of

IGroup.lazy

Inherited from

UI.lazy

Defined in

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


pixelRatio

Optional pixelRatio: number

Implementation of

IGroup.pixelRatio

Inherited from

UI.pixelRatio

Defined in

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


path

Optional path: string | IPathCommandData

Implementation of

IGroup.path

Inherited from

UI.path

Defined in

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


windingRule

Optional windingRule: IWindingRule

Implementation of

IGroup.windingRule

Inherited from

UI.windingRule

Defined in

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


closed

Optional closed: boolean

Implementation of

IGroup.closed

Inherited from

UI.closed

Defined in

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


flow

Optional flow: IFlowType

Implementation of

IGroup.flow

Inherited from

UI.flow

Defined in

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


padding

Optional padding: IFourNumber

Implementation of

IGroup.padding

Inherited from

UI.padding

Defined in

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


gap

Optional gap: IGap | IPointGap

Implementation of

IGroup.gap

Inherited from

UI.gap

Defined in

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


flowAlign

Optional flowAlign: IFlowAxisAlign | IFlowAlign

Implementation of

IGroup.flowAlign

Inherited from

UI.flowAlign

Defined in

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


flowWrap

Optional flowWrap: IFlowWrap

Implementation of

IGroup.flowWrap

Inherited from

UI.flowWrap

Defined in

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


itemBox

Optional itemBox: IFlowBoxType

Implementation of

IGroup.itemBox

Inherited from

UI.itemBox

Defined in

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


inFlow

Optional inFlow: boolean

Implementation of

IGroup.inFlow

Inherited from

UI.inFlow

Defined in

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


autoWidth

Optional autoWidth: IAutoSize

Implementation of

IGroup.autoWidth

Inherited from

UI.autoWidth

Defined in

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


autoHeight

Optional autoHeight: IAutoSize

Implementation of

IGroup.autoHeight

Inherited from

UI.autoHeight

Defined in

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


lockRatio

Optional lockRatio: boolean

Implementation of

IGroup.lockRatio

Inherited from

UI.lockRatio

Defined in

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


autoBox

Optional autoBox: IAutoBoxData | IConstraint

Implementation of

IGroup.autoBox

Inherited from

UI.autoBox

Defined in

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


widthRange

Optional widthRange: IRangeSize

Implementation of

IGroup.widthRange

Inherited from

UI.widthRange

Defined in

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


heightRange

Optional heightRange: IRangeSize

Implementation of

IGroup.heightRange

Inherited from

UI.heightRange

Defined in

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


draggable

Optional draggable: boolean | IAxis

Implementation of

IGroup.draggable

Inherited from

UI.draggable

Defined in

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


dragBounds

Optional dragBounds: "parent" | IBoundsData

Implementation of

IGroup.dragBounds

Inherited from

UI.dragBounds

Defined in

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


editable

Optional editable: boolean

Implementation of

IGroup.editable

Inherited from

UI.editable

Defined in

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


hittable

Optional hittable: boolean

Implementation of

IGroup.hittable

Inherited from

UI.hittable

Defined in

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


hitFill

Optional hitFill: IHitType

Implementation of

IGroup.hitFill

Inherited from

UI.hitFill

Defined in

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


hitStroke

Optional hitStroke: IHitType

Implementation of

IGroup.hitStroke

Inherited from

UI.hitStroke

Defined in

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


hitBox

Optional hitBox: boolean

Implementation of

IGroup.hitBox

Inherited from

UI.hitBox

Defined in

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


hitChildren

Optional hitChildren: boolean

Implementation of

IGroup.hitChildren

Inherited from

UI.hitChildren

Defined in

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


hitSelf

Optional hitSelf: boolean

Implementation of

IGroup.hitSelf

Inherited from

UI.hitSelf

Defined in

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


hitRadius

Optional hitRadius: number

Implementation of

IGroup.hitRadius

Inherited from

UI.hitRadius

Defined in

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


cursor

Optional cursor: ICursorType | ICursorType[]

Implementation of

IGroup.cursor

Inherited from

UI.cursor

Defined in

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


fill

Optional fill: IFill

Implementation of

IGroup.fill

Inherited from

UI.fill

Defined in

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


stroke

Optional stroke: IStroke

Implementation of

IGroup.stroke

Inherited from

UI.stroke

Defined in

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


strokeAlign

Optional strokeAlign: IStrokeAlign

Implementation of

IGroup.strokeAlign

Inherited from

UI.strokeAlign

Defined in

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


strokeWidth

Optional strokeWidth: string | IFourNumber

Implementation of

IGroup.strokeWidth

Inherited from

UI.strokeWidth

Defined in

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


strokeWidthFixed

Optional strokeWidthFixed: boolean

Implementation of

IGroup.strokeWidthFixed

Inherited from

UI.strokeWidthFixed

Defined in

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


strokeCap

Optional strokeCap: IStrokeCap

Implementation of

IGroup.strokeCap

Inherited from

UI.strokeCap

Defined in

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


strokeJoin

Optional strokeJoin: IStrokeJoin

Implementation of

IGroup.strokeJoin

Inherited from

UI.strokeJoin

Defined in

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


dashPattern

Optional dashPattern: string | number[]

Implementation of

IGroup.dashPattern

Inherited from

UI.dashPattern

Defined in

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


dashOffset

Optional dashOffset: number

Implementation of

IGroup.dashOffset

Inherited from

UI.dashOffset

Defined in

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


miterLimit

Optional miterLimit: number

Implementation of

IGroup.miterLimit

Inherited from

UI.miterLimit

Defined in

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


startArrow

Optional startArrow: IArrowType

Implementation of

IGroup.startArrow

Inherited from

UI.startArrow

Defined in

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


endArrow

Optional endArrow: IArrowType

Implementation of

IGroup.endArrow

Inherited from

UI.endArrow

Defined in

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


cornerRadius

Optional cornerRadius: string | IFourNumber

Implementation of

IGroup.cornerRadius

Inherited from

UI.cornerRadius

Defined in

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


cornerSmoothing

Optional cornerSmoothing: number

Implementation of

IGroup.cornerSmoothing

Inherited from

UI.cornerSmoothing

Defined in

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


shadow

Optional shadow: string | IShadowEffect | IShadowEffect[]

Implementation of

IGroup.shadow

Inherited from

UI.shadow

Defined in

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


innerShadow

Optional innerShadow: string | IShadowEffect | IShadowEffect[]

Implementation of

IGroup.innerShadow

Inherited from

UI.innerShadow

Defined in

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


blur

Optional blur: number | IBlurEffect

Implementation of

IGroup.blur

Inherited from

UI.blur

Defined in

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


backgroundBlur

Optional backgroundBlur: number | IBlurEffect

Implementation of

IGroup.backgroundBlur

Inherited from

UI.backgroundBlur

Defined in

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


grayscale

Optional grayscale: number | IGrayscaleEffect

Implementation of

IGroup.grayscale

Inherited from

UI.grayscale

Defined in

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


animation

Optional animation: IAnimation

Implementation of

IGroup.animation

Inherited from

UI.animation

Defined in

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


animationOut

Optional animationOut: IAnimation

Implementation of

IGroup.animationOut

Inherited from

UI.animationOut

Defined in

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


transition

Optional transition: ITransition

Implementation of

IGroup.transition

Inherited from

UI.transition

Defined in

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


transitionOut

Optional transitionOut: ITransition

Implementation of

IGroup.transitionOut

Inherited from

UI.transitionOut

Defined in

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


motionPath

Optional motionPath: boolean

Implementation of

IGroup.motionPath

Inherited from

UI.motionPath

Defined in

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


motion

Optional motion: number | IUnitData

Implementation of

IGroup.motion

Inherited from

UI.motion

Defined in

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


motionRotation

Optional motionRotation: number | boolean

Implementation of

IGroup.motionRotation

Inherited from

UI.motionRotation

Defined in

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


states

Optional states: IStates

Implementation of

IGroup.states

Inherited from

UI.states

Defined in

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


state

Optional state: string

Implementation of

IGroup.state

Inherited from

UI.state

Defined in

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


selected

Optional selected: boolean

Implementation of

IGroup.selected

Inherited from

UI.selected

Defined in

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


disabled

Optional disabled: boolean

Implementation of

IGroup.disabled

Inherited from

UI.disabled

Defined in

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


normalStyle

Optional normalStyle: IUIInputData

Implementation of

IGroup.normalStyle

Inherited from

UI.normalStyle

Defined in

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


hoverStyle

Optional hoverStyle: IUIInputData

Implementation of

IGroup.hoverStyle

Inherited from

UI.hoverStyle

Defined in

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


pressStyle

Optional pressStyle: IUIInputData

Implementation of

IGroup.pressStyle

Inherited from

UI.pressStyle

Defined in

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


focusStyle

Optional focusStyle: IUIInputData

Implementation of

IGroup.focusStyle

Inherited from

UI.focusStyle

Defined in

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


selectedStyle

Optional selectedStyle: IUIInputData

Implementation of

IGroup.selectedStyle

Inherited from

UI.selectedStyle

Defined in

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


disabledStyle

Optional disabledStyle: IUIInputData

Implementation of

IGroup.disabledStyle

Inherited from

UI.disabledStyle

Defined in

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


button

Optional button: boolean

Implementation of

IGroup.button

Inherited from

UI.button

Defined in

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


data

data: IObject

Implementation of

IGroup.data

Inherited from

UI.data

Defined in

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


__animate

Optional __animate: IAnimate

Implementation of

IGroup.__animate

Inherited from

UI.__animate

Defined in

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

Accessors

tag

get tag(): string

Returns

string

Implementation of

IGroup.tag

Inherited from

UI.tag

Defined in

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

set tag(_value): void

Parameters

NameType
_valuestring

Returns

void

Implementation of

IGroup.tag

Inherited from

UI.tag

Defined in

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


innerName

get innerName(): string

Returns

string

Implementation of

IGroup.innerName

Inherited from

UI.innerName

Defined in

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


__DataProcessor

get __DataProcessor(): typeof LeafData

Returns

typeof LeafData

Implementation of

IGroup.__DataProcessor

Inherited from

UI.__DataProcessor

Defined in

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


__LayoutProcessor

get __LayoutProcessor(): typeof LeafLayout

Returns

typeof LeafLayout

Implementation of

IGroup.__LayoutProcessor

Inherited from

UI.__LayoutProcessor

Defined in

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


leaferIsCreated

get leaferIsCreated(): boolean

Returns

boolean

Implementation of

IGroup.leaferIsCreated

Inherited from

UI.leaferIsCreated

Defined in

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


leaferIsReady

get leaferIsReady(): boolean

Returns

boolean

Implementation of

IGroup.leaferIsReady

Inherited from

UI.leaferIsReady

Defined in

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


isLeafer

get isLeafer(): boolean

Returns

boolean

Implementation of

IGroup.isLeafer

Inherited from

UI.isLeafer

Defined in

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


isBranchLeaf

get isBranchLeaf(): boolean

Returns

boolean

Implementation of

IGroup.isBranchLeaf

Inherited from

UI.isBranchLeaf

Defined in

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


__localMatrix

get __localMatrix(): IMatrixData

Returns

IMatrixData

Implementation of

IGroup.__localMatrix

Inherited from

UI.__localMatrix

Defined in

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


__localBoxBounds

get __localBoxBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IGroup.__localBoxBounds

Inherited from

UI.__localBoxBounds

Defined in

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


worldTransform

get worldTransform(): IMatrixWithScaleData

Returns

IMatrixWithScaleData

Implementation of

IGroup.worldTransform

Inherited from

UI.worldTransform

Defined in

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


localTransform

get localTransform(): IMatrixData

Returns

IMatrixData

Implementation of

IGroup.localTransform

Inherited from

UI.localTransform

Defined in

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


boxBounds

get boxBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IGroup.boxBounds

Inherited from

UI.boxBounds

Defined in

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


renderBounds

get renderBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IGroup.renderBounds

Inherited from

UI.renderBounds

Defined in

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


worldBoxBounds

get worldBoxBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IGroup.worldBoxBounds

Inherited from

UI.worldBoxBounds

Defined in

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


worldStrokeBounds

get worldStrokeBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IGroup.worldStrokeBounds

Inherited from

UI.worldStrokeBounds

Defined in

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


worldRenderBounds

get worldRenderBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IGroup.worldRenderBounds

Inherited from

UI.worldRenderBounds

Defined in

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


worldOpacity

get worldOpacity(): number

Returns

number

Implementation of

IGroup.worldOpacity

Inherited from

UI.worldOpacity

Defined in

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


__worldFlipped

get __worldFlipped(): boolean

Returns

boolean

Implementation of

IGroup.__worldFlipped

Inherited from

UI.__worldFlipped

Defined in

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


__onlyHitMask

get __onlyHitMask(): boolean

Returns

boolean

Implementation of

IGroup.__onlyHitMask

Inherited from

UI.__onlyHitMask

Defined in

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


__ignoreHitWorld

get __ignoreHitWorld(): boolean

Returns

boolean

Implementation of

IGroup.__ignoreHitWorld

Inherited from

UI.__ignoreHitWorld

Defined in

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


__inLazyBounds

get __inLazyBounds(): boolean

Returns

boolean

Implementation of

IGroup.__inLazyBounds

Inherited from

UI.__inLazyBounds

Defined in

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


pathInputed

get pathInputed(): boolean

Returns

boolean

Implementation of

IGroup.pathInputed

Inherited from

UI.pathInputed

Defined in

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


event

set event(map): void

Parameters

NameType
mapIEventMap

Returns

void

Implementation of

IGroup.event

Inherited from

UI.event

Defined in

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


__tag

get __tag(): string

Returns

string

Implementation of

IGroup.__tag

Overrides

UI.__tag

Defined in

ui/packages/display/src/Group.ts:14


isBranch

get isBranch(): boolean

Returns

boolean

Implementation of

IGroup.isBranch

Overrides

UI.isBranch

Defined in

ui/packages/display/src/Group.ts:16


app

get app(): ILeafer

Returns

ILeafer

Implementation of

IGroup.app

Inherited from

UI.app

Defined in

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


isFrame

get isFrame(): boolean

Returns

boolean

Implementation of

IGroup.isFrame

Inherited from

UI.isFrame

Defined in

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


scale

get scale(): number | IPointData

Returns

number | IPointData

Implementation of

IGroup.scale

Inherited from

UI.scale

Defined in

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

set scale(value): void

Parameters

NameType
valuenumber | IPointData

Returns

void

Implementation of

IGroup.scale

Inherited from

UI.scale

Defined in

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


pen

get pen(): IPathCreator

Returns

IPathCreator

Implementation of

IGroup.pen

Inherited from

UI.pen

Defined in

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


editConfig

get editConfig(): IEditorConfig

Returns

IEditorConfig

Implementation of

IGroup.editConfig

Inherited from

UI.editConfig

Defined in

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


editOuter

get editOuter(): string

Returns

string

Implementation of

IGroup.editOuter

Inherited from

UI.editOuter

Defined in

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


editInner

get editInner(): string

Returns

string

Implementation of

IGroup.editInner

Inherited from

UI.editInner

Defined in

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

Methods

resetCustom

resetCustom(): void

Returns

void

Implementation of

IGroup.resetCustom

Inherited from

UI.resetCustom

Defined in

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


waitParent

waitParent(item, bind?): void

Parameters

NameType
itemIFunction
bind?IObject

Returns

void

Implementation of

IGroup.waitParent

Inherited from

UI.waitParent

Defined in

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


waitLeafer

waitLeafer(item, bind?): void

Parameters

NameType
itemIFunction
bind?IObject

Returns

void

Implementation of

IGroup.waitLeafer

Inherited from

UI.waitLeafer

Defined in

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


nextRender

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

Parameters

NameType
itemIFunction
bind?IObject
off?"off"

Returns

void

Implementation of

IGroup.nextRender

Inherited from

UI.nextRender

Defined in

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


removeNextRender

removeNextRender(item): void

Parameters

NameType
itemIFunction

Returns

void

Implementation of

IGroup.removeNextRender

Inherited from

UI.removeNextRender

Defined in

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


__bindLeafer

__bindLeafer(leafer): void

Parameters

NameType
leaferILeaferBase

Returns

void

Implementation of

IGroup.__bindLeafer

Inherited from

UI.__bindLeafer

Defined in

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


setAttr

setAttr(name, value): void

Parameters

NameType
namestring
valueany

Returns

void

Implementation of

IGroup.setAttr

Inherited from

UI.setAttr

Defined in

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


getAttr

getAttr(name): any

Parameters

NameType
namestring

Returns

any

Implementation of

IGroup.getAttr

Inherited from

UI.getAttr

Defined in

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


getComputedAttr

getComputedAttr(name): any

Parameters

NameType
namestring

Returns

any

Implementation of

IGroup.getComputedAttr

Inherited from

UI.getComputedAttr

Defined in

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


toString

toString(options?): string

Parameters

NameType
options?IJSONOptions

Returns

string

Implementation of

IGroup.toString

Inherited from

UI.toString

Defined in

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


toSVG

toSVG(): string

Returns

string

Implementation of

IGroup.toSVG

Inherited from

UI.toSVG

Defined in

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


__SVG

__SVG(_data): void

Parameters

NameType
_dataIObject

Returns

void

Implementation of

IGroup.__SVG

Inherited from

UI.__SVG

Defined in

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


toHTML

toHTML(): string

Returns

string

Implementation of

IGroup.toHTML

Inherited from

UI.toHTML

Defined in

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


__setAttr

__setAttr(_attrName, _newValue): boolean

Parameters

NameType
_attrNamestring
_newValueIValue

Returns

boolean

Implementation of

IGroup.__setAttr

Inherited from

UI.__setAttr

Defined in

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


__getAttr

__getAttr(_attrName): IValue

Parameters

NameType
_attrNamestring

Returns

IValue

Implementation of

IGroup.__getAttr

Inherited from

UI.__getAttr

Defined in

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


setProxyAttr

setProxyAttr(_attrName, _newValue): void

Parameters

NameType
_attrNamestring
_newValueIValue

Returns

void

Implementation of

IGroup.setProxyAttr

Inherited from

UI.setProxyAttr

Defined in

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


getProxyAttr

getProxyAttr(_attrName): IValue

Parameters

NameType
_attrNamestring

Returns

IValue

Implementation of

IGroup.getProxyAttr

Inherited from

UI.getProxyAttr

Defined in

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


focus

focus(_value?): void

Parameters

NameType
_value?boolean

Returns

void

Implementation of

IGroup.focus

Inherited from

UI.focus

Defined in

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


updateState

updateState(): void

Returns

void

Implementation of

IGroup.updateState

Inherited from

UI.updateState

Defined in

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


updateLayout

updateLayout(): void

Returns

void

Implementation of

IGroup.updateLayout

Inherited from

UI.updateLayout

Defined in

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


forceUpdate

forceUpdate(attrName?): void

Parameters

NameType
attrName?string

Returns

void

Implementation of

IGroup.forceUpdate

Inherited from

UI.forceUpdate

Defined in

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


forceRender

forceRender(_bounds?): void

Parameters

NameType
_bounds?IBoundsData

Returns

void

Implementation of

IGroup.forceRender

Inherited from

UI.forceRender

Defined in

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


__updateWorldMatrix

__updateWorldMatrix(): void

Returns

void

Implementation of

IGroup.__updateWorldMatrix

Inherited from

UI.__updateWorldMatrix

Defined in

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


__updateLocalMatrix

__updateLocalMatrix(): void

Returns

void

Implementation of

IGroup.__updateLocalMatrix

Inherited from

UI.__updateLocalMatrix

Defined in

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


__updateWorldBounds

__updateWorldBounds(): void

Returns

void

Implementation of

IGroup.__updateWorldBounds

Inherited from

UI.__updateWorldBounds

Defined in

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


__updateLocalBounds

__updateLocalBounds(): void

Returns

void

Implementation of

IGroup.__updateLocalBounds

Inherited from

UI.__updateLocalBounds

Defined in

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


__updateLocalBoxBounds

__updateLocalBoxBounds(): void

Returns

void

Implementation of

IGroup.__updateLocalBoxBounds

Inherited from

UI.__updateLocalBoxBounds

Defined in

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


__updateLocalStrokeBounds

__updateLocalStrokeBounds(): void

Returns

void

Implementation of

IGroup.__updateLocalStrokeBounds

Inherited from

UI.__updateLocalStrokeBounds

Defined in

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


__updateLocalRenderBounds

__updateLocalRenderBounds(): void

Returns

void

Implementation of

IGroup.__updateLocalRenderBounds

Inherited from

UI.__updateLocalRenderBounds

Defined in

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


__updateBoxBounds

__updateBoxBounds(): void

Returns

void

Implementation of

IGroup.__updateBoxBounds

Inherited from

UI.__updateBoxBounds

Defined in

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


__updateContentBounds

__updateContentBounds(): void

Returns

void

Implementation of

IGroup.__updateContentBounds

Inherited from

UI.__updateContentBounds

Defined in

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


__updateStrokeBounds

__updateStrokeBounds(): void

Returns

void

Implementation of

IGroup.__updateStrokeBounds

Inherited from

UI.__updateStrokeBounds

Defined in

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


__updateRenderBounds

__updateRenderBounds(): void

Returns

void

Implementation of

IGroup.__updateRenderBounds

Inherited from

UI.__updateRenderBounds

Defined in

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


__updateAutoLayout

__updateAutoLayout(): void

Returns

void

Implementation of

IGroup.__updateAutoLayout

Inherited from

UI.__updateAutoLayout

Defined in

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


__updateFlowLayout

__updateFlowLayout(): void

Returns

void

Implementation of

IGroup.__updateFlowLayout

Inherited from

UI.__updateFlowLayout

Defined in

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


__updateNaturalSize

__updateNaturalSize(): void

Returns

void

Implementation of

IGroup.__updateNaturalSize

Inherited from

UI.__updateNaturalSize

Defined in

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


__updateStrokeSpread

__updateStrokeSpread(): number

Returns

number

Implementation of

IGroup.__updateStrokeSpread

Inherited from

UI.__updateStrokeSpread

Defined in

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


__updateRenderSpread

__updateRenderSpread(): number

Returns

number

Implementation of

IGroup.__updateRenderSpread

Inherited from

UI.__updateRenderSpread

Defined in

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


__updateEraser

__updateEraser(value?): void

Parameters

NameType
value?boolean

Returns

void

Implementation of

IGroup.__updateEraser

Inherited from

UI.__updateEraser

Defined in

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


__renderEraser

__renderEraser(canvas, options): void

Parameters

NameType
canvasILeaferCanvas
optionsIRenderOptions

Returns

void

Implementation of

IGroup.__renderEraser

Inherited from

UI.__renderEraser

Defined in

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


__updateMask

__updateMask(value?): void

Parameters

NameType
value?boolean

Returns

void

Implementation of

IGroup.__updateMask

Inherited from

UI.__updateMask

Defined in

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


__renderMask

__renderMask(_canvas, _options): void

Parameters

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns

void

Implementation of

IGroup.__renderMask

Inherited from

UI.__renderMask

Defined in

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


__getNowWorld

__getNowWorld(options): IMatrixWithBoundsScaleData

Parameters

NameType
optionsIRenderOptions

Returns

IMatrixWithBoundsScaleData

Implementation of

IGroup.__getNowWorld

Inherited from

UI.__getNowWorld

Defined in

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


getTransform

getTransform(relative?): IMatrixData

Parameters

NameType
relative?ILeaf | ILocationType

Returns

IMatrixData

Implementation of

IGroup.getTransform

Inherited from

UI.getTransform

Defined in

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


getBounds

getBounds(type?, relative?): IBoundsData

Parameters

NameType
type?IBoundsType
relative?ILeaf | ILocationType

Returns

IBoundsData

Implementation of

IGroup.getBounds

Inherited from

UI.getBounds

Defined in

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


getLayoutBounds

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

Parameters

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

Returns

ILayoutBoundsData

Implementation of

IGroup.getLayoutBounds

Inherited from

UI.getLayoutBounds

Defined in

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


getLayoutPoints

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

Parameters

NameType
type?IBoundsType
relative?ILeaf | ILocationType

Returns

IPointData[]

Implementation of

IGroup.getLayoutPoints

Inherited from

UI.getLayoutPoints

Defined in

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


getWorldBounds

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

Parameters

NameType
innerIBoundsData
relative?ILeaf
change?boolean

Returns

IBoundsData

Implementation of

IGroup.getWorldBounds

Inherited from

UI.getWorldBounds

Defined in

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


worldToLocal

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

Parameters

NameType
worldIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns

void

Implementation of

IGroup.worldToLocal

Inherited from

UI.worldToLocal

Defined in

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


localToWorld

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

Parameters

NameType
localIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns

void

Implementation of

IGroup.localToWorld

Inherited from

UI.localToWorld

Defined in

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


worldToInner

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

Parameters

NameType
worldIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns

void

Implementation of

IGroup.worldToInner

Inherited from

UI.worldToInner

Defined in

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


innerToWorld

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

Parameters

NameType
innerIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns

void

Implementation of

IGroup.innerToWorld

Inherited from

UI.innerToWorld

Defined in

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


getBoxPoint

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

Parameters

NameType
worldIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IGroup.getBoxPoint

Inherited from

UI.getBoxPoint

Defined in

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


getBoxPointByInner

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

Parameters

NameType
innerIPointData
_relative?ILeaf
_distance?boolean
change?boolean

Returns

IPointData

Implementation of

IGroup.getBoxPointByInner

Inherited from

UI.getBoxPointByInner

Defined in

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


getInnerPoint

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

Parameters

NameType
worldIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IGroup.getInnerPoint

Inherited from

UI.getInnerPoint

Defined in

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


getInnerPointByBox

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

Parameters

NameType
boxIPointData
_relative?ILeaf
_distance?boolean
change?boolean

Returns

IPointData

Implementation of

IGroup.getInnerPointByBox

Inherited from

UI.getInnerPointByBox

Defined in

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


getInnerPointByLocal

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

Parameters

NameType
localIPointData
_relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IGroup.getInnerPointByLocal

Inherited from

UI.getInnerPointByLocal

Defined in

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


getLocalPoint

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

Parameters

NameType
worldIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IGroup.getLocalPoint

Inherited from

UI.getLocalPoint

Defined in

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


getLocalPointByInner

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

Parameters

NameType
innerIPointData
_relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IGroup.getLocalPointByInner

Inherited from

UI.getLocalPointByInner

Defined in

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


getPagePoint

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

Parameters

NameType
worldIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IGroup.getPagePoint

Inherited from

UI.getPagePoint

Defined in

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


getWorldPoint

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

Parameters

NameType
innerIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IGroup.getWorldPoint

Inherited from

UI.getWorldPoint

Defined in

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


getWorldPointByBox

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

Parameters

NameType
boxIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IGroup.getWorldPointByBox

Inherited from

UI.getWorldPointByBox

Defined in

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


getWorldPointByLocal

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

Parameters

NameType
localIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IGroup.getWorldPointByLocal

Inherited from

UI.getWorldPointByLocal

Defined in

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


getWorldPointByPage

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

Parameters

NameType
pageIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IGroup.getWorldPointByPage

Inherited from

UI.getWorldPointByPage

Defined in

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


setTransform

setTransform(matrix, resize?): void

Parameters

NameType
matrixIMatrixData
resize?boolean

Returns

void

Implementation of

IGroup.setTransform

Inherited from

UI.setTransform

Defined in

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


transform

transform(matrix, resize?): void

Parameters

NameType
matrixIMatrixData
resize?boolean

Returns

void

Implementation of

IGroup.transform

Inherited from

UI.transform

Defined in

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


move

move(x, y?): void

Parameters

NameType
xnumber | IPointData
y?number

Returns

void

Implementation of

IGroup.move

Inherited from

UI.move

Defined in

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


moveInner

moveInner(x, y?): void

Parameters

NameType
xnumber | IPointData
y?number

Returns

void

Implementation of

IGroup.moveInner

Inherited from

UI.moveInner

Defined in

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


scaleOf

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

Parameters

NameType
originIPointData | IDirection
scaleXnumber
scaleY?number
resize?boolean

Returns

void

Implementation of

IGroup.scaleOf

Inherited from

UI.scaleOf

Defined in

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


rotateOf

rotateOf(origin, rotation): void

Parameters

NameType
originIPointData | IDirection
rotationnumber

Returns

void

Implementation of

IGroup.rotateOf

Inherited from

UI.rotateOf

Defined in

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


skewOf

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

Parameters

NameType
originIPointData | IDirection
skewXnumber
skewY?number
resize?boolean

Returns

void

Implementation of

IGroup.skewOf

Inherited from

UI.skewOf

Defined in

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


transformWorld

transformWorld(worldTransform?, resize?): void

Parameters

NameType
worldTransform?IMatrixData
resize?boolean

Returns

void

Implementation of

IGroup.transformWorld

Inherited from

UI.transformWorld

Defined in

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


moveWorld

moveWorld(x, y?): void

Parameters

NameType
xnumber | IPointData
y?number

Returns

void

Implementation of

IGroup.moveWorld

Inherited from

UI.moveWorld

Defined in

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


scaleOfWorld

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

Parameters

NameType
worldOriginIPointData
scaleXnumber
scaleY?number
resize?boolean

Returns

void

Implementation of

IGroup.scaleOfWorld

Inherited from

UI.scaleOfWorld

Defined in

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


rotateOfWorld

rotateOfWorld(worldOrigin, rotation): void

Parameters

NameType
worldOriginIPointData
rotationnumber

Returns

void

Implementation of

IGroup.rotateOfWorld

Inherited from

UI.rotateOfWorld

Defined in

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


skewOfWorld

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

Parameters

NameType
worldOriginIPointData
skewXnumber
skewY?number
resize?boolean

Returns

void

Implementation of

IGroup.skewOfWorld

Inherited from

UI.skewOfWorld

Defined in

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


flip

flip(axis): void

Parameters

NameType
axisIAxis

Returns

void

Implementation of

IGroup.flip

Inherited from

UI.flip

Defined in

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


scaleResize

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

Parameters

NameTypeDefault value
scaleXnumberundefined
scaleYnumberscaleX
_noResize?booleanundefined

Returns

void

Implementation of

IGroup.scaleResize

Inherited from

UI.scaleResize

Defined in

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


__scaleResize

__scaleResize(_scaleX, _scaleY): void

Parameters

NameType
_scaleXnumber
_scaleYnumber

Returns

void

Implementation of

IGroup.__scaleResize

Inherited from

UI.__scaleResize

Defined in

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


resizeWidth

resizeWidth(_width): void

Parameters

NameType
_widthnumber

Returns

void

Implementation of

IGroup.resizeWidth

Inherited from

UI.resizeWidth

Defined in

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


resizeHeight

resizeHeight(_height): void

Parameters

NameType
_heightnumber

Returns

void

Implementation of

IGroup.resizeHeight

Inherited from

UI.resizeHeight

Defined in

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


__hitWorld

__hitWorld(_point): boolean

Parameters

NameType
_pointIRadiusPointData

Returns

boolean

Implementation of

IGroup.__hitWorld

Inherited from

UI.__hitWorld

Defined in

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


__hit

__hit(_local): boolean

Parameters

NameType
_localIRadiusPointData

Returns

boolean

Implementation of

IGroup.__hit

Inherited from

UI.__hit

Defined in

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


__hitFill

__hitFill(_inner): boolean

Parameters

NameType
_innerIRadiusPointData

Returns

boolean

Implementation of

IGroup.__hitFill

Inherited from

UI.__hitFill

Defined in

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


__hitStroke

__hitStroke(_inner, _strokeWidth): boolean

Parameters

NameType
_innerIRadiusPointData
_strokeWidthnumber

Returns

boolean

Implementation of

IGroup.__hitStroke

Inherited from

UI.__hitStroke

Defined in

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


__hitPixel

__hitPixel(_inner): boolean

Parameters

NameType
_innerIRadiusPointData

Returns

boolean

Implementation of

IGroup.__hitPixel

Inherited from

UI.__hitPixel

Defined in

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


__drawHitPath

__drawHitPath(_canvas): void

Parameters

NameType
_canvasILeaferCanvas

Returns

void

Implementation of

IGroup.__drawHitPath

Inherited from

UI.__drawHitPath

Defined in

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


__updateHitCanvas

__updateHitCanvas(): void

Returns

void

Implementation of

IGroup.__updateHitCanvas

Inherited from

UI.__updateHitCanvas

Defined in

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


__render

__render(_canvas, _options): void

Parameters

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns

void

Implementation of

IGroup.__render

Inherited from

UI.__render

Defined in

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


__drawFast

__drawFast(_canvas, _options): void

Parameters

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns

void

Implementation of

IGroup.__drawFast

Inherited from

UI.__drawFast

Defined in

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


__draw

__draw(_canvas, _options): void

Parameters

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns

void

Implementation of

IGroup.__draw

Inherited from

UI.__draw

Defined in

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


__clip

__clip(_canvas, _options): void

Parameters

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns

void

Implementation of

IGroup.__clip

Inherited from

UI.__clip

Defined in

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


__renderShape

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

Parameters

NameType
_canvasILeaferCanvas
_optionsIRenderOptions
_ignoreFill?boolean
_ignoreStroke?boolean

Returns

void

Implementation of

IGroup.__renderShape

Inherited from

UI.__renderShape

Defined in

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


__updateWorldOpacity

__updateWorldOpacity(): void

Returns

void

Implementation of

IGroup.__updateWorldOpacity

Inherited from

UI.__updateWorldOpacity

Defined in

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


__updateChange

__updateChange(): void

Returns

void

Implementation of

IGroup.__updateChange

Inherited from

UI.__updateChange

Defined in

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


__updatePath

__updatePath(): void

Returns

void

Implementation of

IGroup.__updatePath

Inherited from

UI.__updatePath

Defined in

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


getMotionPathData

getMotionPathData(): IMotionPathData

Returns

IMotionPathData

Implementation of

IGroup.getMotionPathData

Inherited from

UI.getMotionPathData

Defined in

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


getMotionPoint

getMotionPoint(_motionDistance): IRotationPointData

Parameters

NameType
_motionDistancenumber | IUnitData

Returns

IRotationPointData

Implementation of

IGroup.getMotionPoint

Inherited from

UI.getMotionPoint

Defined in

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


getMotionTotal

getMotionTotal(): number

Returns

number

Implementation of

IGroup.getMotionTotal

Inherited from

UI.getMotionTotal

Defined in

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


__updateMotionPath

__updateMotionPath(): void

Returns

void

Implementation of

IGroup.__updateMotionPath

Inherited from

UI.__updateMotionPath

Defined in

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


__runAnimation

__runAnimation(_type, _complete?): void

Parameters

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

Returns

void

Implementation of

IGroup.__runAnimation

Inherited from

UI.__runAnimation

Defined in

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


__updateSortChildren

__updateSortChildren(): void

Returns

void

Implementation of

IGroup.__updateSortChildren

Inherited from

UI.__updateSortChildren

Defined in

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


dropTo

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

Parameters

NameType
parentILeaf
index?number
resize?boolean

Returns

void

Implementation of

IGroup.dropTo

Inherited from

UI.dropTo

Defined in

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


on

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

Parameters

NameType
_typestring | string[] | IEventMap
_listener?IFunction
_options?IEventOption

Returns

void

Implementation of

IGroup.on

Inherited from

UI.on

Defined in

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


off

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

Parameters

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

Returns

void

Implementation of

IGroup.off

Inherited from

UI.off

Defined in

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


on_

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

Parameters

NameType
_typestring | string[]
_listenerIFunction
_bind?IObject
_options?IEventOption

Returns

IEventListenerId

Implementation of

IGroup.on_

Inherited from

UI.on_

Defined in

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


off_

off_(_id): void

Parameters

NameType
_idIEventListenerId | IEventListenerId[]

Returns

void

Implementation of

IGroup.off_

Inherited from

UI.off_

Defined in

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


once

once(_type, _listener, _capture?): void

Parameters

NameType
_typestring | string[]
_listenerIFunction
_capture?boolean

Returns

void

Implementation of

IGroup.once

Inherited from

UI.once

Defined in

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


emit

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

Parameters

NameType
_typestring
_event?IObject | IEvent
_capture?boolean

Returns

void

Implementation of

IGroup.emit

Inherited from

UI.emit

Defined in

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


emitEvent

emitEvent(_event?, _capture?): void

Parameters

NameType
_event?IEvent
_capture?boolean

Returns

void

Implementation of

IGroup.emitEvent

Inherited from

UI.emitEvent

Defined in

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


hasEvent

hasEvent(_type, _capture?): boolean

Parameters

NameType
_typestring
_capture?boolean

Returns

boolean

Implementation of

IGroup.hasEvent

Inherited from

UI.hasEvent

Defined in

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


changeAttr

changeAttr(attrName, defaultValue, fn?): void

Parameters

NameType
attrNamestring
defaultValueIValue
fn?IAttrDecorator

Returns

void

Inherited from

UI.changeAttr

Defined in

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


addAttr

addAttr(attrName, defaultValue, fn?): void

Parameters

NameType
attrNamestring
defaultValueIValue
fn?IAttrDecorator

Returns

void

Inherited from

UI.addAttr

Defined in

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


__emitLifeEvent

__emitLifeEvent(type): void

Parameters

NameType
typestring

Returns

void

Implementation of

IGroup.__emitLifeEvent

Inherited from

UI.__emitLifeEvent

Defined in

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


reset

reset(data?): void

Parameters

NameType
data?IGroupInputData

Returns

void

Implementation of

IGroup.reset

Overrides

UI.reset

Defined in

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


__setBranch

__setBranch(): void

Returns

void

Defined in

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


set

set(data, isTemp?): void

Parameters

NameType
dataIUIInputData
isTemp?boolean

Returns

void

Implementation of

IGroup.set

Overrides

UI.set

Defined in

ui/packages/display/src/Group.ts:39


toJSON

toJSON(options?): IUIJSONData

Parameters

NameType
options?IJSONOptions

Returns

IUIJSONData

Implementation of

IGroup.toJSON

Overrides

UI.toJSON

Defined in

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


pick

pick(_hitPoint, _options?): IPickResult

Parameters

NameType
_hitPointIPointData
_options?IPickOptions

Returns

IPickResult

Implementation of

IGroup.pick

Defined in

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


addAt

addAt(child, index): void

Parameters

NameType
childIUIInputData | IUI
indexnumber

Returns

void

Implementation of

IGroup.addAt

Defined in

ui/packages/display/src/Group.ts:79


addAfter

addAfter(child, after): void

Parameters

NameType
childIUIInputData | IUI
afterIUI

Returns

void

Implementation of

IGroup.addAfter

Defined in

ui/packages/display/src/Group.ts:83


addBefore

addBefore(child, before): void

Parameters

NameType
childIUIInputData | IUI
beforeIUI

Returns

void

Implementation of

IGroup.addBefore

Defined in

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


add

add(_child, _index?): void

Parameters

NameType
_childIUIInputData | IUI
_index?number

Returns

void

Implementation of

IGroup.add

Overrides

UI.add

Defined in

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


addMany

addMany(..._children): void

Parameters

NameType
..._childrenIUI[] | IUIInputData[]

Returns

void

Implementation of

IGroup.addMany

Defined in

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


remove

remove(_child?, _destroy?): void

Parameters

NameType
_child?string | number | IFindCondition | IUI | IFindUIMethod
_destroy?boolean

Returns

void

Implementation of

IGroup.remove

Overrides

UI.remove

Defined in

ui/packages/display/src/Group.ts:97


removeAll

removeAll(_destroy?): void

Parameters

NameType
_destroy?boolean

Returns

void

Implementation of

IGroup.removeAll

Defined in

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


clear

clear(): void

Returns

void

Implementation of

IGroup.clear

Defined in

ui/packages/display/src/Group.ts:101


get

get(name?): IValue | IUIInputData

Parameters

NameType
name?string | string[] | IUIInputData

Returns

IValue | IUIInputData

Implementation of

IGroup.get

Inherited from

UI.get

Defined in

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


createProxyData

createProxyData(): IUIInputData

Returns

IUIInputData

Implementation of

IGroup.createProxyData

Inherited from

UI.createProxyData

Defined in

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


find

find(_condition, _options?): IUI[]

Parameters

NameType
_conditionstring | number | IFindCondition | IFindUIMethod
_options?any

Returns

IUI[]

Implementation of

IGroup.find

Inherited from

UI.find

Defined in

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


findTag

findTag(tag): IUI[]

Parameters

NameType
tagstring | string[]

Returns

IUI[]

Implementation of

IGroup.findTag

Inherited from

UI.findTag

Defined in

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


findOne

findOne(_condition, _options?): IUI

Parameters

NameType
_conditionstring | number | IFindCondition | IFindUIMethod
_options?any

Returns

IUI

Implementation of

IGroup.findOne

Inherited from

UI.findOne

Defined in

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


findId

findId(id): IUI

Parameters

NameType
idstring | number

Returns

IUI

Implementation of

IGroup.findId

Inherited from

UI.findId

Defined in

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


getPath

getPath(curve?, pathForRender?): IPathCommandData

Parameters

NameType
curve?boolean
pathForRender?boolean

Returns

IPathCommandData

Implementation of

IGroup.getPath

Inherited from

UI.getPath

Defined in

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


getPathString

getPathString(curve?, pathForRender?): string

Parameters

NameType
curve?boolean
pathForRender?boolean

Returns

string

Implementation of

IGroup.getPathString

Inherited from

UI.getPathString

Defined in

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


load

load(): void

Returns

void

Implementation of

IGroup.load

Inherited from

UI.load

Defined in

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


__onUpdateSize

__onUpdateSize(): void

Returns

void

Implementation of

IGroup.__onUpdateSize

Inherited from

UI.__onUpdateSize

Defined in

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


__updateRenderPath

__updateRenderPath(): void

Returns

void

Implementation of

IGroup.__updateRenderPath

Inherited from

UI.__updateRenderPath

Defined in

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


__drawRenderPath

__drawRenderPath(canvas): void

Parameters

NameType
canvasILeaferCanvas

Returns

void

Implementation of

IGroup.__drawRenderPath

Inherited from

UI.__drawRenderPath

Defined in

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


__drawPath

__drawPath(canvas): void

Parameters

NameType
canvasILeaferCanvas

Returns

void

Implementation of

IGroup.__drawPath

Inherited from

UI.__drawPath

Defined in

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


__drawPathByData

__drawPathByData(drawer, data): void

Parameters

NameType
drawerIPathDrawer
dataIPathCommandData

Returns

void

Implementation of

IGroup.__drawPathByData

Inherited from

UI.__drawPathByData

Defined in

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


__drawPathByBox

__drawPathByBox(drawer): void

Parameters

NameType
drawerIPathDrawer

Returns

void

Implementation of

IGroup.__drawPathByBox

Inherited from

UI.__drawPathByBox

Defined in

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


animate

animate(_keyframe?, _options?, _type?, _isTemp?): IAnimate

Parameters

NameType
_keyframe?IAnimation | IUIInputData | IKeyframe[]
_options?ITransition
_type?IAnimateType
_isTemp?boolean

Returns

IAnimate

Implementation of

IGroup.animate

Inherited from

UI.animate

Defined in

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


killAnimate

killAnimate(_type?): void

Parameters

NameType
_type?IAnimateType

Returns

void

Implementation of

IGroup.killAnimate

Inherited from

UI.killAnimate

Defined in

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


export

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

Parameters

NameType
filenamestring
options?number | boolean | IExportOptions

Returns

Promise<IExportResult>

Implementation of

IGroup.export

Inherited from

UI.export

Defined in

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


clone

clone(data?): IUI

Parameters

NameType
data?IUIInputData

Returns

IUI

Implementation of

IGroup.clone

Inherited from

UI.clone

Defined in

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


one

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

Parameters

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

Returns

IUI

Inherited from

UI.one

Defined in

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


registerUI

registerUI(): void

Returns

void

Inherited from

UI.registerUI

Defined in

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


registerData

registerData(data): void

Parameters

NameType
dataIUIData

Returns

void

Inherited from

UI.registerData

Defined in

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


setEditConfig

setEditConfig(_config): void

Parameters

NameType
_configIEditorConfig | IEditorConfigFunction

Returns

void

Inherited from

UI.setEditConfig

Defined in

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


setEditOuter

setEditOuter(_toolName): void

Parameters

NameType
_toolNamestring | IEditToolFunction

Returns

void

Inherited from

UI.setEditOuter

Defined in

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


setEditInner

setEditInner(_editorName): void

Parameters

NameType
_editorNamestring | IEditToolFunction

Returns

void

Inherited from

UI.setEditInner

Defined in

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


destroy

destroy(): void

Returns

void

Implementation of

IGroup.destroy

Inherited from

UI.destroy

Defined in

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

Released under the MIT License.