pivotick v3.0.0

---

pivotick / GraphRenderer

Abstract Interface: GraphRenderer

Defined in: GraphRenderer.ts:75

Methods

clearEmphasis()

abstract clearEmphasis(): void

Defined in: GraphRenderer.ts:123

Returns

void

---

clearForecast()

abstract clearForecast(): void

Defined in: GraphRenderer.ts:125

Returns

void

---

clearHighlightedElements()

abstract clearHighlightedElements(): void

Defined in: GraphRenderer.ts:121

Returns

void

---

destroy()

destroy(): void

Defined in: GraphRenderer.ts:150

Release renderer-owned resources (observers, listeners) on teardown. No-op by default; renderers that hold such resources override this.

Returns

void

---

emphasiseElements()

abstract emphasiseElements(elements): void

Defined in: GraphRenderer.ts:122

Parameters

elements

(Node | Edge)[]

Returns

void

---

enterNoteEditMode()

abstract enterNoteEditMode(note): void

Defined in: GraphRenderer.ts:133

Parameters

note

Note

Returns

void

---

fitAndCenter()

abstract fitAndCenter(forceScale?): void

Defined in: GraphRenderer.ts:115

Parameters

forceScale?

number

Returns

void

---

fitAndCenterWhenSettled()

fitAndCenterWhenSettled(forceScale?): Promise<void>

Defined in: GraphRenderer.ts:141

Fit-and-centre once the content has stopped resizing. Renderers that lay out over several frames after the sim stops (e.g. expanded clusters) override this to wait for a stable bbox; the default fits immediately. Resolves once the fit is applied.

Parameters

forceScale?

number

Returns

Promise<void>

---

focusElement()

abstract focusElement(element): void

Defined in: GraphRenderer.ts:118

Parameters

element

Node | Edge | Note

Returns

void

---

getCanvas()

getCanvas(): HTMLElement

Defined in: GraphRenderer.ts:152

Returns

HTMLElement

---

getCanvasSelection()

abstract getCanvasSelection(): unknown

Defined in: GraphRenderer.ts:111

Returns

unknown

---

getClosestElementToCursor()

abstract getClosestElementToCursor(maxDistance?): Node | Edge | Note | null

Defined in: GraphRenderer.ts:107

Parameters

maxDistance?

number

Returns

Node | Edge | Note | null

---

getContentBounds()

abstract getContentBounds(): GraphBounds | null

Defined in: GraphRenderer.ts:116

Returns

GraphBounds | null

---

getEdgeStyle()

abstract getEdgeStyle(edge): EdgeStyle

Defined in: GraphRenderer.ts:99

Parameters

edge

Edge

Returns

EdgeStyle

---

getGraphInteraction()

abstract getGraphInteraction(): GraphInteractions<unknown>

Defined in: GraphRenderer.ts:110

Returns

GraphInteractions<unknown>

---

getNodeClosestToCursor()

abstract getNodeClosestToCursor(maxDistance?): Node | null

Defined in: GraphRenderer.ts:108

Parameters

maxDistance?

number

Returns

Node | null

---

getNodeStyle()

abstract getNodeStyle(node, tier?): NodeStyle

Defined in: GraphRenderer.ts:98

The style node draws with. With tier, the style of that one drawing instead of the one the zoom picks: -1 for the floor style, or an index into the node's tiers.

Parameters

node

Node

tier?

number

Returns

NodeStyle

---

getOptions()

abstract getOptions(): GraphRendererOptions

Defined in: GraphRenderer.ts:100

Returns

GraphRendererOptions

---

getRootContainer()

getRootContainer(): HTMLElement

Defined in: GraphRenderer.ts:162

The graph's root container — everything, chrome included. Deliberately distinct from getCanvas: the canvas shrinks whenever chrome opens (a sidebar, the data dock), the container only changes when the page around it does. Anything that must not react to chrome measures this instead.

Returns

HTMLElement

---

getSelectionBox()

abstract getSelectionBox(): AbstractSelectionBox | null

Defined in: GraphRenderer.ts:109

Returns

AbstractSelectionBox | null

---

getShadowEdgeEnd()

getShadowEdgeEnd(): Point | null

Defined in: GraphRenderer.ts:130

Graph-space point where the preview edge ends, or null while none is drawn.

Returns

Point | null

---

getZoomBehavior()

abstract getZoomBehavior(): unknown

Defined in: GraphRenderer.ts:103

Returns

unknown

---

getZoomGroup()

abstract getZoomGroup(): HTMLElement | SVGElement | null

Defined in: GraphRenderer.ts:112

Returns

HTMLElement | SVGElement | null

---

graphToScreenCoordinates()

abstract graphToScreenCoordinates(graphX, graphY): Point

Defined in: GraphRenderer.ts:105

Parameters

graphX

number

graphY

number

Returns

Point

---

hideShadowEdge()

abstract hideShadowEdge(): void

Defined in: GraphRenderer.ts:127

Returns

void

---

highlightElement()

abstract highlightElement(element): void

Defined in: GraphRenderer.ts:119

Parameters

element

Node | Edge

Returns

void

---

init()

abstract init(): void

Defined in: GraphRenderer.ts:92

Returns

void

---

nextTick()

abstract nextTick(): void

Defined in: GraphRenderer.ts:101

Returns

void

---

nextTickFor()

abstract nextTickFor(nodes): void

Defined in: GraphRenderer.ts:102

Parameters

nodes

Node[]

Returns

void

---

screenToGraphCoordinates()

abstract screenToGraphCoordinates(screenX, screenY): Point

Defined in: GraphRenderer.ts:104

Parameters

screenX

number

screenY

number

Returns

Point

---

setupRendering()

setupRendering(): void

Defined in: GraphRenderer.ts:197

Returns

void

---

setViewport()

abstract setViewport(target): void

Defined in: GraphRenderer.ts:117

Parameters

target

ViewportTarget

Returns

void

---

showForecast()

abstract showForecast(forecast): void

Defined in: GraphRenderer.ts:124

Parameters

forecast

GraphForecast

Returns

void

---

showShadowEdge()

abstract showShadowEdge(params): void

Defined in: GraphRenderer.ts:126

Parameters

params

invalid?

boolean

source

Node | Note

targetNode?

Node

targetPosition?

{ x: number; y: number; }

targetPosition.x

number

targetPosition.y

number

Returns

void

---

toggleLassoMode()

abstract toggleLassoMode(enabled): void

Defined in: GraphRenderer.ts:106

Parameters

enabled

boolean

Returns

void

---

unHighlightElement()

abstract unHighlightElement(element): void

Defined in: GraphRenderer.ts:120

Parameters

element

Node | Edge

Returns

void

---

update()

abstract update(dataChanged): void

Defined in: GraphRenderer.ts:93

Parameters

dataChanged

boolean

Returns

void

---

updateLayoutProgress()

updateLayoutProgress(progress, elapsedTime, progressType): void

Defined in: GraphRenderer.ts:166

Parameters

progress

number

elapsedTime

number

progressType

ProgressType

Returns

void

---

zoomIn()

abstract zoomIn(): void

Defined in: GraphRenderer.ts:113

Returns

void

---

zoomOut()

abstract zoomOut(): void

Defined in: GraphRenderer.ts:114

Returns

void