API Reference
VisNetworkClusteringOptions
Represents clustering configuration for VisNetwork.
Inheritance
- Object
- VisNetworkClusteringOptions
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method VisNetworkClusterByConnectionOptions.WithClusterEdgeProperties
- Method VisNetworkClusterByConnectionOptions.WithClusterNodeProperties
- Method VisNetworkClusterByConnectionOptions.WithJoinCondition
- Method VisNetworkClusterByConnectionOptions.WithProcessProperties
- Method VisNetworkClusterByHubsizeOptions.WithClusterEdgeProperties
- Method VisNetworkClusterByHubsizeOptions.WithClusterNodeProperties
- Method VisNetworkClusterByHubsizeOptions.WithJoinCondition
- Method VisNetworkClusterByHubsizeOptions.WithProcessProperties
- Method VisNetworkClusteringOptions.WithClusterEdgeProperties
- Method VisNetworkClusteringOptions.WithClusterNodeProperties
- Method VisNetworkClusteringOptions.WithJoinCondition
- Method VisNetworkClusteringOptions.WithProcessProperties
Accepted by parameters
- Method VisNetwork.Cluster
- Method VisNetwork.ClusterByGroup
- Method VisNetwork.ClusterOutliers
Constructors
public VisNetworkClusteringOptions() #Methods
public VisNetworkClusteringOptions WithClusterEdgeProperties(Action<VisNetworkEdgeOptions> configure) #VisNetworkClusteringOptionsSets the properties for edges connected to the cluster.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkEdgeOptions}
public VisNetworkClusteringOptions WithClusterNodeProperties(Action<VisNetworkNodeOptions> configure) #VisNetworkClusteringOptionsSets the properties for the cluster node.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkNodeOptions}
public VisNetworkClusteringOptions WithJoinCondition(String jsFunction) #VisNetworkClusteringOptionsSets the join condition function that determines which nodes to include in the cluster.
Parameters
- jsFunction System.String
- JavaScript function that receives (nodeOptions, childNodeOptions) and returns boolean
public VisNetworkClusteringOptions WithProcessProperties(String jsFunction) #VisNetworkClusteringOptionsSets the process properties function that modifies cluster node properties based on contained nodes.
Parameters
- jsFunction System.String
- JavaScript function that receives (clusterOptions, childNodesOptions, childEdgesOptions)
Inherited Methods
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; } #JsonIgnoreGets 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; } #JsonIgnoreGets or sets the JavaScript function that processes cluster node properties. This allows dynamic modification of cluster properties based on contained nodes.