Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

SVG renderer on canvas.

Hierarchy

  • default

Index

Constructors

constructor

Properties

Readonly document

document: default

Canvg Document.

Private Readonly documentElement

documentElement: default

Private Readonly options

options: IOptions

Readonly parser

parser: default

XML/HTML parser instance.

Readonly screen

screen: default

Screen instance.

Methods

fork

  • Create new Canvg instance with inherited options.

    Parameters

    Returns Promise<default>

    Canvg instance.

forkString

isReady

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

    Returns boolean

    Is ready or not.

ready

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

    Returns Promise<void>

    Ready promise.

render

resize

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

    Parameters

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

    Returns void

start

stop

  • stop(): void

Static from

  • Create Canvg instance from SVG source string or URL.

    Parameters

    Returns Promise<default>

    Canvg instance.

Static fromString

Generated using TypeDoc