Class: LeaferCanvas
Hierarchy
↳
LeaferCanvas
Table of contents
Constructors
Properties
- view
- parentView
- resizeObserver
- autoBounds
- resizeListener
- context
- smooth
- smoothLevel
- opacity
- fillStyle
- strokeStyle
- strokeWidth
- strokeCap
- strokeJoin
- dashOffset
- miterLimit
- shadowBlur
- shadowColor
- shadowOffsetX
- shadowOffsetY
- filter
- font
- fontKerning
- fontStretch
- fontVariantCaps
- textAlign
- textBaseline
- textRendering
- wordSpacing
- letterSpacing
- direction
- innerId
- name
- manager
- size
- bounds
- clientBounds
- config
- autoLayout
- unreal
- recycled
- worldTransform
- savedBlendMode
Accessors
- zIndex
- childIndex
- backgroundColor
- hittable
- blendMode
- dashPattern
- width
- height
- pixelRatio
- pixelWidth
- pixelHeight
- allowBackgroundColor
Methods
- init
- __createView
- __createViewFrom
- setAbsolute
- updateViewSize
- updateClientBounds
- startAutoLayout
- imitateResizeObserver
- checkAutoBounds
- stopAutoLayout
- emitResize
- unrealCanvas
- destroy
- __bindContext
- setTransform
- resetTransform
- getTransform
- save
- restore
- transform
- translate
- scale
- rotate
- fill
- stroke
- clip
- fillRect
- strokeRect
- clearRect
- drawImage
- beginPath
- moveTo
- lineTo
- bezierCurveTo
- quadraticCurveTo
- closePath
- arc
- arcTo
- ellipse
- rect
- roundRect
- createConicGradient
- createLinearGradient
- createPattern
- createRadialGradient
- fillText
- measureText
- strokeText
- __createContext
- export
- toBlob
- toDataURL
- saveAs
- resize
- getClientBounds
- setCursor
- setWorld
- useWorldTransform
- setStroke
- setStrokeOptions
- saveBlendMode
- restoreBlendMode
- hitFill
- hitStroke
- hitPixel
- setWorldShadow
- setWorldBlur
- copyWorld
- copyWorldToInner
- copyWorldByReset
- useMask
- useEraser
- fillWorld
- strokeWorld
- clearWorld
- clipWorld
- clear
- isSameSize
- getSameCanvas
- recycle
- updateRender
Constructors
constructor
• new LeaferCanvas(config?
, manager?
): LeaferCanvas
Parameters
Name | Type |
---|---|
config? | ILeaferCanvasConfig |
manager? | ICanvasManager |
Returns
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:51
Properties
view
• view: HTMLCanvasElement
Overrides
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:9
parentView
• parentView: HTMLElement
Overrides
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:10
resizeObserver
• Protected
resizeObserver: ResizeObserver
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:31
autoBounds
• Protected
autoBounds: IAutoBounds
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:32
resizeListener
• Protected
resizeListener: IResizeEventListener
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:33
context
• context: ICanvasContext2D
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:27
smooth
• smooth: boolean
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:32
smoothLevel
• smoothLevel: ImageSmoothingQuality
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:35
opacity
• opacity: number
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:38
fillStyle
• fillStyle: string
| object
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:50
strokeStyle
• strokeStyle: string
| object
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:53
strokeWidth
• strokeWidth: number
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:57
strokeCap
• strokeCap: string
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:60
strokeJoin
• strokeJoin: string
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:63
dashOffset
• dashOffset: number
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:73
miterLimit
• miterLimit: number
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:76
shadowBlur
• shadowBlur: number
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:80
shadowColor
• shadowColor: string
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:83
shadowOffsetX
• shadowOffsetX: number
Inherited from
LeaferCanvasBase.shadowOffsetX
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:86
shadowOffsetY
• shadowOffsetY: number
Inherited from
LeaferCanvasBase.shadowOffsetY
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:89
filter
• filter: string
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:92
font
• font: string
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:96
fontKerning
• fontKerning: string
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:99
fontStretch
• fontStretch: string
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:102
fontVariantCaps
• fontVariantCaps: string
Inherited from
LeaferCanvasBase.fontVariantCaps
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:105
textAlign
• textAlign: string
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:109
textBaseline
• textBaseline: string
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:112
textRendering
• textRendering: string
Inherited from
LeaferCanvasBase.textRendering
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:115
wordSpacing
• wordSpacing: string
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:118
letterSpacing
• letterSpacing: string
Inherited from
LeaferCanvasBase.letterSpacing
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:121
direction
• direction: string
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:125
innerId
• Readonly
innerId: number
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:16
name
• name: string
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:18
manager
• manager: ICanvasManager
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:20
size
• size: IScreenSizeData
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:22
bounds
• bounds: IBounds
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:33
clientBounds
• clientBounds: IBoundsData
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:34
config
• config: ILeaferCanvasConfig
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:36
autoLayout
• autoLayout: boolean
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:38
unreal
• Optional
unreal: boolean
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:43
recycled
• Optional
recycled: boolean
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:45
worldTransform
• worldTransform: IMatrixData
Inherited from
LeaferCanvasBase.worldTransform
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:47
savedBlendMode
• Protected
savedBlendMode: IBlendMode
Inherited from
LeaferCanvasBase.savedBlendMode
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:49
Accessors
zIndex
• set
zIndex(zIndex
): void
Parameters
Name | Type |
---|---|
zIndex | number |
Returns
void
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:12
childIndex
• set
childIndex(index
): void
Parameters
Name | Type |
---|---|
index | number |
Returns
void
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:18
backgroundColor
• get
backgroundColor(): string
Returns
string
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:60
• set
backgroundColor(color
): void
Parameters
Name | Type |
---|---|
color | string |
Returns
void
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:59
hittable
• get
hittable(): boolean
Returns
boolean
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:63
• set
hittable(hittable
): void
Parameters
Name | Type |
---|---|
hittable | boolean |
Returns
void
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:62
blendMode
• get
blendMode(): IBlendMode
Returns
Inherited from
LeaferCanvasBase.blendMode
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:45
• set
blendMode(value
): void
Parameters
Name | Type |
---|---|
value | IBlendMode |
Returns
void
Inherited from
LeaferCanvasBase.blendMode
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:40
dashPattern
• get
dashPattern(): number
[]
Returns
number
[]
Inherited from
LeaferCanvasBase.dashPattern
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:68
• set
dashPattern(value
): void
Parameters
Name | Type |
---|---|
value | number [] |
Returns
void
Inherited from
LeaferCanvasBase.dashPattern
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:65
width
• get
width(): number
Returns
number
Inherited from
LeaferCanvasBase.width
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:24
height
• get
height(): number
Returns
number
Inherited from
LeaferCanvasBase.height
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:25
pixelRatio
• get
pixelRatio(): number
Returns
number
Inherited from
LeaferCanvasBase.pixelRatio
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:27
pixelWidth
• get
pixelWidth(): number
Returns
number
Inherited from
LeaferCanvasBase.pixelWidth
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:28
pixelHeight
• get
pixelHeight(): number
Returns
number
Inherited from
LeaferCanvasBase.pixelHeight
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:29
allowBackgroundColor
• get
allowBackgroundColor(): boolean
Returns
boolean
Inherited from
LeaferCanvasBase.allowBackgroundColor
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:31
Methods
init
▸ init(): void
Returns
void
Overrides
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:35
__createView
▸ __createView(): void
Returns
void
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:65
__createViewFrom
▸ __createViewFrom(inputView
): void
Parameters
Name | Type |
---|---|
inputView | string | object |
Returns
void
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:69
setAbsolute
▸ setAbsolute(view
): void
Parameters
Name | Type |
---|---|
view | HTMLCanvasElement |
Returns
void
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:104
updateViewSize
▸ updateViewSize(): void
Returns
void
Overrides
LeaferCanvasBase.updateViewSize
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:110
updateClientBounds
▸ updateClientBounds(): void
Returns
void
Overrides
LeaferCanvasBase.updateClientBounds
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:121
startAutoLayout
▸ startAutoLayout(autoBounds
, listener
): void
Parameters
Name | Type |
---|---|
autoBounds | IAutoBounds |
listener | IResizeEventListener |
Returns
void
Overrides
LeaferCanvasBase.startAutoLayout
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:125
imitateResizeObserver
▸ imitateResizeObserver(): void
Returns
void
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:169
checkAutoBounds
▸ checkAutoBounds(parentSize
): void
Parameters
Name | Type |
---|---|
parentSize | ISizeData |
Returns
void
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:176
stopAutoLayout
▸ stopAutoLayout(): void
Returns
void
Overrides
LeaferCanvasBase.stopAutoLayout
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:188
emitResize
▸ emitResize(size
): void
Parameters
Name | Type |
---|---|
size | IScreenSizeData |
Returns
void
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:197
unrealCanvas
▸ unrealCanvas(): void
Returns
void
Overrides
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:205
destroy
▸ destroy(): void
Returns
void
Overrides
Defined in
leafer/packages/canvas/canvas-web/src/LeaferCanvas.ts:215
__bindContext
▸ __bindContext(): void
Returns
void
Inherited from
LeaferCanvasBase.__bindContext
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:129
setTransform
▸ setTransform(_a
, _b?
, _c?
, _d?
, _e?
, _f?
): void
Parameters
Name | Type |
---|---|
_a | number | IMatrixData |
_b? | number |
_c? | number |
_d? | number |
_e? | number |
_f? | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:141
resetTransform
▸ resetTransform(): void
Returns
void
Inherited from
LeaferCanvasBase.resetTransform
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:144
getTransform
▸ getTransform(): IMatrixData
Returns
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:147
save
▸ save(): void
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:150
restore
▸ restore(): void
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:153
transform
▸ transform(a
, b?
, c?
, d?
, e?
, f?
): void
Parameters
Name | Type |
---|---|
a | number | IMatrixData |
b? | number |
c? | number |
d? | number |
e? | number |
f? | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:155
translate
▸ translate(_x
, _y
): void
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:164
scale
▸ scale(_x
, _y
): void
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:167
rotate
▸ rotate(_angle
): void
Parameters
Name | Type |
---|---|
_angle | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:170
fill
▸ fill(_path2d?
, _rule?
): void
Parameters
Name | Type |
---|---|
_path2d? | IWindingRule | IPath2D |
_rule? | IWindingRule |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:173
stroke
▸ stroke(_path2d?
): void
Parameters
Name | Type |
---|---|
_path2d? | IPath2D |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:176
clip
▸ clip(_path2d?
, _rule?
): void
Parameters
Name | Type |
---|---|
_path2d? | IWindingRule | IPath2D |
_rule? | IWindingRule |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:179
fillRect
▸ fillRect(_x
, _y
, _width
, _height
): void
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
_width | number |
_height | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:182
strokeRect
▸ strokeRect(_x
, _y
, _width
, _height
): void
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
_width | number |
_height | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:185
clearRect
▸ clearRect(_x
, _y
, _width
, _height
): void
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
_width | number |
_height | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:188
drawImage
▸ drawImage(image
, sx
, sy
, sw?
, sh?
, dx?
, dy?
, dw?
, dh?
): void
Parameters
Name | Type |
---|---|
image | CanvasImageSource |
sx | number |
sy | number |
sw? | number |
sh? | number |
dx? | number |
dy? | number |
dw? | number |
dh? | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:190
beginPath
▸ beginPath(): void
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:224
moveTo
▸ moveTo(_x
, _y
): void
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:227
lineTo
▸ lineTo(_x
, _y
): void
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:230
bezierCurveTo
▸ bezierCurveTo(_cp1x
, _cp1y
, _cp2x
, _cp2y
, _x
, _y
): void
Parameters
Name | Type |
---|---|
_cp1x | number |
_cp1y | number |
_cp2x | number |
_cp2y | number |
_x | number |
_y | number |
Returns
void
Inherited from
LeaferCanvasBase.bezierCurveTo
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:233
quadraticCurveTo
▸ quadraticCurveTo(_cpx
, _cpy
, _x
, _y
): void
Parameters
Name | Type |
---|---|
_cpx | number |
_cpy | number |
_x | number |
_y | number |
Returns
void
Inherited from
LeaferCanvasBase.quadraticCurveTo
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:236
closePath
▸ closePath(): void
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:239
arc
▸ arc(_x
, _y
, _radius
, _startAngle
, _endAngle
, _anticlockwise?
): void
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
_radius | number |
_startAngle | number |
_endAngle | number |
_anticlockwise? | boolean |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:242
arcTo
▸ arcTo(_x1
, _y1
, _x2
, _y2
, _radius
): void
Parameters
Name | Type |
---|---|
_x1 | number |
_y1 | number |
_x2 | number |
_y2 | number |
_radius | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:245
ellipse
▸ ellipse(_x
, _y
, _radiusX
, _radiusY
, _rotation
, _startAngle
, _endAngle
, _anticlockwise?
): void
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
_radiusX | number |
_radiusY | number |
_rotation | number |
_startAngle | number |
_endAngle | number |
_anticlockwise? | boolean |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:248
rect
▸ rect(_x
, _y
, _width
, _height
): void
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
_width | number |
_height | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:251
roundRect
▸ roundRect(_x
, _y
, _width
, _height
, _radius?
): void
Parameters
Name | Type |
---|---|
_x | number |
_y | number |
_width | number |
_height | number |
_radius? | number | number [] |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:254
createConicGradient
▸ createConicGradient(_startAngle
, _x
, _y
): CanvasGradient
Parameters
Name | Type |
---|---|
_startAngle | number |
_x | number |
_y | number |
Returns
CanvasGradient
Inherited from
LeaferCanvasBase.createConicGradient
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:261
createLinearGradient
▸ createLinearGradient(_x0
, _y0
, _x1
, _y1
): CanvasGradient
Parameters
Name | Type |
---|---|
_x0 | number |
_y0 | number |
_x1 | number |
_y1 | number |
Returns
CanvasGradient
Inherited from
LeaferCanvasBase.createLinearGradient
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:264
createPattern
▸ createPattern(_image
, _repetition
): CanvasPattern
Parameters
Name | Type |
---|---|
_image | CanvasImageSource |
_repetition | string |
Returns
CanvasPattern
Inherited from
LeaferCanvasBase.createPattern
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:267
createRadialGradient
▸ createRadialGradient(_x0
, _y0
, _r0
, _x1
, _y1
, _r1
): CanvasGradient
Parameters
Name | Type |
---|---|
_x0 | number |
_y0 | number |
_r0 | number |
_x1 | number |
_y1 | number |
_r1 | number |
Returns
CanvasGradient
Inherited from
LeaferCanvasBase.createRadialGradient
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:270
fillText
▸ fillText(_text
, _x
, _y
, _maxWidth?
): void
Parameters
Name | Type |
---|---|
_text | string |
_x | number |
_y | number |
_maxWidth? | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:274
measureText
▸ measureText(_text
): ITextMetrics
Parameters
Name | Type |
---|---|
_text | string |
Returns
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:277
strokeText
▸ strokeText(_text
, _x
, _y
, _maxWidth?
): void
Parameters
Name | Type |
---|---|
_text | string |
_x | number |
_y | number |
_maxWidth? | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/Canvas.ts:280
__createContext
▸ __createContext(): void
Returns
void
Inherited from
LeaferCanvasBase.__createContext
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:70
export
▸ export(_filename
, _options?
): string
| Promise
<any
>
Parameters
Name | Type |
---|---|
_filename | string |
_options? | number | boolean | IExportOptions |
Returns
string
| Promise
<any
>
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:79
toBlob
▸ toBlob(_type?
, _quality?
): Promise
<any
>
Parameters
Name | Type |
---|---|
_type? | IExportFileType |
_quality? | number |
Returns
Promise
<any
>
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:81
toDataURL
▸ toDataURL(_type?
, _quality?
): string
| Promise
<string
>
Parameters
Name | Type |
---|---|
_type? | IExportImageType |
_quality? | number |
Returns
string
| Promise
<string
>
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:83
saveAs
▸ saveAs(_filename
, _quality?
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
_filename | string |
_quality? | number |
Returns
Promise
<boolean
>
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:85
resize
▸ resize(size
): void
Parameters
Name | Type |
---|---|
size | IScreenSizeData |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:89
getClientBounds
▸ getClientBounds(update?
): IBoundsData
Parameters
Name | Type |
---|---|
update? | boolean |
Returns
Inherited from
LeaferCanvasBase.getClientBounds
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:119
setCursor
▸ setCursor(_cursor
): void
Parameters
Name | Type |
---|---|
_cursor | ICursorType | ICursorType [] |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:127
setWorld
▸ setWorld(matrix
, parentMatrix?
): void
Parameters
Name | Type |
---|---|
matrix | IMatrixData |
parentMatrix? | IMatrixData |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:129
useWorldTransform
▸ useWorldTransform(worldTransform?
): void
Parameters
Name | Type |
---|---|
worldTransform? | IMatrixData |
Returns
void
Inherited from
LeaferCanvasBase.useWorldTransform
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:157
setStroke
▸ setStroke(color
, strokeWidth
, options?
): void
Parameters
Name | Type |
---|---|
color | string | object |
strokeWidth | number |
options? | ICanvasStrokeOptions |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:163
setStrokeOptions
▸ setStrokeOptions(options
): void
Parameters
Name | Type |
---|---|
options | ICanvasStrokeOptions |
Returns
void
Inherited from
LeaferCanvasBase.setStrokeOptions
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:169
saveBlendMode
▸ saveBlendMode(blendMode
): void
Parameters
Name | Type |
---|---|
blendMode | IBlendMode |
Returns
void
Inherited from
LeaferCanvasBase.saveBlendMode
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:177
restoreBlendMode
▸ restoreBlendMode(): void
Returns
void
Inherited from
LeaferCanvasBase.restoreBlendMode
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:182
hitFill
▸ hitFill(_point
, _fillRule?
): boolean
Parameters
Name | Type |
---|---|
_point | IPointData |
_fillRule? | IWindingRule |
Returns
boolean
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:188
hitStroke
▸ hitStroke(_point
, _strokeWidth?
): boolean
Parameters
Name | Type |
---|---|
_point | IPointData |
_strokeWidth? | number |
Returns
boolean
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:190
hitPixel
▸ hitPixel(_radiusPoint
, _offset?
, _scale?
): boolean
Parameters
Name | Type | Default value |
---|---|---|
_radiusPoint | IRadiusPointData | undefined |
_offset? | IPointData | undefined |
_scale | number | 1 |
Returns
boolean
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:192
setWorldShadow
▸ setWorldShadow(x
, y
, blur
, color?
): void
Parameters
Name | Type |
---|---|
x | number |
y | number |
blur | number |
color? | string |
Returns
void
Inherited from
LeaferCanvasBase.setWorldShadow
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:196
setWorldBlur
▸ setWorldBlur(blur
): void
Parameters
Name | Type |
---|---|
blur | number |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:204
copyWorld
▸ copyWorld(canvas
, from?
, to?
, blendMode?
): void
Parameters
Name | Type |
---|---|
canvas | ILeaferCanvas |
from? | IBoundsData |
to? | IBoundsData |
blendMode? | IBlendMode |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:210
copyWorldToInner
▸ copyWorldToInner(canvas
, fromWorld
, toInnerBounds
, blendMode?
): void
Parameters
Name | Type |
---|---|
canvas | ILeaferCanvas |
fromWorld | IMatrixWithBoundsData |
toInnerBounds | IBoundsData |
blendMode? | IBlendMode |
Returns
void
Inherited from
LeaferCanvasBase.copyWorldToInner
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:222
copyWorldByReset
▸ copyWorldByReset(canvas
, from?
, to?
, blendMode?
, onlyResetTransform?
): void
Parameters
Name | Type |
---|---|
canvas | ILeaferCanvas |
from? | IBoundsData |
to? | IBoundsData |
blendMode? | IBlendMode |
onlyResetTransform? | boolean |
Returns
void
Inherited from
LeaferCanvasBase.copyWorldByReset
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:236
useMask
▸ useMask(maskCanvas
, fromBounds?
, toBounds?
): void
Parameters
Name | Type |
---|---|
maskCanvas | ILeaferCanvas |
fromBounds? | IBoundsData |
toBounds? | IBoundsData |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:242
useEraser
▸ useEraser(eraserCanvas
, fromBounds?
, toBounds?
): void
Parameters
Name | Type |
---|---|
eraserCanvas | ILeaferCanvas |
fromBounds? | IBoundsData |
toBounds? | IBoundsData |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:246
fillWorld
▸ fillWorld(bounds
, color
, blendMode?
): void
Parameters
Name | Type |
---|---|
bounds | IBoundsData |
color | string | object |
blendMode? | IBlendMode |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:250
strokeWorld
▸ strokeWorld(bounds
, color
, blendMode?
): void
Parameters
Name | Type |
---|---|
bounds | IBoundsData |
color | string | object |
blendMode? | IBlendMode |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:258
clearWorld
▸ clearWorld(bounds
, ceilPixel?
): void
Parameters
Name | Type |
---|---|
bounds | IBoundsData |
ceilPixel? | boolean |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:266
clipWorld
▸ clipWorld(bounds
, ceilPixel?
): void
Parameters
Name | Type |
---|---|
bounds | IBoundsData |
ceilPixel? | boolean |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:272
clear
▸ clear(): void
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:281
isSameSize
▸ isSameSize(size
): boolean
Parameters
Name | Type |
---|---|
size | IScreenSizeData |
Returns
boolean
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:289
getSameCanvas
▸ getSameCanvas(useSameWorldTransform?
, useSameSmooth?
): ILeaferCanvas
Parameters
Name | Type |
---|---|
useSameWorldTransform? | boolean |
useSameSmooth? | boolean |
Returns
Inherited from
LeaferCanvasBase.getSameCanvas
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:294
recycle
▸ recycle(clearBounds?
): void
Parameters
Name | Type |
---|---|
clearBounds? | IBoundsData |
Returns
void
Inherited from
Defined in
leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:305
updateRender
▸ updateRender(_bounds?
): void
Parameters
Name | Type |
---|---|
_bounds? | IBoundsData |
Returns
void