Class NodeCanvas

Hierarchy

AbstractCanvas
- NodeCanvas
  - PDFCanvas
  - SVGCanvas

Implements

Canvas

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new NodeCanvas(diagram: Diagram, zoom?: number, imageFormat: ImageFormat): NodeCanvas

Overrides AbstractCanvas.constructor
- Defined in canvas/NodeCanvas.ts:12
Parameters
- diagram: Diagram
- Default value zoom: number = 1
- imageFormat: ImageFormat
Returns NodeCanvas

Properties

Private _canvas

_canvas: Canvas

Protected _ctx

_ctx: CanvasRenderingContext2D

Private Optional _imageFormat

_imageFormat: undefined | string

Accessors

background

get background(): string | any
set background(value: string | any): void

Inherited from AbstractCanvas.background
- Defined in canvas/AbstractCanvas.ts:80
Returns string | any
Inherited from AbstractCanvas.background
- Defined in canvas/AbstractCanvas.ts:84
Parameters
- value: string | any
Returns void

diagram

get diagram(): Diagram | null
set diagram(val: Diagram | null): void

Inherited from AbstractCanvas.diagram
- Defined in canvas/AbstractCanvas.ts:52
Returns Diagram | null
Inherited from AbstractCanvas.diagram
- Defined in canvas/AbstractCanvas.ts:47
Parameters
- val: Diagram | null
Returns void

grid

get grid(): boolean
set grid(val: boolean): void

Inherited from AbstractCanvas.grid
- Defined in canvas/AbstractCanvas.ts:43
Returns boolean
Inherited from AbstractCanvas.grid
- Defined in canvas/AbstractCanvas.ts:38
Parameters
- val: boolean
Returns void

gridX

get gridX(): number

Inherited from AbstractCanvas.gridX
- Defined in canvas/AbstractCanvas.ts:56
Returns number

gridY

get gridY(): number

Inherited from AbstractCanvas.gridY
- Defined in canvas/AbstractCanvas.ts:60
Returns number

height

get height(): number

Overrides AbstractCanvas.height
- Defined in canvas/NodeCanvas.ts:40
Returns number

offsetX

get offsetX(): number

Inherited from AbstractCanvas.offsetX
- Defined in canvas/AbstractCanvas.ts:64
Returns number

offsetY

get offsetY(): number

Inherited from AbstractCanvas.offsetY
- Defined in canvas/AbstractCanvas.ts:68
Returns number

width

get width(): number

Overrides AbstractCanvas.width
- Defined in canvas/NodeCanvas.ts:36
Returns number

zoom

get zoom(): number
set zoom(value: number): void

Inherited from AbstractCanvas.zoom
- Defined in canvas/AbstractCanvas.ts:72
Returns number
Inherited from AbstractCanvas.zoom
- Defined in canvas/AbstractCanvas.ts:76
Parameters
- value: number
Returns void

zoomHeight

get zoomHeight(): number

Inherited from AbstractCanvas.zoomHeight
- Defined in canvas/AbstractCanvas.ts:93
Returns number

zoomWidth

get zoomWidth(): number

Inherited from AbstractCanvas.zoomWidth
- Defined in canvas/AbstractCanvas.ts:89
Returns number

Methods

clipRectangle

clipRectangle(bounds: Bounds): void

Inherited from AbstractCanvas.clipRectangle
- Defined in canvas/AbstractCanvas.ts:190
Clips the canvas to a rectangle

Parameters
- bounds: Bounds
Returns void

drawLine

drawLine(line: Line, stroke: Stroke, targetTip: LineTip, sourceTip: LineTip): void

Implementation of Canvas.drawLine

Inherited from AbstractCanvas.drawLine
- Defined in canvas/AbstractCanvas.ts:206
Parameters
- line: Line
- stroke: Stroke
- targetTip: LineTip
- sourceTip: LineTip
Returns void

drawRectangle

drawRectangle(bounds: Bounds): void

Inherited from AbstractCanvas.drawRectangle
- Defined in canvas/AbstractCanvas.ts:128
Draws a rectangle within the given bounds

Parameters
- bounds: Bounds
Returns void

drawSimpleLine

drawSimpleLine(x1: number, y1: number, x2: number, y2: number, stroke: Stroke): void

Implementation of Canvas.drawSimpleLine

Inherited from AbstractCanvas.drawSimpleLine
- Defined in canvas/AbstractCanvas.ts:198
Draws a simple line from four coordinates

Parameters
- x1: number
- y1: number
- x2: number
- y2: number
- stroke: Stroke
Returns void

drawText

drawText(text: string, x: number, y: number, font: Font, maxWidth?: undefined | number, hAlign?: TextAlign, vAlign?: Baseline): void

Implementation of Canvas.drawText

Inherited from AbstractCanvas.drawText
- Defined in canvas/AbstractCanvas.ts:166
Draws a text

Parameters
- text: string
  
  The text to draw
- x: number
  
  The text X position
- y: number
  
  The text Y position
- font: Font
  
  The font to use
- Optional maxWidth: undefined | number
  
  The maximum width of the text
- Default value hAlign: TextAlign = "left"
  
  The horizontal alignment
- Default value vAlign: Baseline = "middle"
  
  The vertical alignment
Returns void

fillRectangle

fillRectangle(bounds: Bounds, fill: Fill): void

Implementation of Canvas.fillRectangle

Inherited from AbstractCanvas.fillRectangle
- Defined in canvas/AbstractCanvas.ts:138
Fills a rectangle

Parameters
- bounds: Bounds
  
  The rectangle's bounds
- fill: Fill
  
  The fill to use
Returns void

Protected getElementCoordinates

getElementCoordinates(target: DiagramElement<any>): [number, number]

Inherited from AbstractCanvas.getElementCoordinates
- Defined in canvas/AbstractCanvas.ts:276
Converts global coordinates to element based coordinates

Parameters
- target: DiagramElement<any>
Returns [number, number]

Protected invalidate

invalidate(): void

Inherited from AbstractCanvas.invalidate
- Defined in canvas/AbstractCanvas.ts:255
Invalidates the canvas by emptying it

Returns void

labelLine

labelLine(line: Line, font: Font, label: string, position?: number): void

Inherited from AbstractCanvas.labelLine
- Defined in canvas/AbstractCanvas.ts:210
Parameters
- line: Line
- font: Font
- label: string
- Default value position: number = 0
Returns void

measureTextWidth

measureTextWidth(text: string, font: Font): number

Implementation of Canvas.measureTextWidth

Inherited from AbstractCanvas.measureTextWidth
- Defined in canvas/AbstractCanvas.ts:178
Measures the width of a text

Parameters
- text: string
  
  The text to measure
- font: Font
  
  The font to use
Returns number

moveOffset

moveOffset(dx: number, dy: number): void

Inherited from AbstractCanvas.moveOffset
- Defined in canvas/AbstractCanvas.ts:233
Move the offset point of the canvas

Parameters
- dx: number
- dy: number
Returns void

popCanvasStack

popCanvasStack(): void

Implementation of Canvas.popCanvasStack

Inherited from AbstractCanvas.popCanvasStack
- Defined in canvas/AbstractCanvas.ts:117
Pops the canvas stack

Returns void

pushCanvasStack

pushCanvasStack(): void

Implementation of Canvas.pushCanvasStack

Inherited from AbstractCanvas.pushCanvasStack
- Defined in canvas/AbstractCanvas.ts:110
Pushes the canvas stack

Returns void

Protected render

render(): this

Inherited from AbstractCanvas.render
- Defined in canvas/AbstractCanvas.ts:242
Renders the canvas

Returns this

rerender

rerender(): this

Inherited from AbstractCanvas.rerender
- Defined in canvas/AbstractCanvas.ts:225
Invalidates and renders the canvas

Returns this

resize

resize(width: number, height: number): this

Overrides AbstractCanvas.resize
- Defined in canvas/NodeCanvas.ts:44
Parameters
- width: number
- height: number
Returns this

saveToFile

saveToFile(filename: string, jpegOptions?: JPEGOptions): Promise<void>

- Defined in canvas/NodeCanvas.ts:50
Parameters
- filename: string
- Optional jpegOptions: JPEGOptions
Returns Promise<void>

Private saveToWriteStream

saveToWriteStream(writeStream: WriteStream, jpegOptions?: JPEGOptions): void

- Defined in canvas/NodeCanvas.ts:83
Parameters
- writeStream: WriteStream
- Optional jpegOptions: JPEGOptions
Returns void

strokeRectangle

strokeRectangle(bounds: Bounds, stroke: Stroke): void

Implementation of Canvas.strokeRectangle

Inherited from AbstractCanvas.strokeRectangle
- Defined in canvas/AbstractCanvas.ts:149
Strokes a rectangle

Parameters
- bounds: Bounds
  
  The rectangle's outer bounds
- stroke: Stroke
  
  The fill to use
Returns void

toDataURL

toDataURL(): string

- Defined in canvas/NodeCanvas.ts:62
Outputs the image as an data URL

Returns string

translate

translate(offset: Point): void

Implementation of Canvas.translate

Inherited from AbstractCanvas.translate
- Defined in canvas/AbstractCanvas.ts:121
Parameters
- offset: Point
Returns void

Protected zoomCanvas

zoomCanvas(newZoom: number, x?: undefined | number, y?: undefined | number): void

Inherited from AbstractCanvas.zoomCanvas
- Defined in canvas/AbstractCanvas.ts:264
Parameters
- newZoom: number
- Optional x: undefined | number
- Optional y: undefined | number
Returns void

Generated using TypeDoc