Class: HighlightHostTransformation

HighlightHostTransformation

HighlightHostTransformation "highlights" a set of hosts by removing all edges not incident on the set of highlighted nodes. The highlighted hosts are drawn with a border to distinguish them from unhighlighted ones.

In the case that the set of hosts to highlight is empty, this transformation does nothing. In the case that a specified host does not exist, it is ignored.

Constructor

new HighlightHostTransformation(host)

Constructs a HighlightHostTransformation that highlights the specified host
Parameters:
Name Type Description
host String The host to highlight
Source:

Extends

Methods

addHost(host)

Adds a host to the set of hosts to highlight.
Parameters:
Name Type Description
host String
Source:

clearHosts()

Removes all hosts that are to be highlighted. No hosts will be highlighted by this transformation after running this method.
Source:

getHiddenHosts() → {Array.<String>}

Gets the hosts that are hidden by the transformation.

When hosts are highlighted, irrelevant hosts will be hidden. This method returns those implicitly hidden hosts (not the hosts that are specified to be hidden). Since the hosts to be hidden are only calculated when the transform method is invoked, this method will return the implicity hidden hosts from the last call to transform. If transform has yet to be called, this method returns an empty array.

Source:
Returns:
The array of hosts.
Type
Array.<String>

getHosts() → {Array.<String>}

Gets the highlighted host(s)
Source:
Returns:
A list of highlighted hosts
Type
Array.<String>

removeHost(host)

Removes a host from the set of hosts to highlight. In the case that the provided host isn't in the set of hosts to highlight, this method does nothing.
Parameters:
Name Type Description
host String
Source:

toggleHost(host)

Toggles a host to and from the set of hosts to highlight. In other words, if a host is currently in the set of hosts to highlight, it is removed and if it isn't in that set, it is added to that set.
Parameters:
Name Type Description
host String
Source:

transform()

Overrides Transformation#transform
Overrides:
Source: