API Reference
VisNetworkOptions
Represents comprehensive configuration options for VisNetwork.
Inheritance
- Object
- VisNetworkOptions
Constructors
public VisNetworkOptions() #Methods
public VisNetworkOptions WithAutoResize(Boolean autoResize = true) #VisNetworkOptionsSets AutoResize and returns the current options instance.
Parameters
- autoResize System.Boolean = true
- Whether the network should auto resize.
Returns
The current VisNetworkOptions instance.
public VisNetworkOptions WithClickToUse(Boolean clickToUse = true) #VisNetworkOptionsSets ClickToUse to enable or disable click activation.
Parameters
- clickToUse System.Boolean = true
- Whether click to use is required.
Returns
The current VisNetworkOptions instance.
public VisNetworkOptions WithConfigure(Action<VisNetworkConfigureOptions> configure) #VisNetworkOptionsEnables or disables the configuration panel.
Parameters
- enabled System.Boolean = true
- True to enable the panel.
Returns
The current VisNetworkOptions instance.
WithConfigure(HtmlForgeX.VisNetworkConfigureOptions configureOptions) #Sets the configuration panel options.
Parameters
- configureOptions HtmlForgeX.VisNetworkConfigureOptions
- Options to apply.
Returns
The current VisNetworkOptions instance.
WithConfigure(System.Action{HtmlForgeX.VisNetworkConfigureOptions} configure) #Configures the panel options via delegate.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkConfigureOptions}
- Delegate to configure the options.
Returns
The current VisNetworkOptions instance.
public VisNetworkOptions WithEdges(Action<VisNetworkEdgeGlobalOptions> configure) #VisNetworkOptionsConfigures global edge options.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkEdgeGlobalOptions}
- Delegate to configure edges.
Returns
The current VisNetworkOptions instance.
public VisNetworkOptions WithEvents(Action<VisNetworkEvents> configure) #VisNetworkOptionsConfigures network events.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkEvents}
- Delegate to configure events.
Returns
The current VisNetworkOptions instance.
public VisNetworkOptions WithGroup(String name, Action<VisNetworkGroupOptions> configure) #VisNetworkOptionsAdds or updates a group configuration by name.
Parameters
- name System.String
- Group name.
- configure System.Action{HtmlForgeX.VisNetworkGroupOptions}
- Delegate to configure the group.
Returns
The current VisNetworkOptions instance.
public VisNetworkOptions WithInteraction(Action<VisNetworkInteractionOptions> configure) #VisNetworkOptionsConfigures interaction options.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkInteractionOptions}
- Delegate to configure interactions.
Returns
The current VisNetworkOptions instance.
public VisNetworkOptions WithLayout(Action<VisNetworkLayoutOptions> configure) #VisNetworkOptionsConfigures layout options.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkLayoutOptions}
- Delegate to configure layout.
Returns
The current VisNetworkOptions instance.
public VisNetworkOptions WithLocale(VisNetworkLocale locale) #VisNetworkOptionsSets the Locale used to render the network.
Parameters
- locale HtmlForgeX.VisNetworkLocale
- The locale value.
Returns
The current VisNetworkOptions instance.
public VisNetworkOptions WithManipulation(Action<VisNetworkManipulationOptions> configure) #VisNetworkOptionsConfigures manipulation options.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkManipulationOptions}
- Delegate to configure manipulation.
Returns
The current VisNetworkOptions instance.
public VisNetworkOptions WithNodes(Action<VisNetworkNodeGlobalOptions> configure) #VisNetworkOptionsConfigures global node options.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkNodeGlobalOptions}
- Delegate to configure nodes.
Returns
The current VisNetworkOptions instance.
public VisNetworkOptions WithOption(String key, Object value) #VisNetworkOptionsSets a custom option that is not yet represented as a typed property.
Parameters
- key System.String
- value System.Object
public VisNetworkOptions WithPhysics(Action<VisNetworkPhysicsOptions> configure) #VisNetworkOptionsConfigures physics options.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkPhysicsOptions}
- Delegate to configure physics.
Returns
The current VisNetworkOptions instance.
public VisNetworkOptions WithSize(String width, String height) #VisNetworkOptionsSets the Width and Height of the network container.
Parameters
- width System.String
- Width value.
- height System.String
- Height value.
Returns
The current VisNetworkOptions instance.
Inherited Methods
Properties
public Nullable<Boolean> AutoResize { get; set; } #JsonPropertyName("autoResize") JsonIgnore(Condition = 3)Gets or sets a value indicating whether the network should automatically resize with its container.
public String Width { get; set; } #JsonPropertyName("width") JsonIgnore(Condition = 3)Gets or sets the width of the network container.
public String Height { get; set; } #JsonPropertyName("height") JsonIgnore(Condition = 3)Gets or sets the height of the network container.
public Nullable<VisNetworkLocale> Locale { get; set; } #JsonPropertyName("locale") JsonIgnore(Condition = 3)Gets or sets the locale to use when rendering the network.
public Object Locales { get; set; } #JsonPropertyName("locales") JsonIgnore(Condition = 3)Gets or sets custom locale definitions.
public Nullable<Boolean> ClickToUse { get; set; } #JsonPropertyName("clickToUse") JsonIgnore(Condition = 3)Gets or sets a value indicating whether the network requires click to activate.
public Object Configure { get; set; } #JsonPropertyName("configure") JsonIgnore(Condition = 3)Gets or sets the configuration panel options.
public VisNetworkEdgeGlobalOptions Edges { get; set; } #JsonPropertyName("edges") JsonIgnore(Condition = 3)Gets or sets global edge options applied to all edges.
public VisNetworkNodeGlobalOptions Nodes { get; set; } #JsonPropertyName("nodes") JsonIgnore(Condition = 3)Gets or sets global node options applied to all nodes.
public Dictionary<String, VisNetworkGroupOptions> Groups { get; set; } #JsonPropertyName("groups") JsonIgnore(Condition = 3)Gets or sets per-group visual options.
public VisNetworkLayoutOptions Layout { get; set; } #JsonPropertyName("layout") JsonIgnore(Condition = 3)Gets or sets layout options controlling how nodes are positioned.
public VisNetworkInteractionOptions Interaction { get; set; } #JsonPropertyName("interaction") JsonIgnore(Condition = 3)Gets or sets interaction options for user input.
public VisNetworkManipulationOptions Manipulation { get; set; } #JsonPropertyName("manipulation") JsonIgnore(Condition = 3)Gets or sets options that control node and edge manipulation tools.
public VisNetworkPhysicsOptions Physics { get; set; } #JsonPropertyName("physics") JsonIgnore(Condition = 3)Gets or sets physics simulation options.
public VisNetworkEvents Events { get; set; } #JsonIgnoreGets the events configuration. Events are not serialized to JSON and are handled separately.
public Dictionary<String, Object> AdditionalOptions { get; set; } #JsonExtensionData JsonIgnore(Condition = 3)Allows setting options not yet covered by the typed model (escape hatch for vis-network parity). Keys should match vis-network option names (typically camelCase).