HtmlForgeX

API Reference

Class

VisNetworkSettings

Namespace HtmlForgeX
Assembly HtmlForgeX
Modifiers sealed

Settings sub-builder for VisNetwork to keep the root API small. Returned by VisNetwork.Settings(...) and chains back to the root via End.

Inheritance

  • Object
  • VisNetworkSettings

Methods

public VisNetworkSettings DataFromUrl(String url, Action<VisNetworkRemoteDataOptions> configure = null) #
Returns: VisNetworkSettings

Loads nodes/edges from a remote endpoint (avoids embedding huge graphs into HTML). The endpoint should return JSON: { "nodes": [...], "edges": [...] }.

Parameters

url System.String requiredposition: 0
configure System.Action{HtmlForgeX.VisNetworkRemoteDataOptions} = null optionalposition: 1
public VisNetworkSettings DisablePhysicsAfterStabilization(Boolean enable = true) #
Returns: VisNetworkSettings

Disables physics after stabilization completes (improves responsiveness for large graphs).

Parameters

enable System.Boolean = true optionalposition: 0
public VisNetwork End() #
Returns: VisNetwork

Returns the root VisNetwork to continue chaining.

public VisNetworkSettings Events(Action<VisNetworkEvents> configure) #
Returns: VisNetworkSettings

Configures event handlers.

Parameters

configure System.Action{HtmlForgeX.VisNetworkEvents} requiredposition: 0
public VisNetworkSettings Group(String groupName, Action<VisNetworkGroupOptions> configure) #
Returns: VisNetworkSettings

Configures a node group for consistent styling.

Parameters

groupName System.String requiredposition: 0
configure System.Action{HtmlForgeX.VisNetworkGroupOptions} requiredposition: 1
public VisNetworkSettings HierarchicalLayout(VisNetworkLayoutDirection direction = Ud) #
Returns: VisNetworkSettings

Enables hierarchical layout.

Parameters

direction HtmlForgeX.VisNetworkLayoutDirection = Ud optionalposition: 0
public VisNetworkSettings Id(String id) #
Returns: VisNetworkSettings

Sets the unique identifier for the network container.

Parameters

id System.String requiredposition: 0
public VisNetworkSettings Interaction(Action<VisNetworkInteractionOptions> configure) #
Returns: VisNetworkSettings

Configures interaction options.

Parameters

configure System.Action{HtmlForgeX.VisNetworkInteractionOptions} requiredposition: 0
public VisNetworkSettings Layout(Action<VisNetworkLayoutOptions> configure) #
Returns: VisNetworkSettings

Configures layout options.

Parameters

configure System.Action{HtmlForgeX.VisNetworkLayoutOptions} requiredposition: 0
public VisNetworkSettings LazyInit(Boolean enable = true) #
Returns: VisNetworkSettings

When enabled, initialization is deferred until the diagram becomes visible (e.g., inside inactive tabs/accordions/wizard steps).

Parameters

enable System.Boolean = true optionalposition: 0
public VisNetworkSettings LoadingBar(Boolean enable = true) #
Returns: VisNetworkSettings

Enable/disable the loading bar UI.

Parameters

enable System.Boolean = true optionalposition: 0
public VisNetworkSettings Manipulation(Action<VisNetworkManipulationOptions> configure) #
Returns: VisNetworkSettings

Configures manipulation options.

Parameters

configure System.Action{HtmlForgeX.VisNetworkManipulationOptions} requiredposition: 0
public VisNetworkSettings Options(Action<VisNetworkOptions> configure) #
Returns: VisNetworkSettings

Configures options.

Parameters

configure System.Action{HtmlForgeX.VisNetworkOptions} requiredposition: 0
public VisNetworkSettings PerformancePreset(VisNetworkPerformancePreset preset) #
Returns: VisNetworkSettings

Applies an opinionated performance preset (useful for hundreds/thousands of nodes/edges).

Parameters

preset HtmlForgeX.VisNetworkPerformancePreset requiredposition: 0
Physics 2 overloads
public VisNetworkSettings Physics(Action<VisNetworkPhysicsOptions> configure) #
Returns: VisNetworkSettings

Configures physics options.

Parameters

configure System.Action{HtmlForgeX.VisNetworkPhysicsOptions} requiredposition: 0
public VisNetworkSettings Physics(Boolean enabled = true) #
Returns: VisNetworkSettings

Enable/disable physics simulation.

Parameters

enabled System.Boolean = true optionalposition: 0
public VisNetworkSettings Size(String width, String height) #
Returns: VisNetworkSettings

Sets the size of the network container.

Parameters

width System.String requiredposition: 0
height System.String requiredposition: 1