Skip to content
导航

Interface: ILeaferCanvas

Hierarchy

Implemented by

Table of contents

Properties

Methods

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

ICanvasAttr.smooth

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:33


smoothLevel

smoothLevel: string

Inherited from

ICanvasAttr.smoothLevel

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:34


opacity

opacity: number

Inherited from

ICanvasAttr.opacity

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:35


blendMode

blendMode: string

Inherited from

ICanvasAttr.blendMode

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:36


fillStyle

fillStyle: string | object

Inherited from

ICanvasAttr.fillStyle

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:38


strokeStyle

strokeStyle: string | object

Inherited from

ICanvasAttr.strokeStyle

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:40


strokeWidth

strokeWidth: number

Inherited from

ICanvasAttr.strokeWidth

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:41


shadowBlur

shadowBlur: number

Inherited from

ICanvasAttr.shadowBlur

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:43


shadowColor

shadowColor: string

Inherited from

ICanvasAttr.shadowColor

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:44


shadowOffsetX

shadowOffsetX: number

Inherited from

ICanvasAttr.shadowOffsetX

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:45


shadowOffsetY

shadowOffsetY: number

Inherited from

ICanvasAttr.shadowOffsetY

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:46


filter

filter: string

Inherited from

ICanvasAttr.filter

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:48


font

font: string

Inherited from

ICanvasAttr.font

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:50


fontKerning

fontKerning: string

Inherited from

ICanvasAttr.fontKerning

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:51


fontStretch

fontStretch: string

Inherited from

ICanvasAttr.fontStretch

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:52


fontVariantCaps

fontVariantCaps: string

Inherited from

ICanvasAttr.fontVariantCaps

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:53


textAlign

textAlign: string

Inherited from

ICanvasAttr.textAlign

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:55


textBaseline

textBaseline: string

Inherited from

ICanvasAttr.textBaseline

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:56


textRendering

textRendering: string

Inherited from

ICanvasAttr.textRendering

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:57


wordSpacing

wordSpacing: string

Inherited from

ICanvasAttr.wordSpacing

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:58


letterSpacing

letterSpacing: string

Inherited from

ICanvasAttr.letterSpacing

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:59


direction

direction: string

Inherited from

ICanvasAttr.direction

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:61


strokeAlign

Optional strokeAlign: string

Inherited from

ICanvasAttr.strokeAlign

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:22


strokeCap

Optional strokeCap: string

Inherited from

ICanvasAttr.strokeCap

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:24


strokeJoin

Optional strokeJoin: string

Inherited from

ICanvasAttr.strokeJoin

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:25


dashPattern

Optional dashPattern: number[]

Inherited from

ICanvasAttr.dashPattern

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:26


dashOffset

Optional dashOffset: number

Inherited from

ICanvasAttr.dashOffset

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:27


miterLimit

Optional miterLimit: number

Inherited from

ICanvasAttr.miterLimit

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

NameType
autoBoundsIAutoBounds
listenerIResizeEventListener

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

NameType
sizeIScreenSizeData

Returns

void

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:149


pixel

pixel(num): number

Parameters

NameType
numnumber

Returns

number

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:150


isSameSize

isSameSize(options): boolean

Parameters

NameType
optionsILeaferCanvasConfig

Returns

boolean

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:153


getSameCanvas

getSameCanvas(useSameTransform?): ILeaferCanvas

Parameters

NameType
useSameTransform?boolean

Returns

ILeaferCanvas

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:154


getBiggerCanvas

getBiggerCanvas(addWidth, addHeight): ILeaferCanvas

Parameters

NameType
addWidthnumber
addHeightnumber

Returns

ILeaferCanvas

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:155


useSameTransform

useSameTransform(canvas): void

Parameters

NameType
canvasILeaferCanvas

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

NameType
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

NameType
path?IPath2D

Returns

void

Inherited from

ICanvasMethod.stroke

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:69


clip

clip(path?, rule?): void

Parameters

NameType
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

NameType
xnumber
ynumber
widthnumber
heightnumber

Returns

void

Inherited from

ICanvasMethod.fillRect

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:72


strokeRect

strokeRect(x, y, width, height): void

Parameters

NameType
xnumber
ynumber
widthnumber
heightnumber

Returns

void

Inherited from

ICanvasMethod.strokeRect

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:73


clearRect

clearRect(x, y, width, height): void

Parameters

NameType
xnumber
ynumber
widthnumber
heightnumber

Returns

void

Inherited from

ICanvasMethod.clearRect

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:74


translate

translate(x, y): void

Parameters

NameType
xnumber
ynumber

Returns

void

Inherited from

ICanvasMethod.translate

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:76


scale

scale(x, y): void

Parameters

NameType
xnumber
ynumber

Returns

void

Inherited from

ICanvasMethod.scale

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:77


rotate

rotate(angle): void

Parameters

NameType
anglenumber

Returns

void

Inherited from

ICanvasMethod.rotate

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:78


drawImage

drawImage(image, dx, dy): void

Parameters

NameType
imageCanvasImageSource
dxnumber
dynumber

Returns

void

Inherited from

ICanvasMethod.drawImage

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:80

drawImage(image, dx, dy, dw, dh): void

Parameters

NameType
imageCanvasImageSource
dxnumber
dynumber
dwnumber
dhnumber

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

NameType
imageCanvasImageSource
sxnumber
synumber
swnumber
shnumber
dxnumber
dynumber
dwnumber
dhnumber

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

NameType
anumber | 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

IMatrixData

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

NameType
startAnglenumber
xnumber
ynumber

Returns

CanvasGradient

Inherited from

ICanvasMethod.createConicGradient

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:88


createLinearGradient

createLinearGradient(x0, y0, x1, y1): CanvasGradient

Parameters

NameType
x0number
y0number
x1number
y1number

Returns

CanvasGradient

Inherited from

ICanvasMethod.createLinearGradient

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:89


createPattern

createPattern(image, repetition): CanvasPattern

Parameters

NameType
imageCanvasImageSource
repetitionstring

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

NameType
x0number
y0number
r0number
x1number
y1number
r1number

Returns

CanvasGradient

Inherited from

ICanvasMethod.createRadialGradient

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:91


fillText

fillText(text, x, y, maxWidth?): void

Parameters

NameType
textstring
xnumber
ynumber
maxWidth?number

Returns

void

Inherited from

ICanvasMethod.fillText

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:95


measureText

measureText(text): ITextMetrics

Parameters

NameType
textstring

Returns

ITextMetrics

Inherited from

ICanvasMethod.measureText

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:96


strokeText

strokeText(text, x, y, maxWidth?): void

Parameters

NameType
textstring
xnumber
ynumber
maxWidth?number

Returns

void

Inherited from

ICanvasMethod.strokeText

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:97


hitFill

hitFill(point, fillRule?): boolean

Parameters

NameType
pointIPointData
fillRule?string

Returns

boolean

Inherited from

ICanvasMethod.hitFill

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:101


hitStroke

hitStroke(point): boolean

Parameters

NameType
pointIPointData

Returns

boolean

Inherited from

ICanvasMethod.hitStroke

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:102


setStroke

setStroke(strokeStyle, strokeWidth, options?): void

Parameters

NameType
strokeStylestring | object
strokeWidthnumber
options?ICanvasStrokeOptions

Returns

void

Inherited from

ICanvasMethod.setStroke

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:104


setWorld

setWorld(matrix, parentMatrix?): void

Parameters

NameType
matrixIMatrixData
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

NameType
xnumber
ynumber
blurnumber
color?string

Returns

void

Inherited from

ICanvasMethod.setWorldShadow

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:108


setWorldBlur

setWorldBlur(blur): void

Parameters

NameType
blurnumber

Returns

void

Inherited from

ICanvasMethod.setWorldBlur

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:109


copyWorld

copyWorld(canvas, fromBounds?, toBounds?, blendMode?): void

Parameters

NameType
canvasILeaferCanvas
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

NameType
canvasILeaferCanvas
fromWorldIMatrixWithBoundsData
toInnerBoundsIBoundsData
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

NameType
boundsIBoundsData
colorstring | 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

NameType
boundsIBoundsData
colorstring | 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

NameType
boundsIBoundsData
ceilPixel?boolean

Returns

void

Inherited from

ICanvasMethod.clipWorld

Defined in

leafer/packages/interface/src/canvas/ILeaferCanvas.ts:115


clearWorld

clearWorld(bounds, ceilPixel?): void

Parameters

NameType
boundsIBoundsData
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

IPathDrawer.beginPath

Defined in

leafer/packages/interface/src/path/IPathDrawer.ts:2


moveTo

moveTo(x, y): void

Parameters

NameType
xnumber
ynumber

Returns

void

Inherited from

IPathDrawer.moveTo

Defined in

leafer/packages/interface/src/path/IPathDrawer.ts:4


lineTo

lineTo(x, y): void

Parameters

NameType
xnumber
ynumber

Returns

void

Inherited from

IPathDrawer.lineTo

Defined in

leafer/packages/interface/src/path/IPathDrawer.ts:5


bezierCurveTo

bezierCurveTo(cp1x, cp1y, cp2x, cp2y, x, y): void

Parameters

NameType
cp1xnumber
cp1ynumber
cp2xnumber
cp2ynumber
xnumber
ynumber

Returns

void

Inherited from

IPathDrawer.bezierCurveTo

Defined in

leafer/packages/interface/src/path/IPathDrawer.ts:6


quadraticCurveTo

quadraticCurveTo(cpx, cpy, x, y): void

Parameters

NameType
cpxnumber
cpynumber
xnumber
ynumber

Returns

void

Inherited from

IPathDrawer.quadraticCurveTo

Defined in

leafer/packages/interface/src/path/IPathDrawer.ts:7


closePath

closePath(): void

Returns

void

Inherited from

IPathDrawer.closePath

Defined in

leafer/packages/interface/src/path/IPathDrawer.ts:8


arc

arc(x, y, radius, startAngle, endAngle, counterclockwise?): void

Parameters

NameType
xnumber
ynumber
radiusnumber
startAnglenumber
endAnglenumber
counterclockwise?boolean

Returns

void

Inherited from

IPathDrawer.arc

Defined in

leafer/packages/interface/src/path/IPathDrawer.ts:10


arcTo

arcTo(x1, y1, x2, y2, radius): void

Parameters

NameType
x1number
y1number
x2number
y2number
radiusnumber

Returns

void

Inherited from

IPathDrawer.arcTo

Defined in

leafer/packages/interface/src/path/IPathDrawer.ts:11


ellipse

ellipse(x, y, radiusX, radiusY, rotation, startAngle, endAngle, counterclockwise?): void

Parameters

NameType
xnumber
ynumber
radiusXnumber
radiusYnumber
rotationnumber
startAnglenumber
endAnglenumber
counterclockwise?boolean

Returns

void

Inherited from

IPathDrawer.ellipse

Defined in

leafer/packages/interface/src/path/IPathDrawer.ts:12


rect

rect(x, y, width, height): void

Parameters

NameType
xnumber
ynumber
widthnumber
heightnumber

Returns

void

Inherited from

IPathDrawer.rect

Defined in

leafer/packages/interface/src/path/IPathDrawer.ts:14


roundRect

roundRect(x, y, width, height, radius?): void

Parameters

NameType
xnumber
ynumber
widthnumber
heightnumber
radius?number | number[]

Returns

void

Inherited from

IPathDrawer.roundRect

Defined in

leafer/packages/interface/src/path/IPathDrawer.ts:15

Released under the MIT License.