Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Document

Index

Constructors

constructor

  • new Document(canvg: Canvg, __namedParameters?: object): Document
  • Parameters

    • canvg: Canvg
    • Default value __namedParameters: object = {}
      • createCanvas: function
          • (width: number, height: number): HTMLCanvasElement | OffscreenCanvas
          • Parameters

            • width: number
            • height: number

            Returns HTMLCanvasElement | OffscreenCanvas

      • createImage: function
          • (src: string): Promise<CanvasImageSource>
          • Parameters

            • src: string

            Returns Promise<CanvasImageSource>

      • emSize: number
      • rootEmSize: number

    Returns Document

Properties

canvg

canvg: Canvg

createCanvas

createCanvas: CreateCanvas

createImage

createImage: CreateImage

definitions

definitions: Record<string, Element>

documentElement

documentElement: SVGElement

emSize

emSize: number

fonts

fonts: SVGFontLoader[] = []

images

images: ImageElement[] = []

rootEmSize

rootEmSize: number

screen

screen: Screen

styles

styles: Record<string, Record<string, Property>>

stylesSpecificity

stylesSpecificity: Record<string, string>

Private uniqueId

uniqueId: number = 0

Static createCanvas

createCanvas: createCanvas = createCanvas

Static createImage

createImage: createImage = createImage

Static elementTypes

elementTypes: object = elementTypes

Type declaration

Accessors

ctx

  • get ctx(): CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D

fetch

  • get fetch(): any

window

  • get window(): Window

Methods

createDocumentElement

createElement

  • createElement<T>(node: HTMLElement): T

createTextNode

getUniqueId

  • getUniqueId(): string

isFontsLoaded

  • isFontsLoaded(): boolean

isImagesLoaded

  • isImagesLoaded(): boolean

setAspectRatio

  • setAspectRatio(ctx: RenderingContext2D, aspectRatio: string, width: number, desiredWidth: number, height: number, desiredHeight: number, minX?: number, minY?: number, refX?: number, refY?: number): void
  • Parameters

    • ctx: RenderingContext2D
    • aspectRatio: string
    • width: number
    • desiredWidth: number
    • height: number
    • desiredHeight: number
    • Default value minX: number = 0
    • Default value minY: number = 0
    • Optional refX: number
    • Optional refY: number

    Returns void

Generated using TypeDoc