Class Renderer`Abstract`

Hierarchy

Renderer
- RoughJsRenderer
- SvgJsRenderer

Index

Constructors

Properties

Methods

arc background circle clear fontsLoading line pentagon rect remove size text title toSvgString triangle arcBarrePath ngonPath textSpans toClassName trianglePath

Constructors

`Protected` constructor

new Renderer(container?: string | HTMLElement): Renderer
Parameters
- Optional container: string | HTMLElement
Returns Renderer
- Defined in renderer/renderer.ts:29

Properties

`Protected` `Optional` container

container?: string | HTMLElement

Methods

`Abstract` 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
- Defined in renderer/renderer.ts:101

`Abstract` background

background(color: string): void
Parameters
- color: string
Returns void
- Defined in renderer/renderer.ts:63

`Abstract` 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
- Defined in renderer/renderer.ts:79

`Abstract` clear

clear(): void
Returns void
- Defined in renderer/renderer.ts:43

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>
- Defined in renderer/renderer.ts:50

`Abstract` line

line(x1: number, y1: number, x2: number, y2: number, strokeWidth: number, color: string, classes?: string | string[]): void
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
- strokeWidth: number
- color: string
- Optional classes: string | string[]
Returns void
- Defined in renderer/renderer.ts:31

`Abstract` 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
- Optional fill: string
- Optional classes: string | string[]
Returns GraphcisElement
- Defined in renderer/renderer.ts:123

`Abstract` 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
- Defined in renderer/renderer.ts:89

`Abstract` remove

remove(): void
Returns void
- Defined in renderer/renderer.ts:54

`Abstract` size

size(width: number, height: number, x?: number, y?: number): void
Parameters
- width: number
- height: number
- Optional x: number
- Optional y: number
Returns void
- Defined in renderer/renderer.ts:41

`Abstract` 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
- Defined in renderer/renderer.ts:67

`Abstract` title

title(title: string): void
Parameters
- title: string
Returns void
- Defined in renderer/renderer.ts:65

`Abstract` 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
- Defined in renderer/renderer.ts:61

`Abstract` 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
- Defined in renderer/renderer.ts:113

`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
- Defined in renderer/renderer.ts:161

`Static` `Protected` ngonPath

ngonPath(x: number, y: number, size: number, edges: number): string
Parameters
- x: number
- y: number
- size: number
- edges: number
Returns string
- 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;
}[]
- Defined in renderer/renderer.ts:230

`Static` `Protected` toClassName

toClassName(classes?: string | string[]): string
Parameters
- Optional classes: string | string[]
Returns string
- 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
- Defined in renderer/renderer.ts:133

Class RendererAbstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Parameters

Optional container: string | HTMLElement

Returns Renderer

Properties

Protected Optional container

Methods

Abstract 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

Abstract background

Parameters

color: string

Returns void

Abstract circle

Parameters

x: number

y: number

diameter: number

strokeWidth: number

strokeColor: string

Optional fill: string

Optional classes: string | string[]

Returns GraphcisElement

Abstract clear

Returns void

fontsLoading

Returns undefined | Promise<unknown>

Abstract line

Parameters

x1: number

y1: number

x2: number

y2: number

strokeWidth: number

color: string

Optional classes: string | string[]

Returns void

Abstract pentagon

Parameters

x: number

y: number

size: number

strokeWidth: number

strokeColor: string

Optional fill: string

Optional classes: string | string[]

Returns GraphcisElement

Abstract rect

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

Abstract remove

Returns void

Abstract size

Parameters

Class Renderer`Abstract`

`Protected` constructor

`Optional` container: string | HTMLElement

`Protected` `Optional` container

`Abstract` arc

`Optional` classes: string | string[]

`Optional` fill: string

`Abstract` background

`Abstract` circle

`Optional` fill: string

`Optional` classes: string | string[]

`Abstract` clear

`Abstract` line

`Optional` classes: string | string[]

`Abstract` pentagon

`Optional` fill: string

`Optional` classes: string | string[]

`Abstract` rect

`Optional` classes: string | string[]

`Optional` fill: string

`Optional` radius: number

`Abstract` remove

`Abstract` size

`Optional` x: number

`Optional` y: number

`Abstract` text

`Optional` classes: string | string[]

`Optional` plain: boolean

`Abstract` title

`Abstract` toSvgString

`Abstract` triangle

`Optional` classes: string | string[]

`Optional` fill: string

`Static` `Protected` arcBarrePath

`Static` `Protected` ngonPath

`Static` `Protected` textSpans

Returns {
dy: number;
fontSize: number;
text: string;
}[]

`Static` `Protected` toClassName

`Optional` classes: string | string[]

`Static` `Protected` trianglePath