Graph attributes

#.getAttribute

Returns the desired graph’s attribute or undefined if not found.

Example

graph.setAttribute('name', 'My Beautiful Graph');

const name = graph.getAttribute('name');

console.log(name);
>>> 'My Beautiful Graph'

Arguments

attribute string: name of the attribute to retrieve.

#.getAttributes

Returns the desired graph’s attributes.

Example

graph.setAttribute('name', 'My Beautiful Graph');
graph.setAttribute('color', 'blue');

graph.getAttributes();
>>> {
  name: 'My Beautiful Graph',
  color: 'blue'
}

#.hasAttribute

Returns whether the desired graph’s attribute is set.

Example

graph.setAttribute('name', 'My Beautiful Graph');

graph.hasAttribute('name');
>>> true

graph.hasNodeAttribute('color');
>>> false

#.setAttribute

Set the attribute of the graph to the given value.

Example

graph.setAttribute('name', 'My Beautiful Graph');

graph.getAttribute('name');
>>> 'My Beautiful Graph'

Arguments

attribute string: name of the attribute to set.
value any: value to set.

#.updateAttribute

Update the attribute of the graph using the provided function.

This method is very useful when performing tasks such as incrementing an attribute so you don’t have to first fetch the former value to compute the next one.

Note that if the attribute is not yet setted, the passed value will be undefined.

Example

graph.setAttribute('relevance', 10);

graph.updateAttribute('relevance', x => x + 1);

graph.getAttribute('relevance');
>>> 11

Arguments

attribute string: name of the attribute to update.
updater function: function used to perform the update.

#.removeAttribute

Remove the given graph’s attribute altogether.

Example

graph.setAttribute('name', 'My Beautiful Graph');

graph.removeAttribute('name');

graph.hasAttribute('name');
>>> false

#.replaceAttributes

Completely replace one graph’s attributes by the provided object.

Example

graph.setAttribute('name', 'My Beautiful Graph');

graph.replaceAttributes({
  name: 'My Different Graph',
  color: 'blue'
});

Arguments

attributes object: the new attributes.

#.mergeAttributes

Merge the current attributes of the graph with the provided object.

Example

graph.setAttribute('name', 'My Beautiful Graph');

graph.mergeAttributes({
  name: 'My Different Graph',
  color: 'blue'
});

Arguments

data object: data to merge.

#.updateAttributes

Update the current attributes of the graph using the provided function.

Example

graph.setAttribute('count', 1);

graph.updateAttributes(attr => {
  return {
    ...attr,
    count: attr.count + 1
  };
});

Arguments

updater function: updater function taking the graph attributes and returning the new ones.

Node attributes

#.getNodeAttribute

Returns the desired node’s attribute or undefined if not found..

Example

graph.addNode('Martha', {age: 34});

const age = graph.getNodeAttribute('Martha', 'age');

console.log(age);
>>> 34

Arguments

node any: the target node.
attribute string: name of the attribute to retrieve.

Variants

#.getSourceAttribute
#.getTargetAttribute
#.getOppositeAttribute

#.getNodeAttributes

Returns the desired node’s attributes.

Example

graph.addNode('Martha', {age: 34, eyes: 'blue'});

graph.getNodeAttributes('Martha');
>>> {
  age: 34,
  eyes: 'blue'
}

Variants

#.getSourceAttributes
#.getTargetAttributes
#.getOppositeAttributes

#.hasNodeAttribute

Returns whether the desired node’s attribute is set.

Example

graph.addNode('Martha', {eyes: 'blue'});

graph.hasNodeAttribute('Martha', 'eyes');
>>> true

graph.hasNodeAttribute('Martha', 'age');
>>> false

Variants

#.hasSourceAttribute
#.hasTargetAttribute
#.hasOppositeAttribute

#.setNodeAttribute

Set the attribute of a node to the given value.

Example

graph.addNode('Martha', {age: 36, eyes: 'blue'});

graph.setNodeAttribute('Martha', 'age', 34);

Arguments

node any: the node to update.
attribute string: name of the attribute to set.
value any: value to set.

Variants

#.setSourceAttribute
#.setTargetAttribute
#.setOppositeAttribute

#.updateNodeAttribute

Update the attribute of a node using the provided function.

This method is very useful when performing tasks such as incrementing an attribute so you don’t have to first fetch the former value to compute the next one.

Note that if the attribute is not yet setted, the passed value will be undefined.

Example

graph.addNode('Martha', {occurrences: 1});

graph.updateNodeAttribute('Martha', 'occurrences', n => n + 1);

Arguments

node any: the node to update.
attribute string: name of the attribute to update.
updater function: function used to perform the update.

Variants

#.updateSourceAttribute
#.updateTargetAttribute
#.updateOppositeAttribute

#.removeNodeAttribute

Remove the given node’s attribute altogether.

Example

graph.addNode('Martha', {age: 34});

graph.removeNodeAttribute('Martha', 'age');

graph.hasNodeAttribute('Martha', 'age');
>>> false

Variants

#.removeSourceAttribute
#.removeTargetAttribute
#.removeOppositeAttribute

#.replaceNodeAttributes

Completely replace one node’s attributes by the provided object.

Example

graph.addNode('Martha', {age: 36, eyes: 'blue'});

graph.replaceNodeAttributes('Martha', {
  age: 34,
  eyes: 'green'
});

Arguments

node any: the node to update.
attributes object: the new attributes.

Variants

#.replaceSourceAttributes
#.replaceTargetAttributes
#.replaceOppositeAttributes

#.mergeNodeAttributes

Merge the current attributes of a node with the provided object.

Example

graph.addNode('Martha', {age: 36, eyes: 'blue'});

graph.mergeNodeAttributes('Martha', {age: 34, hair: 'brown'});

Arguments

node any: the node to update.
data object: data to merge.

Variants

#.mergeSourceAttributes
#.mergeTargetAttributes
#.mergeOppositeAttributes

#.updateNodeAttributes

Update the current attributes of a node using the provided function.

Example

graph.addNode('Martha', {occurrences: 36, eyes: 'blue'});

graph.updateNodeAttributes('Martha', attr => {
  return {
    ...attr,
    occurrences: attr.occurrences + 1
  };
});

Arguments

node any: the node to update.
updater function: updater function taking the node attributes and returning the new ones.

Variants

#.updateSourceAttributes
#.updateTargetAttributes
#.updateOppositeAttributes

#.updateEachNodeAttributes

Update each node’s attributes using the given function. This is usually the most performant function to update node attributes in batch.

Note that you can optionally pass hints regarding the updated attribute names so that people listening to the emitted events can handle the situation more efficiently.

Example

graph.addNode('Martha', {age: 34});
graph.addNode('Lara', {age: 78});

graph.updateEachNodeAttributes((node, attr) => {
  return {
    ...attr,
    age: attr.age + 1
  };
});

graph.nodes().map(n => graph.getNodeAttribute(n, 'age'));
>>> [35, 79]

// Note that you can indicate hints
graph.updateEachNodeAttributes((node, attr) => {
  return {
    ...attr,
    age: attr.age + 1
  };
}, {attributes: ['age']}); // <-- here

Arguments

updater function: the udpater function.
hints [object]: optional hints to emit as part of the eachNodeAttributesUpdated event:
- attributes [array]: an array of attribute names that will be updated by your action.

Callback arguments

node string: the node’s key.
attributes object: the node’s attributes.

Edge attributes

#.getEdgeAttribute

Returns the desired edge’s attribute or undefined if not found.

Example

graph.addNode('Martha');
graph.addNode('Catherine');
const edge = graph.addEdge('Martha', 'Catherine', {type: 'KNOWS'});

// Using the edge's key:
graph.getEdgeAttribute(edge, 'type');
>>> 'KNOWS'

// Using the edge's source & target:
graph.getEdgeAttribute('Martha', 'Catherine', 'type');
>>> 'KNOWS'

Arguments

Using the key:
- edge any: the target edge.
- attribute string: name of the attribute to retrieve.
Using the source & target:
- source any: source of the edge.
- target any: target of the edge.
- attribute string: name of the attribute to retrieve.

Variants

#.getDirectedEdgeAttribute
#.getUndirectedEdgeAttribute

#.getEdgeAttributes

Returns the desired edge’s attributes.

Example

graph.addNode('Martha');
graph.addNode('Catherine');
const edge = graph.addEdge('Martha', 'Catherine', {type: 'KNOWS', weight: 2});

// Using the edge's key:
const attributes = graph.getEdgeAttributes(edge);

// Using the edge's source & target:
graph.getEdgeAttributes('Martha', 'Catherine');
>>> {
  type: 'KNOWS',
  weight: 2
}

Arguments

Using the key:
- edge any: the target edge.
Using the source & target:
- source any: source of the edge.
- target any: target of the edge.

Variants

#.getDirectedEdgeAttributes
#.getUndirectedEdgeAttributes

#.hasEdgeAttribute

Returns whether the desired edge’s attribute is set.

Example

graph.addNode('Martha');
graph.addNode('Catherine');
const edge = graph.addEdge('Martha', 'Catherine', {type: 'KNOWS'});

// Using the edge's key:
const type = graph.hasEdgeAttribute(edge, 'type');
>>> true

// Using the edge's source & target:
graph.hasEdgeAttribute('Martha', 'Catherine', 'type');
>>> 'KNOWS'

Arguments

Using the key:
- edge any: the target edge.
- attribute string: name of the attribute to poll.
Using the source & target:
- source any: source of the edge.
- target any: target of the edge.
- attribute string: name of the attribute to poll.

Variants

#.hasDirectedEdgeAttribute
#.hasUndirectedEdgeAttribute

#.setEdgeAttribute

Set the attribute of an edge to the given value.

Example

graph.addNode('Martha');
graph.addNode('Jack');
const edge = graph.addEdge('Martha', 'Jack', {type: 'KNOWS'});

// Using the edge's key:
graph.setEdgeAttribute(edge, 'type', 'LIKES');

// Using the edge's source & target:
graph.setEdgeAttribute('Martha', 'Jack', 'type', 'LIKES');

Arguments

Using the key:
- edge any: the edge to update.
- attribute string: name of the attribute to set.
- value any: value to set.
Using the source & target:
- source any: source of the edge.
- target any: target of the edge.
- attribute string: name of the attribute to set.
- value any: value to set.

Variants

#.setDirectedEdgeAttribute
#.setUndirectedEdgeAttribute

#.updateEdgeAttribute

Update the attribute of an edge using the provided function.

This method is very useful when performing tasks such as incrementing an attribute so you don’t have to first fetch the former value to compute the next one.

Note that if the attribute is not yet setted, the passed value will be undefined.

Example

graph.addNode('Martha');
graph.addNode('Jack');
const edge = graph.addEdge('Martha', 'Jack', {weight: 1});

// Using the edge's key:
graph.updateEdgeAttribute(edge, 'weight', n => n + 1);

// Using the edge's source & target:
graph.updateEdgeAttribute('Martha', 'Jack', 'weight', n => n + 1);

Arguments

Using the key:
- edge any: the edge to update.
- attribute string: name of the attribute to update.
- updater function: function used to perform the update.
Using the source & target:
- source any: source of the edge.
- target any: target of the edge.
- attribute string: name of the attribute to update.
- updater function: function used to perform the update.

Variants

#.updateDirectedEdgeAttribute
#.updateUndirectedEdgeAttribute

#.removeEdgeAttribute

Remove the given edge’s attribute altogether.

Example

graph.addNode('Martha');
graph.addNode('Jack');
const edge = graph.addEdge('Martha', 'Jack', {type: 'KNOWS'});

// Using the edge's key:
graph.removeEdgeAttribute(edge, 'type');

// Using the edge's source & target:
graph.removeEdgeAttribute('Martha', 'Jack', 'type');

graph.hasEdgeAttribute(edge, 'type');
>>> false

Arguments

Using the key:
- edge any: the edge to update.
- attribute string: name of the attribute to set.
Using the source & target:
- source any: source of the edge.
- target any: target of the edge.
- attribute string: name of the attribute to set.

Variants

#.removeDirectedEdgeAttribute
#.removeUndirectedEdgeAttribute

#.replaceEdgeAttributes

Completely replace one edge’s attributes by the provided object.

Example

graph.addNode('Martha');
graph.addNode('Jack');
const edge = graph.addEdge('Martha', 'Jack', {type: 'KNOWS', weight: 1});

// Using the edge's key:
graph.replaceEdgeAttributes(edge, {type: 'LIKES', weight: 3});

// Using the edge's source & target:
graph.replaceEdgeAttributes('Martha', 'Jack', {type: 'LIKES', weight: 3}));

Arguments

Using the key:
- edge any: the edge to update.
- attributes object: the new attributes.
Using the source & target:
- source any: source of the edge.
- target any: target of the edge.
- attributes object: the new attributes.

Variants

#.replaceDirectedEdgeAttributes
#.replaceUndirectedEdgeAttributes

#.mergeEdgeAttributes

Merge the current attributes of an edge with the provided object.

Example

graph.addNode('Martha');
graph.addNode('Jack');
const edge = graph.addEdge('Martha', 'Jack', {type: 'KNOWS'});

// Using the edge's key:
graph.mergeEdgeAttributes(edge, {type: 'LIKES', weight: 3});

// Using the edge's source & target:
graph.mergeEdgeAttributes('Martha', 'Jack', {type: 'LIKES', weight: 3}));

Arguments

Using the key:
- edge any: the edge to update.
- data object: data to merge.
Using the source & target:
- source any: source of the edge.
- target any: target of the edge.
- data object: data to merge.

Variants

#.mergeDirectedEdgeAttributes
#.mergeUndirectedEdgeAttributes

#.updateEdgeAttributes

Update the current attributes of an edge using the provided function.

Example

graph.addNode('Martha');
graph.addNode('Jack');
const edge = graph.addEdge('Martha', 'Jack', {type: 'KNOWS', weight: 3});

// Using the edge's key:
graph.updateEdgeAttributes(edge, attr => {
  return {
    ...attr,
    weight: attr.weight + 1
  };
});

// Using the edge's source & target:
graph.updateEdgeAttributes('Martha', 'Jack', attr => {
  return {
    ...attr,
    weight: attr.weight + 1
  };
});

Arguments

Using the key:
- edge any: the edge to update.
- updater function: updater function taking the edge attributes and returning the new ones.
Using the source & target:
- source any: source of the edge.
- target any: target of the edge.
- updater function: updater function taking the edge attributes and returning the new ones.

Variants

#.updateDirectedEdgeAttributes
#.updateUndirectedEdgeAttributes

#.updateEachEdgeAttributes

Update each edge’s attributes using the given function. This is usually the most performant function to update edge attributes in batch.

Note that you can optionally pass hints regarding the updated attribute names so that people listening to the emitted events can handle the situation more efficiently.

Example

graph.mergeEdge('Martha', 'John', {weight: 12});
graph.mergeEdge('Lucy', 'Martin', {weight: 4})

graph.updateEachEdgeAttributes((edge, attr) => {
  return {
    ...attr,
    weight: attr.weight * 2
  };
});

graph.edges().map(e => graph.getEdgeAttribute(e, 'weight'));
>>> [24, 8]

// Note that you can indicate hints
graph.updateEachEdgeAttributes((edge, attr) => {
  return {
    ...attr,
    weight: attr.weight * 2
  };
}, {attributes: ['weight']}); // <-- here

Arguments

updater function: the udpater function.
hints [object]: optional hints to emit as part of the eachEdgeAttributesUpdated event:
- attributes [array]: an array of attribute names that will be updated by your action.

Callback arguments

edge string: the edge’s key.
attributes object: the edge’s attributes.
source string: key of the edge’s source.
target string: key of the edge’s target.
sourceAttributes object: attributes of the edge’s source.
targetAttributes object= attributes of the edge’s target.
undirected boolean: whether the edge is undirected.