Interface IHighlightAlgorithm<TVertex, TEdge>

Represents a graph highlighting algorithm.

Namespace: GraphShape.Algorithms.Highlight
Assembly: GraphShape.dll
Syntax
public interface IHighlightAlgorithm<in TVertex, in TEdge>
    where TEdge : IEdge<TVertex>
Type Parameters
Name Description
TVertex

Vertex type.
TEdge

Edge type.

Properties

| Improve this Doc View Source

Parameters

Highlight parameters.

Declaration
IHighlightParameters Parameters { get; }
Property Value
Type Description
IHighlightParameters

Methods

| Improve this Doc View Source

IsParametersSettable(IHighlightParameters)

Checks if given highlight algorithm parameters can be set to this highlight algorithm.

Declaration
bool IsParametersSettable(IHighlightParameters parameters)
Parameters
Type Name Description
IHighlightParameters parameters

Highlight parameters to check.
Returns
Type Description
System.Boolean

True if parameters can be set, false otherwise.
| Improve this Doc View Source

OnEdgeHighlighting(TEdge)

Asks to highlight the given edge.

Declaration
bool OnEdgeHighlighting(TEdge edge)
Parameters
Type Name Description
TEdge edge

Edge to highlight.
Returns
Type Description
System.Boolean

True if the edge was highlighted, false otherwise.
Exceptions
Type Condition
System.ArgumentNullException

edge is null.
| Improve this Doc View Source

OnEdgeHighlightRemoving(TEdge)

Asks to remove the highlighting of the given edge.

Declaration
bool OnEdgeHighlightRemoving(TEdge edge)
Parameters
Type Name Description
TEdge edge

Edge to remove its highlighting.
Returns
Type Description
System.Boolean

True if the edge highlight was removed, false otherwise.
Exceptions
Type Condition
System.ArgumentNullException

edge is null.
| Improve this Doc View Source

OnVertexHighlighting(TVertex)

Asks to highlight the given vertex.

Declaration
bool OnVertexHighlighting(TVertex vertex)
Parameters
Type Name Description
TVertex vertex

Vertex to highlight.
Returns
Type Description
System.Boolean

True if the vertex was highlighted, false otherwise.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
| Improve this Doc View Source

OnVertexHighlightRemoving(TVertex)

Asks to remove the highlighting of the given vertex.

Declaration
bool OnVertexHighlightRemoving(TVertex vertex)
Parameters
Type Name Description
TVertex vertex

Vertex to remove its highlighting.
Returns
Type Description
System.Boolean

True if the vertex highlight was removed, false otherwise.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
| Improve this Doc View Source

ResetHighlight()

Resets the whole highlight.

Declaration
void ResetHighlight()
| Improve this Doc View Source

TrySetParameters(IHighlightParameters)

Tries to set the given highlight algorithm parameters.

Declaration
bool TrySetParameters(IHighlightParameters parameters)
Parameters
Type Name Description
IHighlightParameters parameters

Highlight parameters to set.
Returns
Type Description
System.Boolean

True if parameters were set, false otherwise.

Extension Methods