HtmlForgeX

API Reference

Class

VisNetworkForceAtlas2Options

Namespace HtmlForgeX.VisNetworkPhysicsOptions
Assembly HtmlForgeX

Force Atlas 2 physics solver options.

Inheritance

  • Object
  • VisNetworkForceAtlas2Options

Constructors

public VisNetworkForceAtlas2Options() #

Methods

public VisNetworkForceAtlas2Options WithAvoidOverlap(Double overlap) #
Returns: VisNetworkForceAtlas2Options

Sets the overlap avoidance value.

Parameters

overlap System.Double requiredposition: 0
The overlap value.

Returns

The current VisNetworkForceAtlas2Options instance.

public VisNetworkForceAtlas2Options WithCentralGravity(Double gravity) #
Returns: VisNetworkForceAtlas2Options

Sets the central gravity value.

Parameters

gravity System.Double requiredposition: 0
The central gravity.

Returns

The current VisNetworkForceAtlas2Options instance.

public VisNetworkForceAtlas2Options WithDamping(Double damping) #
Returns: VisNetworkForceAtlas2Options

Sets the damping factor.

Parameters

damping System.Double requiredposition: 0
The damping value.

Returns

The current VisNetworkForceAtlas2Options instance.

public VisNetworkForceAtlas2Options WithGravitationalConstant(Double constant) #
Returns: VisNetworkForceAtlas2Options

Sets the gravitational constant.

Parameters

constant System.Double requiredposition: 0
The constant value.

Returns

The current VisNetworkForceAtlas2Options instance.

public VisNetworkForceAtlas2Options WithSpringConstant(Double constant) #
Returns: VisNetworkForceAtlas2Options

Sets the spring constant.

Parameters

constant System.Double requiredposition: 0
The spring constant.

Returns

The current VisNetworkForceAtlas2Options instance.

public VisNetworkForceAtlas2Options WithSpringLength(Double length) #
Returns: VisNetworkForceAtlas2Options

Sets the spring length.

Parameters

length System.Double requiredposition: 0
The spring length.

Returns

The current VisNetworkForceAtlas2Options instance.

public VisNetworkForceAtlas2Options WithTheta(Double theta) #
Returns: VisNetworkForceAtlas2Options

Sets the theta parameter.

Parameters

theta System.Double requiredposition: 0
The theta value.

Returns

The current VisNetworkForceAtlas2Options instance.

Properties

public Nullable<Double> Theta { get; set; } #
JsonPropertyName("theta") JsonIgnore(Condition = 3)

Gets or sets the theta parameter.

public Nullable<Double> GravitationalConstant { get; set; } #
JsonPropertyName("gravitationalConstant") JsonIgnore(Condition = 3)

Gets or sets the gravitational constant.

public Nullable<Double> CentralGravity { get; set; } #
JsonPropertyName("centralGravity") JsonIgnore(Condition = 3)

Gets or sets the central gravity.

public Nullable<Double> SpringLength { get; set; } #
JsonPropertyName("springLength") JsonIgnore(Condition = 3)

Gets or sets the spring length.

public Nullable<Double> SpringConstant { get; set; } #
JsonPropertyName("springConstant") JsonIgnore(Condition = 3)

Gets or sets the spring constant.

public Nullable<Double> Damping { get; set; } #
JsonPropertyName("damping") JsonIgnore(Condition = 3)

Gets or sets the damping factor.

public Nullable<Double> AvoidOverlap { get; set; } #
JsonPropertyName("avoidOverlap") JsonIgnore(Condition = 3)

Gets or sets the overlap avoidance.