Class Renderer`Abstract`

Hierarchy

Renderer
- RoughJsRenderer
- SvgJsRenderer

Index

Constructors

Properties

Methods

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

Constructors

`Protected` constructor

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

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:86

`Abstract` background

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

`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:64

`Abstract` clear

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

`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:25

`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:108

`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:74

`Abstract` remove

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

`Abstract` size

size(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
- Defined in renderer/renderer.ts:35

`Abstract` text

text(text: string, x: number, y: number, fontSize: number, color: string, fontFamily: string, alignment: Alignment, classes?: string | string[], plain?: boolean): GraphcisElement
Parameters
- text: string
- 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:52

`Abstract` title

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

`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:46

`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:98

`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:146

`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:122

`Static` `Protected` toClassName

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

`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:118

Generated using TypeDoc