Interface: ICanvasContext2D

Hierarchy

• CanvasCompositing

• CanvasDrawImage

• CanvasDrawPath

• CanvasFillStrokeStyles

• CanvasFilters

• CanvasImageData

• CanvasImageSmoothing

• CanvasPath

• CanvasPathDrawingStyles

• CanvasRect

• CanvasShadowStyles

• CanvasState

• CanvasText

• CanvasTextDrawingStyles

• CanvasTransform

• CanvasUserInterface

  ↳ ICanvasContext2D

Table of contents

Properties

• globalAlpha
• globalCompositeOperation
• fillStyle
• strokeStyle
• filter
• imageSmoothingEnabled
• imageSmoothingQuality
• lineCap
• lineDashOffset
• lineJoin
• lineWidth
• miterLimit
• canvas
• shadowBlur
• shadowColor
• shadowOffsetX
• shadowOffsetY
• direction
• font
• textAlign
• textBaseline

Methods

• drawImage
• beginPath
• clip
• fill
• isPointInPath
• isPointInStroke
• stroke
• createConicGradient
• createLinearGradient
• createPattern
• createRadialGradient
• createImageData
• getImageData
• putImageData
• arc
• arcTo
• bezierCurveTo
• closePath
• ellipse
• lineTo
• moveTo
• quadraticCurveTo
• rect
• roundRect
• getLineDash
• setLineDash
• clearRect
• fillRect
• strokeRect
• getContextAttributes
• restore
• save
• drawFocusIfNeeded
• fillText
• measureText
• strokeText
• getTransform
• resetTransform
• rotate
• scale
• setTransform
• transform
• translate

Properties

globalAlpha

• globalAlpha: number

Inherited from

CanvasCompositing.globalAlpha

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:23

---

globalCompositeOperation

• globalCompositeOperation: GlobalCompositeOperation

Inherited from

CanvasCompositing.globalCompositeOperation

Defined in

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

---

fillStyle

• fillStyle: string | CanvasGradient | CanvasPattern

Inherited from

CanvasFillStrokeStyles.fillStyle

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:49

---

strokeStyle

• strokeStyle: string | CanvasGradient | CanvasPattern

Inherited from

CanvasFillStrokeStyles.strokeStyle

Defined in

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

---

filter

• filter: string

Inherited from

CanvasFilters.filter

Defined in

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

---

imageSmoothingEnabled

• imageSmoothingEnabled: boolean

Inherited from

CanvasImageSmoothing.imageSmoothingEnabled

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:83

---

imageSmoothingQuality

• imageSmoothingQuality: ImageSmoothingQuality

Inherited from

CanvasImageSmoothing.imageSmoothingQuality

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:84

---

lineCap

• lineCap: CanvasLineCap

Inherited from

CanvasPathDrawingStyles.lineCap

Defined in

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

---

lineDashOffset

• lineDashOffset: number

Inherited from

CanvasPathDrawingStyles.lineDashOffset

Defined in

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

---

lineJoin

• lineJoin: CanvasLineJoin

Inherited from

CanvasPathDrawingStyles.lineJoin

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:103

---

lineWidth

• lineWidth: number

Inherited from

CanvasPathDrawingStyles.lineWidth

Defined in

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

---

miterLimit

• miterLimit: number

Inherited from

CanvasPathDrawingStyles.miterLimit

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:105

---

canvas

• Readonly canvas: HTMLCanvasElement

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:138

---

shadowBlur

• shadowBlur: number

Inherited from

CanvasShadowStyles.shadowBlur

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:148

---

shadowColor

• shadowColor: string

Inherited from

CanvasShadowStyles.shadowColor

Defined in

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

---

shadowOffsetX

• shadowOffsetX: number

Inherited from

CanvasShadowStyles.shadowOffsetX

Defined in

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

---

shadowOffsetY

• shadowOffsetY: number

Inherited from

CanvasShadowStyles.shadowOffsetY

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:151

---

direction

• direction: CanvasDirection

Inherited from

CanvasTextDrawingStyles.direction

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:194

---

font

• font: string

Inherited from

CanvasTextDrawingStyles.font

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:195

---

textAlign

• textAlign: CanvasTextAlign

Inherited from

CanvasTextDrawingStyles.textAlign

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:196

---

textBaseline

• textBaseline: CanvasTextBaseline

Inherited from

CanvasTextDrawingStyles.textBaseline

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:197

Methods

drawImage

▸ drawImage(image, dx, dy): void

Parameters

Name	Type
image	any
dx	number
dy	number

Returns

void

Inherited from

CanvasDrawImage.drawImage

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:29

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

Parameters

Name	Type
image	any
dx	number
dy	number
dw	number
dh	number

Returns

void

Inherited from

CanvasDrawImage.drawImage

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:30

▸ drawImage(image, sx, sy, sw, sh, dx, dy, dw, dh): void

Parameters

Name	Type
image	any
sx	number
sy	number
sw	number
sh	number
dx	number
dy	number
dw	number
dh	number

Returns

void

Inherited from

CanvasDrawImage.drawImage

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:31

---

beginPath

▸ beginPath(): void

Returns

void

Inherited from

CanvasDrawPath.beginPath

Defined in

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

---

clip

▸ clip(fillRule?): void

Parameters

Name	Type
fillRule?	IWindingRule

Returns

void

Inherited from

CanvasDrawPath.clip

Defined in

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

▸ clip(path, fillRule?): void

Parameters

Name	Type
path	IPath2D
fillRule?	IWindingRule

Returns

void

Inherited from

CanvasDrawPath.clip

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:37

---

fill

▸ fill(fillRule?): void

Parameters

Name	Type
fillRule?	IWindingRule

Returns

void

Inherited from

CanvasDrawPath.fill

Defined in

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

▸ fill(path, fillRule?): void

Parameters

Name	Type
path	IPath2D
fillRule?	IWindingRule

Returns

void

Inherited from

CanvasDrawPath.fill

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:39

---

isPointInPath

▸ isPointInPath(x, y, fillRule?): boolean

Parameters

Name	Type
x	number
y	number
fillRule?	IWindingRule

Returns

boolean

Inherited from

CanvasDrawPath.isPointInPath

Defined in

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

▸ isPointInPath(path, x, y, fillRule?): boolean

Parameters

Name	Type
path	IPath2D
x	number
y	number
fillRule?	IWindingRule

Returns

boolean

Inherited from

CanvasDrawPath.isPointInPath

Defined in

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

---

isPointInStroke

▸ isPointInStroke(x, y): boolean

Parameters

Name	Type
x	number
y	number

Returns

boolean

Inherited from

CanvasDrawPath.isPointInStroke

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:42

▸ isPointInStroke(path, x, y): boolean

Parameters

Name	Type
path	IPath2D
x	number
y	number

Returns

boolean

Inherited from

CanvasDrawPath.isPointInStroke

Defined in

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

---

stroke

▸ stroke(): void

Returns

void

Inherited from

CanvasDrawPath.stroke

Defined in

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

▸ stroke(path): void

Parameters

Name	Type
path	IPath2D

Returns

void

Inherited from

CanvasDrawPath.stroke

Defined in

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

---

createConicGradient

▸ createConicGradient(startAngle, x, y): CanvasGradient

Parameters

Name	Type
startAngle	number
x	number
y	number

Returns

CanvasGradient

Inherited from

CanvasFillStrokeStyles.createConicGradient

Defined in

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

---

createLinearGradient

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

Parameters

Name	Type
x0	number
y0	number
x1	number
y1	number

Returns

CanvasGradient

Inherited from

CanvasFillStrokeStyles.createLinearGradient

Defined in

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

---

createPattern

▸ createPattern(image, repetition): CanvasPattern

Parameters

Name	Type
image	any
repetition	string

Returns

CanvasPattern

Inherited from

CanvasFillStrokeStyles.createPattern

Defined in

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

---

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

CanvasFillStrokeStyles.createRadialGradient

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:54

---

createImageData

▸ createImageData(sw, sh, settings?): ImageData

Parameters

Name	Type
sw	number
sh	number
settings?	ImageDataSettings

Returns

ImageData

Inherited from

CanvasImageData.createImageData

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:75

▸ createImageData(imagedata): ImageData

Parameters

Name	Type
imagedata	ImageData

Returns

ImageData

Inherited from

CanvasImageData.createImageData

Defined in

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

---

getImageData

▸ getImageData(sx, sy, sw, sh, settings?): ImageData

Parameters

Name	Type
sx	number
sy	number
sw	number
sh	number
settings?	ImageDataSettings

Returns

ImageData

Inherited from

CanvasImageData.getImageData

Defined in

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

---

putImageData

▸ putImageData(imagedata, dx, dy): void

Parameters

Name	Type
imagedata	ImageData
dx	number
dy	number

Returns

void

Inherited from

CanvasImageData.putImageData

Defined in

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

▸ putImageData(imagedata, dx, dy, dirtyX, dirtyY, dirtyWidth, dirtyHeight): void

Parameters

Name	Type
imagedata	ImageData
dx	number
dy	number
dirtyX	number
dirtyY	number
dirtyWidth	number
dirtyHeight	number

Returns

void

Inherited from

CanvasImageData.putImageData

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:79

---

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

CanvasPath.arc

Defined in

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

---

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

CanvasPath.arcTo

Defined in

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

---

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

CanvasPath.bezierCurveTo

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:90

---

closePath

▸ closePath(): void

Returns

void

Inherited from

CanvasPath.closePath

Defined in

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

---

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

CanvasPath.ellipse

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:92

---

lineTo

▸ lineTo(x, y): void

Parameters

Name	Type
x	number
y	number

Returns

void

Inherited from

CanvasPath.lineTo

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:93

---

moveTo

▸ moveTo(x, y): void

Parameters

Name	Type
x	number
y	number

Returns

void

Inherited from

CanvasPath.moveTo

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:94

---

quadraticCurveTo

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

Parameters

Name	Type
cpx	number
cpy	number
x	number
y	number

Returns

void

Inherited from

CanvasPath.quadraticCurveTo

Defined in

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

---

rect

▸ rect(x, y, w, h): void

Parameters

Name	Type
x	number
y	number
w	number
h	number

Returns

void

Inherited from

CanvasPath.rect

Defined in

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

---

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

CanvasPath.roundRect

Defined in

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

---

getLineDash

▸ getLineDash(): number[]

Returns

number[]

Inherited from

CanvasPathDrawingStyles.getLineDash

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:106

---

setLineDash

▸ setLineDash(segments): void

Parameters

Name	Type
segments	number[]

Returns

void

Inherited from

CanvasPathDrawingStyles.setLineDash

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:107

---

clearRect

▸ clearRect(x, y, w, h): void

Parameters

Name	Type
x	number
y	number
w	number
h	number

Returns

void

Inherited from

CanvasRect.clearRect

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:122

---

fillRect

▸ fillRect(x, y, w, h): void

Parameters

Name	Type
x	number
y	number
w	number
h	number

Returns

void

Inherited from

CanvasRect.fillRect

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:123

---

strokeRect

▸ strokeRect(x, y, w, h): void

Parameters

Name	Type
x	number
y	number
w	number
h	number

Returns

void

Inherited from

CanvasRect.strokeRect

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:124

---

getContextAttributes

▸ getContextAttributes(): ICanvasRenderingContext2DSettings

Returns

ICanvasRenderingContext2DSettings

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:139

---

restore

▸ restore(): void

Returns

void

Inherited from

CanvasState.restore

Defined in

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

---

save

▸ save(): void

Returns

void

Inherited from

CanvasState.save

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:156

---

drawFocusIfNeeded

▸ drawFocusIfNeeded(element): void

Parameters

Name	Type
element	any

Returns

void

Inherited from

CanvasUserInterface.drawFocusIfNeeded

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:160

▸ drawFocusIfNeeded(path, element): void

Parameters

Name	Type
path	IPath2D
element	any

Returns

void

Inherited from

CanvasUserInterface.drawFocusIfNeeded

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:161

---

fillText

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

Parameters

Name	Type
text	string
x	number
y	number
maxWidth?	number

Returns

void

Inherited from

CanvasText.fillText

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:188

---

measureText

▸ measureText(text): ITextMetrics

Parameters

Name	Type
text	string

Returns

ITextMetrics

Inherited from

CanvasText.measureText

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:189

---

strokeText

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

Parameters

Name	Type
text	string
x	number
y	number
maxWidth?	number

Returns

void

Inherited from

CanvasText.strokeText

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:190

---

getTransform

▸ getTransform(): DOMMatrix

Returns

DOMMatrix

Inherited from

CanvasTransform.getTransform

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:201

---

resetTransform

▸ resetTransform(): void

Returns

void

Inherited from

CanvasTransform.resetTransform

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:202

---

rotate

▸ rotate(angle): void

Parameters

Name	Type
angle	number

Returns

void

Inherited from

CanvasTransform.rotate

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:203

---

scale

▸ scale(x, y): void

Parameters

Name	Type
x	number
y	number

Returns

void

Inherited from

CanvasTransform.scale

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:204

---

setTransform

▸ setTransform(a, b, c, d, e, f): void

Parameters

Name	Type
a	number
b	number
c	number
d	number
e	number
f	number

Returns

void

Inherited from

CanvasTransform.setTransform

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:205

▸ setTransform(transform?): void

Parameters

Name	Type
transform?	DOMMatrix2DInit

Returns

void

Inherited from

CanvasTransform.setTransform

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:206

---

transform

▸ transform(a, b, c, d, e, f): void

Parameters

Name	Type
a	number
b	number
c	number
d	number
e	number
f	number

Returns

void

Inherited from

CanvasTransform.transform

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:207

---

translate

▸ translate(x, y): void

Parameters

Name	Type
x	number
y	number

Returns

void

Inherited from

CanvasTransform.translate

Defined in

leafer/packages/interface/src/canvas/ICanvas.ts:208