Class GraphViz

Hierarchy

StructureViz
- GraphViz

Index

Constructors

constructor

Properties

Constructors

constructor

new GraphViz(width: number, height: number, directed: boolean): GraphViz

Overrides StructureViz.constructor
- Defined in lib/graphViz.ts:18
Parameters
- width: number
- height: number
- directed: boolean
Returns GraphViz

Properties

Private boxSize

boxSize: number

directed

directed: boolean

edges

edges: EdgeViz[]

frozen

frozen: boolean

id

id: string

dom id for <g> element

maxHeight

maxHeight: number

maxWidth

maxWidth: number

nodeRadius

nodeRadius: number

nodes

nodes: NodeViz[]

pseudo

pseudo: Pseudocode

separation

separation: number

simulation

simulation: Simulation<any, any>

timeline

timeline: any[]

Array of animation states through time

transitionDuration

transitionDuration: number

Methods

addEdge

addEdge(source: NodeViz, target: NodeViz): EdgeViz

- Defined in lib/graphViz.ts:76
Parameters
- source: NodeViz
- target: NodeViz
Returns EdgeViz

addNode

addNode(): NodeViz

- Defined in lib/graphViz.ts:61
Returns NodeViz

allEdges

allEdges(): NodeViz[]

- Defined in lib/graphViz.ts:112
Returns NodeViz[]

allNodes

allNodes(): NodeViz[]

- Defined in lib/graphViz.ts:108
Returns NodeViz[]

delayedFreeze

delayedFreeze(ms: number): void

- Defined in lib/graphViz.ts:402
Parameters
- ms: number
Returns void

drag

drag(simulation: Simulation<any, any>): DragBehavior<Element, unknown, unknown>

- Defined in lib/graphViz.ts:363
Enables the dragging of nodes with the mouse. From https://observablehq.com/@d3/disjoint-force-directed-graph

Parameters
- simulation: Simulation<any, any>
  
  just this.simulation
Returns DragBehavior<Element, unknown, unknown>

freeze

freeze(): void

- Defined in lib/graphViz.ts:338
Freezes the graph. (Stops the particle simulation from occurring.)

Returns void

Protected getElement

getElement(): Selection<any, any, any, any>

Inherited from StructureViz.getElement
- Defined in lib/structures.ts:49
Returns the d3 selection that represents the structure. Probably a <g> element

Returns Selection<any, any, any, any>

getState

getState(): any

Overrides StructureViz.getState
- Defined in lib/graphViz.ts:82
Returns a copy of the structures current state.

Returns any

pushAndTransition

pushAndTransition(): void

Inherited from StructureViz.pushAndTransition
- Defined in lib/structures.ts:81
Pushes the current state onto the timeline and transitions to it.

Returns void

pushState

pushState(): void

Inherited from StructureViz.pushState
- Defined in lib/structures.ts:64
Adds the current state to the timeline.

Returns void

removeEdge

removeEdge(e: EdgeViz): void

- Defined in lib/graphViz.ts:72
Parameters
- e: EdgeViz
Returns void

removeNode

removeNode(n: NodeViz): void

- Defined in lib/graphViz.ts:67
Parameters
- n: NodeViz
Returns void

setMaxHeight

setMaxHeight(n: number): void

Inherited from StructureViz.setMaxHeight
- Defined in lib/structures.ts:53
Parameters
- n: number
Returns void

setMaxHeightWidth

setMaxHeightWidth(n: number): void

Inherited from StructureViz.setMaxHeightWidth
- Defined in lib/structures.ts:57
Parameters
- n: number
Returns void

simulationTick

simulationTick(): void

- Defined in lib/graphViz.ts:268
Returns void

startSimulation

startSimulation(): void

- Defined in lib/graphViz.ts:49
Sets all the parameters of the particle simulation. Should be rerun if the parameters have been changed.

Returns void

thaw

thaw(): void

- Defined in lib/graphViz.ts:346
Lets

Returns void

transition

transition(state: any): void

Overrides StructureViz.transition
- Defined in lib/graphViz.ts:116
Transitions the visuals to the given state. Details are implemented in subclasses. In subclasses, call super.transition(state); in the transition implementation.

Parameters
- state: any
Returns void

Private transitionLinks

transitionLinks(linkData: any[], trans: Transition<any, any, any, any>): void

- Defined in lib/graphViz.ts:223
Helper method for transition(). Transitions the links.

Parameters
- linkData: any[]
  
  data for the links based off state
- trans: Transition<any, any, any, any>
  
  the D3 transition being used
Returns void

Private transitionNodes

transitionNodes(nodeData: any[], trans: Transition<any, any, any, any>): void

- Defined in lib/graphViz.ts:160
Helper method for transition(). Transitions the nodes.

Parameters
- nodeData: any[]
  
  data for the nodes based off state
- trans: Transition<any, any, any, any>
  
  the D3 transition being used
Returns void

wipeOut

wipeOut(): void

Overrides StructureViz.wipeOut
- Defined in lib/graphViz.ts:353
Returns the structure to it's blank state

Returns void

Generated using TypeDoc