Documentation / @finchart/core / index / Canvas2DContext
Interface: Canvas2DContext
Defined in: packages/core/src/render/types.ts:97
The 2D context CanvasRenderer actually uses. A real CanvasRenderingContext2D is assignable to it as-is (a type test guarantees this), and a test can pass a fake that only satisfies this shape. Why the shape is spelled out directly instead of referencing the global DOM type: this contract has to hold even for a headless consumer (server, worker) whose tsconfig lib has no DOM.
Properties
fillStyle
fillStyle:
string|CanvasGradientLike|CanvasPatternLike
Defined in: packages/core/src/render/types.ts:132
font
font:
string
Defined in: packages/core/src/render/types.ts:138
lineWidth
lineWidth:
number
Defined in: packages/core/src/render/types.ts:130
strokeStyle
strokeStyle:
string|CanvasGradientLike|CanvasPatternLike
Defined in: packages/core/src/render/types.ts:131
textAlign
textAlign:
"start"|"end"|"left"|"center"|"right"
Defined in: packages/core/src/render/types.ts:139
textBaseline
textBaseline:
"top"|"middle"|"bottom"|"alphabetic"|"hanging"|"ideographic"
Defined in: packages/core/src/render/types.ts:140
Methods
arc()
arc(
x,y,radius,startAngle,endAngle,counterclockwise?):void
Defined in: packages/core/src/render/types.ts:103
Parameters
x
number
y
number
radius
number
startAngle
number
endAngle
number
counterclockwise?
boolean
Returns
void
beginPath()
beginPath():
void
Defined in: packages/core/src/render/types.ts:99
Returns
void
clearRect()
clearRect(
x,y,w,h):void
Defined in: packages/core/src/render/types.ts:98
Parameters
x
number
y
number
w
number
h
number
Returns
void
clip()
clip():
void
Defined in: packages/core/src/render/types.ts:153
Returns
void
closePath()
closePath():
void
Defined in: packages/core/src/render/types.ts:100
Returns
void
createLinearGradient()
createLinearGradient(
x0,y0,x1,y1):CanvasGradientLike
Defined in: packages/core/src/render/types.ts:115
A real context's return type (CanvasGradient) satisfies this shape.
Parameters
x0
number
y0
number
x1
number
y1
number
Returns
fill()
fill():
void
Defined in: packages/core/src/render/types.ts:112
Returns
void
fillRect()
fillRect(
x,y,w,h):void
Defined in: packages/core/src/render/types.ts:113
Parameters
x
number
y
number
w
number
h
number
Returns
void
fillText()
fillText(
text,x,y,maxWidth?):void
Defined in: packages/core/src/render/types.ts:136
Parameters
text
string
x
number
y
number
maxWidth?
number
Returns
void
lineTo()
lineTo(
x,y):void
Defined in: packages/core/src/render/types.ts:102
Parameters
x
number
y
number
Returns
void
measureText()
measureText(
text):TextMetricsLike
Defined in: packages/core/src/render/types.ts:137
Parameters
text
string
Returns
moveTo()
moveTo(
x,y):void
Defined in: packages/core/src/render/types.ts:101
Parameters
x
number
y
number
Returns
void
rect()
rect(
x,y,w,h):void
Defined in: packages/core/src/render/types.ts:152
Parameters
x
number
y
number
w
number
h
number
Returns
void
restore()
restore():
void
Defined in: packages/core/src/render/types.ts:151
Returns
void
save()
save():
void
Defined in: packages/core/src/render/types.ts:150
Returns
void
setLineDash()
setLineDash(
segments):void
Defined in: packages/core/src/render/types.ts:121
Parameters
segments
number[]
Returns
void
setTransform()
setTransform(
a,b,c,d,e,f):void
Defined in: packages/core/src/render/types.ts:122
Parameters
a
number
b
number
c
number
d
number
e
number
f
number
Returns
void
stroke()
stroke():
void
Defined in: packages/core/src/render/types.ts:111
Returns
void