Clarity.Vertex protocol (Clarity v0.1.1)
View SourceProtocol for vertices in the Clarity
graph.
Summary
Functions
Returns the shape to be used for the vertex in the graph visualization. This is used to determine how the vertex will be rendered in the graph.
Returns the group to which the vertex belongs in the graph. This is used for grouping vertexs in the visualization.
Returns a graph ID for the vertex, which is used to identify the vertex in the graph.
Returns the overview content for the vertex.
Renders the name of the vertex for display purposes. This is typically used in the UI to show the name of the vertex.
Returns the label for the type of the vertex. This is used for displaying the type of the vertex in the graph.
Returns a unique identifier for the vertex.
Types
@type t() :: term()
All the types that implement this protocol.
Functions
Returns the shape to be used for the vertex in the graph visualization. This is used to determine how the vertex will be rendered in the graph.
Returns the group to which the vertex belongs in the graph. This is used for grouping vertexs in the visualization.
Returns a graph ID for the vertex, which is used to identify the vertex in the graph.
Returns the overview content for the vertex.
Used for tooltips and other informational displays in the UI.
Careful: This component is rendered for every vertex in the graph, so it should be efficient.
Renders the name of the vertex for display purposes. This is typically used in the UI to show the name of the vertex.
Returns the label for the type of the vertex. This is used for displaying the type of the vertex in the graph.
Returns a unique identifier for the vertex.
Used for identifying vertexs in the graph, including in the UI of the dashboard.