HtmlForgeX

API Reference

Class

VisNetworkLayoutOptions

Namespace HtmlForgeX
Assembly HtmlForgeX

Layout configuration options.

Inheritance

  • Object
  • VisNetworkLayoutOptions

Constructors

public VisNetworkLayoutOptions() #

Methods

public VisNetworkLayoutOptions WithClusterThreshold(Int32 threshold) #
Returns: VisNetworkLayoutOptions

Sets the ClusterThreshold property.

Parameters

threshold System.Int32 requiredposition: 0
Cluster threshold value.

Returns

The current VisNetworkLayoutOptions instance.

WithHierarchical 3 overloads
public VisNetworkLayoutOptions WithHierarchical(Action<VisNetworkHierarchicalOptions> configure) #
Returns: VisNetworkLayoutOptions

Enables or disables hierarchical layout.

Parameters

enabled System.Boolean = true requiredposition: 0
True to enable hierarchical layout.

Returns

The current VisNetworkLayoutOptions instance.

WithHierarchical(HtmlForgeX.VisNetworkHierarchicalOptions hierarchicalOptions) #

Sets the hierarchical layout options.

Parameters

hierarchicalOptions HtmlForgeX.VisNetworkHierarchicalOptions required
Options to apply.

Returns

The current VisNetworkLayoutOptions instance.

WithHierarchical(System.Action{HtmlForgeX.VisNetworkHierarchicalOptions} configure) #

Configures hierarchical layout options via delegate.

Parameters

configure System.Action{HtmlForgeX.VisNetworkHierarchicalOptions} required
Delegate to configure hierarchical options.

Returns

The current VisNetworkLayoutOptions instance.

public VisNetworkLayoutOptions WithImprovedLayout(Boolean improved = true) #
Returns: VisNetworkLayoutOptions

Enables or disables improved layout heuristics.

Parameters

improved System.Boolean = true optionalposition: 0
True to enable improved layout.

Returns

The current VisNetworkLayoutOptions instance.

public VisNetworkLayoutOptions WithRandomSeed(Int32 seed) #
Returns: VisNetworkLayoutOptions

Sets the RandomSeed property.

Parameters

seed System.Int32 requiredposition: 0
Random seed value.

Returns

The current VisNetworkLayoutOptions instance.

Properties

public Nullable<Int32> RandomSeed { get; set; } #
JsonPropertyName("randomSeed") JsonIgnore(Condition = 3)

Gets or sets the seed used for initial random positioning.

public Nullable<Boolean> ImprovedLayout { get; set; } #
JsonPropertyName("improvedLayout") JsonIgnore(Condition = 3)

Gets or sets a value indicating whether improved layout heuristics are enabled.

public Nullable<Int32> ClusterThreshold { get; set; } #
JsonPropertyName("clusterThreshold") JsonIgnore(Condition = 3)

Gets or sets the cluster threshold used for performance tuning.

public Object Hierarchical { get; set; } #
JsonPropertyName("hierarchical") JsonIgnore(Condition = 3)

Gets or sets hierarchical layout options or a boolean to enable them.