Interface: ILeaferCanvas
Hierarchy
ICanvasMethod
↳
ILeaferCanvas
Implemented by
Table of contents
Properties
- manager
- innerId
- width
- height
- pixelRatio
- pixelWidth
- pixelHeight
- bounds
- view
- parentView
- offscreen
- context
- recycled
- smooth
- smoothLevel
- opacity
- blendMode
- fillStyle
- strokeStyle
- strokeWidth
- shadowBlur
- shadowColor
- shadowOffsetX
- shadowOffsetY
- filter
- font
- fontKerning
- fontStretch
- fontVariantCaps
- textAlign
- textBaseline
- textRendering
- wordSpacing
- letterSpacing
- direction
- strokeAlign
- strokeCap
- strokeJoin
- dashPattern
- dashOffset
- miterLimit
Methods
- debug
- startAutoLayout
- stopAutoLayout
- resize
- pixel
- isSameSize
- getSameCanvas
- getBiggerCanvas
- useSameTransform
- recycle
- unloadView
- destroy
- save
- restore
- fill
- stroke
- clip
- fillRect
- strokeRect
- clearRect
- translate
- scale
- rotate
- drawImage
- setTransform
- getTransform
- resetTransform
- createConicGradient
- createLinearGradient
- createPattern
- createRadialGradient
- fillText
- measureText
- strokeText
- hitFill
- hitStroke
- setStroke
- setWorld
- setWorldShadow
- setWorldBlur
- copyWorld
- copyWorldToInner
- fillWorld
- strokeWorld
- clipWorld
- clearWorld
- clear
- beginPath
- moveTo
- lineTo
- bezierCurveTo
- quadraticCurveTo
- closePath
- arc
- arcTo
- ellipse
- rect
- roundRect
Properties
manager
manager: ICanvasManager
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:123
innerId
Readonly
innerId: number
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:125
width
width: number
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:127
height
height: number
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:128
pixelRatio
pixelRatio: number
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:130
pixelWidth
Readonly
pixelWidth: number
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:131
pixelHeight
Readonly
pixelHeight: number
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:132
bounds
bounds: IBounds
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:134
view
view: unknown
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:136
parentView
parentView: unknown
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:137
offscreen
offscreen: boolean
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:138
context
context: ICanvasContext2D
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:140
recycled
Optional
recycled: boolean
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:142
smooth
smooth: boolean
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:33
smoothLevel
smoothLevel: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:34
opacity
opacity: number
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:35
blendMode
blendMode: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:36
fillStyle
fillStyle: string
| object
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:38
strokeStyle
strokeStyle: string
| object
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:40
strokeWidth
strokeWidth: number
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:41
shadowBlur
shadowBlur: number
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:43
shadowColor
shadowColor: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:44
shadowOffsetX
shadowOffsetX: number
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:45
shadowOffsetY
shadowOffsetY: number
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:46
filter
filter: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:48
font
font: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:50
fontKerning
fontKerning: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:51
fontStretch
fontStretch: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:52
fontVariantCaps
fontVariantCaps: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:53
textAlign
textAlign: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:55
textBaseline
textBaseline: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:56
textRendering
textRendering: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:57
wordSpacing
wordSpacing: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:58
letterSpacing
letterSpacing: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:59
direction
direction: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:61
strokeAlign
Optional
strokeAlign: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:22
strokeCap
Optional
strokeCap: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:24
strokeJoin
Optional
strokeJoin: string
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:25
dashPattern
Optional
dashPattern: number
[]
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:26
dashOffset
Optional
dashOffset: number
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:27
miterLimit
Optional
miterLimit: number
Inherited from
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:28
Methods
debug
debug(): void
Returns
void
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:144
startAutoLayout
startAutoLayout(autoBounds
, listener
): void
Parameters
Name | Type |
---|---|
autoBounds | IAutoBounds |
listener | IResizeEventListener |
Returns
void
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:146
stopAutoLayout
stopAutoLayout(): void
Returns
void
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:147
resize
resize(size
): void
Parameters
Name | Type |
---|---|
size | IScreenSizeData |
Returns
void
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:149
pixel
pixel(num
): number
Parameters
Name | Type |
---|---|
num | number |
Returns
number
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:150
isSameSize
isSameSize(options
): boolean
Parameters
Name | Type |
---|---|
options | ILeaferCanvasConfig |
Returns
boolean
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:153
getSameCanvas
getSameCanvas(useSameTransform?
): ILeaferCanvas
Parameters
Name | Type |
---|---|
useSameTransform? | boolean |
Returns
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:154
getBiggerCanvas
getBiggerCanvas(addWidth
, addHeight
): ILeaferCanvas
Parameters
Name | Type |
---|---|
addWidth | number |
addHeight | number |
Returns
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:155
useSameTransform
useSameTransform(canvas
): void
Parameters
Name | Type |
---|---|
canvas | ILeaferCanvas |
Returns
void
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:156
recycle
recycle(): void
Returns
void
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:157
unloadView
unloadView(): void
Returns
void
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:159
destroy
destroy(): void
Returns
void
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:160
save
save(): void
Returns
void
Inherited from
ICanvasMethod.save
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:65
restore
restore(): void
Returns
void
Inherited from
ICanvasMethod.restore
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:66
fill
fill(path?
, rule?
): void
Parameters
Name | Type |
---|---|
path? | IWindingRule | IPath2D |
rule? | IWindingRule |
Returns
void
Inherited from
ICanvasMethod.fill
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:68
stroke
stroke(path?
): void
Parameters
Name | Type |
---|---|
path? | IPath2D |
Returns
void
Inherited from
ICanvasMethod.stroke
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:69
clip
clip(path?
, rule?
): void
Parameters
Name | Type |
---|---|
path? | IWindingRule | IPath2D |
rule? | IWindingRule |
Returns
void
Inherited from
ICanvasMethod.clip
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:70
fillRect
fillRect(x
, y
, width
, height
): void
Parameters
Name | Type |
---|---|
x | number |
y | number |
width | number |
height | number |
Returns
void
Inherited from
ICanvasMethod.fillRect
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:72
strokeRect
strokeRect(x
, y
, width
, height
): void
Parameters
Name | Type |
---|---|
x | number |
y | number |
width | number |
height | number |
Returns
void
Inherited from
ICanvasMethod.strokeRect
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:73
clearRect
clearRect(x
, y
, width
, height
): void
Parameters
Name | Type |
---|---|
x | number |
y | number |
width | number |
height | number |
Returns
void
Inherited from
ICanvasMethod.clearRect
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:74
translate
translate(x
, y
): void
Parameters
Name | Type |
---|---|
x | number |
y | number |
Returns
void
Inherited from
ICanvasMethod.translate
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:76
scale
scale(x
, y
): void
Parameters
Name | Type |
---|---|
x | number |
y | number |
Returns
void
Inherited from
ICanvasMethod.scale
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:77
rotate
rotate(angle
): void
Parameters
Name | Type |
---|---|
angle | number |
Returns
void
Inherited from
ICanvasMethod.rotate
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:78
drawImage
drawImage(image
, dx
, dy
): void
Parameters
Name | Type |
---|---|
image | CanvasImageSource |
dx | number |
dy | number |
Returns
void
Inherited from
ICanvasMethod.drawImage
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:80
drawImage(image
, dx
, dy
, dw
, dh
): void
Parameters
Name | Type |
---|---|
image | CanvasImageSource |
dx | number |
dy | number |
dw | number |
dh | number |
Returns
void
Inherited from
ICanvasMethod.drawImage
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:81
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
ICanvasMethod.drawImage
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:82
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
ICanvasMethod.setTransform
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:84
getTransform
getTransform(): IMatrixData
Returns
Inherited from
ICanvasMethod.getTransform
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:85
resetTransform
resetTransform(): void
Returns
void
Inherited from
ICanvasMethod.resetTransform
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:86
createConicGradient
createConicGradient(startAngle
, x
, y
): CanvasGradient
Parameters
Name | Type |
---|---|
startAngle | number |
x | number |
y | number |
Returns
CanvasGradient
Inherited from
ICanvasMethod.createConicGradient
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:88
createLinearGradient
createLinearGradient(x0
, y0
, x1
, y1
): CanvasGradient
Parameters
Name | Type |
---|---|
x0 | number |
y0 | number |
x1 | number |
y1 | number |
Returns
CanvasGradient
Inherited from
ICanvasMethod.createLinearGradient
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:89
createPattern
createPattern(image
, repetition
): CanvasPattern
Parameters
Name | Type |
---|---|
image | CanvasImageSource |
repetition | string |
Returns
CanvasPattern
Inherited from
ICanvasMethod.createPattern
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:90
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
ICanvasMethod.createRadialGradient
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:91
fillText
fillText(text
, x
, y
, maxWidth?
): void
Parameters
Name | Type |
---|---|
text | string |
x | number |
y | number |
maxWidth? | number |
Returns
void
Inherited from
ICanvasMethod.fillText
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:95
measureText
measureText(text
): ITextMetrics
Parameters
Name | Type |
---|---|
text | string |
Returns
Inherited from
ICanvasMethod.measureText
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:96
strokeText
strokeText(text
, x
, y
, maxWidth?
): void
Parameters
Name | Type |
---|---|
text | string |
x | number |
y | number |
maxWidth? | number |
Returns
void
Inherited from
ICanvasMethod.strokeText
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:97
hitFill
hitFill(point
, fillRule?
): boolean
Parameters
Name | Type |
---|---|
point | IPointData |
fillRule? | string |
Returns
boolean
Inherited from
ICanvasMethod.hitFill
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:101
hitStroke
hitStroke(point
): boolean
Parameters
Name | Type |
---|---|
point | IPointData |
Returns
boolean
Inherited from
ICanvasMethod.hitStroke
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:102
setStroke
setStroke(strokeStyle
, strokeWidth
, options?
): void
Parameters
Name | Type |
---|---|
strokeStyle | string | object |
strokeWidth | number |
options? | ICanvasStrokeOptions |
Returns
void
Inherited from
ICanvasMethod.setStroke
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:104
setWorld
setWorld(matrix
, parentMatrix?
): void
Parameters
Name | Type |
---|---|
matrix | IMatrixData |
parentMatrix? | IMatrixData |
Returns
void
Inherited from
ICanvasMethod.setWorld
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:106
setWorldShadow
setWorldShadow(x
, y
, blur
, color?
): void
Parameters
Name | Type |
---|---|
x | number |
y | number |
blur | number |
color? | string |
Returns
void
Inherited from
ICanvasMethod.setWorldShadow
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:108
setWorldBlur
setWorldBlur(blur
): void
Parameters
Name | Type |
---|---|
blur | number |
Returns
void
Inherited from
ICanvasMethod.setWorldBlur
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:109
copyWorld
copyWorld(canvas
, fromBounds?
, toBounds?
, blendMode?
): void
Parameters
Name | Type |
---|---|
canvas | ILeaferCanvas |
fromBounds? | IBoundsData |
toBounds? | IBoundsData |
blendMode? | string |
Returns
void
Inherited from
ICanvasMethod.copyWorld
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:111
copyWorldToInner
copyWorldToInner(canvas
, fromWorld
, toInnerBounds
, blendMode?
): void
Parameters
Name | Type |
---|---|
canvas | ILeaferCanvas |
fromWorld | IMatrixWithBoundsData |
toInnerBounds | IBoundsData |
blendMode? | string |
Returns
void
Inherited from
ICanvasMethod.copyWorldToInner
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:112
fillWorld
fillWorld(bounds
, color
, blendMode?
): void
Parameters
Name | Type |
---|---|
bounds | IBoundsData |
color | string | object |
blendMode? | string |
Returns
void
Inherited from
ICanvasMethod.fillWorld
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:113
strokeWorld
strokeWorld(bounds
, color
, blendMode?
): void
Parameters
Name | Type |
---|---|
bounds | IBoundsData |
color | string | object |
blendMode? | string |
Returns
void
Inherited from
ICanvasMethod.strokeWorld
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:114
clipWorld
clipWorld(bounds
, ceilPixel?
): void
Parameters
Name | Type |
---|---|
bounds | IBoundsData |
ceilPixel? | boolean |
Returns
void
Inherited from
ICanvasMethod.clipWorld
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:115
clearWorld
clearWorld(bounds
, ceilPixel?
): void
Parameters
Name | Type |
---|---|
bounds | IBoundsData |
ceilPixel? | boolean |
Returns
void
Inherited from
ICanvasMethod.clearWorld
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:116
clear
clear(): void
Returns
void
Inherited from
ICanvasMethod.clear
Defined in
leafer/packages/interface/src/canvas/ILeaferCanvas.ts:118
beginPath
Optional
beginPath(): void
Returns
void
Inherited from
Defined in
leafer/packages/interface/src/path/IPathDrawer.ts:2
moveTo
moveTo(x
, y
): void
Parameters
Name | Type |
---|---|
x | number |
y | number |
Returns
void
Inherited from
Defined in
leafer/packages/interface/src/path/IPathDrawer.ts:4
lineTo
lineTo(x
, y
): void
Parameters
Name | Type |
---|---|
x | number |
y | number |
Returns
void
Inherited from
Defined in
leafer/packages/interface/src/path/IPathDrawer.ts:5
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
Defined in
leafer/packages/interface/src/path/IPathDrawer.ts:6
quadraticCurveTo
quadraticCurveTo(cpx
, cpy
, x
, y
): void
Parameters
Name | Type |
---|---|
cpx | number |
cpy | number |
x | number |
y | number |
Returns
void
Inherited from
Defined in
leafer/packages/interface/src/path/IPathDrawer.ts:7
closePath
closePath(): void
Returns
void
Inherited from
Defined in
leafer/packages/interface/src/path/IPathDrawer.ts:8
arc
arc(x
, y
, radius
, startAngle
, endAngle
, counterclockwise?
): void
Parameters
Name | Type |
---|---|
x | number |
y | number |
radius | number |
startAngle | number |
endAngle | number |
counterclockwise? | boolean |
Returns
void
Inherited from
Defined in
leafer/packages/interface/src/path/IPathDrawer.ts:10
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/interface/src/path/IPathDrawer.ts:11
ellipse
ellipse(x
, y
, radiusX
, radiusY
, rotation
, startAngle
, endAngle
, counterclockwise?
): void
Parameters
Name | Type |
---|---|
x | number |
y | number |
radiusX | number |
radiusY | number |
rotation | number |
startAngle | number |
endAngle | number |
counterclockwise? | boolean |
Returns
void
Inherited from
Defined in
leafer/packages/interface/src/path/IPathDrawer.ts:12
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/interface/src/path/IPathDrawer.ts:14
roundRect
roundRect(x
, y
, width
, height
, radius?
): void
Parameters
Name | Type |
---|---|
x | number |
y | number |
width | number |
height | number |
radius? | number | number [] |
Returns
void