Namespace SVG

The SVG module provides utility functions for generating the necessary HTML for various SVG elements based on certain configurations and styles.

Index

Functions

Functions

Const calculateTextSize

calculateTextSize(str: string, fontSize: number, fontStyle?: string, padding?: number[]): number[]

- Defined in src/display/SVG.ts:74
Parameters
- str: string
- fontSize: number
- Optional fontStyle: string
- Optional padding: number[]
Returns number[]

Const circle

circle(container: Size, opts?: SVGCircleOptions): string

- Defined in src/display/SVG.ts:182
Returns the SVG circle string for the specified style options.

memberof

SVG

Parameters
- container: Size
- Optional opts: SVGCircleOptions
Returns string

Const draw

draw(width: number, height: number, opts: any): string

- Defined in src/display/SVG.ts:283
Returns the SVG HTML string using the specified size and options.

memberof

SVG

Parameters
- width: number
- height: number
- opts: any
Returns string

Const image

image(url: string, container: Size, opts?: SVGImageOptions): string

- Defined in src/display/SVG.ts:244
Parameters
- url: string
- container: Size
- Optional opts: SVGImageOptions
Returns string

Const path

path(value: string, opts?: SVGPathOptions): string

- Defined in src/display/SVG.ts:116
Returns the SVG path string using the specified path value string and style options.

memberof

SVG

Parameters
- value: string
- Optional opts: SVGPathOptions
Returns string

Const rect

rect(width: number, height: number, opts?: SVGRectOptions): string

- Defined in src/display/SVG.ts:141
Returns the SVG rectangle string for the specified width, height and style options.

memberof

SVG

Parameters
- width: number
- height: number
- Optional opts: SVGRectOptions
Returns string

Const svg

svg(width: number, height: number, elements: string[], viewBox?: string): string

- Defined in src/display/SVG.ts:268
Returns the SVG HTML string for the specified options and array of drawable elements.

memberof

SVG

Parameters
- width: number
- height: number
- elements: string[]
- Default value viewBox: string = null
Returns string

Const text

text(value: string | number, container: Size, opts?: SVGTextOptions): string

- Defined in src/display/SVG.ts:214
Returns the SVG text string for the specified value and style options.

memberof

SVG

Parameters
- value: string | number
- container: Size
- Optional opts: SVGTextOptions
Returns string

Generated using TypeDoc