API Reference
VisNetworkEdge
Represents an edge in a Vis Network diagram.
Inheritance
- Object
- VisNetworkEdge
Constructors
public VisNetworkEdge() #Methods
public VisNetworkEdge EdgeArrows(VisNetworkArrows arrows) #VisNetworkEdgeConfigures the arrows displayed on this edge.
Parameters
- arrows HtmlForgeX.VisNetworkArrows
- Arrow options.
Returns
The current VisNetworkEdge instance.
public VisNetworkEdge EdgeColor(RGBColor color) #VisNetworkEdgeSpecifies the edge color using a hex or CSS color string.
Parameters
- color System.String
- Color value.
Returns
The current VisNetworkEdge instance.
EdgeColor(HtmlForgeX.RGBColor color) #Specifies the edge color using an RGBColor instance.
Parameters
- color HtmlForgeX.RGBColor
- Color value.
Returns
The current VisNetworkEdge instance.
public VisNetworkEdge EdgeDashes(Boolean dashes = true) #VisNetworkEdgeEnables or disables dashed line style for the edge.
Parameters
- dashes System.Boolean = true
- Value indicating whether dashes should be used.
Returns
The current VisNetworkEdge instance.
public VisNetworkEdge EdgeLabel(String label) #VisNetworkEdgeSets the edge label displayed in the diagram.
Parameters
- label System.String
- Label text.
Returns
The current VisNetworkEdge instance.
public VisNetworkEdge EdgeLength(Double length) #VisNetworkEdgeSpecifies the ideal length of the edge in pixels.
Parameters
- length System.Double
- Length value.
Returns
The current VisNetworkEdge instance.
public VisNetworkEdge EdgePhysics(Boolean physics = true) #VisNetworkEdgeEnables or disables physics calculations for the edge.
Parameters
- physics System.Boolean = true
- True to enable physics.
Returns
The current VisNetworkEdge instance.
public VisNetworkEdge EdgeTitle(String title) #VisNetworkEdgeSets the edge tooltip title.
Parameters
- title System.String
- Title text.
Returns
The current VisNetworkEdge instance.
public VisNetworkEdge EdgeWidth(Double width) #VisNetworkEdgeSets the width of the edge line in pixels.
Parameters
- width System.Double
- Edge width.
Returns
The current VisNetworkEdge instance.
public VisNetworkEdge FromNode(Object from) #VisNetworkEdgeSets the identifier of the source node.
Parameters
- from System.Object
- Source node id.
Returns
The current VisNetworkEdge instance.
public VisNetworkEdge IdValue(Object id) #VisNetworkEdgeSets the identifier of the edge.
Parameters
- id System.Object
- Identifier value.
Returns
The current VisNetworkEdge instance.
public VisNetworkEdge SetCustom(String key, Object value) #VisNetworkEdgeSets a custom property on the edge that will be included in the output dictionary.
Parameters
- key System.String
- Property name.
- value System.Object
- Property value.
Returns
The current VisNetworkEdge instance.
public VisNetworkEdge ToNode(Object to) #VisNetworkEdgeSets the identifier of the destination node.
Parameters
- to System.Object
- Destination node id.
Returns
The current VisNetworkEdge instance.
Inherited Methods
Properties
public Object Id { get; set; } #Gets or sets the unique identifier of the edge.
public Object From { get; set; } #Gets or sets the identifier of the source node.
public Object To { get; set; } #Gets or sets the identifier of the destination node.
public String Label { get; set; } #Gets or sets the text label shown on the edge.
public String Title { get; set; } #Gets or sets the tooltip title for the edge.
public Nullable<VisNetworkArrows> Arrows { get; set; } #Gets or sets the arrows configuration for the edge.
public String Color { get; set; } #Gets or sets the color of the edge line.
public Nullable<Double> Width { get; set; } #Gets or sets the width of the edge line in pixels.
public Nullable<Boolean> Dashes { get; set; } #Gets or sets a value indicating whether the edge should be drawn with dashes.
public Nullable<Boolean> Physics { get; set; } #Gets or sets a value indicating whether physics calculations are enabled for the edge.
public Nullable<Double> Length { get; set; } #Gets or sets the ideal length of the edge in pixels.
public Dictionary<String, Object> Custom { get; } #Gets a dictionary of custom key/value pairs that will be serialized with the edge.
Extension Methods
public static VisNetworkEdgeOptions ToEdgeOptions(VisNetworkEdge edge) #VisNetworkEdgeOptionsConverts legacy VisNetworkEdge to new VisNetworkEdgeOptions.
Parameters
- edge HtmlForgeX.VisNetworkEdge