Global

Type Definitions

AddedObjects

Added nodes and links.
Type:
  • Array.<number>
Properties:
Name Type Description
0 Array.<Node> Nodes.
1 Array.<Link> Links.
Source:

D3Dispatch

D3 dispatch.
Type:
  • Object
Source:
See:

D3Drag

D3 drag behavior.
Type:
  • Object
Source:
See:

D3Selection

D3 selection.
Type:
  • Object
Source:
See:

D3Simulation

D3 force simulation.
Type:
  • Object
Source:
See:

D3Zoom

D3 zoom behavior.
Type:
  • Object
Source:
See:

ExportGraphData

Exported graph data.
Type:
  • Object
Properties:
Name Type Description
nodes Array.<ExportNodeData> Node data.
links Array.<ExportLinkData> Link data.
Source:

ExportLinkData

Exported link data.
Type:
  • Object
Properties:
Name Type Attributes Description
source ID Source node ID.
target ID Target node ID.
size number <optional>
 Size.
title string <optional>
 Title.
data * <optional>
 User data.
Source:

ExportNodeData

Exported node data.
Type:
  • Object
Properties:
Name Type Description
id ID Node ID.
x number Center X coordinate.
y number Center Y coordinate.
size number Size.
title string Title.
data * User data.
Source:

GraphData

Graph data.
Type:
  • Object
Properties:
Name Type Description
nodes Array.<Node> Node data.
links Array.<Link> Link data.
Source:

GraphOptions

Graph options.
Type:
  • Object
Properties:
Name Type Attributes Default Description
id string <optional>
<nullable>
 'ge' + <random> Graph SVG ID.
directed boolean <optional>
 false Graph type.
node.border number <optional>
 2 Node border size.
node.size.def number <optional>
 10 Default node size.
node.size.min number <optional>
 10 Minimal node size.
node.text.dx number | string <optional>
 0 Node title X offset.
node.text.dy number | string <optional>
 0 Node title Y offset.
node.text.inside boolean <optional>
 true Title inside/outside nodes.
link.path function <optional>
 ge.defaultLinkPath Link SVG path generator.
link.size.def number <optional>
 2 Default link size.
link.text.dx number | string <optional>
 0 Link title X offset.
link.text.dy number | string <optional>
 '1.1em' Link title Y offset.
link.text.offset string <optional>
 '50%' for undirected graphs, '20%' for directed Link title start-offset in %.
link.text.anchor string <optional>
 'middle' for undirected graphs, 'start' for directed Link title text-anchor ('start' | 'middle' | 'end').
link.arc.start number <optional>
 180 Reflexive link start angle in degrees.
link.arc.end number <optional>
 270 Reflexive link end angle in degrees.
simulation.create function <optional>
 ge.defaultSimulation Simulation start function.
simulation.start boolean <optional>
 false Start simulation after creating graph.
simulation.stop boolean <optional>
 true Stop simulation when it converges.
simulation.step number <optional>
 1 DOM update interval in simulation ticks.
transition.zoom number <optional>
 250 Zoom transition duration in milliseconds.
transition.drag number <optional>
 50 Drag transition duration in milliseconds.
transition.simulation number <optional>
 50 Simulation transition duration in milliseconds.
scale.min number <optional>
 0.25 Minimal zoom level.
scale.max number <optional>
 8.0 Maximal zoom level.
bbox.padding number <optional>
 80 Graph bounding box padding.
css.graph string <optional>
 'ge-graph' Graph CSS classes.
css.digraph string <optional>
 'ge-digraph' Directed graph CSS classes.
css.node string <optional>
 'ge-node' Node CSS classes.
css.link string <optional>
 'ge-link' Link CSS classes.
css.hide string <optional>
 'ge-hide' Hidden element CSS classes.
css.dragline string <optional>
 'ge-dragline' Drag line CSS classes.
css.selection.node string <optional>
 'ge-selection' Selected node CSS classes.
css.selection.link string <optional>
 'ge-link-selection' Selected link CSS classes.
Source:

ID

Node or link ID.
Type:
  • number | string
Source:

ImportGraphData

Imported graph data.
Type:
  • Object
Properties:
Name Type Description
nodes Array.<ImportNodeData> Node data.
links Array.<ImportLinkData> Link data.
Source:

ImportLinkData

Imported link data.
Type:
  • Object
Properties:
Name Type Attributes Description
source ID | ImportNodeData Source node.
target ID | ImportNodeData Target node.
size number <optional>
 Size.
title string <optional>
 Title.
data * <optional>
 User data.
Source:

ImportNodeData

Imported node data.
Type:
  • Object
Properties:
Name Type Attributes Description
id ID <optional>
 Node ID.
x number <optional>
 Center X coordinate.
y number <optional>
 Center Y coordinate.
size number <optional>
 Size.
title string <optional>
 Title.
data * <optional>
 User data.
Source:

Reference

Node or link reference.
Type:
Source:

Selection

Selection.
Type:
  • Object
Properties:
Name Type Attributes Description
node Node <nullable>
 Selected node.
link Link <nullable>
 Selected link.
Source:

Selector

CSS selector.
Type:
  • string
Source:

Events

click

Graph SVG click/touch event.
This:
Parameters:
Name Type Description
pos Point Click/touch position.
Source:
Link click/touch event.
This:
Parameters:
Name Type Description
link Link Clicked/touched link.
Source:
New link cancel event.
This:
Parameters:
Name Type Description
source Node Cancelled link source.
Source:
New link end event.
This:
Parameters:
Name Type Description
source Node New link source.
target Node New link target.
Source:
New link start event.
This:
Parameters:
Name Type Description
source Node New link source.
Source:

node-click

Node click/touch event.
This:
Parameters:
Name Type Description
node Node Clicked/touched node.
Source:

simulation-start

Simulation start event.
This:
Source:

simulation-stop

Simulation stop event.
This:
Source: