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:172


autoBox โ€‹

โ€ข Optional autoBox: IAutoBoxData | IConstraint

Implementation of โ€‹

IPen.autoBox

Inherited from โ€‹

Group.autoBox

Defined in โ€‹

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


widthRange โ€‹

โ€ข Optional widthRange: IRangeSize

Implementation of โ€‹

IPen.widthRange

Inherited from โ€‹

Group.widthRange

Defined in โ€‹

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


heightRange โ€‹

โ€ข Optional heightRange: IRangeSize

Implementation of โ€‹

IPen.heightRange

Inherited from โ€‹

Group.heightRange

Defined in โ€‹

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


draggable โ€‹

โ€ข Optional draggable: boolean | IAxis

Implementation of โ€‹

IPen.draggable

Inherited from โ€‹

Group.draggable

Defined in โ€‹

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


dragBounds โ€‹

โ€ข Optional dragBounds: "parent" | IBoundsData

Implementation of โ€‹

IPen.dragBounds

Inherited from โ€‹

Group.dragBounds

Defined in โ€‹

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


editable โ€‹

โ€ข Optional editable: boolean

Implementation of โ€‹

IPen.editable

Inherited from โ€‹

Group.editable

Defined in โ€‹

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


hittable โ€‹

โ€ข Optional hittable: boolean

Implementation of โ€‹

IPen.hittable

Inherited from โ€‹

Group.hittable

Defined in โ€‹

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


hitFill โ€‹

โ€ข Optional hitFill: IHitType

Implementation of โ€‹

IPen.hitFill

Inherited from โ€‹

Group.hitFill

Defined in โ€‹

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


hitStroke โ€‹

โ€ข Optional hitStroke: IHitType

Implementation of โ€‹

IPen.hitStroke

Inherited from โ€‹

Group.hitStroke

Defined in โ€‹

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


hitBox โ€‹

โ€ข Optional hitBox: boolean

Implementation of โ€‹

IPen.hitBox

Inherited from โ€‹

Group.hitBox

Defined in โ€‹

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


hitChildren โ€‹

โ€ข Optional hitChildren: boolean

Implementation of โ€‹

IPen.hitChildren

Inherited from โ€‹

Group.hitChildren

Defined in โ€‹

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


hitSelf โ€‹

โ€ข Optional hitSelf: boolean

Implementation of โ€‹

IPen.hitSelf

Inherited from โ€‹

Group.hitSelf

Defined in โ€‹

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


hitRadius โ€‹

โ€ข Optional hitRadius: number

Implementation of โ€‹

IPen.hitRadius

Inherited from โ€‹

Group.hitRadius

Defined in โ€‹

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


cursor โ€‹

โ€ข Optional cursor: ICursorType | ICursorType[]

Implementation of โ€‹

IPen.cursor

Inherited from โ€‹

Group.cursor

Defined in โ€‹

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


fill โ€‹

โ€ข Optional fill: IFill

Implementation of โ€‹

IPen.fill

Inherited from โ€‹

Group.fill

Defined in โ€‹

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


stroke โ€‹

โ€ข Optional stroke: IStroke

Implementation of โ€‹

IPen.stroke

Inherited from โ€‹

Group.stroke

Defined in โ€‹

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


strokeAlign โ€‹

โ€ข Optional strokeAlign: IStrokeAlign

Implementation of โ€‹

IPen.strokeAlign

Inherited from โ€‹

Group.strokeAlign

Defined in โ€‹

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


strokeWidth โ€‹

โ€ข Optional strokeWidth: string | IFourNumber

Implementation of โ€‹

IPen.strokeWidth

Inherited from โ€‹

Group.strokeWidth

Defined in โ€‹

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


strokeWidthFixed โ€‹

โ€ข Optional strokeWidthFixed: boolean

Implementation of โ€‹

IPen.strokeWidthFixed

Inherited from โ€‹

Group.strokeWidthFixed

Defined in โ€‹

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


strokeCap โ€‹

โ€ข Optional strokeCap: IStrokeCap

Implementation of โ€‹

IPen.strokeCap

Inherited from โ€‹

Group.strokeCap

Defined in โ€‹

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


strokeJoin โ€‹

โ€ข Optional strokeJoin: IStrokeJoin

Implementation of โ€‹

IPen.strokeJoin

Inherited from โ€‹

Group.strokeJoin

Defined in โ€‹

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


dashPattern โ€‹

โ€ข Optional dashPattern: string | number[]

Implementation of โ€‹

IPen.dashPattern

Inherited from โ€‹

Group.dashPattern

Defined in โ€‹

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


dashOffset โ€‹

โ€ข Optional dashOffset: number

Implementation of โ€‹

IPen.dashOffset

Inherited from โ€‹

Group.dashOffset

Defined in โ€‹

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


miterLimit โ€‹

โ€ข Optional miterLimit: number

Implementation of โ€‹

IPen.miterLimit

Inherited from โ€‹

Group.miterLimit

Defined in โ€‹

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


startArrow โ€‹

โ€ข Optional startArrow: IArrowType

Implementation of โ€‹

IPen.startArrow

Inherited from โ€‹

Group.startArrow

Defined in โ€‹

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


endArrow โ€‹

โ€ข Optional endArrow: IArrowType

Implementation of โ€‹

IPen.endArrow

Inherited from โ€‹

Group.endArrow

Defined in โ€‹

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


cornerRadius โ€‹

โ€ข Optional cornerRadius: string | IFourNumber

Implementation of โ€‹

IPen.cornerRadius

Inherited from โ€‹

Group.cornerRadius

Defined in โ€‹

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


cornerSmoothing โ€‹

โ€ข Optional cornerSmoothing: number

Implementation of โ€‹

IPen.cornerSmoothing

Inherited from โ€‹

Group.cornerSmoothing

Defined in โ€‹

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


shadow โ€‹

โ€ข Optional shadow: string | IShadowEffect | IShadowEffect[]

Implementation of โ€‹

IPen.shadow

Inherited from โ€‹

Group.shadow

Defined in โ€‹

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


innerShadow โ€‹

โ€ข Optional innerShadow: string | IShadowEffect | IShadowEffect[]

Implementation of โ€‹

IPen.innerShadow

Inherited from โ€‹

Group.innerShadow

Defined in โ€‹

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


blur โ€‹

โ€ข Optional blur: number | IBlurEffect

Implementation of โ€‹

IPen.blur

Inherited from โ€‹

Group.blur

Defined in โ€‹

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


backgroundBlur โ€‹

โ€ข Optional backgroundBlur: number | IBlurEffect

Implementation of โ€‹

IPen.backgroundBlur

Inherited from โ€‹

Group.backgroundBlur

Defined in โ€‹

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


grayscale โ€‹

โ€ข Optional grayscale: number | IGrayscaleEffect

Implementation of โ€‹

IPen.grayscale

Inherited from โ€‹

Group.grayscale

Defined in โ€‹

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


filter โ€‹

โ€ข Optional filter: IObject | IObject[]

Inherited from โ€‹

Group.filter

Defined in โ€‹

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


animation โ€‹

โ€ข Optional animation: IAnimation

Implementation of โ€‹

IPen.animation

Inherited from โ€‹

Group.animation

Defined in โ€‹

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


animationOut โ€‹

โ€ข Optional animationOut: IAnimation

Implementation of โ€‹

IPen.animationOut

Inherited from โ€‹

Group.animationOut

Defined in โ€‹

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


transition โ€‹

โ€ข Optional transition: ITransition

Implementation of โ€‹

IPen.transition

Inherited from โ€‹

Group.transition

Defined in โ€‹

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


transitionOut โ€‹

โ€ข Optional transitionOut: ITransition

Implementation of โ€‹

IPen.transitionOut

Inherited from โ€‹

Group.transitionOut

Defined in โ€‹

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


motionPath โ€‹

โ€ข Optional motionPath: boolean

Implementation of โ€‹

IPen.motionPath

Inherited from โ€‹

Group.motionPath

Defined in โ€‹

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


motion โ€‹

โ€ข Optional motion: number | IUnitData

Implementation of โ€‹

IPen.motion

Inherited from โ€‹

Group.motion

Defined in โ€‹

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


motionRotation โ€‹

โ€ข Optional motionRotation: number | boolean

Implementation of โ€‹

IPen.motionRotation

Inherited from โ€‹

Group.motionRotation

Defined in โ€‹

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


states โ€‹

โ€ข Optional states: IStates

Implementation of โ€‹

IPen.states

Inherited from โ€‹

Group.states

Defined in โ€‹

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


state โ€‹

โ€ข Optional state: string

Implementation of โ€‹

IPen.state

Inherited from โ€‹

Group.state

Defined in โ€‹

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


selected โ€‹

โ€ข Optional selected: boolean

Implementation of โ€‹

IPen.selected

Inherited from โ€‹

Group.selected

Defined in โ€‹

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


disabled โ€‹

โ€ข Optional disabled: boolean

Implementation of โ€‹

IPen.disabled

Inherited from โ€‹

Group.disabled

Defined in โ€‹

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


normalStyle โ€‹

โ€ข Optional normalStyle: IUIInputData

Implementation of โ€‹

IPen.normalStyle

Inherited from โ€‹

Group.normalStyle

Defined in โ€‹

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


hoverStyle โ€‹

โ€ข Optional hoverStyle: IUIInputData

Implementation of โ€‹

IPen.hoverStyle

Inherited from โ€‹

Group.hoverStyle

Defined in โ€‹

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


pressStyle โ€‹

โ€ข Optional pressStyle: IUIInputData

Implementation of โ€‹

IPen.pressStyle

Inherited from โ€‹

Group.pressStyle

Defined in โ€‹

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


focusStyle โ€‹

โ€ข Optional focusStyle: IUIInputData

Implementation of โ€‹

IPen.focusStyle

Inherited from โ€‹

Group.focusStyle

Defined in โ€‹

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


selectedStyle โ€‹

โ€ข Optional selectedStyle: IUIInputData

Implementation of โ€‹

IPen.selectedStyle

Inherited from โ€‹

Group.selectedStyle

Defined in โ€‹

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


disabledStyle โ€‹

โ€ข Optional disabledStyle: IUIInputData

Implementation of โ€‹

IPen.disabledStyle

Inherited from โ€‹

Group.disabledStyle

Defined in โ€‹

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


button โ€‹

โ€ข Optional button: boolean

Implementation of โ€‹

IPen.button

Inherited from โ€‹

Group.button

Defined in โ€‹

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


data โ€‹

โ€ข data: IObject

Implementation of โ€‹

IPen.data

Inherited from โ€‹

Group.data

Defined in โ€‹

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


__animate โ€‹

โ€ข Optional __animate: IAnimate

Implementation of โ€‹

IPen.__animate

Inherited from โ€‹

Group.__animate

Defined in โ€‹

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

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:345

โ€ข 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:344


pen โ€‹

โ€ข get pen(): IPathCreator

Returns โ€‹

IPathCreator

Implementation of โ€‹

IPen.pen

Inherited from โ€‹

Group.pen

Defined in โ€‹

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


editConfig โ€‹

โ€ข get editConfig(): IEditorConfig

Returns โ€‹

IEditorConfig

Implementation of โ€‹

IPen.editConfig

Inherited from โ€‹

Group.editConfig

Defined in โ€‹

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


editOuter โ€‹

โ€ข get editOuter(): string

Returns โ€‹

string

Implementation of โ€‹

IPen.editOuter

Inherited from โ€‹

Group.editOuter

Defined in โ€‹

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


editInner โ€‹

โ€ข get editInner(): string

Returns โ€‹

string

Implementation of โ€‹

IPen.editInner

Inherited from โ€‹

Group.editInner

Defined in โ€‹

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

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?): void

Parameters โ€‹

NameType
_bounds?IBoundsData

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?): void

Parameters โ€‹

NameType
xnumber | IPointData
y?number

Returns โ€‹

void

Implementation of โ€‹

IPen.move

Inherited from โ€‹

Group.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 โ€‹

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?): void

Parameters โ€‹

NameType
xnumber | IPointData
y?number

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, isTemp?): void

Parameters โ€‹

NameType
dataIUIInputData
isTemp?boolean

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:385


createProxyData โ€‹

โ–ธ createProxyData(): IUIInputData

Returns โ€‹

IUIInputData

Implementation of โ€‹

IPen.createProxyData

Inherited from โ€‹

Group.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 โ€‹

IPen.find

Inherited from โ€‹

Group.find

Defined in โ€‹

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


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:396


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:398


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:400


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:405


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:412


load โ€‹

โ–ธ load(): void

Returns โ€‹

void

Implementation of โ€‹

IPen.load

Inherited from โ€‹

Group.load

Defined in โ€‹

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


__onUpdateSize โ€‹

โ–ธ __onUpdateSize(): void

Returns โ€‹

void

Implementation of โ€‹

IPen.__onUpdateSize

Inherited from โ€‹

Group.__onUpdateSize

Defined in โ€‹

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


__updateRenderPath โ€‹

โ–ธ __updateRenderPath(): void

Returns โ€‹

void

Implementation of โ€‹

IPen.__updateRenderPath

Inherited from โ€‹

Group.__updateRenderPath

Defined in โ€‹

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


__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:436


__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:441


__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:446


__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:450


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:460


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:464


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:469


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:473


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:479


registerUI โ€‹

โ–ธ registerUI(): void

Returns โ€‹

void

Inherited from โ€‹

Group.registerUI

Defined in โ€‹

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


registerData โ€‹

โ–ธ registerData(data): void

Parameters โ€‹

NameType
dataIUIData

Returns โ€‹

void

Inherited from โ€‹

Group.registerData

Defined in โ€‹

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


setEditConfig โ€‹

โ–ธ setEditConfig(_config): void

Parameters โ€‹

NameType
_configIEditorConfig | IEditorConfigFunction

Returns โ€‹

void

Inherited from โ€‹

Group.setEditConfig

Defined in โ€‹

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


setEditOuter โ€‹

โ–ธ setEditOuter(_toolName): void

Parameters โ€‹

NameType
_toolNamestring | IEditToolFunction

Returns โ€‹

void

Inherited from โ€‹

Group.setEditOuter

Defined in โ€‹

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


setEditInner โ€‹

โ–ธ setEditInner(_editorName): void

Parameters โ€‹

NameType
_editorNamestring | IEditToolFunction

Returns โ€‹

void

Inherited from โ€‹

Group.setEditInner

Defined in โ€‹

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


destroy โ€‹

โ–ธ destroy(): void

Returns โ€‹

void

Implementation of โ€‹

IPen.destroy

Inherited from โ€‹

Group.destroy

Defined in โ€‹

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

Released under the MIT License.