graphana.graphs.visualization

Interface GraphVisualizer

All Known Implementing Classes:

JungVisualizer, StdVisualizer

public interface GraphVisualizer

Visualizer for a GraphLibrary instance.

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<java.lang.String>	getLayoutKeys() Enables iterating over all layout keys of the visualizer.
java.lang.String	getVisualizerKey() Returns the (unique) key of the visualizer.
<VertexType,EdgeType> java.awt.Component	visualizeGraph(GraphLibrary<VertexType,EdgeType> graph, java.lang.String layoutKeyParams, int initialWidth, int initialHeight, boolean enableManualUpdate, boolean enableModification) Visualizes the given graph.

Method Detail

visualizeGraph

<VertexType,EdgeType> java.awt.Component visualizeGraph(GraphLibrary<VertexType,EdgeType> graph,
                                                        java.lang.String layoutKeyParams,
                                                        int initialWidth,
                                                        int initialHeight,
                                                        boolean enableManualUpdate,
                                                        boolean enableModification)
                                                 throws ArrangeException

Visualizes the given graph.

Type Parameters:

VertexType - the type of the vertices of the graph.

EdgeType - the type of the edges of the graph.

Parameters:

graph - the graph to be visualized.

layoutKeyParams - one string containing the arguments to manipulate the layout.

initialWidth - the initial width of the output area.

initialHeight - the initial height of the output area.

enableManualUpdate - if true, then refreshing of the visualization must be done explicitly. Otherwise, the visualizer will periodically refresh or refresh automatically whenever it is necessary.

enableModification - if true, then the user can modify the graph instance foor example by inserting and deleting vertices.

Returns:

the component containing the visual graph output.

Throws:

ArrangeException - if the vertices can not be arranged.

getVisualizerKey

java.lang.String getVisualizerKey()

Returns the (unique) key of the visualizer.

Returns:

the key of the visualizer.

getLayoutKeys

java.lang.Iterable<java.lang.String> getLayoutKeys()

Enables iterating over all layout keys of the visualizer.

Returns:

Iterable for all layout keys.