ps3
    Preparing search index...

    Interface Canvas

    interface Canvas {
        height: number;
        stride: number;
        type: "image" | "svg" | "pdf";
        width: number;
        createJPEGStream(config?: JpegConfig): JPEGStream;
        createPDFStream(config?: PdfConfig): PDFStream;
        createPNGStream(config?: PngConfig): PNGStream;
        getContext(
            contextId: "2d",
            contextAttributes?: NodeCanvasRenderingContext2DSettings,
        ): CanvasRenderingContext2D;
        toBuffer(cb: (err: Error | null, result: Buffer) => void): void;
        toBuffer(
            cb: (err: Error | null, result: Buffer) => void,
            mimeType: "image/png",
            config?: PngConfig,
        ): void;
        toBuffer(
            cb: (err: Error | null, result: Buffer) => void,
            mimeType: "image/jpeg",
            config?: JpegConfig,
        ): void;
        toBuffer(): Buffer;
        toBuffer(mimeType: "image/png", config?: PngConfig): Buffer;
        toBuffer(mimeType: "image/jpeg", config?: JpegConfig): Buffer;
        toBuffer(mimeType: "application/pdf", config?: PdfConfig): Buffer;
        toBuffer(mimeType: "raw"): Buffer;
        toDataURL(): string;
        toDataURL(mimeType: "image/png"): string;
        toDataURL(mimeType: "image/jpeg", quality?: number): string;
        toDataURL(cb: (err: Error | null, result: string) => void): void;
        toDataURL(
            mimeType: "image/png",
            cb: (err: Error | null, result: string) => void,
        ): void;
        toDataURL(
            mimeType: "image/jpeg",
            cb: (err: Error | null, result: string) => void,
        ): void;
        toDataURL(
            mimeType: "image/jpeg",
            config: JpegConfig,
            cb: (err: Error | null, result: string) => void,
        ): void;
        toDataURL(
            mimeType: "image/jpeg",
            quality: number,
            cb: (err: Error | null, result: string) => void,
        ): void;
    }
    Index

    Properties

    height stride type width

    Methods

    createJPEGStream createPDFStream createPNGStream getContext toBuffer toDataURL

    Properties

    height: number
    stride: number

    Non standard. Getter. The stride used by the canvas.

    type: "image" | "svg" | "pdf"

    Non standard. The type of the canvas.

    width: number

    Methods

    • Parameters

      • Optionalconfig: JpegConfig

      Returns JPEGStream

    • Parameters

      • Optionalconfig: PdfConfig

      Returns PDFStream

    • Parameters

      • Optionalconfig: PngConfig

      Returns PNGStream

    • Parameters

      • contextId: "2d"
      • OptionalcontextAttributes: NodeCanvasRenderingContext2DSettings

      Returns CanvasRenderingContext2D

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • Defaults to PNG image.

      Returns string

    • Defaults to PNG image.

      Parameters

      • mimeType: "image/png"

      Returns string

    • Defaults to PNG image.

      Parameters

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

      Returns string

    • Non-standard. Defaults to PNG image.

      Parameters

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

      Returns void

    • Non-standard.

      Parameters

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

      Returns void

    • Non-standard.

      Parameters

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

      Returns void

    • Non-standard.

      Parameters

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

      Returns void

    • Non-standard.

      Parameters

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

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods