Skip to content

Class: Pen

Hierarchy

Implements

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new Pen(data?)

Parameters

NameType
data?IPenInputData

Overrides

Group.constructor

Defined in

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

Properties

innerId

Readonly innerId: number

Implementation of

IPen.innerId

Inherited from

Group.innerId

Defined in

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


__layout

__layout: ILeafLayout

Implementation of

IPen.__layout

Inherited from

Group.__layout

Defined in

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


__world

__world: IMatrixWithBoundsScaleData

Implementation of

IPen.__world

Inherited from

Group.__world

Defined in

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


__local

Optional __local: IMatrixWithBoundsData

Implementation of

IPen.__local

Inherited from

Group.__local

Defined in

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


__nowWorld

Optional __nowWorld: IMatrixWithBoundsScaleData

Implementation of

IPen.__nowWorld

Inherited from

Group.__nowWorld

Defined in

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


__cameraWorld

Optional __cameraWorld: IMatrixWithBoundsScaleData

Implementation of

IPen.__cameraWorld

Inherited from

Group.__cameraWorld

Defined in

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


__worldOpacity

__worldOpacity: number

Implementation of

IPen.__worldOpacity

Inherited from

Group.__worldOpacity

Defined in

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


__level

__level: number

Implementation of

IPen.__level

Inherited from

Group.__level

Defined in

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


__tempNumber

__tempNumber: number

Implementation of

IPen.__tempNumber

Inherited from

Group.__tempNumber

Defined in

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


__hasAutoLayout

Optional __hasAutoLayout: boolean

Implementation of

IPen.__hasAutoLayout

Inherited from

Group.__hasAutoLayout

Defined in

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


__hasMask

Optional __hasMask: boolean

Implementation of

IPen.__hasMask

Inherited from

Group.__hasMask

Defined in

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


__hasEraser

Optional __hasEraser: boolean

Implementation of

IPen.__hasEraser

Inherited from

Group.__hasEraser

Defined in

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


__hitCanvas

Optional __hitCanvas: IHitCanvas

Implementation of

IPen.__hitCanvas

Inherited from

Group.__hitCanvas

Defined in

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


__captureMap

Optional __captureMap: IEventListenerMap

Implementation of

IPen.__captureMap

Inherited from

Group.__captureMap

Defined in

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


__bubbleMap

Optional __bubbleMap: IEventListenerMap

Implementation of

IPen.__bubbleMap

Inherited from

Group.__bubbleMap

Defined in

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


__parentWait

Optional __parentWait: IFunction[]

Implementation of

IPen.__parentWait

Inherited from

Group.__parentWait

Defined in

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


__leaferWait

Optional __leaferWait: IFunction[]

Implementation of

IPen.__leaferWait

Inherited from

Group.__leaferWait

Defined in

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


noBounds

Optional noBounds: boolean

Implementation of

IPen.noBounds

Inherited from

Group.noBounds

Defined in

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


destroyed

destroyed: boolean

Implementation of

IPen.destroyed

Inherited from

Group.destroyed

Defined in

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


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


pathElement

pathElement: IPath

Implementation of

IPen.pathElement

Defined in

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


pathStyle

pathStyle: IPathInputData

Implementation of

IPen.pathStyle

Defined in

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


path

path: IPathCommandData

Implementation of

IPen.path

Overrides

Group.path

Defined in

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


__path

__path: IPathCommandData

Implementation of

IPen.__path

Defined in

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


proxyData

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

id: string

Implementation of

IPen.id

Inherited from

Group.id

Defined in

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


name

name: string

Implementation of

IPen.name

Inherited from

Group.name

Defined in

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


className

className: string

Implementation of

IPen.className

Inherited from

Group.className

Defined in

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


blendMode

blendMode: IBlendMode

Implementation of

IPen.blendMode

Inherited from

Group.blendMode

Defined in

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


opacity

opacity: number

Implementation of

IPen.opacity

Inherited from

Group.opacity

Defined in

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


visible

visible: boolean

Implementation of

IPen.visible

Inherited from

Group.visible

Defined in

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


selected

selected: boolean

Implementation of

IPen.selected

Inherited from

Group.selected

Defined in

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


disabled

disabled: boolean

Implementation of

IPen.disabled

Inherited from

Group.disabled

Defined in

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


locked

locked: boolean

Implementation of

IPen.locked

Inherited from

Group.locked

Defined in

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


zIndex

zIndex: number

Implementation of

IPen.zIndex

Inherited from

Group.zIndex

Defined in

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


mask

mask: boolean

Implementation of

IPen.mask

Inherited from

Group.mask

Defined in

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


maskType

maskType: IMaskType

Implementation of

IPen.maskType

Inherited from

Group.maskType

Defined in

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


eraser

eraser: boolean

Implementation of

IPen.eraser

Inherited from

Group.eraser

Defined in

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


x

x: number

Implementation of

IPen.x

Inherited from

Group.x

Defined in

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


y

y: number

Implementation of

IPen.y

Inherited from

Group.y

Defined in

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


width

width: number

Implementation of

IPen.width

Inherited from

Group.width

Defined in

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


height

height: number

Implementation of

IPen.height

Inherited from

Group.height

Defined in

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


scaleX

scaleX: number

Implementation of

IPen.scaleX

Inherited from

Group.scaleX

Defined in

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


scaleY

scaleY: number

Implementation of

IPen.scaleY

Inherited from

Group.scaleY

Defined in

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


rotation

rotation: number

Implementation of

IPen.rotation

Inherited from

Group.rotation

Defined in

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


skewX

skewX: number

Implementation of

IPen.skewX

Inherited from

Group.skewX

Defined in

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


skewY

skewY: number

Implementation of

IPen.skewY

Inherited from

Group.skewY

Defined in

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


around

around: IAround

Implementation of

IPen.around

Inherited from

Group.around

Defined in

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


draggable

draggable: boolean

Implementation of

IPen.draggable

Inherited from

Group.draggable

Defined in

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


editable

editable: boolean

Implementation of

IPen.editable

Inherited from

Group.editable

Defined in

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


editSize

Optional editSize: IEditSize

Implementation of

IPen.editSize

Inherited from

Group.editSize

Defined in

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


editorStyle

editorStyle: IEditorConfig

Implementation of

IPen.editorStyle

Inherited from

Group.editorStyle

Defined in

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


hittable

hittable: boolean

Implementation of

IPen.hittable

Inherited from

Group.hittable

Defined in

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


hitFill

hitFill: IHitType

Implementation of

IPen.hitFill

Inherited from

Group.hitFill

Defined in

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


hitStroke

hitStroke: IHitType

Implementation of

IPen.hitStroke

Inherited from

Group.hitStroke

Defined in

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


hitBox

hitBox: boolean

Implementation of

IPen.hitBox

Inherited from

Group.hitBox

Defined in

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


hitChildren

hitChildren: boolean

Implementation of

IPen.hitChildren

Inherited from

Group.hitChildren

Defined in

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


hitSelf

hitSelf: boolean

Implementation of

IPen.hitSelf

Inherited from

Group.hitSelf

Defined in

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


hitRadius

hitRadius: number

Implementation of

IPen.hitRadius

Inherited from

Group.hitRadius

Defined in

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


cursor

cursor: ICursorType | ICursorType[]

Implementation of

IPen.cursor

Inherited from

Group.cursor

Defined in

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


fill

fill: IFill

Implementation of

IPen.fill

Inherited from

Group.fill

Defined in

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


stroke

stroke: IStroke

Implementation of

IPen.stroke

Inherited from

Group.stroke

Defined in

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


strokeAlign

strokeAlign: IStrokeAlign

Implementation of

IPen.strokeAlign

Inherited from

Group.strokeAlign

Defined in

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


strokeWidth

strokeWidth: string | number | number[]

Implementation of

IPen.strokeWidth

Inherited from

Group.strokeWidth

Defined in

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


strokeWidthFixed

strokeWidthFixed: boolean

Implementation of

IPen.strokeWidthFixed

Inherited from

Group.strokeWidthFixed

Defined in

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


strokeCap

strokeCap: IStrokeCap

Implementation of

IPen.strokeCap

Inherited from

Group.strokeCap

Defined in

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


strokeJoin

strokeJoin: IStrokeJoin

Implementation of

IPen.strokeJoin

Inherited from

Group.strokeJoin

Defined in

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


dashPattern

dashPattern: string | number[]

Implementation of

IPen.dashPattern

Inherited from

Group.dashPattern

Defined in

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


dashOffset

dashOffset: number

Implementation of

IPen.dashOffset

Inherited from

Group.dashOffset

Defined in

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


miterLimit

miterLimit: number

Implementation of

IPen.miterLimit

Inherited from

Group.miterLimit

Defined in

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


lazy

lazy: boolean

Implementation of

IPen.lazy

Inherited from

Group.lazy

Defined in

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


pixelRatio

pixelRatio: number

Implementation of

IPen.pixelRatio

Inherited from

Group.pixelRatio

Defined in

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


windingRule

windingRule: IWindingRule

Implementation of

IPen.windingRule

Inherited from

Group.windingRule

Defined in

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


closed

closed: boolean

Implementation of

IPen.closed

Inherited from

Group.closed

Defined in

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


startArrow

startArrow: IArrowType

Implementation of

IPen.startArrow

Inherited from

Group.startArrow

Defined in

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


endArrow

endArrow: IArrowType

Implementation of

IPen.endArrow

Inherited from

Group.endArrow

Defined in

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


cornerRadius

cornerRadius: string | number | number[]

Implementation of

IPen.cornerRadius

Inherited from

Group.cornerRadius

Defined in

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


cornerSmoothing

cornerSmoothing: number

Implementation of

IPen.cornerSmoothing

Inherited from

Group.cornerSmoothing

Defined in

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


shadow

shadow: string | IShadowEffect | IShadowEffect[]

Implementation of

IPen.shadow

Inherited from

Group.shadow

Defined in

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


innerShadow

innerShadow: string | IShadowEffect | IShadowEffect[]

Implementation of

IPen.innerShadow

Inherited from

Group.innerShadow

Defined in

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


blur

blur: number | IBlurEffect

Implementation of

IPen.blur

Inherited from

Group.blur

Defined in

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


backgroundBlur

backgroundBlur: number | IBlurEffect

Implementation of

IPen.backgroundBlur

Inherited from

Group.backgroundBlur

Defined in

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


grayscale

grayscale: number | IGrayscaleEffect

Implementation of

IPen.grayscale

Inherited from

Group.grayscale

Defined in

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


normalStyle

normalStyle: IUIInputData

Implementation of

IPen.normalStyle

Inherited from

Group.normalStyle

Defined in

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


hoverStyle

hoverStyle: IUIInputData

Implementation of

IPen.hoverStyle

Inherited from

Group.hoverStyle

Defined in

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


pressStyle

pressStyle: IUIInputData

Implementation of

IPen.pressStyle

Inherited from

Group.pressStyle

Defined in

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


focusStyle

focusStyle: IUIInputData

Implementation of

IPen.focusStyle

Inherited from

Group.focusStyle

Defined in

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


selectedStyle

selectedStyle: IUIInputData

Implementation of

IPen.selectedStyle

Inherited from

Group.selectedStyle

Defined in

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


disabledStyle

disabledStyle: IUIInputData

Implementation of

IPen.disabledStyle

Inherited from

Group.disabledStyle

Defined in

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

Accessors

tag

get tag(): string

Returns

string

Implementation of

IPen.tag

Inherited from

Group.tag

Defined in

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

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


innerName

get innerName(): string

Returns

string

Implementation of

IPen.innerName

Inherited from

Group.innerName

Defined in

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


__DataProcessor

get __DataProcessor(): typeof LeafData

Returns

typeof LeafData

Implementation of

IPen.__DataProcessor

Inherited from

Group.__DataProcessor

Defined in

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


__LayoutProcessor

get __LayoutProcessor(): typeof LeafLayout

Returns

typeof LeafLayout

Implementation of

IPen.__LayoutProcessor

Inherited from

Group.__LayoutProcessor

Defined in

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


isLeafer

get isLeafer(): boolean

Returns

boolean

Implementation of

IPen.isLeafer

Inherited from

Group.isLeafer

Defined in

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


isBranchLeaf

get isBranchLeaf(): boolean

Returns

boolean

Implementation of

IPen.isBranchLeaf

Inherited from

Group.isBranchLeaf

Defined in

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


__localMatrix

get __localMatrix(): IMatrixData

Returns

IMatrixData

Implementation of

IPen.__localMatrix

Inherited from

Group.__localMatrix

Defined in

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


__localBoxBounds

get __localBoxBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IPen.__localBoxBounds

Inherited from

Group.__localBoxBounds

Defined in

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


worldTransform

get worldTransform(): IMatrixWithScaleData

Returns

IMatrixWithScaleData

Implementation of

IPen.worldTransform

Inherited from

Group.worldTransform

Defined in

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


localTransform

get localTransform(): IMatrixData

Returns

IMatrixData

Implementation of

IPen.localTransform

Inherited from

Group.localTransform

Defined in

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


boxBounds

get boxBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IPen.boxBounds

Inherited from

Group.boxBounds

Defined in

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


renderBounds

get renderBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IPen.renderBounds

Inherited from

Group.renderBounds

Defined in

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


worldBoxBounds

get worldBoxBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IPen.worldBoxBounds

Inherited from

Group.worldBoxBounds

Defined in

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


worldStrokeBounds

get worldStrokeBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IPen.worldStrokeBounds

Inherited from

Group.worldStrokeBounds

Defined in

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


worldRenderBounds

get worldRenderBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IPen.worldRenderBounds

Inherited from

Group.worldRenderBounds

Defined in

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


worldOpacity

get worldOpacity(): number

Returns

number

Implementation of

IPen.worldOpacity

Inherited from

Group.worldOpacity

Defined in

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


__worldFlipped

get __worldFlipped(): boolean

Returns

boolean

Implementation of

IPen.__worldFlipped

Inherited from

Group.__worldFlipped

Defined in

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


__onlyHitMask

get __onlyHitMask(): boolean

Returns

boolean

Implementation of

IPen.__onlyHitMask

Inherited from

Group.__onlyHitMask

Defined in

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


__ignoreHitWorld

get __ignoreHitWorld(): boolean

Returns

boolean

Implementation of

IPen.__ignoreHitWorld

Inherited from

Group.__ignoreHitWorld

Defined in

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


pathInputed

get pathInputed(): boolean

Returns

boolean

Implementation of

IPen.pathInputed

Inherited from

Group.pathInputed

Defined in

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


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


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

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


pen

get pen(): IPathCreator

Returns

IPathCreator

Inherited from

Group.pen

Defined in

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

Methods

resetCustom

resetCustom(): void

Returns

void

Implementation of

IPen.resetCustom

Inherited from

Group.resetCustom

Defined in

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


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


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


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


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


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


toString

toString(): string

Returns

string

Implementation of

IPen.toString

Inherited from

Group.toString

Defined in

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


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


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


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


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


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


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


updateLayout

updateLayout(): void

Returns

void

Implementation of

IPen.updateLayout

Inherited from

Group.updateLayout

Defined in

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


__updateWorldMatrix

__updateWorldMatrix(): void

Returns

void

Implementation of

IPen.__updateWorldMatrix

Inherited from

Group.__updateWorldMatrix

Defined in

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


__updateLocalMatrix

__updateLocalMatrix(): void

Returns

void

Implementation of

IPen.__updateLocalMatrix

Inherited from

Group.__updateLocalMatrix

Defined in

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


__updateWorldBounds

__updateWorldBounds(): void

Returns

void

Implementation of

IPen.__updateWorldBounds

Inherited from

Group.__updateWorldBounds

Defined in

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


__updateLocalBounds

__updateLocalBounds(): void

Returns

void

Implementation of

IPen.__updateLocalBounds

Inherited from

Group.__updateLocalBounds

Defined in

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


__updateLocalBoxBounds

__updateLocalBoxBounds(): void

Returns

void

Implementation of

IPen.__updateLocalBoxBounds

Inherited from

Group.__updateLocalBoxBounds

Defined in

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


__updateLocalStrokeBounds

__updateLocalStrokeBounds(): void

Returns

void

Implementation of

IPen.__updateLocalStrokeBounds

Inherited from

Group.__updateLocalStrokeBounds

Defined in

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


__updateLocalRenderBounds

__updateLocalRenderBounds(): void

Returns

void

Implementation of

IPen.__updateLocalRenderBounds

Inherited from

Group.__updateLocalRenderBounds

Defined in

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


__updateBoxBounds

__updateBoxBounds(): void

Returns

void

Implementation of

IPen.__updateBoxBounds

Inherited from

Group.__updateBoxBounds

Defined in

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


__updateStrokeBounds

__updateStrokeBounds(): void

Returns

void

Implementation of

IPen.__updateStrokeBounds

Inherited from

Group.__updateStrokeBounds

Defined in

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


__updateRenderBounds

__updateRenderBounds(): void

Returns

void

Implementation of

IPen.__updateRenderBounds

Inherited from

Group.__updateRenderBounds

Defined in

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


__updateAutoLayout

__updateAutoLayout(): void

Returns

void

Implementation of

IPen.__updateAutoLayout

Inherited from

Group.__updateAutoLayout

Defined in

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


__updateNaturalSize

__updateNaturalSize(): void

Returns

void

Implementation of

IPen.__updateNaturalSize

Inherited from

Group.__updateNaturalSize

Defined in

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


__updateStrokeSpread

__updateStrokeSpread(): number

Returns

number

Implementation of

IPen.__updateStrokeSpread

Inherited from

Group.__updateStrokeSpread

Defined in

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


__updateRenderSpread

__updateRenderSpread(): number

Returns

number

Implementation of

IPen.__updateRenderSpread

Inherited from

Group.__updateRenderSpread

Defined in

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


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


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


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


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


getWorld

getWorld(attrName): number

Parameters

NameType
attrNameILayoutAttr

Returns

number

Implementation of

IPen.getWorld

Inherited from

Group.getWorld

Defined in

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


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


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


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


getLayoutPoints

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

Parameters

NameType
type?IBoundsType
relative?ILeaf | ILocationType

Returns

IPointData[]

Inherited from

Group.getLayoutPoints

Defined in

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


getWorldBounds

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

Parameters

NameType
innerIBoundsData
relative?ILeaf
change?boolean

Returns

IBoundsData

Implementation of

IPen.getWorldBounds

Inherited from

Group.getWorldBounds

Defined in

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


worldToLocal

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

Parameters

NameType
worldIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns

void

Implementation of

IPen.worldToLocal

Inherited from

Group.worldToLocal

Defined in

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


localToWorld

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

Parameters

NameType
localIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns

void

Implementation of

IPen.localToWorld

Inherited from

Group.localToWorld

Defined in

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


worldToInner

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

Parameters

NameType
worldIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns

void

Implementation of

IPen.worldToInner

Inherited from

Group.worldToInner

Defined in

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


innerToWorld

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

Parameters

NameType
innerIPointData
to?IPointData
distance?boolean
relative?ILeaf

Returns

void

Implementation of

IPen.innerToWorld

Inherited from

Group.innerToWorld

Defined in

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


getInnerPoint

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

Parameters

NameType
worldIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IPen.getInnerPoint

Inherited from

Group.getInnerPoint

Defined in

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


getInnerPointByLocal

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

Parameters

NameType
localIPointData
_relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IPen.getInnerPointByLocal

Inherited from

Group.getInnerPointByLocal

Defined in

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


getLocalPoint

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

Parameters

NameType
worldIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IPen.getLocalPoint

Inherited from

Group.getLocalPoint

Defined in

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


getLocalPointByInner

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

Parameters

NameType
innerIPointData
_relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IPen.getLocalPointByInner

Inherited from

Group.getLocalPointByInner

Defined in

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


getWorldPoint

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

Parameters

NameType
innerIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IPen.getWorldPoint

Inherited from

Group.getWorldPoint

Defined in

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


getWorldPointByLocal

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

Parameters

NameType
localIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IPen.getWorldPointByLocal

Inherited from

Group.getWorldPointByLocal

Defined in

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


getPagePoint

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

Parameters

NameType
worldIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IPen.getPagePoint

Inherited from

Group.getPagePoint

Defined in

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


getWorldPointByPage

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

Parameters

NameType
pageIPointData
relative?ILeaf
distance?boolean
change?boolean

Returns

IPointData

Implementation of

IPen.getWorldPointByPage

Inherited from

Group.getWorldPointByPage

Defined in

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


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


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


move

move(x, y?): void

Parameters

NameType
xnumber
y?number

Returns

void

Implementation of

IPen.move

Inherited from

Group.move

Defined in

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


scaleOf

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

Parameters

NameType
originIPointData
scaleXnumber
scaleY?number
resize?boolean

Returns

void

Implementation of

IPen.scaleOf

Inherited from

Group.scaleOf

Defined in

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


rotateOf

rotateOf(origin, rotation): void

Parameters

NameType
originIPointData
rotationnumber

Returns

void

Implementation of

IPen.rotateOf

Inherited from

Group.rotateOf

Defined in

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


skewOf

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

Parameters

NameType
originIPointData
skewXnumber
skewY?number
resize?boolean

Returns

void

Implementation of

IPen.skewOf

Inherited from

Group.skewOf

Defined in

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


transformWorld

transformWorld(worldTransform?, resize?): void

Parameters

NameType
worldTransform?IMatrixData
resize?boolean

Returns

void

Implementation of

IPen.transformWorld

Inherited from

Group.transformWorld

Defined in

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


moveWorld

moveWorld(x, y?): void

Parameters

NameType
xnumber
y?number

Returns

void

Implementation of

IPen.moveWorld

Inherited from

Group.moveWorld

Defined in

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


scaleOfWorld

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

Parameters

NameType
worldOriginIPointData
scaleXnumber
scaleY?number
resize?boolean

Returns

void

Implementation of

IPen.scaleOfWorld

Inherited from

Group.scaleOfWorld

Defined in

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


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


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


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


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


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


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


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


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


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


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


__updateHitCanvas

__updateHitCanvas(): void

Returns

void

Implementation of

IPen.__updateHitCanvas

Inherited from

Group.__updateHitCanvas

Defined in

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


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


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


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


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


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


__updateWorldOpacity

__updateWorldOpacity(): void

Returns

void

Implementation of

IPen.__updateWorldOpacity

Inherited from

Group.__updateWorldOpacity

Defined in

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


__updateChange

__updateChange(): void

Returns

void

Implementation of

IPen.__updateChange

Inherited from

Group.__updateChange

Defined in

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


__updatePath

__updatePath(): void

Returns

void

Implementation of

IPen.__updatePath

Inherited from

Group.__updatePath

Defined in

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


__updateSortChildren

__updateSortChildren(): void

Returns

void

Implementation of

IPen.__updateSortChildren

Inherited from

Group.__updateSortChildren

Defined in

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


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


on

on(_type, _listener, _options?): void

Parameters

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

Returns

void

Implementation of

IPen.on

Inherited from

Group.on

Defined in

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


off

off(_type, _listener, _options?): void

Parameters

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

Returns

void

Implementation of

IPen.off

Inherited from

Group.off

Defined in

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


on_

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

Parameters

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

Returns

IEventListenerId

Implementation of

IPen.on_

Inherited from

Group.on_

Defined in

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


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


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


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


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


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


changeAttr

Static changeAttr(attrName, defaultValue): void

Parameters

NameType
attrNamestring
defaultValueIValue

Returns

void

Inherited from

Group.changeAttr

Defined in

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


addAttr

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

Parameters

NameType
attrNamestring
defaultValueIValue
fn?IAttrDecorator

Returns

void

Inherited from

Group.addAttr

Defined in

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


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

Parameters

NameType
dataIUIInputData

Returns

void

Implementation of

IPen.set

Inherited from

Group.set

Defined in

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


toJSON

toJSON(): IUIInputData

Returns

IUIInputData

Implementation of

IPen.toJSON

Inherited from

Group.toJSON

Defined in

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


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


addAt

addAt(child, index): void

Parameters

NameType
childIUI
indexnumber

Returns

void

Implementation of

IPen.addAt

Inherited from

Group.addAt

Defined in

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


addAfter

addAfter(child, after): void

Parameters

NameType
childIUI
afterIUI

Returns

void

Implementation of

IPen.addAfter

Inherited from

Group.addAfter

Defined in

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


addBefore

addBefore(child, before): void

Parameters

NameType
childUI
beforeIUI

Returns

void

Implementation of

IPen.addBefore

Inherited from

Group.addBefore

Defined in

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


add

add(_child, _index?): void

Parameters

NameType
_childIUI
_index?number

Returns

void

Implementation of

IPen.add

Inherited from

Group.add

Defined in

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


addMany

addMany(..._children): void

Parameters

NameType
..._childrenIUI[]

Returns

void

Implementation of

IPen.addMany

Inherited from

Group.addMany

Defined in

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


remove

remove(_child?, _destroy?): void

Parameters

NameType
_child?IUI
_destroy?boolean

Returns

void

Implementation of

IPen.remove

Inherited from

Group.remove

Defined in

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


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


clear

clear(): void

Returns

void

Implementation of

IPen.clear

Inherited from

Group.clear

Defined in

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


setStyle

setStyle(data): Pen

Parameters

NameType
dataIPathInputData

Returns

Pen

Defined in

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


beginPath

beginPath(): Pen

Returns

Pen

Implementation of

IPen.beginPath

Defined in

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


moveTo

moveTo(_x, _y): Pen

Parameters

NameType
_xnumber
_ynumber

Returns

Pen

Implementation of

IPen.moveTo

Defined in

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


lineTo

lineTo(_x, _y): Pen

Parameters

NameType
_xnumber
_ynumber

Returns

Pen

Implementation of

IPen.lineTo

Defined in

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


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


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


closePath

closePath(): Pen

Returns

Pen

Implementation of

IPen.closePath

Defined in

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


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


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


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


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


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


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


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


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


clearPath

clearPath(): Pen

Returns

Pen

Implementation of

IPen.clearPath

Defined in

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


paint

paint(): void

Returns

void

Implementation of

IPen.paint

Defined in

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


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


createProxyData

createProxyData(): IUIInputData

Returns

IUIInputData

Implementation of

IPen.createProxyData

Inherited from

Group.createProxyData

Defined in

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


find

find(_condition, _options?): IUI[]

Parameters

NameType
_conditionstring | number | IFindUIMethod
_options?any

Returns

IUI[]

Implementation of

IPen.find

Inherited from

Group.find

Defined in

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


findOne

findOne(_condition, _options?): IUI

Parameters

NameType
_conditionstring | number | IFindUIMethod
_options?any

Returns

IUI

Implementation of

IPen.findOne

Inherited from

Group.findOne

Defined in

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


getPath

getPath(curve?, pathForRender?): IPathCommandData

Parameters

NameType
curve?boolean
pathForRender?boolean

Returns

IPathCommandData

Implementation of

IPen.getPath

Inherited from

Group.getPath

Defined in

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


getPathString

getPathString(curve?, pathForRender?): string

Parameters

NameType
curve?boolean
pathForRender?boolean

Returns

string

Implementation of

IPen.getPathString

Inherited from

Group.getPathString

Defined in

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


__onUpdateSize

__onUpdateSize(): void

Returns

void

Implementation of

IPen.__onUpdateSize

Inherited from

Group.__onUpdateSize

Defined in

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


__updateRenderPath

__updateRenderPath(): void

Returns

void

Implementation of

IPen.__updateRenderPath

Inherited from

Group.__updateRenderPath

Defined in

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


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


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


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


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


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


clone

clone(): IUI

Returns

IUI

Implementation of

IPen.clone

Inherited from

Group.clone

Defined in

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


one

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

Parameters

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

Returns

IUI

Inherited from

Group.one

Defined in

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


registerUI

Static registerUI(): void

Returns

void

Inherited from

Group.registerUI

Defined in

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


registerData

Static registerData(data): void

Parameters

NameType
dataIUIData

Returns

void

Inherited from

Group.registerData

Defined in

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


destroy

destroy(): void

Returns

void

Implementation of

IPen.destroy

Inherited from

Group.destroy

Defined in

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

Released under the MIT License.