API Reference
VisNetworkNode
Represents a node in a Vis Network diagram.
Inheritance
- Object
- VisNetworkNode
Constructors
public VisNetworkNode() #Methods
public VisNetworkNode IdValue(Object id) #VisNetworkNodeSets the node identifier.
Parameters
- id System.Object
- Identifier value.
Returns
The current VisNetworkNode instance.
public VisNetworkNode LabelText(String label) #VisNetworkNodeSets the text label shown on the node.
Parameters
- label System.String
- Label text.
Returns
The current VisNetworkNode instance.
public VisNetworkNode NodeColor(RGBColor color) #VisNetworkNodeSets the node color using a CSS color string.
Parameters
- color System.String
- Color value.
Returns
The current VisNetworkNode instance.
NodeColor(HtmlForgeX.RGBColor color) #Sets the node color using an RGBColor object.
Parameters
- color HtmlForgeX.RGBColor
- Color instance.
Returns
The current VisNetworkNode instance.
public VisNetworkNode NodeGroup(String group) #VisNetworkNodeAssigns the node to a group.
Parameters
- group System.String
- Group name.
Returns
The current VisNetworkNode instance.
public VisNetworkNode NodePhysics(Boolean physics = true) #VisNetworkNodeEnables or disables physics calculations for the node.
Parameters
- physics System.Boolean = true
- True to enable physics.
Returns
The current VisNetworkNode instance.
public VisNetworkNode NodeShape(VisNetworkNodeShape shape) #VisNetworkNodeSets the visual shape of the node.
Parameters
- shape HtmlForgeX.VisNetworkNodeShape
- Shape type.
Returns
The current VisNetworkNode instance.
public VisNetworkNode NodeSize(Double size) #VisNetworkNodeSets the size of the node.
Parameters
- size System.Double
- Size value.
Returns
The current VisNetworkNode instance.
public VisNetworkNode Position(Double x, Double y) #VisNetworkNodeSets the initial position of the node.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
Returns
The current VisNetworkNode instance.
public VisNetworkNode SetCustom(String key, Object value) #VisNetworkNodeAdds a custom property that will be serialized with the node.
Parameters
- key System.String
- Property name.
- value System.Object
- Property value.
Returns
The current VisNetworkNode instance.
public VisNetworkNode TitleText(String title) #VisNetworkNodeSets the tooltip title for the node.
Parameters
- title System.String
- Title text.
Returns
The current VisNetworkNode instance.
public VisNetworkNode UseImage(String url) #VisNetworkNodeUses an external image for the node.
Parameters
- url System.String
- URL of the image.
Returns
The current VisNetworkNode instance.
public VisNetworkNode UseImageOffline(String source, Int32 timeoutSeconds = 30) #VisNetworkNodeEmbeds an image from a file or URL into the document.
Parameters
- source System.String
- Local path or URL of the image.
- timeoutSeconds System.Int32 = 30
- Download timeout in seconds.
Returns
The current VisNetworkNode instance.
public VisNetworkNode WithoutAutoEmbedding() #VisNetworkNodePrevents the library from automatically embedding the image when offline mode is active.
Returns
The current VisNetworkNode instance.
Inherited Methods
Properties
public Object Id { get; set; } #Gets or sets the unique identifier of the node.
public String Label { get; set; } #Gets or sets the text label displayed inside the node.
public String Title { get; set; } #Gets or sets the tooltip title shown when hovering over the node.
public String Image { get; set; } #Gets or sets the image URL or data URI used when the Shape is set to Image.
public Nullable<VisNetworkNodeShape> Shape { get; set; } #Gets or sets the visual representation of the node.
public String Group { get; set; } #Gets or sets the optional group name for the node.
public String Color { get; set; } #Gets or sets the color of the node using a CSS color string.
public Nullable<Double> Size { get; set; } #Gets or sets the size of the node in pixels.
public Nullable<Boolean> Physics { get; set; } #Gets or sets a value indicating whether physics calculations are enabled for this node.
public Nullable<Double> X { get; set; } #Gets or sets the X coordinate used for the initial positioning of the node.
public Nullable<Double> Y { get; set; } #Gets or sets the Y coordinate used for the initial positioning of the node.
public Boolean SkipAutoEmbedding { get; set; } #Gets or sets a value indicating whether automatic image embedding should be skipped when offline mode is active.
public Dictionary<String, Object> Custom { get; } #Gets a dictionary of custom key/value pairs that will be serialized along with the node definition.
Extension Methods
public static VisNetworkNodeOptions ToNodeOptions(VisNetworkNode node) #VisNetworkNodeOptionsConverts legacy VisNetworkNode to new VisNetworkNodeOptions.
Parameters
- node HtmlForgeX.VisNetworkNode