Class SvgJsRenderer

Hierarchy

Renderer
- SvgJsRenderer

Index

Constructors

constructor

Properties

backgroundElement? container? svg

Constructors

constructor

new SvgJsRenderer(container?: string | HTMLElement): SvgJsRenderer
Parameters
- Optional container: string | HTMLElement
Returns SvgJsRenderer
Overrides Renderer.constructor
- Defined in renderer/svgjs/svg-js-renderer.ts:10

Properties

`Private` `Optional` backgroundElement

backgroundElement?: Rect

`Protected` `Optional` container

container?: string | HTMLElement

`Private` svg

svg: Container

Methods

arc

arc(x: number, y: number, width: number, height: number, direction: ArcDirection, strokeWidth: number, strokeColor: string, classes?: string | string[], fill?: string): GraphcisElement
Parameters
- x: number
- y: number
- width: number
- height: number
- direction: ArcDirection
- strokeWidth: number
- strokeColor: string
- Optional classes: string | string[]
- Optional fill: string
Returns GraphcisElement
Overrides Renderer.arc
- Defined in renderer/svgjs/svg-js-renderer.ts:243

background

background(color: string): void
Parameters
- color: string
Returns void
Overrides Renderer.background
- Defined in renderer/svgjs/svg-js-renderer.ts:68

circle

circle(x: number, y: number, diameter: number, strokeWidth: number, strokeColor: string, fill?: string, classes?: string | string[]): GraphcisElement
Parameters
- x: number
- y: number
- diameter: number
- strokeWidth: number
- strokeColor: string
- Optional fill: string
- Optional classes: string | string[]
Returns GraphcisElement
Overrides Renderer.circle
- Defined in renderer/svgjs/svg-js-renderer.ts:129

clear

clear(): void
Returns void
Overrides Renderer.clear
- Defined in renderer/svgjs/svg-js-renderer.ts:46

fontsLoading

fontsLoading(): undefined | Promise<unknown>
A promise that resolves once the fonts used by this renderer have loaded, or undefined if they already have (or can't be loaded in this environment).

Returns undefined | Promise<unknown>
Inherited from Renderer.fontsLoading
- Defined in renderer/renderer.ts:50

line

line(fromX: number, fromY: number, toX: number, toY: number, strokeWidth: number, color: string): void
Parameters
- fromX: number
- fromY: number
- toX: number
- toY: number
- strokeWidth: number
- color: string
Returns void
Overrides Renderer.line
- Defined in renderer/svgjs/svg-js-renderer.ts:30

`Private` ngon

ngon(x: number, y: number, size: number, strokeWidth: number, strokeColor: string, fill: string, edges: number, classes?: string | string[]): GraphcisElement
Parameters
- x: number
- y: number
- size: number
- strokeWidth: number
- strokeColor: string
- fill: string
- edges: number
- Optional classes: string | string[]
Returns GraphcisElement
- Defined in renderer/svgjs/svg-js-renderer.ts:210

pentagon

pentagon(x: number, y: number, size: number, strokeWidth: number, strokeColor: string, fill: string, classes?: string | string[]): GraphcisElement
Parameters
- x: number
- y: number
- size: number
- strokeWidth: number
- strokeColor: string
- fill: string
- Optional classes: string | string[]
Returns GraphcisElement
Overrides Renderer.pentagon
- Defined in renderer/svgjs/svg-js-renderer.ts:198

rect

rect(x: number, y: number, width: number, height: number, strokeWidth: number, strokeColor: string, classes?: string | string[], fill?: string, radius?: number): GraphcisElement
Parameters
- x: number
- y: number
- width: number
- height: number
- strokeWidth: number
- strokeColor: string
- Optional classes: string | string[]
- Optional fill: string
- Optional radius: number
Returns GraphcisElement
Overrides Renderer.rect
- Defined in renderer/svgjs/svg-js-renderer.ts:151

remove

remove(): void
Returns void
Overrides Renderer.remove
- Defined in renderer/svgjs/svg-js-renderer.ts:51

`Private` segmentText

segmentText(segments: TextSegment[], fontSize: number): Text
Parameters
- segments: TextSegment[]
- fontSize: number
Returns Text
- Defined in renderer/svgjs/svg-js-renderer.ts:118

size

size(width: number, height: number, x?: number, y?: number): void
Parameters
- width: number
- height: number
- x: number = 0
- y: number = 0
Returns void
Overrides Renderer.size
- Defined in renderer/svgjs/svg-js-renderer.ts:41

text

text(text: string | TextSegment[], x: number, y: number, fontSize: number, color: string, fontFamily: string, alignment: Alignment, classes?: string | string[], plain?: boolean): GraphcisElement
Parameters
- text: string | TextSegment[]
- x: number
- y: number
- fontSize: number
- color: string
- fontFamily: string
- alignment: Alignment
- Optional classes: string | string[]
- Optional plain: boolean
Returns GraphcisElement
Overrides Renderer.text
- Defined in renderer/svgjs/svg-js-renderer.ts:72

title

title(title: string): void
Parameters
- title: string
Returns void
Overrides Renderer.title
- Defined in renderer/svgjs/svg-js-renderer.ts:26

toSvgString

toSvgString(): string
Serialize the current state of the diagram to an SVG string. The returned string is a standalone <svg> document (including the xmlns attribute) and can be written to a file or used without ever attaching it to the DOM.

Returns string
Overrides Renderer.toSvgString
- Defined in renderer/svgjs/svg-js-renderer.ts:55

triangle

triangle(x: number, y: number, size: number, strokeWidth: number, strokeColor: string, classes?: string | string[], fill?: string): GraphcisElement
Parameters
- x: number
- y: number
- size: number
- strokeWidth: number
- strokeColor: string
- Optional classes: string | string[]
- Optional fill: string
Returns GraphcisElement
Overrides Renderer.triangle
- Defined in renderer/svgjs/svg-js-renderer.ts:176

`Static` `Protected` arcBarrePath

arcBarrePath(x: number, y: number, width: number, height: number, direction: ArcDirection): string
Parameters
- x: number
- y: number
- width: number
- height: number
- direction: ArcDirection
Returns string
Inherited from Renderer.arcBarrePath
- Defined in renderer/renderer.ts:161

`Static` `Private` boxToElement

boxToElement(box: Box, remove: (() => void)): GraphcisElement
Parameters
- box: Box
- remove: (() => void)
  - - (): void
    - Returns void
Returns GraphcisElement
- Defined in renderer/svgjs/svg-js-renderer.ts:233

`Static` `Protected` ngonPath

ngonPath(x: number, y: number, size: number, edges: number): string
Parameters
- x: number
- y: number
- size: number
- edges: number
Returns string
Inherited from Renderer.ngonPath
- Defined in renderer/renderer.ts:137

`Static` `Protected` textSpans

textSpans(segments: TextSegment[], fontSize: number): {
    dy: number;
    fontSize: number;
    text: string;
}[]
Parameters
- segments: TextSegment[]
- fontSize: number
Returns {
    dy: number;
    fontSize: number;
    text: string;
}[]
Inherited from Renderer.textSpans
- Defined in renderer/renderer.ts:230

`Static` `Protected` toClassName

toClassName(classes?: string | string[]): string
Parameters
- Optional classes: string | string[]
Returns string
Inherited from Renderer.toClassName
- Defined in renderer/renderer.ts:245

`Static` `Protected` trianglePath

trianglePath(x: number, y: number, size: number): string
Parameters
- x: number
- y: number
- size: number
Returns string
Inherited from Renderer.trianglePath
- Defined in renderer/renderer.ts:133

Class SvgJsRenderer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional container: string | HTMLElement

Returns SvgJsRenderer

Properties

Private Optional backgroundElement

Protected Optional container

Private svg

Methods

arc

Parameters

x: number

y: number

width: number

height: number

direction: ArcDirection

strokeWidth: number

strokeColor: string

Optional classes: string | string[]

Optional fill: string

Returns GraphcisElement

background

Parameters

color: string

Returns void

circle

Parameters

x: number

y: number

diameter: number

strokeWidth: number

strokeColor: string

Optional fill: string

Optional classes: string | string[]

Returns GraphcisElement

clear

Returns void

fontsLoading

Returns undefined | Promise<unknown>

line

Parameters

fromX: number

fromY: number

toX: number

toY: number

strokeWidth: number

color: string

Returns void

Private ngon

Parameters

x: number

y: number

size: number

strokeWidth: number

strokeColor: string

fill: string

edges: number

Optional classes: string | string[]

Returns GraphcisElement

pentagon

Parameters

x: number

y: number

size: number

strokeWidth: number

strokeColor: string

fill: string

Optional classes: string | string[]

Returns GraphcisElement

rect

Parameters

x: number

y: number

`Optional` container: string | HTMLElement

`Private` `Optional` backgroundElement

`Protected` `Optional` container

`Private` svg

`Optional` classes: string | string[]

`Optional` fill: string

`Optional` fill: string

`Optional` classes: string | string[]

`Private` ngon

`Optional` classes: string | string[]

`Optional` classes: string | string[]

`Optional` classes: string | string[]

`Optional` fill: string

`Optional` radius: number

`Private` segmentText

`Optional` classes: string | string[]

`Optional` plain: boolean

`Optional` classes: string | string[]

`Optional` fill: string

`Static` `Protected` arcBarrePath

`Static` `Private` boxToElement

`Static` `Protected` ngonPath