Class Renderer

Hierarchy

Renderer

Constructors

constructor

new Renderer(renderState?: iRenderState): Renderer
Parameters
- Optional renderState: iRenderState
Returns Renderer
- Defined in src/core/rendering/renderer.ts:21

Properties

FOCUS_ZOOM_LEVEL

FOCUS_ZOOM_LEVEL: number = 1.5

`Private` _container

_container: HTMLElement

`Private` _lifecycle

_lifecycle: Lifecycle

`Private` `Optional` _renderState

_renderState?: iRenderState

`Private` _theme

_theme: GrapholscapeTheme

`Optional` cy

cy?: Core

`Optional` diagram

diagram?: Diagram

filters

filters: Map<string, Filter> = ...

renderStateData

renderStateData: {
[x: string]: any;
} = {}

Type declaration

[x: string]: any

Accessors

container

get container(): HTMLElement
Returns HTMLElement
- Defined in src/core/rendering/renderer.ts:332
set container(container: HTMLElement): void
Parameters
- container: HTMLElement
Returns void
- Defined in src/core/rendering/renderer.ts:323

edges

get edges(): undefined | string[]
Getter

Returns undefined | string[]
- Defined in src/core/rendering/renderer.ts:344

grapholElements

get grapholElements(): undefined | Map<string, GrapholElement>
Returns undefined | Map<string, GrapholElement>
- Defined in src/core/rendering/renderer.ts:305

isThemeApplied

get isThemeApplied(): undefined | Style
Returns undefined | Style
- Defined in src/core/rendering/renderer.ts:301

lifecycle

set lifecycle(lc: Lifecycle): void
Parameters
- lc: Lifecycle
Returns void
- Defined in src/core/rendering/renderer.ts:26

nodes

get nodes(): undefined | string[]
Getter

Returns undefined | string[]
- Defined in src/core/rendering/renderer.ts:337

renderState

get renderState(): undefined | iRenderState
Returns undefined | iRenderState
- Defined in src/core/rendering/renderer.ts:51
set renderState(rs: undefined | iRenderState): void
Parameters
- rs: undefined | iRenderState
Returns void
- Defined in src/core/rendering/renderer.ts:30

selectedElement

get selectedElement(): undefined | GrapholElement
Returns undefined | GrapholElement
- Defined in src/core/rendering/renderer.ts:310

theme

get theme(): GrapholscapeTheme
Returns GrapholscapeTheme
- Defined in src/core/rendering/renderer.ts:53

viewportState

get viewportState(): undefined | {
pan: Position;
zoom: number;
}
Returns undefined | {
pan: Position;
zoom: number;
}
- Defined in src/core/rendering/renderer.ts:315

Methods

addElement

addElement(element: ElementDefinition): void
Parameters
- element: ElementDefinition
Returns void
- Defined in src/core/rendering/renderer.ts:71

`Private` applyActiveFilters

applyActiveFilters(): void
Returns void
- Defined in src/core/rendering/renderer.ts:144

applyTheme

applyTheme(): void
Returns void
- Defined in src/core/rendering/renderer.ts:269

centerOnElement

centerOnElement(element: GrapholElement, zoom?: number, select?: boolean): void
Parameters
- element: GrapholElement
- Optional zoom: number
- Optional select: boolean
Returns void
- Defined in src/core/rendering/renderer.ts:204

centerOnElementById

centerOnElementById(elementId: string, zoom?: undefined | number, select?: boolean): void
Put a set of elements (nodes and/or edges) at the center of the viewport. If just one element then the element will be at the center.
Parameters
- elementId: string
  
  the element's ID
- zoom: undefined | number = ...
  
  the zoom level to apply, if not passed, zoom level won't be changed
- Optional select: boolean
Returns void
- Defined in src/core/rendering/renderer.ts:200

centerOnModelPosition

centerOnModelPosition(xPos: number, yPos: number, zoom?: number): void
Parameters
- xPos: number
- yPos: number
- Optional zoom: number
Returns void
- Defined in src/core/rendering/renderer.ts:208

centerOnRenderedPosition

centerOnRenderedPosition(xPos: number, yPos: number, zoom?: number): void
Parameters
- xPos: number
- yPos: number
- Optional zoom: number
Returns void
- Defined in src/core/rendering/renderer.ts:225

filter

filter(filter: string | Filter): void
Filter elements on the diagram. It will be actually applied only if the user defined callback on the event FilterRequest returns true and if the internal logic allows for the filter to be applied.
Parameters
- filter: string | Filter
  
  Can be an object of type Filter, DefaultFilterKeyEnum or a string representing the unique key of a defined filter
Returns void
- Defined in src/core/rendering/renderer.ts:83

fit

fit(): void
Fit viewport to diagram

Returns void
- Defined in src/core/rendering/renderer.ts:190

`Private` getFilter

getFilter(filter: string | Filter): undefined | Filter
Parameters
- filter: string | Filter
Returns undefined | Filter
- Defined in src/core/rendering/renderer.ts:128

mount

mount(): void
Returns void
- Defined in src/core/rendering/renderer.ts:65

`Private` performAllFilters

performAllFilters(): void
Returns void
- Defined in src/core/rendering/renderer.ts:152

`Private` performFilter

performFilter(filter: Filter, activate?: boolean): void
Parameters
- filter: Filter
- activate: boolean = true
Returns void
- Defined in src/core/rendering/renderer.ts:94

render

render(diagram: Diagram): void
Parameters
- diagram: Diagram
Returns void
- Defined in src/core/rendering/renderer.ts:55

selectElement

selectElement(elementId: string): void
Select a node or an edge in the current diagram given its unique id
Parameters
- elementId: string
  
  elem id (node or edge)
Returns void
- Defined in src/core/rendering/renderer.ts:175

setTheme

setTheme(theme: GrapholscapeTheme): void
Parameters
- theme: GrapholscapeTheme
Returns void
- Defined in src/core/rendering/renderer.ts:260

stopRendering

stopRendering(): void
Returns void
- Defined in src/core/rendering/renderer.ts:165

unfilter

unfilter(filter: string | Filter): void
Unfilter elements on the diagram. It will be actually deactivated only if the user defined callback on the event FilterRequest returns true and if the internal logic allows for the filter to be deactivated.
Parameters
- filter: string | Filter
  
  Can be an object of type Filter, DefaultFilterKeyEnum or a string representing the unique key of a defined filter
Returns void
- Defined in src/core/rendering/renderer.ts:117

unselect

unselect(): void
Unselect every selected element in this diagram

Returns void
- Defined in src/core/rendering/renderer.ts:183

updateElement

updateElement(grapholElement: GrapholElement): void
Parameters
- grapholElement: GrapholElement
Returns void
- Defined in src/core/rendering/renderer.ts:283

zoom

zoom(zoomValue: number): void
Parameters
- zoomValue: number
Returns void
- Defined in src/core/rendering/renderer.ts:232

zoomIn

zoomIn(zoomValue: number): void
Parameters
- zoomValue: number
Returns void
- Defined in src/core/rendering/renderer.ts:240

zoomOut

zoomOut(zoomValue: number): void
Parameters
- zoomValue: number
Returns void
- Defined in src/core/rendering/renderer.ts:250