Class CanvasBuilder

Fluent canvas builder — wraps a 2D context with chainable drawing methods.

Index

Constructors

constructor

Methods

fill rect outline text textTruncated image gradient circle line save restore raw toBuffer toAttachment

Constructors

constructor

new CanvasBuilder(_canvas: any, _ctx: any): CanvasBuilder
Parameters
- _canvas: any
- _ctx: any
Returns CanvasBuilder
- Defined in plugins/canvas.ts:41

Methods

fill

fill(color: string): CanvasBuilder
Parameters
- color: string
Returns CanvasBuilder
- Defined in plugins/canvas.ts:43

rect

rect(
    x: number,
    y: number,
    w: number,
    h: number,
    color: string,
    radius?: number,
): CanvasBuilder
Parameters
- x: number
- y: number
- w: number
- h: number
- color: string
- radius: number = 0
Returns CanvasBuilder
- Defined in plugins/canvas.ts:49

outline

outline(
    x: number,
    y: number,
    w: number,
    h: number,
    color: string,
    lineWidth?: number,
    radius?: number,
): CanvasBuilder
Parameters
- x: number
- y: number
- w: number
- h: number
- color: string
- lineWidth: number = 2
- radius: number = 0
Returns CanvasBuilder
- Defined in plugins/canvas.ts:61

text

text(
    str: string,
    x: number,
    y: number,
    opts?: {
        color?: string;
        font?: string;
        size?: number;
        weight?: string;
        align?: CanvasTextAlign;
        baseline?: CanvasTextBaseline;
        maxWidth?: number;
        shadow?: {
            color: string;
            blur: number;
            offsetX?: number;
            offsetY?: number;
        };
    },
): CanvasBuilder
Parameters
- str: string
- x: number
- y: number
- opts: {
      color?: string;
      font?: string;
      size?: number;
      weight?: string;
      align?: CanvasTextAlign;
      baseline?: CanvasTextBaseline;
      maxWidth?: number;
      shadow?: {
          color: string;
          blur: number;
          offsetX?: number;
          offsetY?: number;
      };
  } = {}
Returns CanvasBuilder
- Defined in plugins/canvas.ts:74

textTruncated

textTruncated(
    str: string,
    x: number,
    y: number,
    maxWidth: number,
    opts?:
        | {
            color?: string;
            font?: string;
            size?: number;
            weight?: string;
            align?: CanvasTextAlign;
            baseline?: CanvasTextBaseline;
            maxWidth?: number;
            shadow?: {
                color: string;
                blur: number;
                offsetX?: number;
                offsetY?: number;
            };
        }
        | undefined,
): this
Draws a string truncated with "…" to fit within maxWidth. Returns the string actually drawn.
Parameters
- str: string
- x: number
- y: number
- maxWidth: number
- opts:
      | {
          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 this
- Defined in plugins/canvas.ts:105

image

image(
    src: string | Buffer<ArrayBufferLike>,
    x: number,
    y: number,
    w: number,
    h: number,
    opts?: { radius?: number; opacity?: number; filter?: string },
): Promise<CanvasBuilder>
Parameters
- src: string | Buffer<ArrayBufferLike>
- x: number
- y: number
- w: number
- h: number
- opts: { radius?: number; opacity?: number; filter?: string } = {}
Returns Promise<CanvasBuilder>
- Defined in plugins/canvas.ts:115

gradient

gradient(
    x: number,
    y: number,
    w: number,
    h: number,
    stops: { offset: number; color: string }[],
    direction?: "v" | "h",
): CanvasBuilder
Parameters
- x: number
- y: number
- w: number
- h: number
- stops: { offset: number; color: string }[]
- direction: "v" | "h" = "h"
Returns CanvasBuilder
- Defined in plugins/canvas.ts:135

circle

circle(cx: number, cy: number, r: number, color: string): CanvasBuilder
Parameters
- cx: number
- cy: number
- r: number
- color: string
Returns CanvasBuilder
- Defined in plugins/canvas.ts:145

line

line(
    x1: number,
    y1: number,
    x2: number,
    y2: number,
    color: string,
    lineWidth?: number,
): CanvasBuilder
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
- color: string
- lineWidth: number = 2
Returns CanvasBuilder
- Defined in plugins/canvas.ts:153

save

save(): CanvasBuilder
Returns CanvasBuilder
- Defined in plugins/canvas.ts:163

restore

restore(): CanvasBuilder
Returns CanvasBuilder
- Defined in plugins/canvas.ts:164

raw

raw(): any
Returns the raw CanvasRenderingContext2D for custom operations.

Returns any
- Defined in plugins/canvas.ts:167

toBuffer

toBuffer(): Promise<Buffer<ArrayBufferLike>>
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in plugins/canvas.ts:169

toAttachment

toAttachment(name?: string): Promise<AttachmentBuilder>
Parameters
- name: string = "image.png"
Returns Promise<AttachmentBuilder>
- Defined in plugins/canvas.ts:173

Class CanvasBuilder

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CanvasBuilder

Methods

fill

Parameters

Returns CanvasBuilder

rect

Parameters

Returns CanvasBuilder

outline

Parameters

Returns CanvasBuilder

text

Parameters

Returns CanvasBuilder

textTruncated

Parameters

Returns this

image

Parameters

Returns Promise<CanvasBuilder>

gradient

Parameters

Returns CanvasBuilder

circle

Parameters

Returns CanvasBuilder

line

Parameters

Returns CanvasBuilder

save

Returns CanvasBuilder

restore

Returns CanvasBuilder

raw

Returns any

toBuffer

Returns Promise<Buffer<ArrayBufferLike>>

toAttachment

Parameters

Returns Promise<AttachmentBuilder>

Settings

On This Page