Class Canvas

constructor

• new Canvas(options?): Canvas

• The Canvas constructor

  Parameters

  • Optional options: Partial<CanvasData>

    The canvas data

  Returns Canvas

  Example

  const { Canvas } = require("kiutils")
  const canvas = new Canvas({
      width: 500,
      height: 500,
      background: {
          image: "color",
          color: "#23272A"
      },   
      fontColor: "#ffffff"
  })
  
  canvas.render()
  Copy

data

print

• print(options?): void

• Prints the canvas data

  Parameters

  • Optional options: Partial<CanvasData>

    The canvas data

  Returns void

render

• render(): Promise<Buffer>

• Renders the canvas

  Returns Promise<Buffer>

  The rendered canvas as buffer

renderWithText

• renderWithText(text, options?): Promise<Buffer>

• Renders the canvas with text

  Parameters

  • text: string

    The text to render

  • options: {
        align?: CanvasTextAlign;
        font?: string;
        x?: number;
        y?: number;
    } = {}

    Text options

    • Optional align?: CanvasTextAlign

      Text alignment

    • Optional font?: string

      Font settings (e.g., "20px Arial")

    • Optional x?: number

      X position

    • Optional y?: number

      Y position

  Returns Promise<Buffer>

  The rendered canvas as buffer

update

• update(options): Canvas

• Updates the canvas data

  Parameters

  • options: Partial<CanvasData>

    The canvas data to update

  Returns Canvas

  The canvas instance for chaining