Skip to content

Class: Pen ​

Hierarchy ​

Implements ​

Table of contents ​

Constructors ​

Properties ​

Accessors ​

Methods ​

Constructors ​

constructor ​

• new Pen(data?): Pen

Parameters ​

NameType
data?IPenInputData

Returns ​

Pen

Overrides ​

Group.constructor

Defined in ​

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

Properties ​

innerId ​

• Readonly innerId: number

Implementation of ​

IPen.innerId

Inherited from ​

Group.innerId

Defined in ​

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


syncEventer ​

• Optional syncEventer: ILeaf

Implementation of ​

IPen.syncEventer

Inherited from ​

Group.syncEventer

Defined in ​

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


lockNormalStyle ​

• Optional lockNormalStyle: boolean

Implementation of ​

IPen.lockNormalStyle

Inherited from ​

Group.lockNormalStyle

Defined in ​

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


__layout ​

• __layout: ILeafLayout

Implementation of ​

IPen.__layout

Inherited from ​

Group.__layout

Defined in ​

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


__world ​

• __world: IMatrixWithBoundsScaleData

Implementation of ​

IPen.__world

Inherited from ​

Group.__world

Defined in ​

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


__local ​

• Optional __local: IMatrixWithBoundsData

Implementation of ​

IPen.__local

Inherited from ​

Group.__local

Defined in ​

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


__nowWorld ​

• Optional __nowWorld: IMatrixWithBoundsScaleData

Implementation of ​

IPen.__nowWorld

Inherited from ​

Group.__nowWorld

Defined in ​

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


__cameraWorld ​

• Optional __cameraWorld: IMatrixWithBoundsScaleData

Implementation of ​

IPen.__cameraWorld

Inherited from ​

Group.__cameraWorld

Defined in ​

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


__worldOpacity ​

• __worldOpacity: number

Implementation of ​

IPen.__worldOpacity

Inherited from ​

Group.__worldOpacity

Defined in ​

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


__level ​

• __level: number

Implementation of ​

IPen.__level

Inherited from ​

Group.__level

Defined in ​

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


__tempNumber ​

• __tempNumber: number

Implementation of ​

IPen.__tempNumber

Inherited from ​

Group.__tempNumber

Defined in ​

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


__hasAutoLayout ​

• Optional __hasAutoLayout: boolean

Implementation of ​

IPen.__hasAutoLayout

Inherited from ​

Group.__hasAutoLayout

Defined in ​

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


__hasMask ​

• Optional __hasMask: boolean

Implementation of ​

IPen.__hasMask

Inherited from ​

Group.__hasMask

Defined in ​

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


__hasEraser ​

• Optional __hasEraser: boolean

Implementation of ​

IPen.__hasEraser

Inherited from ​

Group.__hasEraser

Defined in ​

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


__hitCanvas ​

• Optional __hitCanvas: IHitCanvas

Implementation of ​

IPen.__hitCanvas

Inherited from ​

Group.__hitCanvas

Defined in ​

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


__captureMap ​

• Optional __captureMap: IEventListenerMap

Implementation of ​

IPen.__captureMap

Inherited from ​

Group.__captureMap

Defined in ​

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


__bubbleMap ​

• Optional __bubbleMap: IEventListenerMap

Implementation of ​

IPen.__bubbleMap

Inherited from ​

Group.__bubbleMap

Defined in ​

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


noBounds ​

• Optional noBounds: boolean

Implementation of ​

IPen.noBounds

Inherited from ​

Group.noBounds

Defined in ​

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


destroyed ​

• destroyed: boolean

Implementation of ​

IPen.destroyed

Inherited from ​

Group.destroyed

Defined in ​

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


children ​

• children: IUI[]

Implementation of ​

IPen.children

Inherited from ​

Group.children

Defined in ​

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


__ ​

• __: IPenData

Implementation of ​

IPen.__

Overrides ​

Group.__

Defined in ​

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


pathElement ​

• pathElement: IPath

Implementation of ​

IPen.pathElement

Defined in ​

ui/packages/display/src/Pen.ts:18


pathStyle ​

• pathStyle: IPathInputData

Implementation of ​

IPen.pathStyle

Defined in ​

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


path ​

• path: IPathCommandData

Implementation of ​

IPen.path

Overrides ​

Group.path

Defined in ​

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


__path ​

• __path: IPathCommandData

Implementation of ​

IPen.__path

Defined in ​

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


proxyData ​

• Optional proxyData: IUIInputData

Implementation of ​

IPen.proxyData

Inherited from ​

Group.proxyData

Defined in ​

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


__proxyData ​

• Optional __proxyData: IUIInputData

Implementation of ​

IPen.__proxyData

Inherited from ​

Group.__proxyData

Defined in ​

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


leafer ​

• Optional leafer: ILeafer

Implementation of ​

IPen.leafer

Inherited from ​

Group.leafer

Defined in ​

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


parent ​

• Optional parent: IGroup

Implementation of ​

IPen.parent

Inherited from ​

Group.parent

Defined in ​

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


zoomLayer ​

• zoomLayer: IGroup

Implementation of ​

IPen.zoomLayer

Inherited from ​

Group.zoomLayer

Defined in ​

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


id ​

• Optional id: string

Implementation of ​

IPen.id

Inherited from ​

Group.id

Defined in ​

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


name ​

• Optional name: string

Implementation of ​

IPen.name

Inherited from ​

Group.name

Defined in ​

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


className ​

• Optional className: string

Implementation of ​

IPen.className

Inherited from ​

Group.className

Defined in ​

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


blendMode ​

• Optional blendMode: IBlendMode

Implementation of ​

IPen.blendMode

Inherited from ​

Group.blendMode

Defined in ​

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


opacity ​

• Optional opacity: number

Implementation of ​

IPen.opacity

Inherited from ​

Group.opacity

Defined in ​

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


visible ​

• Optional visible: boolean | 0

Implementation of ​

IPen.visible

Inherited from ​

Group.visible

Defined in ​

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


locked ​

• Optional locked: boolean

Implementation of ​

IPen.locked

Inherited from ​

Group.locked

Defined in ​

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


zIndex ​

• Optional zIndex: number

Implementation of ​

IPen.zIndex

Inherited from ​

Group.zIndex

Defined in ​

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


mask ​

• Optional mask: boolean | IMaskType

Implementation of ​

IPen.mask

Inherited from ​

Group.mask

Defined in ​

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


eraser ​

• Optional eraser: boolean | IEraserType

Implementation of ​

IPen.eraser

Inherited from ​

Group.eraser

Defined in ​

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


x ​

• Optional x: number

Implementation of ​

IPen.x

Inherited from ​

Group.x

Defined in ​

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


y ​

• Optional y: number

Implementation of ​

IPen.y

Inherited from ​

Group.y

Defined in ​

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


width ​

• Optional width: number

Implementation of ​

IPen.width

Inherited from ​

Group.width

Defined in ​

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


height ​

• Optional height: number

Implementation of ​

IPen.height

Inherited from ​

Group.height

Defined in ​

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


scaleX ​

• Optional scaleX: number

Implementation of ​

IPen.scaleX

Inherited from ​

Group.scaleX

Defined in ​

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


scaleY ​

• Optional scaleY: number

Implementation of ​

IPen.scaleY

Inherited from ​

Group.scaleY

Defined in ​

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


rotation ​

• Optional rotation: number

Implementation of ​

IPen.rotation

Inherited from ​

Group.rotation

Defined in ​

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


skewX ​

• Optional skewX: number

Implementation of ​

IPen.skewX

Inherited from ​

Group.skewX

Defined in ​

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


skewY ​

• Optional skewY: number

Implementation of ​

IPen.skewY

Inherited from ​

Group.skewY

Defined in ​

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


offsetX ​

• Optional offsetX: number

Implementation of ​

IPen.offsetX

Inherited from ​

Group.offsetX

Defined in ​

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


offsetY ​

• Optional offsetY: number

Implementation of ​

IPen.offsetY

Inherited from ​

Group.offsetY

Defined in ​

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


scrollX ​

• Optional scrollX: number

Implementation of ​

IPen.scrollX

Inherited from ​

Group.scrollX

Defined in ​

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


scrollY ​

• Optional scrollY: number

Implementation of ​

IPen.scrollY

Inherited from ​

Group.scrollY

Defined in ​

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


origin ​

• Optional origin: IUnitPointData | IDirection

Implementation of ​

IPen.origin

Inherited from ​

Group.origin

Defined in ​

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


around ​

• Optional around: IUnitPointData | IDirection

Implementation of ​

IPen.around

Inherited from ​

Group.around

Defined in ​

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


lazy ​

• Optional lazy: boolean

Implementation of ​

IPen.lazy

Inherited from ​

Group.lazy

Defined in ​

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


pixelRatio ​

• Optional pixelRatio: number

Implementation of ​

IPen.pixelRatio

Inherited from ​

Group.pixelRatio

Defined in ​

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


windingRule ​

• Optional windingRule: IWindingRule

Implementation of ​

IPen.windingRule

Inherited from ​

Group.windingRule

Defined in ​

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


closed ​

• Optional closed: boolean

Implementation of ​

IPen.closed

Inherited from ​

Group.closed

Defined in ​

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


flow ​

• Optional flow: IFlowType

Implementation of ​

IPen.flow

Inherited from ​

Group.flow

Defined in ​

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


padding ​

• Optional padding: IFourNumber

Implementation of ​

IPen.padding

Inherited from ​

Group.padding

Defined in ​

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


gap ​

• Optional gap: IGap | IPointGap

Implementation of ​

IPen.gap

Inherited from ​

Group.gap

Defined in ​

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


flowAlign ​

• Optional flowAlign: IFlowAxisAlign | IFlowAlign

Implementation of ​

IPen.flowAlign

Inherited from ​

Group.flowAlign

Defined in ​

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


flowWrap ​

• Optional flowWrap: IFlowWrap

Implementation of ​

IPen.flowWrap

Inherited from ​

Group.flowWrap

Defined in ​

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


itemBox ​

• Optional itemBox: IFlowBoxType

Implementation of ​

IPen.itemBox

Inherited from ​

Group.itemBox

Defined in ​

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


inFlow ​

• Optional inFlow: boolean

Implementation of ​

IPen.inFlow

Inherited from ​

Group.inFlow

Defined in ​

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


autoWidth ​

• Optional autoWidth: IAutoSize

Implementation of ​

IPen.autoWidth

Inherited from ​

Group.autoWidth

Defined in ​

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


autoHeight ​

• Optional autoHeight: IAutoSize

Implementation of ​

IPen.autoHeight

Inherited from ​

Group.autoHeight

Defined in ​

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


lockRatio ​

• Optional lockRatio: boolean

Implementation of ​

IPen.lockRatio

Inherited from ​

Group.lockRatio

Defined in ​

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


autoBox ​

• Optional autoBox: IAutoBoxData | IConstraint

Implementation of ​

IPen.autoBox

Inherited from ​

Group.autoBox

Defined in ​

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


widthRange ​

• Optional widthRange: IRangeSize

Implementation of ​

IPen.widthRange

Inherited from ​

Group.widthRange

Defined in ​

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


heightRange ​

• Optional heightRange: IRangeSize

Implementation of ​

IPen.heightRange

Inherited from ​

Group.heightRange

Defined in ​

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


draggable ​

• Optional draggable: boolean | IAxis

Implementation of ​

IPen.draggable

Inherited from ​

Group.draggable

Defined in ​

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


dragBounds ​

• Optional dragBounds: "parent" | IBoundsData

Implementation of ​

IPen.dragBounds

Inherited from ​

Group.dragBounds

Defined in ​

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


editable ​

• Optional editable: boolean

Implementation of ​

IPen.editable

Inherited from ​

Group.editable

Defined in ​

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


hittable ​

• Optional hittable: boolean

Implementation of ​

IPen.hittable

Inherited from ​

Group.hittable

Defined in ​

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


hitFill ​

• Optional hitFill: IHitType

Implementation of ​

IPen.hitFill

Inherited from ​

Group.hitFill

Defined in ​

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


hitStroke ​

• Optional hitStroke: IHitType

Implementation of ​

IPen.hitStroke

Inherited from ​

Group.hitStroke

Defined in ​

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


hitBox ​

• Optional hitBox: boolean

Implementation of ​

IPen.hitBox

Inherited from ​

Group.hitBox

Defined in ​

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


hitChildren ​

• Optional hitChildren: boolean

Implementation of ​

IPen.hitChildren

Inherited from ​

Group.hitChildren

Defined in ​

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


hitSelf ​

• Optional hitSelf: boolean

Implementation of ​

IPen.hitSelf

Inherited from ​

Group.hitSelf

Defined in ​

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


hitRadius ​

• Optional hitRadius: number

Implementation of ​

IPen.hitRadius

Inherited from ​

Group.hitRadius

Defined in ​

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


cursor ​

• Optional cursor: ICursorType | ICursorType[]

Implementation of ​

IPen.cursor

Inherited from ​

Group.cursor

Defined in ​

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


fill ​

• Optional fill: IFill

Implementation of ​

IPen.fill

Inherited from ​

Group.fill

Defined in ​

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


stroke ​

• Optional stroke: IStroke

Implementation of ​

IPen.stroke

Inherited from ​

Group.stroke

Defined in ​

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


strokeAlign ​

• Optional strokeAlign: IStrokeAlign

Implementation of ​

IPen.strokeAlign

Inherited from ​

Group.strokeAlign

Defined in ​

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


strokeWidth ​

• Optional strokeWidth: string | IFourNumber

Implementation of ​

IPen.strokeWidth

Inherited from ​

Group.strokeWidth

Defined in ​

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


strokeWidthFixed ​

• Optional strokeWidthFixed: boolean

Implementation of ​

IPen.strokeWidthFixed

Inherited from ​

Group.strokeWidthFixed

Defined in ​

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


strokeCap ​

• Optional strokeCap: IStrokeCap

Implementation of ​

IPen.strokeCap

Inherited from ​

Group.strokeCap

Defined in ​

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


strokeJoin ​

• Optional strokeJoin: IStrokeJoin

Implementation of ​

IPen.strokeJoin

Inherited from ​

Group.strokeJoin

Defined in ​

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


dashPattern ​

• Optional dashPattern: string | number[]

Implementation of ​

IPen.dashPattern

Inherited from ​

Group.dashPattern

Defined in ​

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


dashOffset ​

• Optional dashOffset: number

Implementation of ​

IPen.dashOffset

Inherited from ​

Group.dashOffset

Defined in ​

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


miterLimit ​

• Optional miterLimit: number

Implementation of ​

IPen.miterLimit

Inherited from ​

Group.miterLimit

Defined in ​

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


startArrow ​

• Optional startArrow: IArrowType

Implementation of ​

IPen.startArrow

Inherited from ​

Group.startArrow

Defined in ​

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


endArrow ​

• Optional endArrow: IArrowType

Implementation of ​

IPen.endArrow

Inherited from ​

Group.endArrow

Defined in ​

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


cornerRadius ​

• Optional cornerRadius: string | IFourNumber

Implementation of ​

IPen.cornerRadius

Inherited from ​

Group.cornerRadius

Defined in ​

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


cornerSmoothing ​

• Optional cornerSmoothing: number

Implementation of ​

IPen.cornerSmoothing

Inherited from ​

Group.cornerSmoothing

Defined in ​

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


shadow ​

• Optional shadow: string | IShadowEffect | IShadowEffect[]

Implementation of ​

IPen.shadow

Inherited from ​

Group.shadow

Defined in ​

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


innerShadow ​

• Optional innerShadow: string | IShadowEffect | IShadowEffect[]

Implementation of ​

IPen.innerShadow

Inherited from ​

Group.innerShadow

Defined in ​

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


blur ​

• Optional blur: number | IBlurEffect

Implementation of ​

IPen.blur

Inherited from ​

Group.blur

Defined in ​

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


backgroundBlur ​

• Optional backgroundBlur: number | IBlurEffect

Implementation of ​

IPen.backgroundBlur

Inherited from ​

Group.backgroundBlur

Defined in ​

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


grayscale ​

• Optional grayscale: number | IGrayscaleEffect

Implementation of ​

IPen.grayscale

Inherited from ​

Group.grayscale

Defined in ​

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


filter ​

• Optional filter: IObject | IObject[]

Inherited from ​

Group.filter

Defined in ​

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


animation ​

• Optional animation: IAnimation

Implementation of ​

IPen.animation

Inherited from ​

Group.animation

Defined in ​

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


animationOut ​

• Optional animationOut: IAnimation

Implementation of ​

IPen.animationOut

Inherited from ​

Group.animationOut

Defined in ​

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


transition ​

• Optional transition: ITransition

Implementation of ​

IPen.transition

Inherited from ​

Group.transition

Defined in ​

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


transitionOut ​

• Optional transitionOut: ITransition

Implementation of ​

IPen.transitionOut

Inherited from ​

Group.transitionOut

Defined in ​

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


motionPath ​

• Optional motionPath: boolean

Implementation of ​

IPen.motionPath

Inherited from ​

Group.motionPath

Defined in ​

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


motionPrecision ​

• Optional motionPrecision: number

Implementation of ​

IPen.motionPrecision

Inherited from ​

Group.motionPrecision

Defined in ​

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


motion ​

• Optional motion: number | IUnitData

Implementation of ​

IPen.motion

Inherited from ​

Group.motion

Defined in ​

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


motionRotation ​

• Optional motionRotation: number | boolean

Implementation of ​

IPen.motionRotation

Inherited from ​

Group.motionRotation

Defined in ​

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


states ​

• Optional states: IStates

Implementation of ​

IPen.states

Inherited from ​

Group.states

Defined in ​

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


state ​

• Optional state: string

Implementation of ​

IPen.state

Inherited from ​

Group.state

Defined in ​

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


selected ​

• Optional selected: boolean

Implementation of ​

IPen.selected

Inherited from ​

Group.selected

Defined in ​

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


disabled ​

• Optional disabled: boolean

Implementation of ​

IPen.disabled

Inherited from ​

Group.disabled

Defined in ​

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


normalStyle ​

• Optional normalStyle: IUIInputData

Implementation of ​

IPen.normalStyle

Inherited from ​

Group.normalStyle

Defined in ​

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


hoverStyle ​

• Optional hoverStyle: IUIInputData

Implementation of ​

IPen.hoverStyle

Inherited from ​

Group.hoverStyle

Defined in ​

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


pressStyle ​

• Optional pressStyle: IUIInputData

Implementation of ​

IPen.pressStyle

Inherited from ​

Group.pressStyle

Defined in ​

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


focusStyle ​

• Optional focusStyle: IUIInputData

Implementation of ​

IPen.focusStyle

Inherited from ​

Group.focusStyle

Defined in ​

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


selectedStyle ​

• Optional selectedStyle: IUIInputData

Implementation of ​

IPen.selectedStyle

Inherited from ​

Group.selectedStyle

Defined in ​

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


disabledStyle ​

• Optional disabledStyle: IUIInputData

Implementation of ​

IPen.disabledStyle

Inherited from ​

Group.disabledStyle

Defined in ​

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


button ​

• Optional button: boolean

Implementation of ​

IPen.button

Inherited from ​

Group.button

Defined in ​

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


data ​

• data: IObject

Implementation of ​

IPen.data

Inherited from ​

Group.data

Defined in ​

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


__animate ​

• Optional __animate: IAnimate

Implementation of ​

IPen.__animate

Inherited from ​

Group.__animate

Defined in ​

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

Accessors ​

tag ​

• get tag(): string

Returns ​

string

Implementation of ​

IPen.tag

Inherited from ​

Group.tag

Defined in ​

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

• set tag(_value): void

Parameters ​

NameType
_valuestring

Returns ​

void

Implementation of ​

IPen.tag

Inherited from ​

Group.tag

Defined in ​

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


innerName ​

• get innerName(): string

Returns ​

string

Implementation of ​

IPen.innerName

Inherited from ​

Group.innerName

Defined in ​

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


__DataProcessor ​

• get __DataProcessor(): typeof LeafData

Returns ​

typeof LeafData

Implementation of ​

IPen.__DataProcessor

Inherited from ​

Group.__DataProcessor

Defined in ​

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


__LayoutProcessor ​

• get __LayoutProcessor(): typeof LeafLayout

Returns ​

typeof LeafLayout

Implementation of ​

IPen.__LayoutProcessor

Inherited from ​

Group.__LayoutProcessor

Defined in ​

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


leaferIsCreated ​

• get leaferIsCreated(): boolean

Returns ​

boolean

Implementation of ​

IPen.leaferIsCreated

Inherited from ​

Group.leaferIsCreated

Defined in ​

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


leaferIsReady ​

• get leaferIsReady(): boolean

Returns ​

boolean

Implementation of ​

IPen.leaferIsReady

Inherited from ​

Group.leaferIsReady

Defined in ​

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


isLeafer ​

• get isLeafer(): boolean

Returns ​

boolean

Implementation of ​

IPen.isLeafer

Inherited from ​

Group.isLeafer

Defined in ​

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


isBranchLeaf ​

• get isBranchLeaf(): boolean

Returns ​

boolean

Implementation of ​

IPen.isBranchLeaf

Inherited from ​

Group.isBranchLeaf

Defined in ​

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


__localMatrix ​

• get __localMatrix(): IMatrixData

Returns ​

IMatrixData

Implementation of ​

IPen.__localMatrix

Inherited from ​

Group.__localMatrix

Defined in ​

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


__localBoxBounds ​

• get __localBoxBounds(): IBoundsData

Returns ​

IBoundsData

Implementation of ​

IPen.__localBoxBounds

Inherited from ​

Group.__localBoxBounds

Defined in ​

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


worldTransform ​

• get worldTransform(): IMatrixWithScaleData

Returns ​

IMatrixWithScaleData

Implementation of ​

IPen.worldTransform

Inherited from ​

Group.worldTransform

Defined in ​

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


localTransform ​

• get localTransform(): IMatrixData

Returns ​

IMatrixData

Implementation of ​

IPen.localTransform

Inherited from ​

Group.localTransform

Defined in ​

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


boxBounds ​

• get boxBounds(): IBoundsData

Returns ​

IBoundsData

Implementation of ​

IPen.boxBounds

Inherited from ​

Group.boxBounds

Defined in ​

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


renderBounds ​

• get renderBounds(): IBoundsData

Returns ​

IBoundsData

Implementation of ​

IPen.renderBounds

Inherited from ​

Group.renderBounds

Defined in ​

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


worldBoxBounds ​

• get worldBoxBounds(): IBoundsData

Returns ​

IBoundsData

Implementation of ​

IPen.worldBoxBounds

Inherited from ​

Group.worldBoxBounds

Defined in ​

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


worldStrokeBounds ​

• get worldStrokeBounds(): IBoundsData

Returns ​

IBoundsData

Implementation of ​

IPen.worldStrokeBounds

Inherited from ​

Group.worldStrokeBounds

Defined in ​

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


worldRenderBounds ​

• get worldRenderBounds(): IBoundsData

Returns ​

IBoundsData

Implementation of ​

IPen.worldRenderBounds

Inherited from ​

Group.worldRenderBounds

Defined in ​

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


worldOpacity ​

• get worldOpacity(): number

Returns ​

number

Implementation of ​

IPen.worldOpacity

Inherited from ​

Group.worldOpacity

Defined in ​

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


__worldFlipped ​

• get __worldFlipped(): boolean

Returns ​

boolean

Implementation of ​

IPen.__worldFlipped

Inherited from ​

Group.__worldFlipped

Defined in ​

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


__onlyHitMask ​

• get __onlyHitMask(): boolean

Returns ​

boolean

Implementation of ​

IPen.__onlyHitMask

Inherited from ​

Group.__onlyHitMask

Defined in ​

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


__ignoreHitWorld ​

• get __ignoreHitWorld(): boolean

Returns ​

boolean

Implementation of ​

IPen.__ignoreHitWorld

Inherited from ​

Group.__ignoreHitWorld

Defined in ​

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


__inLazyBounds ​

• get __inLazyBounds(): boolean

Returns ​

boolean

Implementation of ​

IPen.__inLazyBounds

Inherited from ​

Group.__inLazyBounds

Defined in ​

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


pathInputed ​

• get pathInputed(): boolean

Returns ​

boolean

Implementation of ​

IPen.pathInputed

Inherited from ​

Group.pathInputed

Defined in ​

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


event ​

• set event(map): void

Parameters ​

NameType
mapIEventMap

Returns ​

void

Implementation of ​

IPen.event

Inherited from ​

Group.event

Defined in ​

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


isBranch ​

• get isBranch(): boolean

Returns ​

boolean

Implementation of ​

IPen.isBranch

Inherited from ​

Group.isBranch

Defined in ​

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


__tag ​

• get __tag(): string

Returns ​

string

Implementation of ​

IPen.__tag

Overrides ​

Group.__tag

Defined in ​

ui/packages/display/src/Pen.ts:13


app ​

• get app(): ILeafer

Returns ​

ILeafer

Implementation of ​

IPen.app

Inherited from ​

Group.app

Defined in ​

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


isFrame ​

• get isFrame(): boolean

Returns ​

boolean

Implementation of ​

IPen.isFrame

Inherited from ​

Group.isFrame

Defined in ​

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


scale ​

• get scale(): number | IPointData

Returns ​

number | IPointData

Implementation of ​

IPen.scale

Inherited from ​

Group.scale

Defined in ​

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

• set scale(value): void

Parameters ​

NameType
valuenumber | IPointData

Returns ​

void

Implementation of ​

IPen.scale

Inherited from ​

Group.scale

Defined in ​

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


pen ​

• get pen(): IPathCreator

Returns ​

IPathCreator

Implementation of ​

IPen.pen

Inherited from ​

Group.pen

Defined in ​

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


editConfig ​

• get editConfig(): IEditorConfig

Returns ​

IEditorConfig

Implementation of ​

IPen.editConfig

Inherited from ​

Group.editConfig

Defined in ​

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


editOuter ​

• get editOuter(): string

Returns ​

string

Implementation of ​

IPen.editOuter

Inherited from ​

Group.editOuter

Defined in ​

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


editInner ​

• get editInner(): string

Returns ​

string

Implementation of ​

IPen.editInner

Inherited from ​

Group.editInner

Defined in ​

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

Methods ​

resetCustom ​

▸ resetCustom(): void

Returns ​

void

Implementation of ​

IPen.resetCustom

Inherited from ​

Group.resetCustom

Defined in ​

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


waitParent ​

▸ waitParent(item, bind?): void

Parameters ​

NameType
itemIFunction
bind?IObject

Returns ​

void

Implementation of ​

IPen.waitParent

Inherited from ​

Group.waitParent

Defined in ​

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


waitLeafer ​

▸ waitLeafer(item, bind?): void

Parameters ​

NameType
itemIFunction
bind?IObject

Returns ​

void

Implementation of ​

IPen.waitLeafer

Inherited from ​

Group.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 ​

IPen.nextRender

Inherited from ​

Group.nextRender

Defined in ​

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


removeNextRender ​

▸ removeNextRender(item): void

Parameters ​

NameType
itemIFunction

Returns ​

void

Implementation of ​

IPen.removeNextRender

Inherited from ​

Group.removeNextRender

Defined in ​

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


__bindLeafer ​

▸ __bindLeafer(leafer): void

Parameters ​

NameType
leaferILeaferBase

Returns ​

void

Implementation of ​

IPen.__bindLeafer

Inherited from ​

Group.__bindLeafer

Defined in ​

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


setAttr ​

▸ setAttr(name, value): void

Parameters ​

NameType
namestring
valueany

Returns ​

void

Implementation of ​

IPen.setAttr

Inherited from ​

Group.setAttr

Defined in ​

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


getAttr ​

▸ getAttr(name): any

Parameters ​

NameType
namestring

Returns ​

any

Implementation of ​

IPen.getAttr

Inherited from ​

Group.getAttr

Defined in ​

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


getComputedAttr ​

▸ getComputedAttr(name): any

Parameters ​

NameType
namestring

Returns ​

any

Implementation of ​

IPen.getComputedAttr

Inherited from ​

Group.getComputedAttr

Defined in ​

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


toString ​

▸ toString(options?): string

Parameters ​

NameType
options?IJSONOptions

Returns ​

string

Implementation of ​

IPen.toString

Inherited from ​

Group.toString

Defined in ​

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


toSVG ​

▸ toSVG(): string

Returns ​

string

Implementation of ​

IPen.toSVG

Inherited from ​

Group.toSVG

Defined in ​

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


__SVG ​

▸ __SVG(_data): void

Parameters ​

NameType
_dataIObject

Returns ​

void

Implementation of ​

IPen.__SVG

Inherited from ​

Group.__SVG

Defined in ​

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


toHTML ​

▸ toHTML(): string

Returns ​

string

Implementation of ​

IPen.toHTML

Inherited from ​

Group.toHTML

Defined in ​

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


__setAttr ​

▸ __setAttr(_attrName, _newValue): boolean

Parameters ​

NameType
_attrNamestring
_newValueIValue

Returns ​

boolean

Implementation of ​

IPen.__setAttr

Inherited from ​

Group.__setAttr

Defined in ​

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


__getAttr ​

▸ __getAttr(_attrName): IValue

Parameters ​

NameType
_attrNamestring

Returns ​

IValue

Implementation of ​

IPen.__getAttr

Inherited from ​

Group.__getAttr

Defined in ​

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


setProxyAttr ​

▸ setProxyAttr(_attrName, _newValue): void

Parameters ​

NameType
_attrNamestring
_newValueIValue

Returns ​

void

Implementation of ​

IPen.setProxyAttr

Inherited from ​

Group.setProxyAttr

Defined in ​

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


getProxyAttr ​

▸ getProxyAttr(_attrName): IValue

Parameters ​

NameType
_attrNamestring

Returns ​

IValue

Implementation of ​

IPen.getProxyAttr

Inherited from ​

Group.getProxyAttr

Defined in ​

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


focus ​

▸ focus(_value?): void

Parameters ​

NameType
_value?boolean

Returns ​

void

Implementation of ​

IPen.focus

Inherited from ​

Group.focus

Defined in ​

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


updateState ​

▸ updateState(): void

Returns ​

void

Implementation of ​

IPen.updateState

Inherited from ​

Group.updateState

Defined in ​

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


updateLayout ​

▸ updateLayout(): void

Returns ​

void

Implementation of ​

IPen.updateLayout

Inherited from ​

Group.updateLayout

Defined in ​

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


forceUpdate ​

▸ forceUpdate(attrName?): void

Parameters ​

NameType
attrName?string

Returns ​

void

Implementation of ​

IPen.forceUpdate

Inherited from ​

Group.forceUpdate

Defined in ​

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


forceRender ​

▸ forceRender(_bounds?, _sync?): void

Parameters ​

NameType
_bounds?IBoundsData
_sync?boolean

Returns ​

void

Implementation of ​

IPen.forceRender

Inherited from ​

Group.forceRender

Defined in ​

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


__updateWorldMatrix ​

▸ __updateWorldMatrix(): void

Returns ​

void

Implementation of ​

IPen.__updateWorldMatrix

Inherited from ​

Group.__updateWorldMatrix

Defined in ​

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


__updateLocalMatrix ​

▸ __updateLocalMatrix(): void

Returns ​

void

Implementation of ​

IPen.__updateLocalMatrix

Inherited from ​

Group.__updateLocalMatrix

Defined in ​

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


__updateWorldBounds ​

▸ __updateWorldBounds(): void

Returns ​

void

Implementation of ​

IPen.__updateWorldBounds

Inherited from ​

Group.__updateWorldBounds

Defined in ​

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


__updateLocalBounds ​

▸ __updateLocalBounds(): void

Returns ​

void

Implementation of ​

IPen.__updateLocalBounds

Inherited from ​

Group.__updateLocalBounds

Defined in ​

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


__updateLocalBoxBounds ​

▸ __updateLocalBoxBounds(): void

Returns ​

void

Implementation of ​

IPen.__updateLocalBoxBounds

Inherited from ​

Group.__updateLocalBoxBounds

Defined in ​

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


__updateLocalStrokeBounds ​

▸ __updateLocalStrokeBounds(): void

Returns ​

void

Implementation of ​

IPen.__updateLocalStrokeBounds

Inherited from ​

Group.__updateLocalStrokeBounds

Defined in ​

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


__updateLocalRenderBounds ​

▸ __updateLocalRenderBounds(): void

Returns ​

void

Implementation of ​

IPen.__updateLocalRenderBounds

Inherited from ​

Group.__updateLocalRenderBounds

Defined in ​

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


__updateBoxBounds ​

▸ __updateBoxBounds(): void

Returns ​

void

Implementation of ​

IPen.__updateBoxBounds

Inherited from ​

Group.__updateBoxBounds

Defined in ​

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


__updateContentBounds ​

▸ __updateContentBounds(): void

Returns ​

void

Implementation of ​

IPen.__updateContentBounds

Inherited from ​

Group.__updateContentBounds

Defined in ​

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


__updateStrokeBounds ​

▸ __updateStrokeBounds(): void

Returns ​

void

Implementation of ​

IPen.__updateStrokeBounds

Inherited from ​

Group.__updateStrokeBounds

Defined in ​

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


__updateRenderBounds ​

▸ __updateRenderBounds(): void

Returns ​

void

Implementation of ​

IPen.__updateRenderBounds

Inherited from ​

Group.__updateRenderBounds

Defined in ​

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


__updateAutoLayout ​

▸ __updateAutoLayout(): void

Returns ​

void

Implementation of ​

IPen.__updateAutoLayout

Inherited from ​

Group.__updateAutoLayout

Defined in ​

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


__updateFlowLayout ​

▸ __updateFlowLayout(): void

Returns ​

void

Implementation of ​

IPen.__updateFlowLayout

Inherited from ​

Group.__updateFlowLayout

Defined in ​

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


__updateNaturalSize ​

▸ __updateNaturalSize(): void

Returns ​

void

Implementation of ​

IPen.__updateNaturalSize

Inherited from ​

Group.__updateNaturalSize

Defined in ​

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


__updateStrokeSpread ​

▸ __updateStrokeSpread(): number

Returns ​

number

Implementation of ​

IPen.__updateStrokeSpread

Inherited from ​

Group.__updateStrokeSpread

Defined in ​

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


__updateRenderSpread ​

▸ __updateRenderSpread(): number

Returns ​

number

Implementation of ​

IPen.__updateRenderSpread

Inherited from ​

Group.__updateRenderSpread

Defined in ​

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


__updateEraser ​

▸ __updateEraser(value?): void

Parameters ​

NameType
value?boolean

Returns ​

void

Implementation of ​

IPen.__updateEraser

Inherited from ​

Group.__updateEraser

Defined in ​

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


__renderEraser ​

▸ __renderEraser(canvas, options): void

Parameters ​

NameType
canvasILeaferCanvas
optionsIRenderOptions

Returns ​

void

Implementation of ​

IPen.__renderEraser

Inherited from ​

Group.__renderEraser

Defined in ​

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


__updateMask ​

▸ __updateMask(_value?): void

Parameters ​

NameType
_value?boolean

Returns ​

void

Implementation of ​

IPen.__updateMask

Inherited from ​

Group.__updateMask

Defined in ​

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


__renderMask ​

▸ __renderMask(_canvas, _options): void

Parameters ​

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns ​

void

Implementation of ​

IPen.__renderMask

Inherited from ​

Group.__renderMask

Defined in ​

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


__getNowWorld ​

▸ __getNowWorld(options): IMatrixWithBoundsScaleData

Parameters ​

NameType
optionsIRenderOptions

Returns ​

IMatrixWithBoundsScaleData

Implementation of ​

IPen.__getNowWorld

Inherited from ​

Group.__getNowWorld

Defined in ​

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


getTransform ​

▸ getTransform(relative?): IMatrixData

Parameters ​

NameType
relative?ILeaf | ILocationType

Returns ​

IMatrixData

Implementation of ​

IPen.getTransform

Inherited from ​

Group.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 ​

IPen.getBounds

Inherited from ​

Group.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 ​

IPen.getLayoutBounds

Inherited from ​

Group.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 ​

IPen.getLayoutPoints

Inherited from ​

Group.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 ​

IPen.getWorldBounds

Inherited from ​

Group.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 ​

IPen.worldToLocal

Inherited from ​

Group.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 ​

IPen.localToWorld

Inherited from ​

Group.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 ​

IPen.worldToInner

Inherited from ​

Group.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 ​

IPen.innerToWorld

Inherited from ​

Group.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 ​

IPen.getBoxPoint

Inherited from ​

Group.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 ​

IPen.getBoxPointByInner

Inherited from ​

Group.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 ​

IPen.getInnerPoint

Inherited from ​

Group.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 ​

IPen.getInnerPointByBox

Inherited from ​

Group.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 ​

IPen.getInnerPointByLocal

Inherited from ​

Group.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 ​

IPen.getLocalPoint

Inherited from ​

Group.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 ​

IPen.getLocalPointByInner

Inherited from ​

Group.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 ​

IPen.getPagePoint

Inherited from ​

Group.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 ​

IPen.getWorldPoint

Inherited from ​

Group.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 ​

IPen.getWorldPointByBox

Inherited from ​

Group.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 ​

IPen.getWorldPointByLocal

Inherited from ​

Group.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 ​

IPen.getWorldPointByPage

Inherited from ​

Group.getWorldPointByPage

Defined in ​

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


setTransform ​

▸ setTransform(matrix, resize?): void

Parameters ​

NameType
matrixIMatrixData
resize?boolean

Returns ​

void

Implementation of ​

IPen.setTransform

Inherited from ​

Group.setTransform

Defined in ​

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


transform ​

▸ transform(matrix, resize?): void

Parameters ​

NameType
matrixIMatrixData
resize?boolean

Returns ​

void

Implementation of ​

IPen.transform

Inherited from ​

Group.transform

Defined in ​

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


move ​

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

Parameters ​

NameType
xnumber | IPointData
y?number
transition?any

Returns ​

void

Implementation of ​

IPen.move

Inherited from ​

Group.move

Defined in ​

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


moveInner ​

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

Parameters ​

NameType
xnumber | IPointData
y?number
transition?any

Returns ​

void

Implementation of ​

IPen.moveInner

Inherited from ​

Group.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 ​

IPen.scaleOf

Inherited from ​

Group.scaleOf

Defined in ​

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


rotateOf ​

▸ rotateOf(origin, rotation): void

Parameters ​

NameType
originIPointData | IDirection
rotationnumber

Returns ​

void

Implementation of ​

IPen.rotateOf

Inherited from ​

Group.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 ​

IPen.skewOf

Inherited from ​

Group.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 ​

IPen.transformWorld

Inherited from ​

Group.transformWorld

Defined in ​

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


moveWorld ​

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

Parameters ​

NameType
xnumber | IPointData
y?number
transition?any

Returns ​

void

Implementation of ​

IPen.moveWorld

Inherited from ​

Group.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 ​

IPen.scaleOfWorld

Inherited from ​

Group.scaleOfWorld

Defined in ​

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


rotateOfWorld ​

▸ rotateOfWorld(worldOrigin, rotation): void

Parameters ​

NameType
worldOriginIPointData
rotationnumber

Returns ​

void

Implementation of ​

IPen.rotateOfWorld

Inherited from ​

Group.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 ​

IPen.skewOfWorld

Inherited from ​

Group.skewOfWorld

Defined in ​

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


flip ​

▸ flip(axis): void

Parameters ​

NameType
axisIAxis

Returns ​

void

Implementation of ​

IPen.flip

Inherited from ​

Group.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 ​

IPen.scaleResize

Inherited from ​

Group.scaleResize

Defined in ​

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


__scaleResize ​

▸ __scaleResize(_scaleX, _scaleY): void

Parameters ​

NameType
_scaleXnumber
_scaleYnumber

Returns ​

void

Implementation of ​

IPen.__scaleResize

Inherited from ​

Group.__scaleResize

Defined in ​

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


resizeWidth ​

▸ resizeWidth(_width): void

Parameters ​

NameType
_widthnumber

Returns ​

void

Implementation of ​

IPen.resizeWidth

Inherited from ​

Group.resizeWidth

Defined in ​

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


resizeHeight ​

▸ resizeHeight(_height): void

Parameters ​

NameType
_heightnumber

Returns ​

void

Implementation of ​

IPen.resizeHeight

Inherited from ​

Group.resizeHeight

Defined in ​

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


__hitWorld ​

▸ __hitWorld(_point): boolean

Parameters ​

NameType
_pointIRadiusPointData

Returns ​

boolean

Implementation of ​

IPen.__hitWorld

Inherited from ​

Group.__hitWorld

Defined in ​

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


__hit ​

▸ __hit(_local): boolean

Parameters ​

NameType
_localIRadiusPointData

Returns ​

boolean

Implementation of ​

IPen.__hit

Inherited from ​

Group.__hit

Defined in ​

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


__hitFill ​

▸ __hitFill(_inner): boolean

Parameters ​

NameType
_innerIRadiusPointData

Returns ​

boolean

Implementation of ​

IPen.__hitFill

Inherited from ​

Group.__hitFill

Defined in ​

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


__hitStroke ​

▸ __hitStroke(_inner, _strokeWidth): boolean

Parameters ​

NameType
_innerIRadiusPointData
_strokeWidthnumber

Returns ​

boolean

Implementation of ​

IPen.__hitStroke

Inherited from ​

Group.__hitStroke

Defined in ​

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


__hitPixel ​

▸ __hitPixel(_inner): boolean

Parameters ​

NameType
_innerIRadiusPointData

Returns ​

boolean

Implementation of ​

IPen.__hitPixel

Inherited from ​

Group.__hitPixel

Defined in ​

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


__drawHitPath ​

▸ __drawHitPath(_canvas): void

Parameters ​

NameType
_canvasILeaferCanvas

Returns ​

void

Implementation of ​

IPen.__drawHitPath

Inherited from ​

Group.__drawHitPath

Defined in ​

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


__updateHitCanvas ​

▸ __updateHitCanvas(): void

Returns ​

void

Implementation of ​

IPen.__updateHitCanvas

Inherited from ​

Group.__updateHitCanvas

Defined in ​

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


__render ​

▸ __render(_canvas, _options): void

Parameters ​

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns ​

void

Implementation of ​

IPen.__render

Inherited from ​

Group.__render

Defined in ​

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


__drawFast ​

▸ __drawFast(_canvas, _options): void

Parameters ​

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns ​

void

Implementation of ​

IPen.__drawFast

Inherited from ​

Group.__drawFast

Defined in ​

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


__draw ​

▸ __draw(_canvas, _options): void

Parameters ​

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns ​

void

Implementation of ​

IPen.__draw

Inherited from ​

Group.__draw

Defined in ​

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


__clip ​

▸ __clip(_canvas, _options): void

Parameters ​

NameType
_canvasILeaferCanvas
_optionsIRenderOptions

Returns ​

void

Implementation of ​

IPen.__clip

Inherited from ​

Group.__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 ​

IPen.__renderShape

Inherited from ​

Group.__renderShape

Defined in ​

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


__updateWorldOpacity ​

▸ __updateWorldOpacity(): void

Returns ​

void

Implementation of ​

IPen.__updateWorldOpacity

Inherited from ​

Group.__updateWorldOpacity

Defined in ​

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


__updateChange ​

▸ __updateChange(): void

Returns ​

void

Implementation of ​

IPen.__updateChange

Inherited from ​

Group.__updateChange

Defined in ​

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


__updatePath ​

▸ __updatePath(): void

Returns ​

void

Implementation of ​

IPen.__updatePath

Inherited from ​

Group.__updatePath

Defined in ​

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


getMotionPathData ​

▸ getMotionPathData(): IMotionPathData

Returns ​

IMotionPathData

Implementation of ​

IPen.getMotionPathData

Inherited from ​

Group.getMotionPathData

Defined in ​

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


getMotionPoint ​

▸ getMotionPoint(_motionDistance): IRotationPointData

Parameters ​

NameType
_motionDistancenumber | IUnitData

Returns ​

IRotationPointData

Implementation of ​

IPen.getMotionPoint

Inherited from ​

Group.getMotionPoint

Defined in ​

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


getMotionTotal ​

▸ getMotionTotal(): number

Returns ​

number

Implementation of ​

IPen.getMotionTotal

Inherited from ​

Group.getMotionTotal

Defined in ​

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


__updateMotionPath ​

▸ __updateMotionPath(): void

Returns ​

void

Implementation of ​

IPen.__updateMotionPath

Inherited from ​

Group.__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 ​

IPen.__runAnimation

Inherited from ​

Group.__runAnimation

Defined in ​

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


__updateSortChildren ​

▸ __updateSortChildren(): void

Returns ​

void

Implementation of ​

IPen.__updateSortChildren

Inherited from ​

Group.__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 ​

IPen.dropTo

Inherited from ​

Group.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 ​

IPen.on

Inherited from ​

Group.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 ​

IPen.off

Inherited from ​

Group.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 ​

IPen.on_

Inherited from ​

Group.on_

Defined in ​

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


off_ ​

▸ off_(_id): void

Parameters ​

NameType
_idIEventListenerId | IEventListenerId[]

Returns ​

void

Implementation of ​

IPen.off_

Inherited from ​

Group.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 ​

IPen.once

Inherited from ​

Group.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 ​

IPen.emit

Inherited from ​

Group.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 ​

IPen.emitEvent

Inherited from ​

Group.emitEvent

Defined in ​

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


hasEvent ​

▸ hasEvent(_type, _capture?): boolean

Parameters ​

NameType
_typestring
_capture?boolean

Returns ​

boolean

Implementation of ​

IPen.hasEvent

Inherited from ​

Group.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 ​

Group.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 ​

Group.addAttr

Defined in ​

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


__emitLifeEvent ​

▸ __emitLifeEvent(type): void

Parameters ​

NameType
typestring

Returns ​

void

Implementation of ​

IPen.__emitLifeEvent

Inherited from ​

Group.__emitLifeEvent

Defined in ​

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


reset ​

▸ reset(data?): void

Parameters ​

NameType
data?IGroupInputData

Returns ​

void

Implementation of ​

IPen.reset

Inherited from ​

Group.reset

Defined in ​

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


__setBranch ​

▸ __setBranch(): void

Returns ​

void

Inherited from ​

Group.__setBranch

Defined in ​

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


set ​

▸ set(data, transition?): void

Parameters ​

NameType
dataIUIInputData
transition?ITransition | "temp"

Returns ​

void

Implementation of ​

IPen.set

Inherited from ​

Group.set

Defined in ​

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


toJSON ​

▸ toJSON(options?): IUIJSONData

Parameters ​

NameType
options?IJSONOptions

Returns ​

IUIJSONData

Implementation of ​

IPen.toJSON

Inherited from ​

Group.toJSON

Defined in ​

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


pick ​

▸ pick(_hitPoint, _options?): IPickResult

Parameters ​

NameType
_hitPointIPointData
_options?IPickOptions

Returns ​

IPickResult

Implementation of ​

IPen.pick

Inherited from ​

Group.pick

Defined in ​

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


addAt ​

▸ addAt(child, index): void

Parameters ​

NameType
childIUIInputData | IUI | IUI[] | IUIInputData[]
indexnumber

Returns ​

void

Implementation of ​

IPen.addAt

Inherited from ​

Group.addAt

Defined in ​

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


addAfter ​

▸ addAfter(child, after): void

Parameters ​

NameType
childIUIInputData | IUI | IUI[] | IUIInputData[]
afterIUI

Returns ​

void

Implementation of ​

IPen.addAfter

Inherited from ​

Group.addAfter

Defined in ​

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


addBefore ​

▸ addBefore(child, before): void

Parameters ​

NameType
childIUIInputData | IUI | IUI[] | IUIInputData[]
beforeIUI

Returns ​

void

Implementation of ​

IPen.addBefore

Inherited from ​

Group.addBefore

Defined in ​

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


add ​

▸ add(_child, _index?): void

Parameters ​

NameType
_childIUIInputData | IUI | IUI[] | IUIInputData[]
_index?number

Returns ​

void

Implementation of ​

IPen.add

Inherited from ​

Group.add

Defined in ​

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


addMany ​

▸ addMany(..._children): void

Parameters ​

NameType
..._childrenIUI[] | IUIInputData[]

Returns ​

void

Implementation of ​

IPen.addMany

Inherited from ​

Group.addMany

Defined in ​

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


remove ​

▸ remove(_child?, _destroy?): void

Parameters ​

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

Returns ​

void

Implementation of ​

IPen.remove

Inherited from ​

Group.remove

Defined in ​

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


removeAll ​

▸ removeAll(_destroy?): void

Parameters ​

NameType
_destroy?boolean

Returns ​

void

Implementation of ​

IPen.removeAll

Inherited from ​

Group.removeAll

Defined in ​

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


clear ​

▸ clear(): void

Returns ​

void

Implementation of ​

IPen.clear

Inherited from ​

Group.clear

Defined in ​

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


setStyle ​

▸ setStyle(data): Pen

Parameters ​

NameType
dataIPathInputData

Returns ​

Pen

Defined in ​

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


beginPath ​

▸ beginPath(): Pen

Returns ​

Pen

Implementation of ​

IPen.beginPath

Defined in ​

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


moveTo ​

▸ moveTo(_x, _y): Pen

Parameters ​

NameType
_xnumber
_ynumber

Returns ​

Pen

Implementation of ​

IPen.moveTo

Defined in ​

ui/packages/display/src/Pen.ts:42


lineTo ​

▸ lineTo(_x, _y): Pen

Parameters ​

NameType
_xnumber
_ynumber

Returns ​

Pen

Implementation of ​

IPen.lineTo

Defined in ​

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


bezierCurveTo ​

▸ bezierCurveTo(_x1, _y1, _x2, _y2, _x, _y): Pen

Parameters ​

NameType
_x1number
_y1number
_x2number
_y2number
_xnumber
_ynumber

Returns ​

Pen

Implementation of ​

IPen.bezierCurveTo

Defined in ​

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


quadraticCurveTo ​

▸ quadraticCurveTo(_x1, _y1, _x, _y): Pen

Parameters ​

NameType
_x1number
_y1number
_xnumber
_ynumber

Returns ​

Pen

Implementation of ​

IPen.quadraticCurveTo

Defined in ​

ui/packages/display/src/Pen.ts:48


closePath ​

▸ closePath(): Pen

Returns ​

Pen

Implementation of ​

IPen.closePath

Defined in ​

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


rect ​

▸ rect(_x, _y, _width, _height): Pen

Parameters ​

NameType
_xnumber
_ynumber
_widthnumber
_heightnumber

Returns ​

Pen

Implementation of ​

IPen.rect

Defined in ​

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


roundRect ​

▸ roundRect(_x, _y, _width, _height, _cornerRadius): Pen

Parameters ​

NameType
_xnumber
_ynumber
_widthnumber
_heightnumber
_cornerRadiusnumber | number[]

Returns ​

Pen

Implementation of ​

IPen.roundRect

Defined in ​

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


ellipse ​

▸ ellipse(_x, _y, _radiusX, _radiusY, _rotation?, _startAngle?, _endAngle?, _anticlockwise?): Pen

Parameters ​

NameType
_xnumber
_ynumber
_radiusXnumber
_radiusYnumber
_rotation?number
_startAngle?number
_endAngle?number
_anticlockwise?boolean

Returns ​

Pen

Implementation of ​

IPen.ellipse

Defined in ​

ui/packages/display/src/Pen.ts:59


arc ​

▸ arc(_x, _y, _radius, _startAngle?, _endAngle?, _anticlockwise?): Pen

Parameters ​

NameType
_xnumber
_ynumber
_radiusnumber
_startAngle?number
_endAngle?number
_anticlockwise?boolean

Returns ​

Pen

Implementation of ​

IPen.arc

Defined in ​

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


arcTo ​

▸ arcTo(_x1, _y1, _x2, _y2, _radius): Pen

Parameters ​

NameType
_x1number
_y1number
_x2number
_y2number
_radiusnumber

Returns ​

Pen

Implementation of ​

IPen.arcTo

Defined in ​

ui/packages/display/src/Pen.ts:63


drawEllipse ​

▸ drawEllipse(_x, _y, _radiusX, _radiusY, _rotation?, _startAngle?, _endAngle?, _anticlockwise?): Pen

Parameters ​

NameType
_xnumber
_ynumber
_radiusXnumber
_radiusYnumber
_rotation?number
_startAngle?number
_endAngle?number
_anticlockwise?boolean

Returns ​

Pen

Implementation of ​

IPen.drawEllipse

Defined in ​

ui/packages/display/src/Pen.ts:68


drawArc ​

▸ drawArc(_x, _y, _radius, _startAngle?, _endAngle?, _anticlockwise?): Pen

Parameters ​

NameType
_xnumber
_ynumber
_radiusnumber
_startAngle?number
_endAngle?number
_anticlockwise?boolean

Returns ​

Pen

Implementation of ​

IPen.drawArc

Defined in ​

ui/packages/display/src/Pen.ts:70


drawPoints ​

▸ drawPoints(_points, _curve?, _close?): Pen

Parameters ​

NameType
_pointsnumber[]
_curve?number | boolean
_close?boolean

Returns ​

Pen

Implementation of ​

IPen.drawPoints

Defined in ​

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


clearPath ​

▸ clearPath(): Pen

Returns ​

Pen

Implementation of ​

IPen.clearPath

Defined in ​

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


paint ​

▸ paint(): void

Returns ​

void

Implementation of ​

IPen.paint

Defined in ​

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


get ​

▸ get(name?): IValue | IUIInputData

Parameters ​

NameType
name?string | string[] | IUIInputData

Returns ​

IValue | IUIInputData

Implementation of ​

IPen.get

Inherited from ​

Group.get

Defined in ​

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


createProxyData ​

▸ createProxyData(): IUIInputData

Returns ​

IUIInputData

Implementation of ​

IPen.createProxyData

Inherited from ​

Group.createProxyData

Defined in ​

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


find ​

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

Parameters ​

NameType
_conditionstring | number | IFindCondition | IFindUIMethod
_options?any

Returns ​

IUI[]

Implementation of ​

IPen.find

Inherited from ​

Group.find

Defined in ​

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


findTag ​

▸ findTag(tag): IUI[]

Parameters ​

NameType
tagstring | string[]

Returns ​

IUI[]

Implementation of ​

IPen.findTag

Inherited from ​

Group.findTag

Defined in ​

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


findOne ​

▸ findOne(_condition, _options?): IUI

Parameters ​

NameType
_conditionstring | number | IFindCondition | IFindUIMethod
_options?any

Returns ​

IUI

Implementation of ​

IPen.findOne

Inherited from ​

Group.findOne

Defined in ​

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


findId ​

▸ findId(id): IUI

Parameters ​

NameType
idstring | number

Returns ​

IUI

Implementation of ​

IPen.findId

Inherited from ​

Group.findId

Defined in ​

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


getPath ​

▸ getPath(curve?, pathForRender?): IPathCommandData

Parameters ​

NameType
curve?boolean
pathForRender?boolean

Returns ​

IPathCommandData

Implementation of ​

IPen.getPath

Inherited from ​

Group.getPath

Defined in ​

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


getPathString ​

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

Parameters ​

NameType
curve?boolean
pathForRender?boolean
floatLength?number

Returns ​

string

Implementation of ​

IPen.getPathString

Inherited from ​

Group.getPathString

Defined in ​

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


load ​

▸ load(): void

Returns ​

void

Implementation of ​

IPen.load

Inherited from ​

Group.load

Defined in ​

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


__onUpdateSize ​

▸ __onUpdateSize(): void

Returns ​

void

Implementation of ​

IPen.__onUpdateSize

Inherited from ​

Group.__onUpdateSize

Defined in ​

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


__updateRenderPath ​

▸ __updateRenderPath(): void

Returns ​

void

Implementation of ​

IPen.__updateRenderPath

Inherited from ​

Group.__updateRenderPath

Defined in ​

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


__drawRenderPath ​

▸ __drawRenderPath(canvas): void

Parameters ​

NameType
canvasILeaferCanvas

Returns ​

void

Implementation of ​

IPen.__drawRenderPath

Inherited from ​

Group.__drawRenderPath

Defined in ​

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


__drawPath ​

▸ __drawPath(canvas): void

Parameters ​

NameType
canvasILeaferCanvas

Returns ​

void

Implementation of ​

IPen.__drawPath

Inherited from ​

Group.__drawPath

Defined in ​

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


__drawPathByData ​

▸ __drawPathByData(drawer, data): void

Parameters ​

NameType
drawerIPathDrawer
dataIPathCommandData

Returns ​

void

Implementation of ​

IPen.__drawPathByData

Inherited from ​

Group.__drawPathByData

Defined in ​

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


__drawPathByBox ​

▸ __drawPathByBox(drawer): void

Parameters ​

NameType
drawerIPathDrawer

Returns ​

void

Implementation of ​

IPen.__drawPathByBox

Inherited from ​

Group.__drawPathByBox

Defined in ​

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


animate ​

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

Parameters ​

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

Returns ​

IAnimate

Implementation of ​

IPen.animate

Inherited from ​

Group.animate

Defined in ​

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


killAnimate ​

▸ killAnimate(_type?): void

Parameters ​

NameType
_type?IAnimateType

Returns ​

void

Implementation of ​

IPen.killAnimate

Inherited from ​

Group.killAnimate

Defined in ​

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


export ​

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

Parameters ​

NameType
filenamestring
options?number | boolean | IExportOptions

Returns ​

Promise<IExportResult>

Implementation of ​

IPen.export

Inherited from ​

Group.export

Defined in ​

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


clone ​

▸ clone(data?): IUI

Parameters ​

NameType
data?IUIInputData

Returns ​

IUI

Implementation of ​

IPen.clone

Inherited from ​

Group.clone

Defined in ​

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


one ​

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

Parameters ​

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

Returns ​

IUI

Inherited from ​

Group.one

Defined in ​

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


registerUI ​

▸ registerUI(): void

Returns ​

void

Inherited from ​

Group.registerUI

Defined in ​

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


registerData ​

▸ registerData(data): void

Parameters ​

NameType
dataIUIData

Returns ​

void

Inherited from ​

Group.registerData

Defined in ​

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


setEditConfig ​

▸ setEditConfig(_config): void

Parameters ​

NameType
_configIEditorConfig | IEditorConfigFunction

Returns ​

void

Inherited from ​

Group.setEditConfig

Defined in ​

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


setEditOuter ​

▸ setEditOuter(_toolName): void

Parameters ​

NameType
_toolNamestring | IEditToolFunction

Returns ​

void

Inherited from ​

Group.setEditOuter

Defined in ​

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


setEditInner ​

▸ setEditInner(_editorName): void

Parameters ​

NameType
_editorNamestring | IEditToolFunction

Returns ​

void

Inherited from ​

Group.setEditInner

Defined in ​

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


destroy ​

▸ destroy(): void

Returns ​

void

Implementation of ​

IPen.destroy

Inherited from ​

Group.destroy

Defined in ​

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

Released under the MIT License.