Interface CanvasRenderingContext2D

The CanvasRenderingContext2D interface, part of the Canvas API, provides the 2D rendering context for the drawing surface of a

MDN Reference

interface CanvasRenderingContext2D {
    canvas: HTMLCanvasElement;
    direction: CanvasDirection;
    fillStyle: string | CanvasGradient | CanvasPattern;
    filter: string;
    font: string;
    fontKerning: CanvasFontKerning;
    globalAlpha: number;
    globalCompositeOperation: GlobalCompositeOperation;
    imageSmoothingEnabled: boolean;
    imageSmoothingQuality: ImageSmoothingQuality;
    lineCap: CanvasLineCap;
    lineDashOffset: number;
    lineJoin: CanvasLineJoin;
    lineWidth: number;
    miterLimit: number;
    shadowBlur: number;
    shadowColor: string;
    shadowOffsetX: number;
    shadowOffsetY: number;
    strokeStyle: string | CanvasGradient | CanvasPattern;
    textAlign: CanvasTextAlign;
    textBaseline: CanvasTextBaseline;
    arc(x, y, radius, startAngle, endAngle, counterclockwise?): void;
    arcTo(x1, y1, x2, y2, radius): void;
    beginPath(): void;
    bezierCurveTo(cp1x, cp1y, cp2x, cp2y, x, y): void;
    clearRect(x, y, w, h): void;
    clip(fillRule?): void;
    clip(path, fillRule?): void;
    closePath(): void;
    createConicGradient(startAngle, x, y): CanvasGradient;
    createImageData(sw, sh, settings?): ImageData;
    createImageData(imagedata): ImageData;
    createLinearGradient(x0, y0, x1, y1): CanvasGradient;
    createPattern(image, repetition): CanvasPattern;
    createRadialGradient(x0, y0, r0, x1, y1, r1): CanvasGradient;
    drawFocusIfNeeded(element): void;
    drawFocusIfNeeded(path, element): void;
    drawImage(image, dx, dy): void;
    drawImage(image, dx, dy, dw, dh): void;
    drawImage(image, sx, sy, sw, sh, dx, dy, dw, dh): void;
    ellipse(x, y, radiusX, radiusY, rotation, startAngle, endAngle, counterclockwise?): void;
    fill(fillRule?): void;
    fill(path, fillRule?): void;
    fillRect(x, y, w, h): void;
    fillText(text, x, y, maxWidth?): void;
    getContextAttributes(): CanvasRenderingContext2DSettings;
    getImageData(sx, sy, sw, sh, settings?): ImageData;
    getLineDash(): number[];
    getTransform(): DOMMatrix;
    isPointInPath(x, y, fillRule?): boolean;
    isPointInPath(path, x, y, fillRule?): boolean;
    isPointInStroke(x, y): boolean;
    isPointInStroke(path, x, y): boolean;
    lineTo(x, y): void;
    measureText(text): TextMetrics;
    moveTo(x, y): void;
    putImageData(imagedata, dx, dy): void;
    putImageData(imagedata, dx, dy, dirtyX, dirtyY, dirtyWidth, dirtyHeight): void;
    quadraticCurveTo(cpx, cpy, x, y): void;
    rect(x, y, w, h): void;
    resetTransform(): void;
    restore(): void;
    rotate(angle): void;
    roundRect(x, y, w, h, radii?): void;
    save(): void;
    scale(x, y): void;
    setLineDash(segments): void;
    setTransform(a, b, c, d, e, f): void;
    setTransform(transform?): void;
    stroke(): void;
    stroke(path): void;
    strokeRect(x, y, w, h): void;
    strokeText(text, x, y, maxWidth?): void;
    transform(a, b, c, d, e, f): void;
    translate(x, y): void;
}

Hierarchy (view full)

Properties

filter

filter: string

MDN Reference

font

font: string

MDN Reference

fontKerning

fontKerning: CanvasFontKerning

MDN Reference

globalAlpha

globalAlpha: number

MDN Reference

globalCompositeOperation

globalCompositeOperation: GlobalCompositeOperation

MDN Reference

imageSmoothingEnabled

imageSmoothingEnabled: boolean

MDN Reference

imageSmoothingQuality

imageSmoothingQuality: ImageSmoothingQuality

MDN Reference

lineCap

lineCap: CanvasLineCap

MDN Reference

lineDashOffset

lineDashOffset: number

MDN Reference

lineJoin

lineJoin: CanvasLineJoin

MDN Reference

lineWidth

lineWidth: number

MDN Reference

miterLimit

miterLimit: number

MDN Reference

shadowBlur

shadowBlur: number

MDN Reference

shadowColor

shadowColor: string

MDN Reference

shadowOffsetX

shadowOffsetX: number

MDN Reference

shadowOffsetY

shadowOffsetY: number

MDN Reference

strokeStyle

strokeStyle: string | CanvasGradient | CanvasPattern

MDN Reference

textAlign

textAlign: CanvasTextAlign

MDN Reference

textBaseline

textBaseline: CanvasTextBaseline

MDN Reference

Methods

arc

arc(x, y, radius, startAngle, endAngle, counterclockwise?): void
MDN Reference
Parameters
- x: number
- y: number
- radius: number
- startAngle: number
- endAngle: number
- Optional counterclockwise: boolean
Returns void
Inherited from CanvasPath.arc
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5346

arcTo

arcTo(x1, y1, x2, y2, radius): void
MDN Reference
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
- radius: number
Returns void
Inherited from CanvasPath.arcTo
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5348

beginPath

beginPath(): void
MDN Reference

Returns void
Inherited from CanvasDrawPath.beginPath
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5267

bezierCurveTo

bezierCurveTo(cp1x, cp1y, cp2x, cp2y, x, y): void
MDN Reference
Parameters
- cp1x: number
- cp1y: number
- cp2x: number
- cp2y: number
- x: number
- y: number
Returns void
Inherited from CanvasPath.bezierCurveTo
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5350

clearRect

clearRect(x, y, w, h): void
MDN Reference
Parameters
- x: number
- y: number
- w: number
- h: number
Returns void
Inherited from CanvasRect.clearRect
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5405

clip

clip(fillRule?): void
MDN Reference
Parameters
- Optional fillRule: CanvasFillRule
Returns void
Inherited from CanvasDrawPath.clip
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5269
clip(path, fillRule?): void
Parameters
- path: Path2D
- Optional fillRule: CanvasFillRule
Returns void
Inherited from CanvasDrawPath.clip
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5270

closePath

closePath(): void
MDN Reference

Returns void
Inherited from CanvasPath.closePath
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5352

createConicGradient

createConicGradient(startAngle, x, y): CanvasGradient
MDN Reference
Parameters
- startAngle: number
- x: number
- y: number
Returns CanvasGradient
Inherited from CanvasFillStrokeStyles.createConicGradient
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5291

createImageData

createImageData(sw, sh, settings?): ImageData
MDN Reference
Parameters
- sw: number
- sh: number
- Optional settings: ImageDataSettings
Returns ImageData
Inherited from CanvasImageData.createImageData
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5328
createImageData(imagedata): ImageData
Parameters
- imagedata: ImageData
Returns ImageData
Inherited from CanvasImageData.createImageData
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5329

createLinearGradient

createLinearGradient(x0, y0, x1, y1): CanvasGradient
MDN Reference
Parameters
- x0: number
- y0: number
- x1: number
- y1: number
Returns CanvasGradient
Inherited from CanvasFillStrokeStyles.createLinearGradient
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5293

createPattern

createPattern(image, repetition): CanvasPattern
MDN Reference
Parameters
- image: CanvasImageSource
- repetition: string
Returns CanvasPattern
Inherited from CanvasFillStrokeStyles.createPattern
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5295

createRadialGradient

createRadialGradient(x0, y0, r0, x1, y1, r1): CanvasGradient
MDN Reference
Parameters
- x0: number
- y0: number
- r0: number
- x1: number
- y1: number
- r1: number
Returns CanvasGradient
Inherited from CanvasFillStrokeStyles.createRadialGradient
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5297

drawFocusIfNeeded

drawFocusIfNeeded(element): void
MDN Reference
Parameters
- element: Element
Returns void
Inherited from CanvasUserInterface.drawFocusIfNeeded
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5489
drawFocusIfNeeded(path, element): void
Parameters
- path: Path2D
- element: Element
Returns void
Inherited from CanvasUserInterface.drawFocusIfNeeded
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5490

drawImage

drawImage(image, dx, dy): void
MDN Reference
Parameters
- image: CanvasImageSource
- dx: number
- dy: number
Returns void
Inherited from CanvasDrawImage.drawImage
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5260
drawImage(image, dx, dy, dw, dh): void
Parameters
- image: CanvasImageSource
- dx: number
- dy: number
- dw: number
- dh: number
Returns void
Inherited from CanvasDrawImage.drawImage
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5261
drawImage(image, sx, sy, sw, sh, dx, dy, dw, dh): void
Parameters
- image: CanvasImageSource
- sx: number
- sy: number
- sw: number
- sh: number
- dx: number
- dy: number
- dw: number
- dh: number
Returns void
Inherited from CanvasDrawImage.drawImage
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5262

ellipse

ellipse(x, y, radiusX, radiusY, rotation, startAngle, endAngle, counterclockwise?): void
MDN Reference
Parameters
- x: number
- y: number
- radiusX: number
- radiusY: number
- rotation: number
- startAngle: number
- endAngle: number
- Optional counterclockwise: boolean
Returns void
Inherited from CanvasPath.ellipse
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5354

fill

fill(fillRule?): void
MDN Reference
Parameters
- Optional fillRule: CanvasFillRule
Returns void
Inherited from CanvasDrawPath.fill
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5272
fill(path, fillRule?): void
Parameters
- path: Path2D
- Optional fillRule: CanvasFillRule
Returns void
Inherited from CanvasDrawPath.fill
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5273

fillRect

fillRect(x, y, w, h): void
MDN Reference
Parameters
- x: number
- y: number
- w: number
- h: number
Returns void
Inherited from CanvasRect.fillRect
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5407

fillText

fillText(text, x, y, maxWidth?): void
MDN Reference
Parameters
- text: string
- x: number
- y: number
- Optional maxWidth: number
Returns void
Inherited from CanvasText.fillText
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5449

getContextAttributes

getContextAttributes(): CanvasRenderingContext2DSettings
MDN Reference

Returns CanvasRenderingContext2DSettings
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5421

getImageData

getImageData(sx, sy, sw, sh, settings?): ImageData
MDN Reference
Parameters
- sx: number
- sy: number
- sw: number
- sh: number
- Optional settings: ImageDataSettings
Returns ImageData
Inherited from CanvasImageData.getImageData
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5331

getLineDash

getLineDash(): number[]
MDN Reference

Returns number[]
Inherited from CanvasPathDrawingStyles.getLineDash
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5379

getTransform

getTransform(): DOMMatrix
MDN Reference

Returns DOMMatrix
Inherited from CanvasTransform.getTransform
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5471

isPointInPath

isPointInPath(x, y, fillRule?): boolean
MDN Reference
Parameters
- x: number
- y: number
- Optional fillRule: CanvasFillRule
Returns boolean
Inherited from CanvasDrawPath.isPointInPath
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5275
isPointInPath(path, x, y, fillRule?): boolean
Parameters
- path: Path2D
- x: number
- y: number
- Optional fillRule: CanvasFillRule
Returns boolean
Inherited from CanvasDrawPath.isPointInPath
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5276

isPointInStroke

isPointInStroke(x, y): boolean
MDN Reference
Parameters
- x: number
- y: number
Returns boolean
Inherited from CanvasDrawPath.isPointInStroke
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5278
isPointInStroke(path, x, y): boolean
Parameters
- path: Path2D
- x: number
- y: number
Returns boolean
Inherited from CanvasDrawPath.isPointInStroke
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5279

lineTo

lineTo(x, y): void
MDN Reference
Parameters
- x: number
- y: number
Returns void
Inherited from CanvasPath.lineTo
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5356

measureText

measureText(text): TextMetrics
MDN Reference
Parameters
- text: string
Returns TextMetrics
Inherited from CanvasText.measureText
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5451

moveTo

moveTo(x, y): void
MDN Reference
Parameters
- x: number
- y: number
Returns void
Inherited from CanvasPath.moveTo
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5358

putImageData

putImageData(imagedata, dx, dy): void
MDN Reference
Parameters
- imagedata: ImageData
- dx: number
- dy: number
Returns void
Inherited from CanvasImageData.putImageData
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5333
putImageData(imagedata, dx, dy, dirtyX, dirtyY, dirtyWidth, dirtyHeight): void
Parameters
- imagedata: ImageData
- dx: number
- dy: number
- dirtyX: number
- dirtyY: number
- dirtyWidth: number
- dirtyHeight: number
Returns void
Inherited from CanvasImageData.putImageData
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5334

quadraticCurveTo

quadraticCurveTo(cpx, cpy, x, y): void
MDN Reference
Parameters
- cpx: number
- cpy: number
- x: number
- y: number
Returns void
Inherited from CanvasPath.quadraticCurveTo
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5360

rect

rect(x, y, w, h): void
MDN Reference
Parameters
- x: number
- y: number
- w: number
- h: number
Returns void
Inherited from CanvasPath.rect
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5362

resetTransform

resetTransform(): void
MDN Reference

Returns void
Inherited from CanvasTransform.resetTransform
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5473

restore

restore(): void
MDN Reference

Returns void
Inherited from CanvasState.restore
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5442

rotate

rotate(angle): void
MDN Reference
Parameters
- angle: number
Returns void
Inherited from CanvasTransform.rotate
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5475

roundRect

roundRect(x, y, w, h, radii?): void
MDN Reference
Parameters
- x: number
- y: number
- w: number
- h: number
- Optional radii: number | DOMPointInit | (number | DOMPointInit)[]
Returns void
Inherited from CanvasPath.roundRect
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5364

save

save(): void
MDN Reference

Returns void
Inherited from CanvasState.save
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5444

scale

scale(x, y): void
MDN Reference
Parameters
- x: number
- y: number
Returns void
Inherited from CanvasTransform.scale
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5477

setLineDash

setLineDash(segments): void
MDN Reference
Parameters
- segments: number[]
Returns void
Inherited from CanvasPathDrawingStyles.setLineDash
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5381

setTransform

setTransform(a, b, c, d, e, f): void
MDN Reference
Parameters
- a: number
- b: number
- c: number
- d: number
- e: number
- f: number
Returns void
Inherited from CanvasTransform.setTransform
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5479
setTransform(transform?): void
Parameters
- Optional transform: DOMMatrix2DInit
Returns void
Inherited from CanvasTransform.setTransform
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5480

stroke

stroke(): void
MDN Reference

Returns void
Inherited from CanvasDrawPath.stroke
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5281
stroke(path): void
Parameters
- path: Path2D
Returns void
Inherited from CanvasDrawPath.stroke
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5282

strokeRect

strokeRect(x, y, w, h): void
MDN Reference
Parameters
- x: number
- y: number
- w: number
- h: number
Returns void
Inherited from CanvasRect.strokeRect
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5409

strokeText

strokeText(text, x, y, maxWidth?): void
MDN Reference
Parameters
- text: string
- x: number
- y: number
- Optional maxWidth: number
Returns void
Inherited from CanvasText.strokeText
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5453

transform

transform(a, b, c, d, e, f): void
MDN Reference
Parameters
- a: number
- b: number
- c: number
- d: number
- e: number
- f: number
Returns void
Inherited from CanvasTransform.transform
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5482

translate

translate(x, y): void
MDN Reference
Parameters
- x: number
- y: number
Returns void
Inherited from CanvasTransform.translate
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5484

Interface CanvasRenderingContext2D

Hierarchy (view full)

Index

Properties

Methods

Properties

Readonly canvas

direction

fillStyle

filter

font

fontKerning

globalAlpha

globalCompositeOperation

imageSmoothingEnabled

imageSmoothingQuality

lineCap

lineDashOffset

lineJoin

lineWidth

miterLimit

shadowBlur

shadowColor

shadowOffsetX

shadowOffsetY

strokeStyle

textAlign

textBaseline

Methods

arc

Parameters

Returns void

arcTo

Parameters

Returns void

beginPath

Returns void

bezierCurveTo

Parameters

Returns void

clearRect

Parameters

Returns void

clip

Parameters

Returns void

Parameters

Returns void

closePath

Returns void

createConicGradient

Parameters

Returns CanvasGradient

createImageData

Parameters

Returns ImageData

Parameters

Returns ImageData

createLinearGradient

Parameters

Returns CanvasGradient

createPattern

Parameters

Returns CanvasPattern

createRadialGradient

Parameters

Returns CanvasGradient

drawFocusIfNeeded

Parameters

Returns void

Parameters

Returns void

drawImage

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

ellipse

`Readonly` canvas