API Reference
VisNetworkHierarchicalOptions
Hierarchical layout configuration.
Inheritance
- Object
- VisNetworkHierarchicalOptions
Constructors
public VisNetworkHierarchicalOptions() #Methods
public VisNetworkHierarchicalOptions WithBlockShifting(Boolean enabled = true) #VisNetworkHierarchicalOptionsSets the BlockShifting value.
Parameters
- enabled System.Boolean = true
- Whether block shifting is enabled.
Returns
The current VisNetworkHierarchicalOptions instance.
public VisNetworkHierarchicalOptions WithDirection(VisNetworkLayoutDirection direction) #VisNetworkHierarchicalOptionsSets the Direction property.
Parameters
- direction HtmlForgeX.VisNetworkLayoutDirection
- Layout direction.
Returns
The current VisNetworkHierarchicalOptions instance.
public VisNetworkHierarchicalOptions WithEdgeMinimization(Boolean enabled = true) #VisNetworkHierarchicalOptionsSets the EdgeMinimization value.
Parameters
- enabled System.Boolean = true
- Whether edge minimization is enabled.
Returns
The current VisNetworkHierarchicalOptions instance.
public VisNetworkHierarchicalOptions WithEnabled(Boolean enabled = true) #VisNetworkHierarchicalOptionsSets Enabled.
Parameters
- enabled System.Boolean = true
- Whether hierarchical layout is enabled.
Returns
The current VisNetworkHierarchicalOptions instance.
public VisNetworkHierarchicalOptions WithLevelSeparation(Double separation) #VisNetworkHierarchicalOptionsSets the LevelSeparation value.
Parameters
- separation System.Double
- Distance between levels.
Returns
The current VisNetworkHierarchicalOptions instance.
public VisNetworkHierarchicalOptions WithNodeSpacing(Double spacing) #VisNetworkHierarchicalOptionsSets the NodeSpacing value.
Parameters
- spacing System.Double
- Spacing between nodes.
Returns
The current VisNetworkHierarchicalOptions instance.
public VisNetworkHierarchicalOptions WithParentCentralization(Boolean enabled = true) #VisNetworkHierarchicalOptionsSets the ParentCentralization value.
Parameters
- enabled System.Boolean = true
- Whether parents should be centered.
Returns
The current VisNetworkHierarchicalOptions instance.
public VisNetworkHierarchicalOptions WithShakeTowards(VisNetworkShakeTowards direction) #VisNetworkHierarchicalOptionsSets the ShakeTowards property using an enum value.
Parameters
- direction HtmlForgeX.VisNetworkShakeTowards
- Direction to shake towards.
Returns
The current VisNetworkHierarchicalOptions instance.
public VisNetworkHierarchicalOptions WithShakeTowards(String direction) #VisNetworkHierarchicalOptionsSets the ShakeTowards property using a string value.
Parameters
- direction System.String
- String representation of the direction.
Returns
The current VisNetworkHierarchicalOptions instance.
public VisNetworkHierarchicalOptions WithSortMethod(VisNetworkLayoutSort sortMethod) #VisNetworkHierarchicalOptionsSets the SortMethod property.
Parameters
- sortMethod HtmlForgeX.VisNetworkLayoutSort
- The sort method to use.
Returns
The current VisNetworkHierarchicalOptions instance.
public VisNetworkHierarchicalOptions WithTreeSpacing(Double spacing) #VisNetworkHierarchicalOptionsSets the TreeSpacing value.
Parameters
- spacing System.Double
- Spacing between branches.
Returns
The current VisNetworkHierarchicalOptions instance.
Inherited Methods
Properties
public Nullable<Boolean> Enabled { get; set; } #JsonPropertyName("enabled") JsonIgnore(Condition = 3)Gets or sets a value indicating whether hierarchical layout is enabled.
public Nullable<Double> LevelSeparation { get; set; } #JsonPropertyName("levelSeparation") JsonIgnore(Condition = 3)Gets or sets the separation distance between levels.
public Nullable<Double> NodeSpacing { get; set; } #JsonPropertyName("nodeSpacing") JsonIgnore(Condition = 3)Gets or sets the spacing between nodes on the same level.
public Nullable<Double> TreeSpacing { get; set; } #JsonPropertyName("treeSpacing") JsonIgnore(Condition = 3)Gets or sets the spacing between different branches.
public Nullable<Boolean> BlockShifting { get; set; } #JsonPropertyName("blockShifting") JsonIgnore(Condition = 3)Gets or sets a value indicating whether blocks may shift to reduce edge crossings.
public Nullable<Boolean> EdgeMinimization { get; set; } #JsonPropertyName("edgeMinimization") JsonIgnore(Condition = 3)Gets or sets a value indicating whether edge crossings should be minimized.
public Nullable<Boolean> ParentCentralization { get; set; } #JsonPropertyName("parentCentralization") JsonIgnore(Condition = 3)Gets or sets a value indicating whether parents are centered above their children.
public Nullable<VisNetworkLayoutDirection> Direction { get; set; } #JsonPropertyName("direction") JsonIgnore(Condition = 3)Gets or sets the layout direction.
public Nullable<VisNetworkLayoutSort> SortMethod { get; set; } #JsonPropertyName("sortMethod") JsonIgnore(Condition = 3)Gets or sets the sorting method for nodes on the same level.
public Object ShakeTowards { get; set; } #JsonPropertyName("shakeTowards") JsonIgnore(Condition = 3)Gets or sets the direction in which nodes are shaken when stabilizing.