Class SvgDocument

Represents an SVG document.

Hierarchy (View Summary)

ObjectBase
- SvgDocument

Accessors

cursiveFont

get cursiveFont(): Font | null
Gets or sets the font belonging to the Cursive font family.

Returns Font | null
set cursiveFont(font: Font | null): void
Gets or sets the font belonging to the Cursive font family.
Parameters
- font: Font | null
Returns void

description

get description(): string
Gets the description of the SVG document.

Returns string

fantasyFont

get fantasyFont(): Font | null
Gets or sets the font belonging to the Fantasy font family.

Returns Font | null
set fantasyFont(font: Font | null): void
Gets or sets the font belonging to the Fantasy font family.
Parameters
- font: Font | null
Returns void

fontCollection

get fontCollection(): FontCollection | null
Gets or sets the custom FontCollection used for searching fonts and font fallbacks.

Returns FontCollection | null
set fontCollection(coll: FontCollection | null): void
Gets or sets the custom FontCollection used for searching fonts and font fallbacks.
Parameters
- coll: FontCollection | null
Returns void

fontFallbackScope

get fontFallbackScope(): FontFallbackScope
Gets or sets a value specifying the scope for searching fallback fonts for the glyphs missing in the mentioned type faces.

Returns FontFallbackScope
set fontFallbackScope(fallbackScope: FontFallbackScope): void
Gets or sets a value specifying the scope for searching fallback fonts for the glyphs missing in the mentioned type faces.
Parameters
- fallbackScope: FontFallbackScope
Returns void

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from ObjectBase.id

monospaceFont

get monospaceFont(): Font | null
Gets or sets the font belonging to the Monospace font family.

Returns Font | null
set monospaceFont(font: Font | null): void
Gets or sets the font belonging to the Monospace font family.
Parameters
- font: Font | null
Returns void

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from ObjectBase.om

restrictedFontLookup

get restrictedFontLookup(): boolean
Gets or sets a value indicating whether the fonts should be searched in the custom collection only, if any specified. The default is false.

Returns boolean
set restrictedFontLookup(value: boolean): void
Gets or sets a value indicating whether the fonts should be searched in the custom collection only, if any specified. The default is false.
Parameters
- value: boolean
Returns void

sansSerifFont

get sansSerifFont(): Font | null
Gets or sets the font belonging to the SansSerif font family.

Returns Font | null
set sansSerifFont(font: Font | null): void
Gets or sets the font belonging to the SansSerif font family.
Parameters
- font: Font | null
Returns void

serifFont

get serifFont(): Font | null
Gets or sets the font belonging to the Serif font family.

Returns Font | null
set serifFont(font: Font | null): void
Gets or sets the font belonging to the Serif font family.
Parameters
- font: Font | null
Returns void

title

get title(): string
Gets the title of the SVG document.

Returns string

Methods

`Static`load

load(svgBytes: Uint8Array): SvgDocument
Loads a SvgDocument from a byte array.
Parameters
- svgBytes: Uint8Array
  The binary data of the SVG document.
Returns SvgDocument
A new instance of the SVG document.
load(om: ObjectManager, svgBytes: Uint8Array): SvgDocument
Loads a SvgDocument from a byte array.
Parameters
- om: ObjectManager
  An object manager that controls the lifetime of the SvgDocument object.
- svgBytes: Uint8Array
  The binary data of the SVG document.
Returns SvgDocument
A new instance of the SVG document.

`Static`loadGz

loadGz(gzSvgBytes: Uint8Array): SvgDocument
Loads a SvgDocument from a byte array with gzipped SVG data.
Parameters
- gzSvgBytes: Uint8Array
  The binary data of the gzipped SVG document.
Returns SvgDocument
A new instance of the SVG document.
loadGz(om: ObjectManager, gzSvgBytes: Uint8Array): SvgDocument
Loads a SvgDocument from a byte array with gzipped SVG data.
Parameters
- om: ObjectManager
  An object manager that controls the lifetime of the SvgDocument object.
- gzSvgBytes: Uint8Array
  The binary data of the gzipped SVG document.
Returns SvgDocument
A new instance of the SVG document.

free

free(): void
Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns void
Inherited from ObjectBase.free

getIntrinsicSize

getIntrinsicSize(): Size | null
Gets the intrinsic size of SVG viewport.

Returns Size | null
The intrinsic size of SVG viewport, or null if the size is undefined.

measure

measure(x: number, y: number): Rect
Calculates the content bounds of an SVG document when its viewport is drawn at a specified point.
Parameters
- x: number
  The X coordinate of SVG viewport.
- y: number
  The Y coordinate of SVG viewport.
Returns Rect
The content rectangle of the resulting image.

measureToRect

measureToRect(x: number, y: number, width: number, height: number): Rect
Calculates the content bounds of an SVG document, resizing the SVG viewport to fit into a specified rectangle.
Parameters
- x: number
  The X coordinate of the target rectangle for SVG viewport.
- y: number
  The Y coordinate of the target rectangle for SVG viewport.
- width: number
  The width of the target rectangle for SVG viewport.
- height: number
  The height of the target rectangle for SVG viewport.
Returns Rect
The content rectangle of the resulting image.
measureToRect(bounds: Bounds): Rect
Calculates the content bounds of an SVG document, resizing the SVG viewport to fit into a specified rectangle.
Parameters
- bounds: Bounds
  The target rectangle for SVG viewport.
Returns Rect
The content rectangle of the resulting image.

rebind

rebind(omTo: ObjectManager): void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
- omTo: ObjectManager
  The new ObjectManager for the object.
Returns void
Inherited from ObjectBase.rebind

save

save(options?: SaveSvgOptions): Uint8Array
Saves the current SvgDocument to a byte array.
Parameters
- Optionaloptions: SaveSvgOptions
  The settings for saving the document.
Returns Uint8Array
A byte array with UTF8-encoded SVG data.

saveGz

saveGz(): Uint8Array
Saves the current SvgDocument to a byte array in SVG.GZ format.

Returns Uint8Array

setCurrentColor

setCurrentColor(color: Color | null): void
Sets the 'currentColor' value used by the SVG renderer.
Parameters
- color: Color | null
Returns void

setLanguageTags

setLanguageTags(langTags: string[] | null): void
Sets the list of cultures to match values of the 'systemLanguage' attribute of SVG elements.
Parameters
- langTags: string[] | null
Returns void

Class SvgDocument

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

cursiveFont

Returns Font | null

Parameters

Returns void

description

Returns string

fantasyFont

Returns Font | null

Parameters

Returns void

fontCollection

Returns FontCollection | null

Parameters

Returns void

fontFallbackScope

Returns FontFallbackScope

Parameters

Returns void

id

Returns number

monospaceFont

Returns Font | null

Parameters

Returns void

om

Returns ObjectManager

restrictedFontLookup

Returns boolean

Parameters

Returns void

sansSerifFont

Returns Font | null

Parameters

Returns void

serifFont

Returns Font | null

Parameters

Returns void

title

Returns string

Methods

Staticload

Parameters

Returns SvgDocument

Parameters

Returns SvgDocument

StaticloadGz

Parameters

Returns SvgDocument

Parameters

Returns SvgDocument

free

Returns void

getIntrinsicSize

Returns Size | null

measure

Parameters

Returns Rect

measureToRect

Parameters

Returns Rect

Parameters

Returns Rect

rebind

Parameters

Returns void

save

Parameters

Returns Uint8Array

saveGz

Returns Uint8Array

setCurrentColor

Parameters

Returns void

`Static`load

`Static`loadGz