CanvasBuilder
Popii / CanvasBuilder
Class: CanvasBuilder
Section titled “Class: CanvasBuilder”Defined in: plugins/canvas.ts:81
Fluent canvas builder — wraps a 2D context with chainable drawing methods.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CanvasBuilder(
_canvas,_ctx):CanvasBuilder
Defined in: plugins/canvas.ts:82
Parameters
Section titled “Parameters”_canvas
Section titled “_canvas”any
any
Returns
Section titled “Returns”CanvasBuilder
Methods
Section titled “Methods”fill()
Section titled “fill()”fill(
color):CanvasBuilder
Defined in: plugins/canvas.ts:84
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”CanvasBuilder
rect()
Section titled “rect()”rect(
x,y,w,h,color,radius?):CanvasBuilder
Defined in: plugins/canvas.ts:90
Parameters
Section titled “Parameters”number
number
number
number
string
radius?
Section titled “radius?”number = 0
Returns
Section titled “Returns”CanvasBuilder
outline()
Section titled “outline()”outline(
x,y,w,h,color,lineWidth?,radius?):CanvasBuilder
Defined in: plugins/canvas.ts:102
Parameters
Section titled “Parameters”number
number
number
number
string
lineWidth?
Section titled “lineWidth?”number = 2
radius?
Section titled “radius?”number = 0
Returns
Section titled “Returns”CanvasBuilder
text()
Section titled “text()”text(
str,x,y,opts?):CanvasBuilder
Defined in: plugins/canvas.ts:115
Parameters
Section titled “Parameters”string
number
number
color?
Section titled “color?”string
string
number
weight?
Section titled “weight?”string
align?
Section titled “align?”CanvasTextAlign
baseline?
Section titled “baseline?”CanvasTextBaseline
maxWidth?
Section titled “maxWidth?”number
shadow?
Section titled “shadow?”{ color: string; blur: number; offsetX?: number; offsetY?: number; }
shadow.color
Section titled “shadow.color”string
shadow.blur
Section titled “shadow.blur”number
shadow.offsetX?
Section titled “shadow.offsetX?”number
shadow.offsetY?
Section titled “shadow.offsetY?”number
Returns
Section titled “Returns”CanvasBuilder
textTruncated()
Section titled “textTruncated()”textTruncated(
str,x,y,maxWidth,opts?):this
Defined in: plugins/canvas.ts:146
Draws a string truncated with ”…” to fit within maxWidth. Returns the string actually drawn.
Parameters
Section titled “Parameters”string
number
number
maxWidth
Section titled “maxWidth”number
{ color?: string; font?: string; size?: number; weight?: string; align?: CanvasTextAlign; baseline?: CanvasTextBaseline; maxWidth?: number; shadow?: { color: string; blur: number; offsetX?: number; offsetY?: number; }; } | undefined
Returns
Section titled “Returns”this
image()
Section titled “image()”image(
src,x,y,w,h,opts?):Promise<CanvasBuilder>
Defined in: plugins/canvas.ts:156
Parameters
Section titled “Parameters”string | Buffer<ArrayBufferLike>
number
number
number
number
radius?
Section titled “radius?”number
opacity?
Section titled “opacity?”number
filter?
Section titled “filter?”string
Returns
Section titled “Returns”Promise<CanvasBuilder>
gradient()
Section titled “gradient()”gradient(
x,y,w,h,stops,direction?):CanvasBuilder
Defined in: plugins/canvas.ts:176
Parameters
Section titled “Parameters”number
number
number
number
object[]
direction?
Section titled “direction?”"h" | "v"
Returns
Section titled “Returns”CanvasBuilder
circle()
Section titled “circle()”circle(
cx,cy,r,color):CanvasBuilder
Defined in: plugins/canvas.ts:186
Parameters
Section titled “Parameters”number
number
number
string
Returns
Section titled “Returns”CanvasBuilder
line()
Section titled “line()”line(
x1,y1,x2,y2,color,lineWidth?):CanvasBuilder
Defined in: plugins/canvas.ts:194
Parameters
Section titled “Parameters”number
number
number
number
string
lineWidth?
Section titled “lineWidth?”number = 2
Returns
Section titled “Returns”CanvasBuilder
save()
Section titled “save()”save():
CanvasBuilder
Defined in: plugins/canvas.ts:204
Returns
Section titled “Returns”CanvasBuilder
restore()
Section titled “restore()”restore():
CanvasBuilder
Defined in: plugins/canvas.ts:205
Returns
Section titled “Returns”CanvasBuilder
raw():
any
Defined in: plugins/canvas.ts:208
Returns the raw CanvasRenderingContext2D for custom operations.
Returns
Section titled “Returns”any
toBuffer()
Section titled “toBuffer()”toBuffer():
Promise<Buffer<ArrayBufferLike>>
Defined in: plugins/canvas.ts:210
Returns
Section titled “Returns”Promise<Buffer<ArrayBufferLike>>
toAttachment()
Section titled “toAttachment()”toAttachment(
name?):Promise<AttachmentBuilder>
Defined in: plugins/canvas.ts:214
Parameters
Section titled “Parameters”string = "image.png"
Returns
Section titled “Returns”Promise<AttachmentBuilder>