HtmlForgeX

API Reference

Class

VisNetworkClusteringOptions

Namespace HtmlForgeX
Assembly HtmlForgeX

Represents clustering configuration for VisNetwork.

Inheritance

  • Object
  • VisNetworkClusteringOptions

Constructors

public VisNetworkClusteringOptions() #

Methods

public VisNetworkClusteringOptions WithClusterEdgeProperties(Action<VisNetworkEdgeOptions> configure) #
Returns: VisNetworkClusteringOptions

Sets the properties for edges connected to the cluster.

Parameters

configure System.Action{HtmlForgeX.VisNetworkEdgeOptions} requiredposition: 0
public VisNetworkClusteringOptions WithClusterNodeProperties(Action<VisNetworkNodeOptions> configure) #
Returns: VisNetworkClusteringOptions

Sets the properties for the cluster node.

Parameters

configure System.Action{HtmlForgeX.VisNetworkNodeOptions} requiredposition: 0
public VisNetworkClusteringOptions WithJoinCondition(String jsFunction) #
Returns: VisNetworkClusteringOptions

Sets the join condition function that determines which nodes to include in the cluster.

Parameters

jsFunction System.String requiredposition: 0
JavaScript function that receives (nodeOptions, childNodeOptions) and returns boolean
public VisNetworkClusteringOptions WithProcessProperties(String jsFunction) #
Returns: VisNetworkClusteringOptions

Sets the process properties function that modifies cluster node properties based on contained nodes.

Parameters

jsFunction System.String requiredposition: 0
JavaScript function that receives (clusterOptions, childNodesOptions, childEdgesOptions)

Properties

public VisNetworkNodeOptions ClusterNodeProperties { get; set; } #
JsonPropertyName("clusterNodeProperties") JsonIgnore(Condition = 3)

Gets or sets the cluster node properties that will be applied to the created cluster.

public VisNetworkEdgeOptions ClusterEdgeProperties { get; set; } #
JsonPropertyName("clusterEdgeProperties") JsonIgnore(Condition = 3)

Gets or sets the cluster edge properties that will be applied to edges connected to the cluster.

public String JoinCondition { get; set; } #
JsonIgnore

Gets or sets the JavaScript function that determines which nodes to include in the cluster. The function should return true to include the node.

public String ProcessProperties { get; set; } #
JsonIgnore

Gets or sets the JavaScript function that processes cluster node properties. This allows dynamic modification of cluster properties based on contained nodes.