API Reference
VisNetworkPhysicsOptions
Physics simulation configuration options for VisNetwork.
Inheritance
- Object
- VisNetworkPhysicsOptions
Constructors
public VisNetworkPhysicsOptions() #Methods
public VisNetworkPhysicsOptions WithAdaptiveTimestep(Boolean adaptive = true) #VisNetworkPhysicsOptionsEnables or disables adaptive time stepping.
Parameters
- adaptive System.Boolean = true
- Whether adaptive time stepping is enabled.
Returns
The current VisNetworkPhysicsOptions instance.
public VisNetworkPhysicsOptions WithBarnesHut(Action<VisNetworkBarnesHutOptions> configure) #VisNetworkPhysicsOptionsConfigures and enables the Barnes Hut solver.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkPhysicsOptions.VisNetworkBarnesHutOptions}
- Callback to configure the solver options.
Returns
The current VisNetworkPhysicsOptions instance.
public VisNetworkPhysicsOptions WithEnabled(Boolean enabled = true) #VisNetworkPhysicsOptionsEnables or disables physics simulation.
Parameters
- enabled System.Boolean = true
- Whether physics should be enabled.
Returns
The current VisNetworkPhysicsOptions instance.
public VisNetworkPhysicsOptions WithForceAtlas2Based(Action<VisNetworkForceAtlas2Options> configure) #VisNetworkPhysicsOptionsConfigures and enables the Force Atlas 2 based solver.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkPhysicsOptions.VisNetworkForceAtlas2Options}
- Callback to configure the solver options.
Returns
The current VisNetworkPhysicsOptions instance.
public VisNetworkPhysicsOptions WithHierarchicalRepulsion(Action<VisNetworkHierarchicalRepulsionOptions> configure) #VisNetworkPhysicsOptionsConfigures and enables the hierarchical repulsion solver.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkPhysicsOptions.VisNetworkHierarchicalRepulsionOptions}
- Callback to configure the solver options.
Returns
The current VisNetworkPhysicsOptions instance.
public VisNetworkPhysicsOptions WithMaxVelocity(Double velocity) #VisNetworkPhysicsOptionsSets the maximum velocity for the simulation.
Parameters
- velocity System.Double
- The maximum velocity value.
Returns
The current VisNetworkPhysicsOptions instance.
public VisNetworkPhysicsOptions WithMinVelocity(Double velocity) #VisNetworkPhysicsOptionsSets the minimum velocity for the simulation.
Parameters
- velocity System.Double
- The minimum velocity value.
Returns
The current VisNetworkPhysicsOptions instance.
public VisNetworkPhysicsOptions WithRepulsion(Action<VisNetworkRepulsionOptions> configure) #VisNetworkPhysicsOptionsConfigures and enables the repulsion solver.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkPhysicsOptions.VisNetworkRepulsionOptions}
- Callback to configure the solver options.
Returns
The current VisNetworkPhysicsOptions instance.
public VisNetworkPhysicsOptions WithSolver(VisNetworkPhysicsSolver solver) #VisNetworkPhysicsOptionsSets the physics solver to use.
Parameters
- solver HtmlForgeX.VisNetworkPhysicsSolver
- The solver to apply.
Returns
The current VisNetworkPhysicsOptions instance.
public VisNetworkPhysicsOptions WithStabilization(Action<VisNetworkStabilizationOptions> configure) #VisNetworkPhysicsOptionsEnables stabilization using a simple boolean flag.
Parameters
- enabled System.Boolean = true
- Whether stabilization is enabled.
Returns
The current VisNetworkPhysicsOptions instance.
WithStabilization(HtmlForgeX.VisNetworkStabilizationOptions stabilizationOptions) #Enables stabilization using the provided options instance.
Parameters
- stabilizationOptions HtmlForgeX.VisNetworkStabilizationOptions
- Detailed stabilization options.
Returns
The current VisNetworkPhysicsOptions instance.
WithStabilization(System.Action{HtmlForgeX.VisNetworkStabilizationOptions} configure) #Configures stabilization using a callback.
Parameters
- configure System.Action{HtmlForgeX.VisNetworkStabilizationOptions}
- Callback to configure the options.
Returns
The current VisNetworkPhysicsOptions instance.
public VisNetworkPhysicsOptions WithTimestep(Double timestep) #VisNetworkPhysicsOptionsSets the simulation time step.
Parameters
- timestep System.Double
- The time step value.
Returns
The current VisNetworkPhysicsOptions instance.
public VisNetworkPhysicsOptions WithWind(Double x, Double y) #VisNetworkPhysicsOptionsSets a constant wind force.
Parameters
- x System.Double
- Horizontal force component.
- y System.Double
- Vertical force component.
Returns
The current VisNetworkPhysicsOptions instance.
Inherited Methods
Properties
public Nullable<Boolean> Enabled { get; set; } #JsonPropertyName("enabled") JsonIgnore(Condition = 3)Gets or sets a value indicating whether physics simulation is enabled.
public Nullable<Double> MaxVelocity { get; set; } #JsonPropertyName("maxVelocity") JsonIgnore(Condition = 3)Gets or sets the maximum allowed velocity for the physics simulation.
public Nullable<Double> MinVelocity { get; set; } #JsonPropertyName("minVelocity") JsonIgnore(Condition = 3)Gets or sets the minimum velocity for the physics simulation.
public Object Stabilization { get; set; } #JsonPropertyName("stabilization") JsonIgnore(Condition = 3)Gets or sets stabilization settings. Can be a boolean to enable or disable stabilization or a VisNetworkStabilizationOptions instance for detailed configuration.
public Nullable<Double> Timestep { get; set; } #JsonPropertyName("timestep") JsonIgnore(Condition = 3)Gets or sets the time step for the physics simulation.
public Nullable<Boolean> AdaptiveTimestep { get; set; } #JsonPropertyName("adaptiveTimestep") JsonIgnore(Condition = 3)Gets or sets a value indicating whether the timestep is adaptive.
public VisNetworkWindOptions Wind { get; set; } #JsonPropertyName("wind") JsonIgnore(Condition = 3)Gets or sets the wind force applied to all nodes.
public VisNetworkBarnesHutOptions BarnesHut { get; set; } #JsonPropertyName("barnesHut") JsonIgnore(Condition = 3)Gets or sets the options for the Barnes Hut physics solver.
public VisNetworkForceAtlas2Options ForceAtlas2Based { get; set; } #JsonPropertyName("forceAtlas2Based") JsonIgnore(Condition = 3)Gets or sets the options for the Force Atlas 2 based physics solver.
public VisNetworkRepulsionOptions Repulsion { get; set; } #JsonPropertyName("repulsion") JsonIgnore(Condition = 3)Gets or sets the options for the repulsion physics solver.
public VisNetworkHierarchicalRepulsionOptions HierarchicalRepulsion { get; set; } #JsonPropertyName("hierarchicalRepulsion") JsonIgnore(Condition = 3)Gets or sets the options for the hierarchical repulsion solver.
public Nullable<VisNetworkPhysicsSolver> Solver { get; set; } #JsonPropertyName("solver") JsonIgnore(Condition = 3)Gets or sets the physics solver to use.