Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Canvg

SVG renderer on canvas.

Hierarchy

  • Canvg

Index

Constructors

Properties

document: Document

Canvg Document.

documentElement: SVGElement
options: IOptions
parser: Parser

XML/HTML parser instance.

screen: Screen

Screen instance.

Methods

  • Create new Canvg instance with inherited options.

    Parameters

    Returns Promise<Canvg>

    Canvg instance.

  • isReady(): boolean
  • Document is ready value.

    Returns boolean

    Is ready or not.

  • ready(): Promise<void>
  • Document is ready promise.

    Returns Promise<void>

    Ready promise.

  • resize(width: number, height?: number, preserveAspectRatio?: string | boolean): void
  • Resize SVG to fit in given size.

    Parameters

    • width: number
    • height: number = width
    • preserveAspectRatio: string | boolean = false

    Returns void

  • stop(): void
  • Create Canvg instance from SVG source string or URL.

    Parameters

    Returns Promise<Canvg>

    Canvg instance.

Generated using TypeDoc