API Reference
VisNetworkEdgeOptions
Represents comprehensive configuration options for an edge in VisNetwork.
Inheritance
- Object
- VisNetworkEdgeOptions
Constructors
public VisNetworkEdgeOptions() #Methods
public VisNetworkEdgeOptions WithArrows(Action<VisNetworkArrowOptions> configure) #VisNetworkEdgeOptionsConfigures the arrows.
Parameters
- arrows HtmlForgeX.VisNetworkArrowOptions
WithArrows(System.Action{HtmlForgeX.VisNetworkArrowOptions} configure) #Configures the arrows.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkArrowOptions}
public VisNetworkEdgeOptions WithArrowStrikethrough(Boolean strikethrough = true) #VisNetworkEdgeOptionsConfigures the arrow strikethrough.
Parameters
- strikethrough System.Boolean = true
public VisNetworkEdgeOptions WithChosen(VisNetworkChosenEdgeOptions chosenOptions) #VisNetworkEdgeOptionsConfigures the chosen.
Parameters
- enabled System.Boolean = true
WithChosen(HtmlForgeX.VisNetworkChosenEdgeOptions chosenOptions) #Configures the chosen.
Parameters
- chosenOptions HtmlForgeX.VisNetworkChosenEdgeOptions
public VisNetworkEdgeOptions WithColor(Action<VisNetworkAdvancedColorOptions> configure) #VisNetworkEdgeOptionsConfigures the color.
Parameters
- color HtmlForgeX.RGBColor
public VisNetworkEdgeOptions WithColor(String color) #VisNetworkEdgeOptionsConfigures the color.
Parameters
- color System.String
WithColor(HtmlForgeX.VisNetworkAdvancedColorOptions colorOptions) #Configures the color using advanced color options.
Parameters
- colorOptions HtmlForgeX.VisNetworkAdvancedColorOptions
WithColor(System.Action{HtmlForgeX.VisNetworkAdvancedColorOptions} configure) #Configures the color using advanced color options.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkAdvancedColorOptions}
public VisNetworkEdgeOptions WithConnection(Object from, Object to) #VisNetworkEdgeOptionsConfigures the connection.
Parameters
- from System.Object
- to System.Object
public VisNetworkEdgeOptions WithDashes(VisNetworkDashPattern pattern) #VisNetworkEdgeOptionsEnables or disables dashed lines for the edge.
Parameters
- enabled System.Boolean = true
- True to enable dashed lines, false for solid lines
Returns
The edge options for method chaining
public VisNetworkEdgeOptions WithDashes(params Int32[] pattern) #VisNetworkEdgeOptionsSets a custom dash pattern for the edge line.
Parameters
- pattern System.Int32[]
- An array of integers representing dash and gap lengths
Returns
The edge options for method chaining
WithDashes(HtmlForgeX.VisNetworkDashPattern pattern) #Sets a predefined dash pattern for the edge line.
Parameters
- pattern HtmlForgeX.VisNetworkDashPattern
- The dash pattern to use
Returns
The edge options for method chaining
public VisNetworkEdgeOptions WithEndPointOffset(Action<VisNetworkEndPointOffset> configure) #VisNetworkEdgeOptionsConfigures the end point offset.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkEndPointOffset}
public VisNetworkEdgeOptions WithFont(Action<VisNetworkFontOptions> configure) #VisNetworkEdgeOptionsConfigures the font.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkFontOptions}
public VisNetworkEdgeOptions WithGradientColor(RGBColor fromColor, RGBColor toColor) #VisNetworkEdgeOptionsSets a gradient color for the edge that transitions from one color to another. The gradient follows the edge direction from source to target.
Parameters
- fromColor HtmlForgeX.RGBColor
- The color at the start of the edge (source node)
- toColor HtmlForgeX.RGBColor
- The color at the end of the edge (target node)
Returns
The edge options for method chaining
public VisNetworkEdgeOptions WithGradientColor(String fromColor, String toColor) #VisNetworkEdgeOptionsSets a gradient color for the edge using color strings.
Parameters
- fromColor System.String
- The color at the start of the edge (source node)
- toColor System.String
- The color at the end of the edge (target node)
Returns
The edge options for method chaining
public VisNetworkEdgeOptions WithHtmlLabel(String htmlLabel) #VisNetworkEdgeOptionsSets an HTML-formatted label with multi-line support. Automatically enables HTML multi-line mode.
Parameters
- htmlLabel System.String
- The HTML-formatted label content
Returns
The edge options for method chaining
public VisNetworkEdgeOptions WithId(Object id) #VisNetworkEdgeOptionsConfigures the id.
Parameters
- id System.Object
public VisNetworkEdgeOptions WithLabel(String label) #VisNetworkEdgeOptionsConfigures the label.
Parameters
- label System.String
public VisNetworkEdgeOptions WithLabelHighlightBold(Boolean highlightBold = true) #VisNetworkEdgeOptionsConfigures the label highlight bold.
Parameters
- highlightBold System.Boolean = true
public VisNetworkEdgeOptions WithLength(Double length) #VisNetworkEdgeOptionsConfigures the length.
Parameters
- length System.Double
public VisNetworkEdgeOptions WithMarkdownLabel(String markdownLabel) #VisNetworkEdgeOptionsSets a Markdown-formatted label with multi-line support. Automatically enables Markdown multi-line mode.
Parameters
- markdownLabel System.String
- The Markdown-formatted label content
Returns
The edge options for method chaining
public VisNetworkEdgeOptions WithOption(String key, Object value) #VisNetworkEdgeOptionsSets a custom option that is not yet represented as a typed property.
Parameters
- key System.String
- value System.Object
public VisNetworkEdgeOptions WithPhysics(Boolean physics = true) #VisNetworkEdgeOptionsConfigures the physics.
Parameters
- physics System.Boolean = true
public VisNetworkEdgeOptions WithScaling(Action<VisNetworkScalingOptions> configure) #VisNetworkEdgeOptionsConfigures the scaling.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkScalingOptions}
public VisNetworkEdgeOptions WithSelfReference(Action<VisNetworkSelfReferenceOptions> configure) #VisNetworkEdgeOptionsConfigures the self reference.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkSelfReferenceOptions}
public VisNetworkEdgeOptions WithSelfReferenceSize(Double size) #VisNetworkEdgeOptionsConfigures the self reference size.
Parameters
- size System.Double
public VisNetworkEdgeOptions WithShadow(VisNetworkShadowOptions shadowOptions) #VisNetworkEdgeOptionsConfigures the shadow.
Parameters
- enabled System.Boolean = true
WithShadow(HtmlForgeX.VisNetworkShadowOptions shadowOptions) #Configures the shadow.
Parameters
- shadowOptions HtmlForgeX.VisNetworkShadowOptions
public VisNetworkEdgeOptions WithSmooth(Action<VisNetworkSmoothOptions> configure) #VisNetworkEdgeOptionsConfigures the smooth.
Parameters
- enabled System.Boolean = true
WithSmooth(HtmlForgeX.VisNetworkSmoothOptions smoothOptions) #Configures the smooth.
Parameters
- smoothOptions HtmlForgeX.VisNetworkSmoothOptions
WithSmooth(System.Action{HtmlForgeX.VisNetworkSmoothOptions} configure) #Configures the smooth.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkSmoothOptions}
public VisNetworkEdgeOptions WithTitle(String title) #VisNetworkEdgeOptionsConfigures the title.
Parameters
- title System.String
public VisNetworkEdgeOptions WithValue(Double value) #VisNetworkEdgeOptionsConfigures the value.
Parameters
- value System.Double
public VisNetworkEdgeOptions WithWidth(Double width, Nullable<Double> selectionWidth = null, Nullable<Double> hoverWidth = null) #VisNetworkEdgeOptionsConfigures the width.
Parameters
- width System.Double
- selectionWidth System.Nullable{System.Double} = null
- hoverWidth System.Nullable{System.Double} = null
public VisNetworkEdgeOptions WithWidthConstraint(Nullable<Double> maximum = null) #VisNetworkEdgeOptionsConfigures the width constraint.
Parameters
- maximum System.Nullable{System.Double} = null
Inherited Methods
Properties
public String Label { get; set; } #JsonPropertyName("label") JsonIgnore(Condition = 3)Gets or sets the label.
public String Title { get; set; } #JsonPropertyName("title") JsonIgnore(Condition = 3)Gets or sets the title.
public Nullable<Double> Value { get; set; } #JsonPropertyName("value") JsonIgnore(Condition = 3)Gets or sets the value.
public Nullable<Double> Length { get; set; } #JsonPropertyName("length") JsonIgnore(Condition = 3)Gets or sets the length.
public Nullable<Double> Width { get; set; } #JsonPropertyName("width") JsonIgnore(Condition = 3)Gets or sets the width.
public Object WidthConstraint { get; set; } #JsonPropertyName("widthConstraint") JsonIgnore(Condition = 3)Gets or sets the width constraint.
public Nullable<Double> SelectionWidth { get; set; } #JsonPropertyName("selectionWidth") JsonIgnore(Condition = 3)Gets or sets the selection width.
public Object Arrows { get; set; } #JsonPropertyName("arrows") JsonIgnore(Condition = 3)Gets or sets the arrows.
public Nullable<Boolean> ArrowStrikethrough { get; set; } #JsonPropertyName("arrowStrikethrough") JsonIgnore(Condition = 3)Gets or sets the arrow strikethrough.
public Object Chosen { get; set; } #JsonPropertyName("chosen") JsonIgnore(Condition = 3)Gets or sets the chosen.
public Object Color { get; set; } #JsonPropertyName("color") JsonIgnore(Condition = 3)Gets or sets the color.
public Object Dashes { get; set; } #JsonPropertyName("dashes") JsonIgnore(Condition = 3)Gets or sets the dashes.
public VisNetworkFontOptions Font { get; set; } #JsonPropertyName("font") JsonIgnore(Condition = 3)Gets or sets the font.
public Nullable<Double> HoverWidth { get; set; } #JsonPropertyName("hoverWidth") JsonIgnore(Condition = 3)Gets or sets the hover width.
public Nullable<Boolean> LabelHighlightBold { get; set; } #JsonPropertyName("labelHighlightBold") JsonIgnore(Condition = 3)Gets or sets the label highlight bold.
public Nullable<Boolean> Physics { get; set; } #JsonPropertyName("physics") JsonIgnore(Condition = 3)Gets or sets the physics.
public VisNetworkScalingOptions Scaling { get; set; } #JsonPropertyName("scaling") JsonIgnore(Condition = 3)Gets or sets the scaling.
public Nullable<Double> SelfReferenceSize { get; set; } #JsonPropertyName("selfReferenceSize") JsonIgnore(Condition = 3)Gets or sets the self reference size.
public VisNetworkSelfReferenceOptions SelfReference { get; set; } #JsonPropertyName("selfReference") JsonIgnore(Condition = 3)Gets or sets the self reference.
public Object Shadow { get; set; } #JsonPropertyName("shadow") JsonIgnore(Condition = 3)Gets or sets the shadow.
public Object Smooth { get; set; } #JsonPropertyName("smooth") JsonIgnore(Condition = 3)Gets or sets the smooth.
public VisNetworkEndPointOffset EndPointOffset { get; set; } #JsonPropertyName("endPointOffset") JsonIgnore(Condition = 3)Gets or sets the end point offset.
public Dictionary<String, Object> AdditionalOptions { get; set; } #JsonExtensionData JsonIgnore(Condition = 3)Allows setting edge options not yet covered by the typed model (escape hatch for vis-network parity). Keys should match vis-network option names (typically camelCase).