LayoutGraphHider

Provides functionality to temporarily hide and unhide nodes and edges of a graph.

Inheritance Hierarchy

LayoutGraphHider

Remarks

Hiding and unhiding graph elements is often useful during algorithmic operations where specific elements should be ignored.

This class allows hiding and restoring nodes and edges in a LayoutGraph without permanently removing them. The hidden elements are tracked, so they can be selectively restored when required. This can be especially useful in graph algorithms that need to work on a subgraph.

Type Details

yFiles module: algorithms

Constructors

LayoutGraphHider

(graph: LayoutGraph)

Initializes a new instance of the LayoutGraphHider class for the specified graph.

Parameters

options - Object
A map of options to pass to the method.

graph - LayoutGraph: The LayoutGraph to operate on. All non-static hiding and unhiding methods will modify this graph.

Throws

Exception({ name: 'ArgumentError' }): Thrown if the graph parameter is null.

Properties

hiddenEdges

: IEnumerable<LayoutEdge>

Gets the collection of edges that are currently hidden.

Property Value

An IEnumerable<Edge> representing the currently hidden edges.

hiddenNodes

: IEnumerable<LayoutNode>

Gets the collection of nodes that are currently hidden.

Property Value

An IEnumerable<Node> representing the currently hidden nodes.

Methods

hide

(node: LayoutNode)

Hides the specified node and all its adjacent edges.

Remarks

The specified node and all edges connected to it will be hidden and stored for later restoration.

Parameters

options - Object
A map of options to pass to the method.

node - LayoutNode: The LayoutNode to be hidden.

Throws

Exception({ name: 'ArgumentError' }): Thrown when the node parameter is null.

hide

(edge: LayoutEdge)

Hides the specified edge.

Remarks

The specified edge will be hidden and stored for later restoration.

Parameters

options - Object
A map of options to pass to the method.

edge - LayoutEdge: The LayoutEdge to be hidden.

Throws

Exception({ name: 'ArgumentError' }): Thrown when the edge parameter is null.

hideAll

()

Hides all nodes and edges in the graph.

Remarks

This method hides every node and edge in the graph and stores them for later restoration, e.g. using the unhideAll method.

hideEdges

(edges: IEnumerable<LayoutEdge>)

Hides the specified collection of edges.

Remarks

All edges in the collection will be hidden and stored for later restoration.

Parameters

options - Object
A map of options to pass to the method.

edges - IEnumerable<LayoutEdge>: A collection of LayoutEdge objects to be hidden.

Throws

Exception({ name: 'ArgumentError' }): Thrown when the edges parameter is null.

hideNodes

(nodes: IEnumerable<LayoutNode>)

Hides the specified collection of nodes and their adjacent edges.

Remarks

All specified nodes and their adjacent edges will be hidden and stored for later restoration.

Parameters

options - Object
A map of options to pass to the method.

nodes - IEnumerable<LayoutNode>: A collection of LayoutNode objects to be hidden.

Throws

Exception({ name: 'ArgumentError' }): Thrown when the nodes parameter is null.

showOnly

(nodes: IEnumerable<LayoutNode>, showAdjacentEdges?: boolean)

Hides all graph elements except the specified nodes and optionally their adjacent edges.

Remarks

All nodes and edges in the graph will be hidden except the specified nodes and, if requested, the edges between them.

Parameters

options - Object
A map of options to pass to the method.

nodes - IEnumerable<LayoutNode>: A collection of LayoutNode objects to remain visible.
showAdjacentEdges - boolean: If true, edges between the specified nodes will remain visible.

Throws

Exception({ name: 'ArgumentError' }): Thrown when the nodes parameter is null.

unhide

(edge: LayoutEdge)

Unhides the specified edge.

Remarks

The specified edge will be restored. Ensure that both endpoints of the edge are visible before calling this method.

Parameters

options - Object
A map of options to pass to the method.

edge - LayoutEdge: The LayoutEdge to be unhidden.

Throws

Exception({ name: 'ArgumentError' }): Thrown when the edge parameter is null.

unhide

(node: LayoutNode, unhideAdjacentEdges?: boolean)

Unhides the specified node and optionally its adjacent edges.

Remarks

The specified node and, if requested, its adjacent edges will be restored.

Parameters

options - Object
A map of options to pass to the method.

node - LayoutNode: The LayoutNode to be unhidden.
unhideAdjacentEdges - boolean: If true, adjacent edges will also be unhidden if the other endpoint is visible.

Throws

Exception({ name: 'ArgumentError' }): Thrown when the node parameter is null.

unhideAll

()

Unhides all previously hidden nodes and edges in the graph.

Remarks

Restores the visibility of all graph elements hidden by the hideAll or other hide operations.

unhideEdges

(edges: IEnumerable<LayoutEdge>)

Unhides the specified collection of edges.

Remarks

The specified edges will be restored. Ensure that both endpoints of each edge are visible before calling this method.

Parameters

options - Object
A map of options to pass to the method.

edges - IEnumerable<LayoutEdge>: A collection of LayoutEdge objects to be unhidden.

Throws

Exception({ name: 'ArgumentError' }): Thrown when the edges parameter is null.

unhideNodes

(nodes: IEnumerable<LayoutNode>, unhideAdjacentEdges?: boolean)

Unhides the specified collection of nodes and optionally their adjacent edges.

Remarks

The specified nodes and, if requested, their adjacent edges will be restored.

Parameters

options - Object
A map of options to pass to the method.

nodes - IEnumerable<LayoutNode>: A collection of LayoutNode objects to be unhidden.
unhideAdjacentEdges - boolean: If true, adjacent edges will also be unhidden if the other endpoint is visible.

Throws

Exception({ name: 'ArgumentError' }): Thrown when the nodes parameter is null.