Class Canvas

constructor

• new Canvas(
      width: number,
      height: number,
      type?: "pdf" | "svg" | "image",
  ): Canvas

  Parameters

  • width: number
  • height: number
  • Optionaltype: "pdf" | "svg" | "image"

  Returns Canvas

height

Readonlystride

Readonlytype

width

Static ReadonlyPNG_ALL_FILTERS

Static ReadonlyPNG_FILTER_AVG

Static ReadonlyPNG_FILTER_NONE

Static ReadonlyPNG_FILTER_PAETH

Static ReadonlyPNG_FILTER_SUB

Static ReadonlyPNG_FILTER_UP

Static ReadonlyPNG_NO_FILTERS

createJPEGStream

• createJPEGStream(config?: JpegConfig): JPEGStream

  Parameters

  • Optionalconfig: JpegConfig

  Returns JPEGStream

createPDFStream

• createPDFStream(config?: PdfConfig): PDFStream

  Parameters

  • Optionalconfig: PdfConfig

  Returns PDFStream

createPNGStream

• createPNGStream(config?: PngConfig): PNGStream

  Parameters

  • Optionalconfig: PngConfig

  Returns PNGStream

getContext

• getContext(
      contextId: "2d",
      contextAttributes?: NodeCanvasRenderingContext2DSettings,
  ): CanvasRenderingContext2D

  Parameters

  • contextId: "2d"
  • OptionalcontextAttributes: NodeCanvasRenderingContext2DSettings

  Returns CanvasRenderingContext2D

toBuffer

• toBuffer(cb: (err: Error | null, result: Buffer) => void): void

  For image canvases, encodes the canvas as a PNG. For PDF canvases, encodes the canvas as a PDF. For SVG canvases, encodes the canvas as an SVG.

  Parameters

  • cb: (err: Error | null, result: Buffer) => void

  Returns void

• toBuffer(
      cb: (err: Error | null, result: Buffer) => void,
      mimeType: "image/png",
      config?: PngConfig,
  ): void

  For image canvases, encodes the canvas as a PNG. For PDF canvases, encodes the canvas as a PDF. For SVG canvases, encodes the canvas as an SVG.

  Parameters

  • cb: (err: Error | null, result: Buffer) => void
  • mimeType: "image/png"
  • Optionalconfig: PngConfig

  Returns void

• toBuffer(
      cb: (err: Error | null, result: Buffer) => void,
      mimeType: "image/jpeg",
      config?: JpegConfig,
  ): void

  For image canvases, encodes the canvas as a PNG. For PDF canvases, encodes the canvas as a PDF. For SVG canvases, encodes the canvas as an SVG.

  Parameters

  • cb: (err: Error | null, result: Buffer) => void
  • mimeType: "image/jpeg"
  • Optionalconfig: JpegConfig

  Returns void

• toBuffer(): Buffer

  For image canvases, encodes the canvas as a PNG. For PDF canvases, encodes the canvas as a PDF. For SVG canvases, encodes the canvas as an SVG.

  Returns Buffer

• toBuffer(mimeType: "image/png", config?: PngConfig): Buffer

  For image canvases, encodes the canvas as a PNG. For PDF canvases, encodes the canvas as a PDF. For SVG canvases, encodes the canvas as an SVG.

  Parameters

  • mimeType: "image/png"
  • Optionalconfig: PngConfig

  Returns Buffer

• toBuffer(mimeType: "image/jpeg", config?: JpegConfig): Buffer

  For image canvases, encodes the canvas as a PNG. For PDF canvases, encodes the canvas as a PDF. For SVG canvases, encodes the canvas as an SVG.

  Parameters

  • mimeType: "image/jpeg"
  • Optionalconfig: JpegConfig

  Returns Buffer

• toBuffer(mimeType: "application/pdf", config?: PdfConfig): Buffer

  For image canvases, encodes the canvas as a PNG. For PDF canvases, encodes the canvas as a PDF. For SVG canvases, encodes the canvas as an SVG.

  Parameters

  • mimeType: "application/pdf"
  • Optionalconfig: PdfConfig

  Returns Buffer

• toBuffer(mimeType: "raw"): Buffer

  Returns the unencoded pixel data, top-to-bottom. On little-endian (most) systems, the array will be ordered BGRA; on big-endian systems, it will be ARGB.

  Parameters

  • mimeType: "raw"

  Returns Buffer

toDataURL

• toDataURL(): string

  Defaults to PNG image.

  Returns string

• toDataURL(mimeType: "image/png"): string

  Defaults to PNG image.

  Parameters

  • mimeType: "image/png"

  Returns string

• toDataURL(mimeType: "image/jpeg", quality?: number): string

  Defaults to PNG image.

  Parameters

  • mimeType: "image/jpeg"
  • Optionalquality: number

  Returns string

• toDataURL(cb: (err: Error | null, result: string) => void): void

  Non-standard. Defaults to PNG image.

  Parameters

  • cb: (err: Error | null, result: string) => void

  Returns void

• toDataURL(
      mimeType: "image/png",
      cb: (err: Error | null, result: string) => void,
  ): void

  Non-standard.

  Parameters

  • mimeType: "image/png"
  • cb: (err: Error | null, result: string) => void

  Returns void

• toDataURL(
      mimeType: "image/jpeg",
      cb: (err: Error | null, result: string) => void,
  ): void

  Non-standard.

  Parameters

  • mimeType: "image/jpeg"
  • cb: (err: Error | null, result: string) => void

  Returns void

• toDataURL(
      mimeType: "image/jpeg",
      config: JpegConfig,
      cb: (err: Error | null, result: string) => void,
  ): void

  Non-standard.

  Parameters

  • mimeType: "image/jpeg"
  • config: JpegConfig
  • cb: (err: Error | null, result: string) => void

  Returns void

• toDataURL(
      mimeType: "image/jpeg",
      quality: number,
      cb: (err: Error | null, result: string) => void,
  ): void

  Non-standard.

  Parameters

  • mimeType: "image/jpeg"
  • quality: number
  • cb: (err: Error | null, result: string) => void

  Returns void