Class: Document
Constructors
constructor
• new Document(canvg, «destructured»?)
Parameters
| Name | Type |
|---|---|
canvg | Canvg |
«destructured» | IDocumentOptions |
Defined in
Properties
createCanvas
▪ Static Readonly createCanvas: (width: number, height: number) => HTMLCanvasElement = createCanvas
Type declaration
▸ (width, height): HTMLCanvasElement
Parameters
| Name | Type |
|---|---|
width | number |
height | number |
Returns
HTMLCanvasElement
Defined in
createImage
▪ Static Readonly createImage: (src: string, anonymousCrossOrigin: boolean) => Promise<HTMLImageElement> = createImage
Type declaration
▸ (src, anonymousCrossOrigin?): Promise<HTMLImageElement>
Parameters
| Name | Type | Default value |
|---|---|---|
src | string | undefined |
anonymousCrossOrigin | boolean | false |
Returns
Promise<HTMLImageElement>
Defined in
elementTypes
▪ Static Readonly elementTypes: Record<string, AnyElement> = elementTypes
Defined in
rootEmSize
• rootEmSize: number
Defined in
documentElement
• Optional documentElement: SVGElement
Defined in
screen
• Readonly screen: Screen
Defined in
createCanvas
• Readonly createCanvas: CreateCanvas
Defined in
createImage
• Readonly createImage: CreateImage
Defined in
definitions
• Readonly definitions: Record<string, Element> = {}
Defined in
styles
• Readonly styles: Record<string, Record<string, Property<unknown>>> = {}
Defined in
stylesSpecificity
• Readonly stylesSpecificity: Record<string, string> = {}
Defined in
images
• Readonly images: ImageElement[] = []
Defined in
fonts
• Readonly fonts: SVGFontLoader[] = []
Defined in
emSizeStack
• Private Readonly emSizeStack: number[] = []
Defined in
uniqueId
• Private uniqueId: number = 0
Defined in
canvg
• Readonly canvg: Canvg
Defined in
Accessors
window
• get window(): Window
Returns
Window
Defined in
fetch
• get fetch(): (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>
Returns
fn
▸ (input, init?): Promise<Response>
Parameters
| Name | Type |
|---|---|
input | RequestInfo | URL |
init? | RequestInit |
Returns
Promise<Response>
Defined in
ctx
• get ctx(): RenderingContext2D
Returns
Defined in
emSize
• get emSize(): number
Returns
number
Defined in
• set emSize(value): void
Parameters
| Name | Type |
|---|---|
value | number |
Returns
void
Defined in
Methods
bindCreateImage
▸ Private bindCreateImage(createImage, anonymousCrossOrigin?): CreateImage
Parameters
| Name | Type |
|---|---|
createImage | CreateImage |
anonymousCrossOrigin? | boolean |
Returns
Defined in
popEmSize
▸ popEmSize(): void
Returns
void
Defined in
getUniqueId
▸ getUniqueId(): string
Returns
string
Defined in
isImagesLoaded
▸ isImagesLoaded(): boolean
Returns
boolean
Defined in
isFontsLoaded
▸ isFontsLoaded(): boolean
Returns
boolean
Defined in
createDocumentElement
▸ createDocumentElement(document): SVGElement
Parameters
| Name | Type |
|---|---|
document | Document |
Returns
Defined in
createElement
▸ createElement<T>(node): T
Type parameters
| Name | Type |
|---|---|
T | extends Element<T> |
Parameters
| Name | Type |
|---|---|
node | HTMLElement |
Returns
T
Defined in
createTextNode
▸ createTextNode(node): TextNode
Parameters
| Name | Type |
|---|---|
node | HTMLElement |
Returns
TextNode
Defined in
setViewBox
▸ setViewBox(config): void
Parameters
| Name | Type |
|---|---|
config | IViewBoxConfig |
Returns
void