Class: Pen
Hierarchy
↳
Pen
Implements
Table of contents
Constructors
Properties
- innerId
- __layout
- __world
- __local
- __nowWorld
- __cameraWorld
- __worldOpacity
- __level
- __tempNumber
- __hasAutoLayout
- __hasMask
- __hasEraser
- __hitCanvas
- __captureMap
- __bubbleMap
- __parentWait
- __leaferWait
- noBounds
- destroyed
- children
- __
- pathElement
- pathStyle
- path
- __path
- proxyData
- __proxyData
- leafer
- parent
- zoomLayer
- id
- name
- className
- blendMode
- opacity
- visible
- selected
- disabled
- locked
- zIndex
- mask
- eraser
- x
- y
- width
- height
- scaleX
- scaleY
- rotation
- skewX
- skewY
- offsetX
- offsetY
- scrollX
- scrollY
- origin
- around
- lazy
- pixelRatio
- windingRule
- closed
- flow
- padding
- gap
- flowAlign
- flowWrap
- itemBox
- inFlow
- autoWidth
- autoHeight
- lockRatio
- autoBox
- widthRange
- heightRange
- draggable
- dragBounds
- editable
- hittable
- hitFill
- hitStroke
- hitBox
- hitChildren
- hitSelf
- hitRadius
- cursor
- fill
- stroke
- strokeAlign
- strokeWidth
- strokeWidthFixed
- strokeCap
- strokeJoin
- dashPattern
- dashOffset
- miterLimit
- startArrow
- endArrow
- cornerRadius
- cornerSmoothing
- shadow
- innerShadow
- blur
- backgroundBlur
- grayscale
- normalStyle
- hoverStyle
- pressStyle
- focusStyle
- selectedStyle
- disabledStyle
- data
Accessors
- tag
- innerName
- __DataProcessor
- __LayoutProcessor
- isLeafer
- isBranchLeaf
- __localMatrix
- __localBoxBounds
- worldTransform
- localTransform
- boxBounds
- renderBounds
- worldBoxBounds
- worldStrokeBounds
- worldRenderBounds
- worldOpacity
- __worldFlipped
- __onlyHitMask
- __ignoreHitWorld
- __inLazyBounds
- pathInputed
- event
- isBranch
- __tag
- app
- isFrame
- scale
- pen
- editConfig
- editOuter
- editInner
Methods
- resetCustom
- waitParent
- waitLeafer
- nextRender
- removeNextRender
- __bindLeafer
- setAttr
- getAttr
- getComputedAttr
- toString
- toSVG
- __SVG
- toHTML
- __setAttr
- __getAttr
- setProxyAttr
- getProxyAttr
- focus
- updateLayout
- forceUpdate
- forceRender
- __updateWorldMatrix
- __updateLocalMatrix
- __updateWorldBounds
- __updateLocalBounds
- __updateLocalBoxBounds
- __updateLocalStrokeBounds
- __updateLocalRenderBounds
- __updateBoxBounds
- __updateContentBounds
- __updateStrokeBounds
- __updateRenderBounds
- __updateAutoLayout
- __updateFlowLayout
- __updateNaturalSize
- __updateStrokeSpread
- __updateRenderSpread
- __updateEraser
- __renderEraser
- __updateMask
- __renderMask
- __getNowWorld
- getTransform
- getBounds
- getLayoutBounds
- getLayoutPoints
- getWorldBounds
- worldToLocal
- localToWorld
- worldToInner
- innerToWorld
- getInnerPoint
- getInnerPointByLocal
- getLocalPoint
- getLocalPointByInner
- getWorldPoint
- getWorldPointByLocal
- getPagePoint
- getWorldPointByPage
- setTransform
- transform
- move
- moveInner
- scaleOf
- rotateOf
- skewOf
- transformWorld
- moveWorld
- scaleOfWorld
- rotateOfWorld
- skewOfWorld
- flip
- scaleResize
- __scaleResize
- resizeWidth
- resizeHeight
- __hitWorld
- __hit
- __hitFill
- __hitStroke
- __hitPixel
- __drawHitPath
- __updateHitCanvas
- __render
- __drawFast
- __draw
- __clip
- __renderShape
- __updateWorldOpacity
- __updateChange
- __updatePath
- __updateSortChildren
- dropTo
- on
- off
- on_
- off_
- once
- emit
- emitEvent
- hasEvent
- changeAttr
- addAttr
- reset
- __setBranch
- set
- toJSON
- pick
- addAt
- addAfter
- addBefore
- add
- addMany
- remove
- removeAll
- clear
- setStyle
- beginPath
- moveTo
- lineTo
- bezierCurveTo
- quadraticCurveTo
- closePath
- rect
- roundRect
- ellipse
- arc
- arcTo
- drawEllipse
- drawArc
- drawPoints
- clearPath
- paint
- get
- createProxyData
- find
- findTag
- findOne
- findId
- getPath
- getPathString
- load
- __onUpdateSize
- __updateRenderPath
- __drawRenderPath
- __drawPath
- __drawPathByData
- __drawPathByBox
- export
- clone
- one
- registerUI
- registerData
- setEditConfig
- setEditOuter
- setEditInner
- destroy
Constructors
constructor
• new Pen(data?
): Pen
Parameters
Name | Type |
---|---|
data? | IPenInputData |
Returns
Overrides
Defined in
ui/packages/display/src/Pen.ts:26
Properties
innerId
• Readonly
innerId: number
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:29
__layout
• __layout: ILeafLayout
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:43
__world
• __world: IMatrixWithBoundsScaleData
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:45
__local
• Optional
__local: IMatrixWithBoundsData
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:46
__nowWorld
• Optional
__nowWorld: IMatrixWithBoundsScaleData
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:48
__cameraWorld
• Optional
__cameraWorld: IMatrixWithBoundsScaleData
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:49
__worldOpacity
• __worldOpacity: number
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:54
__level
• __level: number
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:70
__tempNumber
• __tempNumber: number
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:71
__hasAutoLayout
• Optional
__hasAutoLayout: boolean
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:75
__hasMask
• Optional
__hasMask: boolean
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:76
__hasEraser
• Optional
__hasEraser: boolean
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:77
__hitCanvas
• Optional
__hitCanvas: IHitCanvas
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:78
__captureMap
• Optional
__captureMap: IEventListenerMap
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:89
__bubbleMap
• Optional
__bubbleMap: IEventListenerMap
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:90
__parentWait
• Optional
__parentWait: IFunction
[]
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:92
__leaferWait
• Optional
__leaferWait: IFunction
[]
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:93
noBounds
• Optional
noBounds: boolean
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:99
destroyed
• destroyed: boolean
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:101
children
• children: IUI
[]
Implementation of
Inherited from
Defined in
ui/packages/display/src/Group.ts:21
__
• __: IPenData
Implementation of
Overrides
Defined in
ui/packages/display/src/Pen.ts:16
pathElement
• pathElement: IPath
Implementation of
Defined in
ui/packages/display/src/Pen.ts:18
pathStyle
• pathStyle: IPathInputData
Implementation of
Defined in
ui/packages/display/src/Pen.ts:19
path
• path: IPathCommandData
Implementation of
Overrides
Defined in
ui/packages/display/src/Pen.ts:22
__path
• __path: IPathCommandData
Implementation of
Defined in
ui/packages/display/src/Pen.ts:24
proxyData
• Optional
proxyData: IUIInputData
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:21
__proxyData
• Optional
__proxyData: IUIInputData
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:22
leafer
• Optional
leafer: ILeafer
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:26
parent
• Optional
parent: IGroup
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:27
zoomLayer
• zoomLayer: IGroup
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:30
id
• Optional
id: string
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:40
name
• Optional
name: string
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:43
className
• Optional
className: string
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:46
blendMode
• Optional
blendMode: IBlendMode
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:51
opacity
• Optional
opacity: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:54
visible
• Optional
visible: boolean
| 0
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:57
selected
• Optional
selected: boolean
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:61
disabled
• Optional
disabled: boolean
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:64
locked
• Optional
locked: boolean
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:67
zIndex
• Optional
zIndex: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:71
mask
• Optional
mask: boolean
| IMaskType
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:75
eraser
• Optional
eraser: boolean
| IEraserType
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:78
x
• Optional
x: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:83
y
• Optional
y: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:86
width
• Optional
width: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:90
height
• Optional
height: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:93
scaleX
• Optional
scaleX: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:97
scaleY
• Optional
scaleY: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:100
rotation
• Optional
rotation: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:104
skewX
• Optional
skewX: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:108
skewY
• Optional
skewY: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:111
offsetX
• Optional
offsetX: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:116
offsetY
• Optional
offsetY: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:119
scrollX
• Optional
scrollX: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:123
scrollY
• Optional
scrollY: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:126
origin
• Optional
origin: IUnitPointData
| IDirection
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:131
around
• Optional
around: IUnitPointData
| IDirection
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:134
lazy
• Optional
lazy: boolean
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:139
pixelRatio
• Optional
pixelRatio: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:142
windingRule
• Optional
windingRule: IWindingRule
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:150
closed
• Optional
closed: boolean
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:153
flow
• Optional
flow: IFlowType
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:158
padding
• Optional
padding: IFourNumber
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:161
gap
• Optional
gap: IGap
| IPointGap
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:164
flowAlign
• Optional
flowAlign: IFlowAlign
| IFlowAxisAlign
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:167
flowWrap
• Optional
flowWrap: IFlowWrap
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:170
itemBox
• Optional
itemBox: IFlowBoxType
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:173
inFlow
• Optional
inFlow: boolean
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:177
autoWidth
• Optional
autoWidth: IAutoSize
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:180
autoHeight
• Optional
autoHeight: IAutoSize
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:183
lockRatio
• Optional
lockRatio: boolean
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:186
autoBox
• Optional
autoBox: IAutoBoxData
| IConstraint
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:189
widthRange
• Optional
widthRange: IRangeSize
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:193
heightRange
• Optional
heightRange: IRangeSize
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:196
draggable
• Optional
draggable: boolean
| IAxis
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:201
dragBounds
• Optional
dragBounds: "parent"
| IBoundsData
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:204
editable
• Optional
editable: boolean
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:208
hittable
• Optional
hittable: boolean
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:213
hitFill
• Optional
hitFill: IHitType
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:216
hitStroke
• Optional
hitStroke: IHitType
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:219
hitBox
• Optional
hitBox: boolean
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:222
hitChildren
• Optional
hitChildren: boolean
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:225
hitSelf
• Optional
hitSelf: boolean
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:228
hitRadius
• Optional
hitRadius: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:231
cursor
• Optional
cursor: ICursorType
| ICursorType
[]
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:234
fill
• Optional
fill: IFill
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:242
stroke
• Optional
stroke: IStroke
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:247
strokeAlign
• Optional
strokeAlign: IStrokeAlign
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:250
strokeWidth
• Optional
strokeWidth: string
| IFourNumber
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:253
strokeWidthFixed
• Optional
strokeWidthFixed: boolean
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:256
strokeCap
• Optional
strokeCap: IStrokeCap
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:259
strokeJoin
• Optional
strokeJoin: IStrokeJoin
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:262
dashPattern
• Optional
dashPattern: string
| number
[]
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:265
dashOffset
• Optional
dashOffset: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:268
miterLimit
• Optional
miterLimit: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:271
startArrow
• Optional
startArrow: IArrowType
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:277
endArrow
• Optional
endArrow: IArrowType
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:280
cornerRadius
• Optional
cornerRadius: string
| IFourNumber
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:285
cornerSmoothing
• Optional
cornerSmoothing: number
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:288
shadow
• Optional
shadow: string
| IShadowEffect
| IShadowEffect
[]
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:293
innerShadow
• Optional
innerShadow: string
| IShadowEffect
| IShadowEffect
[]
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:296
blur
• Optional
blur: number
| IBlurEffect
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:299
backgroundBlur
• Optional
backgroundBlur: number
| IBlurEffect
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:302
grayscale
• Optional
grayscale: number
| IGrayscaleEffect
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:305
normalStyle
• Optional
normalStyle: IUIInputData
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:311
hoverStyle
• Optional
hoverStyle: IUIInputData
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:314
pressStyle
• Optional
pressStyle: IUIInputData
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:317
focusStyle
• Optional
focusStyle: IUIInputData
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:320
selectedStyle
• Optional
selectedStyle: IUIInputData
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:323
disabledStyle
• Optional
disabledStyle: IUIInputData
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:326
data
• data: IObject
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:331
Accessors
tag
• get
tag(): string
Returns
string
Implementation of
Inherited from
Group.tag
Defined in
leafer/packages/display/src/Leaf.ts:24
• set
tag(_value
): void
Parameters
Name | Type |
---|---|
_value | string |
Returns
void
Implementation of
Inherited from
Group.tag
Defined in
leafer/packages/display/src/Leaf.ts:25
innerName
• get
innerName(): string
Returns
string
Implementation of
Inherited from
Group.innerName
Defined in
leafer/packages/display/src/Leaf.ts:30
__DataProcessor
• get
__DataProcessor(): typeof LeafData
Returns
typeof LeafData
Implementation of
Inherited from
Group.__DataProcessor
Defined in
leafer/packages/display/src/Leaf.ts:32
__LayoutProcessor
• get
__LayoutProcessor(): typeof LeafLayout
Returns
typeof LeafLayout
Implementation of
Inherited from
Group.__LayoutProcessor
Defined in
leafer/packages/display/src/Leaf.ts:33
isLeafer
• get
isLeafer(): boolean
Returns
boolean
Implementation of
Inherited from
Group.isLeafer
Defined in
leafer/packages/display/src/Leaf.ts:38
isBranchLeaf
• get
isBranchLeaf(): boolean
Returns
boolean
Implementation of
Inherited from
Group.isBranchLeaf
Defined in
leafer/packages/display/src/Leaf.ts:40
__localMatrix
• get
__localMatrix(): IMatrixData
Returns
Implementation of
Inherited from
Group.__localMatrix
Defined in
leafer/packages/display/src/Leaf.ts:51
__localBoxBounds
• get
__localBoxBounds(): IBoundsData
Returns
Implementation of
Inherited from
Group.__localBoxBounds
Defined in
leafer/packages/display/src/Leaf.ts:52
worldTransform
• get
worldTransform(): IMatrixWithScaleData
Returns
Implementation of
Inherited from
Group.worldTransform
Defined in
leafer/packages/display/src/Leaf.ts:57
localTransform
• get
localTransform(): IMatrixData
Returns
Implementation of
Inherited from
Group.localTransform
Defined in
leafer/packages/display/src/Leaf.ts:58
boxBounds
• get
boxBounds(): IBoundsData
Returns
Implementation of
Inherited from
Group.boxBounds
Defined in
leafer/packages/display/src/Leaf.ts:61
renderBounds
• get
renderBounds(): IBoundsData
Returns
Implementation of
Inherited from
Group.renderBounds
Defined in
leafer/packages/display/src/Leaf.ts:62
worldBoxBounds
• get
worldBoxBounds(): IBoundsData
Returns
Implementation of
Inherited from
Group.worldBoxBounds
Defined in
leafer/packages/display/src/Leaf.ts:63
worldStrokeBounds
• get
worldStrokeBounds(): IBoundsData
Returns
Implementation of
Inherited from
Group.worldStrokeBounds
Defined in
leafer/packages/display/src/Leaf.ts:64
worldRenderBounds
• get
worldRenderBounds(): IBoundsData
Returns
Implementation of
Inherited from
Group.worldRenderBounds
Defined in
leafer/packages/display/src/Leaf.ts:65
worldOpacity
• get
worldOpacity(): number
Returns
number
Implementation of
Inherited from
Group.worldOpacity
Defined in
leafer/packages/display/src/Leaf.ts:68
__worldFlipped
• get
__worldFlipped(): boolean
Returns
boolean
Implementation of
Inherited from
Group.__worldFlipped
Defined in
leafer/packages/display/src/Leaf.ts:73
__onlyHitMask
• get
__onlyHitMask(): boolean
Returns
boolean
Implementation of
Inherited from
Group.__onlyHitMask
Defined in
leafer/packages/display/src/Leaf.ts:80
__ignoreHitWorld
• get
__ignoreHitWorld(): boolean
Returns
boolean
Implementation of
Inherited from
Group.__ignoreHitWorld
Defined in
leafer/packages/display/src/Leaf.ts:81
__inLazyBounds
• get
__inLazyBounds(): boolean
Returns
boolean
Implementation of
Inherited from
Group.__inLazyBounds
Defined in
leafer/packages/display/src/Leaf.ts:82
pathInputed
• get
pathInputed(): boolean
Returns
boolean
Implementation of
Inherited from
Group.pathInputed
Defined in
leafer/packages/display/src/Leaf.ts:84
event
• set
event(map
): void
Parameters
Name | Type |
---|---|
map | IEventMap |
Returns
void
Implementation of
Inherited from
Group.event
Defined in
leafer/packages/display/src/Leaf.ts:87
isBranch
• get
isBranch(): boolean
Returns
boolean
Implementation of
Inherited from
Group.isBranch
Defined in
ui/packages/display/src/Group.ts:16
__tag
• get
__tag(): string
Returns
string
Implementation of
Overrides
Group.__tag
Defined in
ui/packages/display/src/Pen.ts:13
app
• get
app(): ILeafer
Returns
Implementation of
Inherited from
Group.app
Defined in
ui/packages/display/src/UI.ts:24
isFrame
• get
isFrame(): boolean
Returns
boolean
Implementation of
Inherited from
Group.isFrame
Defined in
ui/packages/display/src/UI.ts:32
scale
• get
scale(): number
| IPointData
Returns
number
| IPointData
Implementation of
Inherited from
Group.scale
Defined in
ui/packages/display/src/UI.ts:343
• set
scale(value
): void
Parameters
Name | Type |
---|---|
value | number | IPointData |
Returns
void
Implementation of
Inherited from
Group.scale
Defined in
ui/packages/display/src/UI.ts:334
pen
• get
pen(): IPathCreator
Returns
Implementation of
Inherited from
Group.pen
Defined in
ui/packages/display/src/UI.ts:348
editConfig
• get
editConfig(): IEditorConfig
Returns
Implementation of
Inherited from
Group.editConfig
Defined in
ui/packages/display/src/UI.ts:358
editOuter
• get
editOuter(): string
Returns
string
Implementation of
Inherited from
Group.editOuter
Defined in
ui/packages/display/src/UI.ts:360
editInner
• get
editInner(): string
Returns
string
Implementation of
Inherited from
Group.editInner
Defined in
ui/packages/display/src/UI.ts:362
Methods
resetCustom
▸ resetCustom(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:127
waitParent
▸ waitParent(item
, bind?
): void
Parameters
Name | Type |
---|---|
item | IFunction |
bind? | IObject |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:133
waitLeafer
▸ waitLeafer(item
, bind?
): void
Parameters
Name | Type |
---|---|
item | IFunction |
bind? | IObject |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:138
nextRender
▸ nextRender(item
, bind?
, off?
): void
Parameters
Name | Type |
---|---|
item | IFunction |
bind? | IObject |
off? | "off" |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:143
removeNextRender
▸ removeNextRender(item
): void
Parameters
Name | Type |
---|---|
item | IFunction |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:147
__bindLeafer
▸ __bindLeafer(leafer
): void
Parameters
Name | Type |
---|---|
leafer | ILeaferBase |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:151
setAttr
▸ setAttr(name
, value
): void
Parameters
Name | Type |
---|---|
name | string |
value | any |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:179
getAttr
▸ getAttr(name
): any
Parameters
Name | Type |
---|---|
name | string |
Returns
any
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:180
getComputedAttr
▸ getComputedAttr(name
): any
Parameters
Name | Type |
---|---|
name | string |
Returns
any
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:182
toString
▸ toString(options?
): string
Parameters
Name | Type |
---|---|
options? | IJSONOptions |
Returns
string
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:189
toSVG
▸ toSVG(): string
Returns
string
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:193
__SVG
▸ __SVG(_data
): void
Parameters
Name | Type |
---|---|
_data | IObject |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:195
toHTML
▸ toHTML(): string
Returns
string
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:197
__setAttr
▸ __setAttr(_attrName
, _newValue
): boolean
Parameters
Name | Type |
---|---|
_attrName | string |
_newValue | IValue |
Returns
boolean
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:201
__getAttr
▸ __getAttr(_attrName
): IValue
Parameters
Name | Type |
---|---|
_attrName | string |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:203
setProxyAttr
▸ setProxyAttr(_attrName
, _newValue
): void
Parameters
Name | Type |
---|---|
_attrName | string |
_newValue | IValue |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:205
getProxyAttr
▸ getProxyAttr(_attrName
): IValue
Parameters
Name | Type |
---|---|
_attrName | string |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:207
focus
▸ focus(_value?
): void
Parameters
Name | Type |
---|---|
_value? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:227
updateLayout
▸ updateLayout(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:231
forceUpdate
▸ forceUpdate(attrName?
): void
Parameters
Name | Type |
---|---|
attrName? | string |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:235
forceRender
▸ forceRender(_bounds?
): void
Parameters
Name | Type |
---|---|
_bounds? | IBoundsData |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:243
__updateWorldMatrix
▸ __updateWorldMatrix(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:249
__updateLocalMatrix
▸ __updateLocalMatrix(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:251
__updateWorldBounds
▸ __updateWorldBounds(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:257
__updateLocalBounds
▸ __updateLocalBounds(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:259
__updateLocalBoxBounds
▸ __updateLocalBoxBounds(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:262
__updateLocalStrokeBounds
▸ __updateLocalStrokeBounds(): void
Returns
void
Implementation of
IPen.__updateLocalStrokeBounds
Inherited from
Group.__updateLocalStrokeBounds
Defined in
leafer/packages/display/src/Leaf.ts:264
__updateLocalRenderBounds
▸ __updateLocalRenderBounds(): void
Returns
void
Implementation of
IPen.__updateLocalRenderBounds
Inherited from
Group.__updateLocalRenderBounds
Defined in
leafer/packages/display/src/Leaf.ts:266
__updateBoxBounds
▸ __updateBoxBounds(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:270
__updateContentBounds
▸ __updateContentBounds(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:272
__updateStrokeBounds
▸ __updateStrokeBounds(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:274
__updateRenderBounds
▸ __updateRenderBounds(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:276
__updateAutoLayout
▸ __updateAutoLayout(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:279
__updateFlowLayout
▸ __updateFlowLayout(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:281
__updateNaturalSize
▸ __updateNaturalSize(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:283
__updateStrokeSpread
▸ __updateStrokeSpread(): number
Returns
number
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:286
__updateRenderSpread
▸ __updateRenderSpread(): number
Returns
number
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:288
__updateEraser
▸ __updateEraser(value?
): void
Parameters
Name | Type |
---|---|
value? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:295
__renderEraser
▸ __renderEraser(canvas
, options
): void
Parameters
Name | Type |
---|---|
canvas | ILeaferCanvas |
options | IRenderOptions |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:299
__updateMask
▸ __updateMask(value?
): void
Parameters
Name | Type |
---|---|
value? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:307
__renderMask
▸ __renderMask(_canvas
, _options
): void
Parameters
Name | Type |
---|---|
_canvas | ILeaferCanvas |
_options | IRenderOptions |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:313
__getNowWorld
▸ __getNowWorld(options
): IMatrixWithBoundsScaleData
Parameters
Name | Type |
---|---|
options | IRenderOptions |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:321
getTransform
▸ getTransform(relative?
): IMatrixData
Parameters
Name | Type |
---|---|
relative? | ILeaf | ILocationType |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:333
getBounds
▸ getBounds(type?
, relative?
): IBoundsData
Parameters
Name | Type |
---|---|
type? | IBoundsType |
relative? | ILeaf | ILocationType |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:338
getLayoutBounds
▸ getLayoutBounds(type?
, relative?
, unscale?
): ILayoutBoundsData
Parameters
Name | Type |
---|---|
type? | IBoundsType |
relative? | ILeaf | ILocationType |
unscale? | boolean |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:342
getLayoutPoints
▸ getLayoutPoints(type?
, relative?
): IPointData
[]
Parameters
Name | Type |
---|---|
type? | IBoundsType |
relative? | ILeaf | ILocationType |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:346
getWorldBounds
▸ getWorldBounds(inner
, relative?
, change?
): IBoundsData
Parameters
Name | Type |
---|---|
inner | IBoundsData |
relative? | ILeaf |
change? | boolean |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:351
worldToLocal
▸ worldToLocal(world
, to?
, distance?
, relative?
): void
Parameters
Name | Type |
---|---|
world | IPointData |
to? | IPointData |
distance? | boolean |
relative? | ILeaf |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:359
localToWorld
▸ localToWorld(local
, to?
, distance?
, relative?
): void
Parameters
Name | Type |
---|---|
local | IPointData |
to? | IPointData |
distance? | boolean |
relative? | ILeaf |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:367
worldToInner
▸ worldToInner(world
, to?
, distance?
, relative?
): void
Parameters
Name | Type |
---|---|
world | IPointData |
to? | IPointData |
distance? | boolean |
relative? | ILeaf |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:375
innerToWorld
▸ innerToWorld(inner
, to?
, distance?
, relative?
): void
Parameters
Name | Type |
---|---|
inner | IPointData |
to? | IPointData |
distance? | boolean |
relative? | ILeaf |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:383
getInnerPoint
▸ getInnerPoint(world
, relative?
, distance?
, change?
): IPointData
Parameters
Name | Type |
---|---|
world | IPointData |
relative? | ILeaf |
distance? | boolean |
change? | boolean |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:390
getInnerPointByLocal
▸ getInnerPointByLocal(local
, _relative?
, distance?
, change?
): IPointData
Parameters
Name | Type |
---|---|
local | IPointData |
_relative? | ILeaf |
distance? | boolean |
change? | boolean |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:396
getLocalPoint
▸ getLocalPoint(world
, relative?
, distance?
, change?
): IPointData
Parameters
Name | Type |
---|---|
world | IPointData |
relative? | ILeaf |
distance? | boolean |
change? | boolean |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:400
getLocalPointByInner
▸ getLocalPointByInner(inner
, _relative?
, distance?
, change?
): IPointData
Parameters
Name | Type |
---|---|
inner | IPointData |
_relative? | ILeaf |
distance? | boolean |
change? | boolean |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:406
getWorldPoint
▸ getWorldPoint(inner
, relative?
, distance?
, change?
): IPointData
Parameters
Name | Type |
---|---|
inner | IPointData |
relative? | ILeaf |
distance? | boolean |
change? | boolean |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:410
getWorldPointByLocal
▸ getWorldPointByLocal(local
, relative?
, distance?
, change?
): IPointData
Parameters
Name | Type |
---|---|
local | IPointData |
relative? | ILeaf |
distance? | boolean |
change? | boolean |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:416
getPagePoint
▸ getPagePoint(world
, relative?
, distance?
, change?
): IPointData
Parameters
Name | Type |
---|---|
world | IPointData |
relative? | ILeaf |
distance? | boolean |
change? | boolean |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:422
getWorldPointByPage
▸ getWorldPointByPage(page
, relative?
, distance?
, change?
): IPointData
Parameters
Name | Type |
---|---|
page | IPointData |
relative? | ILeaf |
distance? | boolean |
change? | boolean |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:427
setTransform
▸ setTransform(matrix
, resize?
): void
Parameters
Name | Type |
---|---|
matrix | IMatrixData |
resize? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:435
transform
▸ transform(matrix
, resize?
): void
Parameters
Name | Type |
---|---|
matrix | IMatrixData |
resize? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:439
move
▸ move(x
, y?
): void
Parameters
Name | Type |
---|---|
x | number | IPointData |
y? | number |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:443
moveInner
▸ moveInner(x
, y?
): void
Parameters
Name | Type |
---|---|
x | number | IPointData |
y? | number |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:448
scaleOf
▸ scaleOf(origin
, scaleX
, scaleY?
, resize?
): void
Parameters
Name | Type |
---|---|
origin | IPointData | IDirection |
scaleX | number |
scaleY? | number |
resize? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:452
rotateOf
▸ rotateOf(origin
, rotation
): void
Parameters
Name | Type |
---|---|
origin | IPointData | IDirection |
rotation | number |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:456
skewOf
▸ skewOf(origin
, skewX
, skewY?
, resize?
): void
Parameters
Name | Type |
---|---|
origin | IPointData | IDirection |
skewX | number |
skewY? | number |
resize? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:460
transformWorld
▸ transformWorld(worldTransform?
, resize?
): void
Parameters
Name | Type |
---|---|
worldTransform? | IMatrixData |
resize? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:465
moveWorld
▸ moveWorld(x
, y?
): void
Parameters
Name | Type |
---|---|
x | number | IPointData |
y? | number |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:469
scaleOfWorld
▸ scaleOfWorld(worldOrigin
, scaleX
, scaleY?
, resize?
): void
Parameters
Name | Type |
---|---|
worldOrigin | IPointData |
scaleX | number |
scaleY? | number |
resize? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:473
rotateOfWorld
▸ rotateOfWorld(worldOrigin
, rotation
): void
Parameters
Name | Type |
---|---|
worldOrigin | IPointData |
rotation | number |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:477
skewOfWorld
▸ skewOfWorld(worldOrigin
, skewX
, skewY?
, resize?
): void
Parameters
Name | Type |
---|---|
worldOrigin | IPointData |
skewX | number |
skewY? | number |
resize? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:481
flip
▸ flip(axis
): void
Parameters
Name | Type |
---|---|
axis | IAxis |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:485
scaleResize
▸ scaleResize(scaleX
, scaleY?
, _noResize?
): void
Parameters
Name | Type | Default value |
---|---|---|
scaleX | number | undefined |
scaleY | number | scaleX |
_noResize? | boolean | undefined |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:492
__scaleResize
▸ __scaleResize(_scaleX
, _scaleY
): void
Parameters
Name | Type |
---|---|
_scaleX | number |
_scaleY | number |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:497
resizeWidth
▸ resizeWidth(_width
): void
Parameters
Name | Type |
---|---|
_width | number |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:500
resizeHeight
▸ resizeHeight(_height
): void
Parameters
Name | Type |
---|---|
_height | number |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:502
__hitWorld
▸ __hitWorld(_point
): boolean
Parameters
Name | Type |
---|---|
_point | IRadiusPointData |
Returns
boolean
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:507
__hit
▸ __hit(_local
): boolean
Parameters
Name | Type |
---|---|
_local | IRadiusPointData |
Returns
boolean
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:509
__hitFill
▸ __hitFill(_inner
): boolean
Parameters
Name | Type |
---|---|
_inner | IRadiusPointData |
Returns
boolean
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:511
__hitStroke
▸ __hitStroke(_inner
, _strokeWidth
): boolean
Parameters
Name | Type |
---|---|
_inner | IRadiusPointData |
_strokeWidth | number |
Returns
boolean
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:513
__hitPixel
▸ __hitPixel(_inner
): boolean
Parameters
Name | Type |
---|---|
_inner | IRadiusPointData |
Returns
boolean
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:515
__drawHitPath
▸ __drawHitPath(_canvas
): void
Parameters
Name | Type |
---|---|
_canvas | ILeaferCanvas |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:517
__updateHitCanvas
▸ __updateHitCanvas(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:519
__render
▸ __render(_canvas
, _options
): void
Parameters
Name | Type |
---|---|
_canvas | ILeaferCanvas |
_options | IRenderOptions |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:526
__drawFast
▸ __drawFast(_canvas
, _options
): void
Parameters
Name | Type |
---|---|
_canvas | ILeaferCanvas |
_options | IRenderOptions |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:528
__draw
▸ __draw(_canvas
, _options
): void
Parameters
Name | Type |
---|---|
_canvas | ILeaferCanvas |
_options | IRenderOptions |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:530
__clip
▸ __clip(_canvas
, _options
): void
Parameters
Name | Type |
---|---|
_canvas | ILeaferCanvas |
_options | IRenderOptions |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:533
__renderShape
▸ __renderShape(_canvas
, _options
, _ignoreFill?
, _ignoreStroke?
): void
Parameters
Name | Type |
---|---|
_canvas | ILeaferCanvas |
_options | IRenderOptions |
_ignoreFill? | boolean |
_ignoreStroke? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:535
__updateWorldOpacity
▸ __updateWorldOpacity(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:538
__updateChange
▸ __updateChange(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:540
__updatePath
▸ __updatePath(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:551
__updateSortChildren
▸ __updateSortChildren(): void
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:558
dropTo
▸ dropTo(parent
, index?
, resize?
): void
Parameters
Name | Type |
---|---|
parent | ILeaf |
index? | number |
resize? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:566
on
▸ on(_type
, _listener
, _options?
): void
Parameters
Name | Type |
---|---|
_type | string | string [] |
_listener | IFunction |
_options? | IEventOption |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:575
off
▸ off(_type?
, _listener?
, _options?
): void
Parameters
Name | Type |
---|---|
_type? | string | string [] |
_listener? | IFunction |
_options? | IEventOption |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:577
on_
▸ on_(_type
, _listener
, _bind?
, _options?
): IEventListenerId
Parameters
Name | Type |
---|---|
_type | string | string [] |
_listener | IFunction |
_bind? | IObject |
_options? | IEventOption |
Returns
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:579
off_
▸ off_(_id
): void
Parameters
Name | Type |
---|---|
_id | IEventListenerId | IEventListenerId [] |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:581
once
▸ once(_type
, _listener
, _capture?
): void
Parameters
Name | Type |
---|---|
_type | string | string [] |
_listener | IFunction |
_capture? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:583
emit
▸ emit(_type
, _event?
, _capture?
): void
Parameters
Name | Type |
---|---|
_type | string |
_event? | IObject | IEvent |
_capture? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:585
emitEvent
▸ emitEvent(_event?
, _capture?
): void
Parameters
Name | Type |
---|---|
_event? | IEvent |
_capture? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:587
hasEvent
▸ hasEvent(_type
, _capture?
): boolean
Parameters
Name | Type |
---|---|
_type | string |
_capture? | boolean |
Returns
boolean
Implementation of
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:589
changeAttr
▸ changeAttr(attrName
, defaultValue
, fn?
): void
Parameters
Name | Type |
---|---|
attrName | string |
defaultValue | IValue |
fn? | IAttrDecorator |
Returns
void
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:593
addAttr
▸ addAttr(attrName
, defaultValue
, fn?
): void
Parameters
Name | Type |
---|---|
attrName | string |
defaultValue | IValue |
fn? | IAttrDecorator |
Returns
void
Inherited from
Defined in
leafer/packages/display/src/Leaf.ts:597
reset
▸ reset(data?
): void
Parameters
Name | Type |
---|---|
data? | IGroupInputData |
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/Group.ts:27
__setBranch
▸ __setBranch(): void
Returns
void
Inherited from
Defined in
ui/packages/display/src/Group.ts:32
set
▸ set(data
): void
Parameters
Name | Type |
---|---|
data | IUIInputData |
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/Group.ts:39
toJSON
▸ toJSON(options?
): IUIJSONData
Parameters
Name | Type |
---|---|
options? | IJSONOptions |
Returns
Implementation of
Inherited from
Defined in
ui/packages/display/src/Group.ts:65
pick
▸ pick(_hitPoint
, _options?
): IPickResult
Parameters
Name | Type |
---|---|
_hitPoint | IPointData |
_options? | IPickOptions |
Returns
Implementation of
Inherited from
Defined in
ui/packages/display/src/Group.ts:74
addAt
▸ addAt(child
, index
): void
Parameters
Name | Type |
---|---|
child | IUI |
index | number |
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/Group.ts:79
addAfter
▸ addAfter(child
, after
): void
Parameters
Name | Type |
---|---|
child | IUI |
after | IUI |
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/Group.ts:83
addBefore
▸ addBefore(child
, before
): void
Parameters
Name | Type |
---|---|
child | IUI |
before | IUI |
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/Group.ts:87
add
▸ add(_child
, _index?
): void
Parameters
Name | Type |
---|---|
_child | IUI |
_index? | number |
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/Group.ts:93
addMany
▸ addMany(..._children
): void
Parameters
Name | Type |
---|---|
..._children | IUI [] |
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/Group.ts:95
remove
▸ remove(_child?
, _destroy?
): void
Parameters
Name | Type |
---|---|
_child? | IUI |
_destroy? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/Group.ts:97
removeAll
▸ removeAll(_destroy?
): void
Parameters
Name | Type |
---|---|
_destroy? | boolean |
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/Group.ts:99
clear
▸ clear(): void
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/Group.ts:101
setStyle
▸ setStyle(data
): Pen
Parameters
Name | Type |
---|---|
data | IPathInputData |
Returns
Defined in
ui/packages/display/src/Pen.ts:30
beginPath
▸ beginPath(): Pen
Returns
Implementation of
Defined in
ui/packages/display/src/Pen.ts:38
moveTo
▸ moveTo(_x
, _y
): Pen
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
Returns
Implementation of
Defined in
ui/packages/display/src/Pen.ts:46
lineTo
▸ lineTo(_x
, _y
): Pen
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
Returns
Implementation of
Defined in
ui/packages/display/src/Pen.ts:48
bezierCurveTo
▸ bezierCurveTo(_x1
, _y1
, _x2
, _y2
, _x
, _y
): Pen
Parameters
Name | Type |
---|---|
_x1 | number |
_y1 | number |
_x2 | number |
_y2 | number |
_x | number |
_y | number |
Returns
Implementation of
Defined in
ui/packages/display/src/Pen.ts:50
quadraticCurveTo
▸ quadraticCurveTo(_x1
, _y1
, _x
, _y
): Pen
Parameters
Name | Type |
---|---|
_x1 | number |
_y1 | number |
_x | number |
_y | number |
Returns
Implementation of
Defined in
ui/packages/display/src/Pen.ts:52
closePath
▸ closePath(): Pen
Returns
Implementation of
Defined in
ui/packages/display/src/Pen.ts:54
rect
▸ rect(_x
, _y
, _width
, _height
): Pen
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
_width | number |
_height | number |
Returns
Implementation of
Defined in
ui/packages/display/src/Pen.ts:59
roundRect
▸ roundRect(_x
, _y
, _width
, _height
, _cornerRadius
): Pen
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
_width | number |
_height | number |
_cornerRadius | number | number [] |
Returns
Implementation of
Defined in
ui/packages/display/src/Pen.ts:61
ellipse
▸ ellipse(_x
, _y
, _radiusX
, _radiusY
, _rotation?
, _startAngle?
, _endAngle?
, _anticlockwise?
): Pen
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
_radiusX | number |
_radiusY | number |
_rotation? | number |
_startAngle? | number |
_endAngle? | number |
_anticlockwise? | boolean |
Returns
Implementation of
Defined in
ui/packages/display/src/Pen.ts:63
arc
▸ arc(_x
, _y
, _radius
, _startAngle?
, _endAngle?
, _anticlockwise?
): Pen
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
_radius | number |
_startAngle? | number |
_endAngle? | number |
_anticlockwise? | boolean |
Returns
Implementation of
Defined in
ui/packages/display/src/Pen.ts:65
arcTo
▸ arcTo(_x1
, _y1
, _x2
, _y2
, _radius
): Pen
Parameters
Name | Type |
---|---|
_x1 | number |
_y1 | number |
_x2 | number |
_y2 | number |
_radius | number |
Returns
Implementation of
Defined in
ui/packages/display/src/Pen.ts:67
drawEllipse
▸ drawEllipse(_x
, _y
, _radiusX
, _radiusY
, _rotation?
, _startAngle?
, _endAngle?
, _anticlockwise?
): Pen
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
_radiusX | number |
_radiusY | number |
_rotation? | number |
_startAngle? | number |
_endAngle? | number |
_anticlockwise? | boolean |
Returns
Implementation of
Defined in
ui/packages/display/src/Pen.ts:72
drawArc
▸ drawArc(_x
, _y
, _radius
, _startAngle?
, _endAngle?
, _anticlockwise?
): Pen
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
_radius | number |
_startAngle? | number |
_endAngle? | number |
_anticlockwise? | boolean |
Returns
Implementation of
Defined in
ui/packages/display/src/Pen.ts:74
drawPoints
▸ drawPoints(_points
, _curve?
, _close?
): Pen
Parameters
Name | Type |
---|---|
_points | number [] |
_curve? | number | boolean |
_close? | boolean |
Returns
Implementation of
Defined in
ui/packages/display/src/Pen.ts:76
clearPath
▸ clearPath(): Pen
Returns
Implementation of
Defined in
ui/packages/display/src/Pen.ts:78
paint
▸ paint(): void
Returns
void
Implementation of
Defined in
ui/packages/display/src/Pen.ts:80
get
▸ get(name?
): IValue
| IUIInputData
Parameters
Name | Type |
---|---|
name? | string | string [] | IUIInputData |
Returns
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:380
createProxyData
▸ createProxyData(): IUIInputData
Returns
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:384
find
▸ find(_condition
, _options?
): IUI
[]
Parameters
Name | Type |
---|---|
_condition | string | number | IFindCondition | IFindUIMethod |
_options? | any |
Returns
IUI
[]
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:389
findTag
▸ findTag(tag
): IUI
[]
Parameters
Name | Type |
---|---|
tag | string | string [] |
Returns
IUI
[]
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:391
findOne
▸ findOne(_condition
, _options?
): IUI
Parameters
Name | Type |
---|---|
_condition | string | number | IFindCondition | IFindUIMethod |
_options? | any |
Returns
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:393
findId
▸ findId(id
): IUI
Parameters
Name | Type |
---|---|
id | string | number |
Returns
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:395
getPath
▸ getPath(curve?
, pathForRender?
): IPathCommandData
Parameters
Name | Type |
---|---|
curve? | boolean |
pathForRender? | boolean |
Returns
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:400
getPathString
▸ getPathString(curve?
, pathForRender?
): string
Parameters
Name | Type |
---|---|
curve? | boolean |
pathForRender? | boolean |
Returns
string
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:407
load
▸ load(): void
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:412
__onUpdateSize
▸ __onUpdateSize(): void
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:416
__updateRenderPath
▸ __updateRenderPath(): void
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:423
__drawRenderPath
▸ __drawRenderPath(canvas
): void
Parameters
Name | Type |
---|---|
canvas | ILeaferCanvas |
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:431
__drawPath
▸ __drawPath(canvas
): void
Parameters
Name | Type |
---|---|
canvas | ILeaferCanvas |
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:436
__drawPathByData
▸ __drawPathByData(drawer
, data
): void
Parameters
Name | Type |
---|---|
drawer | IPathDrawer |
data | IPathCommandData |
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:441
__drawPathByBox
▸ __drawPathByBox(drawer
): void
Parameters
Name | Type |
---|---|
drawer | IPathDrawer |
Returns
void
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:449
export
▸ export(filename
, options?
): Promise
<IExportResult
>
Parameters
Name | Type |
---|---|
filename | string |
options? | number | boolean | IExportOptions |
Returns
Promise
<IExportResult
>
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:462
clone
▸ clone(): IUI
Returns
Implementation of
Inherited from
Defined in
ui/packages/display/src/UI.ts:466
one
▸ one(data
, x?
, y?
, width?
, height?
): IUI
Parameters
Name | Type |
---|---|
data | IUIInputData |
x? | number |
y? | number |
width? | number |
height? | number |
Returns
Inherited from
Defined in
ui/packages/display/src/UI.ts:470
registerUI
▸ registerUI(): void
Returns
void
Inherited from
Defined in
ui/packages/display/src/UI.ts:474
registerData
▸ registerData(data
): void
Parameters
Name | Type |
---|---|
data | IUIData |
Returns
void
Inherited from
Defined in
ui/packages/display/src/UI.ts:478
setEditConfig
▸ setEditConfig(_config
): void
Parameters
Name | Type |
---|---|
_config | IEditorConfig | IEditorConfigFunction |
Returns
void
Inherited from
Defined in
ui/packages/display/src/UI.ts:485
setEditOuter
▸ setEditOuter(_toolName
): void
Parameters
Name | Type |
---|---|
_toolName | string | IEditToolFunction |
Returns
void
Inherited from
Defined in
ui/packages/display/src/UI.ts:487
setEditInner
▸ setEditInner(_editorName
): void
Parameters
Name | Type |
---|---|
_editorName | string | IEditToolFunction |
Returns
void
Inherited from
Defined in
ui/packages/display/src/UI.ts:489
destroy
▸ destroy(): void
Returns
void