# readonly canvasElement

View Source core/HeliosCore.js, line 123

# readonly element

View Source core/HeliosCore.js, line 109

# additiveBlending(enableAdditiveBlending) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 4256

Examples

// Enable additive blending.
helios.additiveBlending(true);

// Disable additive blending.
helios.additiveBlending(false);

# attributesTrackers() → {Object}

View Source core/HeliosCore.js, line 3881

Example

// Get the tracked attributes.
let attributesTrackers = helios.attributesTrackers();

# backgroundColor(color) → {Array.<number>|this}

Parameters:

View Source core/HeliosCore.js, line 2876

Examples

// Set the background color of the graph to red
helios.backgroundColor([1.0,0,0,1.0]);

// Get the background color of the graph
let backgroundColor = helios.backgroundColor();

# centerOnNodes(nodes, duration)

Parameters:

View Source core/HeliosCore.js, line 2334

Examples

// Center on node with id 1
helios.centerOnNodes([1], 1000);

// Center on node with id 1 and 2
helios.centerOnNodes([1, 2], 1000);

// Center on node with id 1 and node object
helios.centerOnNodes([1, helios.network.nodes[2]], 1000);
return {this} The current instance of Helios for chaining.

# cleanup(keepGLContext)

Parameters:

View Source core/HeliosCore.js, line 4359

Examples

// Cleanup the Helios instance.
helios.cleanup();

// Cleanup the Helios instance and keep the WebGL context alive.
helios.cleanup(true);

# destroy()

View Source core/HeliosCore.js, line 4506

# edgeColor(colorInput, edgeIDopt) → {number|this}

Parameters:

View Source core/HeliosCore.js, line 3180

Examples

// Set the color of all edges to red
helios.edgeColor([1, 0, 0, 1]);

// Set the color of a specific edge to red
helios.edgeColor([1, 0, 0, 1], "edgeID");

// Set the color of all edges to a random color
helios.edgeColor(() => {
	return [Math.random(), Math.random(), Math.random(), 1];
});

// Set the color of all edges based on an edge attribute called `altColor`
helios.edgeColor((edge) => {
	return edge.altColor;
});

# edgeWidth(widthInput, edgeIndexopt) → {number|this}

Parameters:

View Source core/HeliosCore.js, line 3319

Examples

// Set the width of all edges to 5.
helios.edgeWidth(5);

// Set the width of the edge with index 0 to 5.
helios.edgeWidth(5, 0);

// Set the width of all edges to a random number between 1 and 10.
helios.edgeWidth(sourceNode, targetNode, edgeIndex) => {
   return Math.random() * 9 + 1;
});

// Set the width of all edges to 5 at source and 2 at target.
helios.edgeWidth(sourceNode, targetNode, edgeIndex) => {
  return [5, 2];
});

// Set the width of the edge with altSizes properties from source and target.
helios.edgeWidth(sourceNode, targetNode, edgeIndex) => {
 return [sourceNode.altSizes, targetNode.altSizes];
});

# edgesColorsFromNodes(edgesColorsFromNodes) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 4211

Example

// Enable updating the edge colors to match the node colors.
helios.edgesColorsFromNodes(true);

# edgesGlobalOpacityBase(opacity) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 3969

Example

// Set the global opacity base of the edges to 0.5.
helios.edgesGlobalOpacityBase(0.5);

# edgesGlobalOpacityScale(opacity) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 3948

Example

// Set the global opacity of the edges to 0.5.
helios.edgesGlobalOpacityScale(0.5);

# edgesGlobalWidthBase(width) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 4011

Example

// Set the global width base of the edges to 0.5.
helios.edgesGlobalWidthBase(0.5);

# edgesGlobalWidthScale(width) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 3990

Example

// Set the global width of the edges to 0.5.
helios.edgesGlobalWidthScale(0.5);

# edgesWidthFromNodes(edgesWidthFromNodes) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 4232

Example

// Enable updating the edge widths to match the node widths.
helios.edgesWidthFromNodes(true);

# exportFigure(filename, options)

Parameters:

View Source core/HeliosCore.js, line 907

Example

helios.exportFigure("figure.png", {
  scale: 1.0,
  supersampleFactor: 4.0,
  width: 800,
  height: 600,
  backgroundColor: "#FFFFFF",
});

# getCenterNodes() → {Array.<Node>}

View Source core/HeliosCore.js, line 2383

Example

// Get the nodes being centered on
let nodes = helios.getCenterNodes();

# getProjectedPositions(nodes) → {Float32Array}

Parameters:

View Source core/HeliosCore.js, line 3406

Example

// Get the projected positions of all nodes.
let projectedPositions = helios.getProjectedPositions(helios.network.nodes);

# isReady() → {boolean}

View Source core/HeliosCore.js, line 4488

Example

// Check if Helios is ready to be used.
if (helios.isReady()) {
  // Helios is ready, do something.
} else {
  // Helios is not ready yet, wait or handle the error.
}

# labelsMaxPixels(labelsMaxPixels) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 4337

Example

// Set the maximum number of pixels for the labels buffer to 10000.
helios.labelsMaxPixels(10000);

# nodeColor(colorInput, nodeIDopt) → {Array.<number>|this}

Parameters:

View Source core/HeliosCore.js, line 2901

Examples

// Set the color of all nodes to red
helios.nodeColor([1.0,0,0,1.0]);

// Set the color of a specific node to red
helios.nodeColor([1.0,0,0,1.0], "nodeID");

// Set the color of all nodes to a random color
helios.nodeColor((node) => {
	return [Math.random(), Math.random(), Math.random(), 1.0];
});

// Set the color of all nodes based on an node attribute called `altColor`
helios.nodeColor((node) => {
	return node.altColor;
});

# nodeOutlineColor(colorInput, nodeIDopt) → {Array.<number>|this}

Parameters:

View Source core/HeliosCore.js, line 3040

Examples

// Set the color of all node outlines to red
helios.nodeOutlineColor([1, 0, 0, 1]);

// Set the color of a specific node outline to red
helios.nodeOutlineColor([1, 0, 0, 1], "nodeID");

// Set the color of all node outlines to a random color
helios.nodeOutlineColor(() => {
	return [Math.random(), Math.random(), Math.random(), 1];
});

// Set the color of all node outlines based on an node attribute called `altColor`
helios.nodeOutlineColor((node) => {
	return node.altColor;
});

# nodeOutlineWidth(widthInput, nodeIDopt) → {number|this}

Parameters:

View Source core/HeliosCore.js, line 3118

Examples

// Set the width of all node outlines to 5
helios.nodeOutlineWidth(5);

// Set the width of a specific node outline to 5
helios.nodeOutlineWidth(5, "nodeID");

// Set the width of all node outlines to a random width
helios.nodeOutlineWidth(() => {
	return Math.random() * 10;
});

// Set the width of all node outlines based on an node attribute called `altWidth`
helios.nodeOutlineWidth((node) => {
	return node.altWidth;
});

// Set the width of all node outlines based on an node attribute called `altWidth`
helios.nodeOutlineWidth((node) => {
	return node.altWidth;
});

# nodeSize(sizeInput, nodeIDopt) → {number|this}

Parameters:

View Source core/HeliosCore.js, line 2984

Examples

// Set the size of all nodes to 10
helios.nodeSize(10);

// Set the size of a specific node to 10
helios.nodeSize(10, "nodeID");

// Set the size of all nodes to a random size
helios.nodeSize(() => {
	return Math.random() * 10;
});

// Set the size of all nodes based on an node attribute called `altSize`
helios.nodeSize((node) => {
	return node.altSize;
});

# nodesGlobalOpacityBase(opacity) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 4056

Examples

// Set the global opacity base of the nodes to 0.5.
helios.nodesGlobalOpacityBase(0.5);

// Get the global opacity base of the nodes.
let base = helios.nodesGlobalOpacityBase();

# nodesGlobalOpacityScale(opacity) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 4032

Examples

// Set the global opacity of the nodes to 0.5.
helios.nodesGlobalOpacityScale(0.5);

// Get the global opacity of the nodes.
let scale = helios.nodesGlobalOpacityScale();

# nodesGlobalOutlineOpacityScale(opacity) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 4177

Examples

// Set the global outline opacity of the nodes to 0.5.
helios.nodesGlobalOutlineOpacityScale(0.5);

// Get the global outline opacity of the nodes.
let scale = helios.nodesGlobalOutlineOpacityScale();

# nodesGlobalOutlineWidthBase(width) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 4152

Examples

// Set the global outline width base of the nodes to 0.5.
helios.nodesGlobalOutlineWidthBase(0.5);

// Get the global outline width base of the nodes.
let base = helios.nodesGlobalOutlineWidthBase();

# nodesGlobalOutlineWidthScale(width) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 4128

Examples

// Set the global outline width of the nodes to 0.5.
helios.nodesGlobalOutlineWidthScale(0.5);

// Get the global outline width of the nodes.
let scale = helios.nodesGlobalOutlineWidthScale();

# nodesGlobalSizeBase(size) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 4104

Examples

// Set the global size base of the nodes to 0.5.
helios.nodesGlobalSizeBase(0.5);

// Get the global size base of the nodes.
let base = helios.nodesGlobalSizeBase();

# nodesGlobalSizeScale(size) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 4080

Examples

// Set the global size of the nodes to 0.5.
helios.nodesGlobalSizeScale(0.5);

// Get the global size of the nodes.
let scale = helios.nodesGlobalSizeScale();

# onCleanup(callback) → {this}

Parameters:

View Source core/HeliosCore.js, line 2848

Example

// Set the callback for when Helios is cleaned up
let helios = Helios("elementID",networkData);
helios.onCleanup(() => {
	console.log("Helios is cleaned up");
});

# onDraw(callback) → {this}

Parameters:

See:

• Helios#onReady

View Source core/HeliosCore.js, line 2806

Example

// Set the callback for the draw event
helios.onDraw(() => {
	console.log("The graph was drawn");
});

# onEdgeClick(callback) → {this}

Parameters:

See:

• Helios#onEdgeDoubleClick
• Helios#onEdgeHoverStart
• Helios#onEdgeHoverEnd
• Helios#onEdgeHoverMove

View Source core/HeliosCore.js, line 2608

Example

// Set the callback for the edge click event
helios.onEdgeClick((edge) => {
	console.log("The edge " + edge.id + " was clicked");
});

# onEdgeDoubleClick(callback) → {this}

Parameters:

See:

• Helios#onEdgeClick
• Helios#onEdgeHoverStart
• Helios#onEdgeHoverEnd
• Helios#onEdgeHoverMove

View Source core/HeliosCore.js, line 2630

Example

// Set the callback for the edge double click event
helios.onEdgeDoubleClick((edge) => {
	console.log("The edge " + edge.id + " was double clicked");
});

# onEdgeHoverEnd(callback) → {this}

Parameters:

See:

• Helios#onEdgeClick
• Helios#onEdgeDoubleClick
• Helios#onEdgeHoverStart
• Helios#onEdgeHoverMove

View Source core/HeliosCore.js, line 2674

Example

// Set the callback for the edge hover end event
helios.onEdgeHoverEnd((edge) => {
	console.log("The edge " + edge.id + " was no longer hovered");
});

# onEdgeHoverMove(callback) → {this}

Parameters:

See:

• Helios#onEdgeClick
• Helios#onEdgeDoubleClick
• Helios#onEdgeHoverStart
• Helios#onEdgeHoverEnd

View Source core/HeliosCore.js, line 2696

Example

// Set the callback for the edge hover move event
helios.onEdgeHoverMove((edge) => {
	console.log("The edge " + edge.id + " was hovered");
});

# onEdgeHoverStart(callback) → {this}

Parameters:

See:

• Helios#onEdgeClick
• Helios#onEdgeDoubleClick
• Helios#onEdgeHoverEnd
• Helios#onEdgeHoverMove

View Source core/HeliosCore.js, line 2652

Example

// Set the callback for the edge hover start event
helios.onEdgeHoverStart((edge) => {
	console.log("The edge " + edge.id + " was hovered");
});

# onLayoutStart(callback) → {this}

Parameters:

See:

• Helios#onLayoutStop
• Helios#onLayoutTick
• Helios#onLayoutEnd

View Source core/HeliosCore.js, line 2756

Example

// Set the callback for the layout start event
helios.onLayoutStart(() => {
	console.log("The layout has started");
});

# onLayoutStop(callback) → {this}

Parameters:

See:

• Helios#onLayoutStart
• Helios#onLayoutTick

View Source core/HeliosCore.js, line 2782

Example

// Set the callback for the layout stop event
helios.onLayoutStop(() => {
	console.log("The layout has stopped");
});

# onNodeClick(callback) → {this}

Parameters:

View Source core/HeliosCore.js, line 2508

Example

// Set the callback for the node click event
helios.onNodeClick((node) => {
	console.log("The node " + node.id + " was clicked");
});

# onNodeDoubleClick(callback) → {this}

Parameters:

See:

• Helios#onNodeClick

View Source core/HeliosCore.js, line 2526

Example

// Set the callback for the node double click event
helios.onNodeDoubleClick((node) => {
	console.log("The node " + node.id + " was double clicked");
});

# onNodeHoverEnd(callback) → {this}

Parameters:

See:

• Helios#onNodeHoverStart
• Helios#onNodeHoverMove

View Source core/HeliosCore.js, line 2565

Example

// Set the callback for the node hover end event
helios.onNodeHoverEnd((node) => {
	console.log("The node " + node.id + " was no longer hovered");
});

# onNodeHoverMove(callback) → {this}

Parameters:

See:

• Helios#onNodeHoverStart
• Helios#onNodeHoverEnd

View Source core/HeliosCore.js, line 2585

Example

// Set the callback for the node hover move event
helios.onNodeHoverMove((node) => {
	console.log("The node " + node.id + " was hovered");
});

# onNodeHoverStart(callback) → {this}

Parameters:

See:

• Helios#onNodeHoverEnd
• Helios#onNodeHoverMove

View Source core/HeliosCore.js, line 2545

Example

// Set the callback for the node hover start event
helios.onNodeHoverStart((node) => {
	console.log("The node " + node.id + " was hovered");
});

# onReady(callback) → {this}

Parameters:

View Source core/HeliosCore.js, line 2825

Example

// Set the callback for when Helios is ready
let helios = Helios("elementID",networkData);
helios.onReady(() => {
	console.log("Helios is ready");
});

# onResize(callback) → {this}

Parameters:

View Source core/HeliosCore.js, line 2490

Example

// Set the callback for the resize event
helios.onResize((width, height) => {
	console.log("The canvas was resized to " + width + "x" + height);
});

# onRotation(callback) → {this}

Parameters:

See:

• Helios#onZoom

View Source core/HeliosCore.js, line 2737

Example

// Set the callback for the rotation event
helios.onRotation((rotation) => {
	console.log("The rotation is now " + rotation);
});

# onZoom(callback) → {this}

Parameters:

See:

• Helios#onRotation

View Source core/HeliosCore.js, line 2718

Example

// Set the callback for the zoom event
helios.onZoom((zoom) => {
	console.log("The zoom is now " + zoom);
});

# pauseLayout() → {this}

View Source core/HeliosCore.js, line 487

# pickNode(x, y) → {Node}

Parameters:

View Source core/HeliosCore.js, line 3474

Examples

// Pick a node at the center of the canvas.
let node = helios.pickNode(helios.canvasElement.width / 2, helios.canvasElement.height / 2);
if(node !== null) {
   console.log("Picked node " + node.index);
}

// Pick a node at the center of the canvas, and highlight it.
let node = helios.pickNode(helios.canvasElement.width / 2, helios.canvasElement.height / 2);
if(node !== null) {
  console.log("Picked node " + node.index);
 helios.highlightNode(node);
}

# pickeableEdges(pickables) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 4301

Examples

// Enable pickeable edges for [0,1,2,3]
helios.pickeableEdges([0, 1, 2, 3]);

// Enable pickeable edges for all edges
helios.pickeableEdges("all");

# redraw() → {this}

View Source core/HeliosCore.js, line 1723

Examples

// Redraw the network
helios.redraw();

// Update geometry and redraw the network
helios.update().redraw();

# render(immediateopt) → {this}

Parameters:

View Source core/HeliosCore.js, line 1786

Examples

// Render the network
helios.render();

// Update geometry and render the network
helios.update().render();

# resumeLayout() → {this}

View Source core/HeliosCore.js, line 503

# semanticZoomExponent(semanticZoomExponent) → {this|number}

Parameters:

View Source core/HeliosCore.js, line 1641

Examples

// Set the semantic zoom exponent to 0.5
helios.semanticZoomExponent(0.5);

// Get the current semantic zoom exponent
let semanticZoomExponent = helios.semanticZoomExponent();

# shadedNodes(enableShadedNodes) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 4280

Example

// Enable shaded nodes.
helios.shadedNodes(true);

# trackAttribute(trackerName, attribute) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 3822

Examples

// Track the index of the nodes, with a minimum proportion of 0.001, a smoothness of 0.8 and a maximum of 10 labels.
helios.trackAttribute("indexTracker","index",{minProportion:0.001,smoothness:0.8,maxLabels:20});

// Track the community attribute of the nodes, with a minimum proportion of 0.001, a smoothness of 0.8 and a maximum of 20 labels.
helios.trackAttribute("communityTracker","community",{minProportion:0.001,smoothness:0.8,maxLabels:20});

# trackingNodeUpdateInterval(interval) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 3895

Examples

// Set the tracker node update interval to 200ms.
helios._trackingBufferUpdateInterval(200);

// Get the tracker node update interval.
let interval = helios._trackingBufferUpdateInterval();
console.log(interval);

# trackingUpdateInterval(interval) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 3921

Examples

// Set the tracker update interval to 33ms.
helios._trackingUpdateInterval(33);

// Get the tracker update interval.
let interval = helios._trackingUpdateInterval();
console.log(interval);

# triggerHoverEvents(event, shallCancel)

Parameters:

View Source core/HeliosCore.js, line 962

Example

helios.triggerHoverEvents(event, false);

# untrackAttribute(attribute) → {Helios|this}

Parameters:

View Source core/HeliosCore.js, line 3862

Example

// Untrack the index of the nodes.
helios.untrackAttribute("indexTracker");

# update(immediateopt, nodesopt, edgesopt) → {this}

Parameters:

View Source core/HeliosCore.js, line 1753

Examples

// Update the network geometry
helios.update();

// Update the network geometry immediately
helios.update(true);

# updateAttributeTrackers() → {Helios|this}

View Source core/HeliosCore.js, line 3562

# updateDensityMap() → {this}

View Source core/HeliosCore.js, line 1187

# updateEdgesGeometry(forceopt) → {this}

Parameters:

View Source core/HeliosCore.js, line 1375

# updateNodesGeometry() → {this}

View Source core/HeliosCore.js, line 1206

# zoomFactor(zoomFactor, durationopt) → {this|number}

Parameters:

View Source core/HeliosCore.js, line 1599

Examples

// Set the zoom factor to 0.5
helios.zoomFactor(0.5);

// Set the zoom factor to 0.5 with an animation duration of 500 milliseconds
helios.zoomFactor(0.5, 500);

// Get the current zoom factor
let zoomFactor = helios.zoomFactor();