New-DiagramOptionsPhysics
SYNOPSIS
Short description
SYNTAX
BarnesHut (Default)
New-DiagramOptionsPhysics [-Enabled <Boolean>] [-Solver <String>] [-StabilizationEnabled <Boolean>]
[-Stabilizationiterations <Int32>] [-StabilizationupdateInterval <Int32>]
[-StabilizationonlyDynamicEdges <Boolean>] [-Stabilizationfit <Boolean>] [-MaxVelocity <Int32>]
[-MinVelocity <Int32>] [-Timestep <Int32>] [-AdaptiveTimestep <Boolean>] [-BarnesHutTheta <Double>]
[-BarnesHutGravitationalConstant <Int32>] [-BarnesHutCentralGravity <Double>] [-BarnesHutSpringLength <Int32>]
[-BarnesHutSpringConstant <Double>] [-BarnesHutDamping <Double>] [-BarnesHutAvoidOverlap <Int32>]
[-WindX <Int32>] [-WindY <Int32>] [<CommonParameters>]
ForceAtlas2Based
New-DiagramOptionsPhysics [-Enabled <Boolean>] [-Solver <String>] [-StabilizationEnabled <Boolean>]
[-Stabilizationiterations <Int32>] [-StabilizationupdateInterval <Int32>]
[-StabilizationonlyDynamicEdges <Boolean>] [-Stabilizationfit <Boolean>] [-MaxVelocity <Int32>]
[-MinVelocity <Int32>] [-Timestep <Int32>] [-AdaptiveTimestep <Boolean>] [-ForceAtlas2BasedTheta <Double>]
[-ForceAtlas2BasedGravitationalConstant <Int32>] [-ForceAtlas2BasedCentralGravity <Double>]
[-ForceAtlas2BasedSpringLength <Int32>] [-ForceAtlas2BasedSpringConstant <Double>]
[-ForceAtlas2BasedDamping <Double>] [-ForceAtlas2BasedAvoidOverlap <Int32>] [-WindX <Int32>] [-WindY <Int32>]
[<CommonParameters>]
Repulsion
New-DiagramOptionsPhysics [-Enabled <Boolean>] [-Solver <String>] [-StabilizationEnabled <Boolean>]
[-Stabilizationiterations <Int32>] [-StabilizationupdateInterval <Int32>]
[-StabilizationonlyDynamicEdges <Boolean>] [-Stabilizationfit <Boolean>] [-MaxVelocity <Int32>]
[-MinVelocity <Int32>] [-Timestep <Int32>] [-AdaptiveTimestep <Boolean>] [-RepulsionNodeDistance <Int32>]
[-RepulsionCentralGravity <Double>] [-RepulsionSpringLength <Int32>] [-RepulsionSpringConstant <Double>]
[-RepulsionDamping <Double>] [-WindX <Int32>] [-WindY <Int32>] [<CommonParameters>]
HierarchicalRepulsion
New-DiagramOptionsPhysics [-Enabled <Boolean>] [-Solver <String>] [-StabilizationEnabled <Boolean>]
[-Stabilizationiterations <Int32>] [-StabilizationupdateInterval <Int32>]
[-StabilizationonlyDynamicEdges <Boolean>] [-Stabilizationfit <Boolean>] [-MaxVelocity <Int32>]
[-MinVelocity <Int32>] [-Timestep <Int32>] [-AdaptiveTimestep <Boolean>]
[-HierarchicalRepulsionNodeDistance <Int32>] [-HierarchicalRepulsionCentralGravity <Double>]
[-HierarchicalRepulsionSpringLength <Int32>] [-HierarchicalRepulsionSpringConstant <Double>]
[-HierarchicalRepulsionDamping <Double>] [-HierarchicalRepulsionAvoidOverlap <Double>] [-WindX <Int32>]
[-WindY <Int32>] [<CommonParameters>]
DESCRIPTION
Long description
EXAMPLES
EXAMPLE 1
An example
PARAMETERS
-Enabled
Toggle the physics system on or off. This property is optional. If you define any of the options below and enabled is undefined, this will be set to true.
Type: System.Nullable`1[System.Boolean]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Solver
You can select your own solver. Possible options: 'barnesHut', 'repulsion', 'hierarchicalRepulsion', 'forceAtlas2Based'. When setting the hierarchical layout, the hierarchical repulsion solver is automatically selected, regardless of what you fill in here.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StabilizationEnabled
Toggle the stabilization. This is an optional property. If undefined, it is automatically set to true when any of the properties of this object are defined.
Type: System.Nullable`1[System.Boolean]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Stabilizationiterations
The physics module tries to stabilize the network on load up til a maximum number of iterations defined here. If the network stabilized with less, you are finished before the maximum number.
Type: System.Nullable`1[System.Int32]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StabilizationupdateInterval
When stabilizing, the DOM can freeze. You can chop the stabilization up into pieces to show a loading bar for instance. The interval determines after how many iterations the stabilizationProgress event is triggered.
Type: System.Nullable`1[System.Int32]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StabilizationonlyDynamicEdges
If you have predefined the position of all nodes and only want to stabilize the dynamic smooth edges, set this to true. It freezes all nodes except the invisible dynamic smooth curve support nodes. If you want the visible nodes to move and stabilize, do not use this.
Type: System.Nullable`1[System.Boolean]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Stabilizationfit
Toggle whether or not you want the view to zoom to fit all nodes when the stabilization is finished.
Type: System.Nullable`1[System.Boolean]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MaxVelocity
The physics module limits the maximum velocity of the nodes to increase the time to stabilization. This is the maximum value.
Type: System.Nullable`1[System.Int32]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MinVelocity
Once the minimum velocity is reached for all nodes, we assume the network has been stabilized and the simulation stops.
Type: System.Nullable`1[System.Int32]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Timestep
The physics simulation is discrete. This means we take a step in time, calculate the forces, move the nodes and take another step. If you increase this number the steps will be too large and the network can get unstable. If you see a lot of jittery movement in the network, you may want to reduce this value a little.
Type: System.Nullable`1[System.Int32]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AdaptiveTimestep
If this is enabled, the timestep will intelligently be adapted (only during the stabilization stage if stabilization is enabled!) to greatly decrease stabilization times. The timestep configured above is taken as the minimum timestep. This can be further improved by using the improvedLayout algorithm. Layout: https://visjs.github.io/vis-network/docs/network/layout.html#layout
Type: System.Nullable`1[System.Boolean]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BarnesHutTheta
This parameter determines the boundary between consolidated long range forces and individual short range forces. To oversimplify higher values are faster but generate more errors, lower values are slower but with less errors.
Type: System.Nullable`1[System.Double]
Parameter Sets: BarnesHut
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BarnesHutGravitationalConstant
Gravity attracts. We like repulsion. So the value is negative. If you want the repulsion to be stronger, decrease the value (so -10000, -50000).
Type: System.Nullable`1[System.Int32]
Parameter Sets: BarnesHut
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BarnesHutCentralGravity
There is a central gravity attractor to pull the entire network back to the center.
Type: System.Nullable`1[System.Double]
Parameter Sets: BarnesHut
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BarnesHutSpringLength
The edges are modelled as springs. This springLength here is the rest length of the spring.
Type: System.Nullable`1[System.Int32]
Parameter Sets: BarnesHut
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BarnesHutSpringConstant
This is how 'sturdy' the springs are. Higher values mean stronger springs.
Type: System.Nullable`1[System.Double]
Parameter Sets: BarnesHut
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BarnesHutDamping
Accepted range: [0 .. 1]. The damping factor is how much of the velocity from the previous physics simulation iteration carries over to the next iteration.
Type: System.Nullable`1[System.Double]
Parameter Sets: BarnesHut
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BarnesHutAvoidOverlap
Accepted range: [0 .. 1]. When larger than 0, the size of the node is taken into account. The distance will be calculated from the radius of the encompassing circle of the node for both the gravity model. Value 1 is maximum overlap avoidance.
Type: System.Nullable`1[System.Int32]
Parameter Sets: BarnesHut
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ForceAtlas2BasedTheta
This parameter determines the boundary between consolidated long range forces and individual short range forces. To oversimplify higher values are faster but generate more errors, lower values are slower but with less errors.
Type: System.Nullable`1[System.Double]
Parameter Sets: ForceAtlas2Based
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ForceAtlas2BasedGravitationalConstant
This is similar to the barnesHut method except that the falloff is linear instead of quadratic. The connectivity is also taken into account as a factor of the mass. If you want the repulsion to be stronger, decrease the value (so -1000, -2000).
Type: System.Nullable`1[System.Int32]
Parameter Sets: ForceAtlas2Based
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ForceAtlas2BasedCentralGravity
There is a central gravity attractor to pull the entire network back to the center. This is not dependent on distance.
Type: System.Nullable`1[System.Double]
Parameter Sets: ForceAtlas2Based
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ForceAtlas2BasedSpringLength
The edges are modelled as springs. This springLength here is the rest length of the spring.
Type: System.Nullable`1[System.Int32]
Parameter Sets: ForceAtlas2Based
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ForceAtlas2BasedSpringConstant
This is how 'sturdy' the springs are. Higher values mean stronger springs.
Type: System.Nullable`1[System.Double]
Parameter Sets: ForceAtlas2Based
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ForceAtlas2BasedDamping
Accepted range: [0 .. 1]. The damping factor is how much of the velocity from the previous physics simulation iteration carries over to the next iteration.
Type: System.Nullable`1[System.Double]
Parameter Sets: ForceAtlas2Based
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ForceAtlas2BasedAvoidOverlap
Accepted range: [0 .. 1]. When larger than 0, the size of the node is taken into account. The distance will be calculated from the radius of the encompassing circle of the node for both the gravity model. Value 1 is maximum overlap avoidance.
Type: System.Nullable`1[System.Int32]
Parameter Sets: ForceAtlas2Based
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RepulsionNodeDistance
This is the range of influence for the repulsion.
Type: System.Nullable`1[System.Int32]
Parameter Sets: Repulsion
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RepulsionCentralGravity
There is a central gravity attractor to pull the entire network back to the center.
Type: System.Nullable`1[System.Double]
Parameter Sets: Repulsion
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RepulsionSpringLength
The edges are modelled as springs. This springLength here is the rest length of the spring.
Type: System.Nullable`1[System.Int32]
Parameter Sets: Repulsion
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RepulsionSpringConstant
This is how 'sturdy' the springs are. Higher values mean stronger springs.
Type: System.Nullable`1[System.Double]
Parameter Sets: Repulsion
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RepulsionDamping
Accepted range: [0 .. 1]. The damping factor is how much of the velocity from the previous physics simulation iteration carries over to the next iteration.
Type: System.Nullable`1[System.Double]
Parameter Sets: Repulsion
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HierarchicalRepulsionNodeDistance
This is the range of influence for the repulsion. Default (Number) Default 120
Type: System.Nullable`1[System.Int32]
Parameter Sets: HierarchicalRepulsion
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HierarchicalRepulsionCentralGravity
There is a central gravity attractor to pull the entire network back to the center. Default (Number) 0.0
Type: System.Nullable`1[System.Double]
Parameter Sets: HierarchicalRepulsion
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HierarchicalRepulsionSpringLength
The edges are modelled as springs. This springLength here is the rest length of the spring.
Type: System.Nullable`1[System.Int32]
Parameter Sets: HierarchicalRepulsion
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HierarchicalRepulsionSpringConstant
This is how 'sturdy' the springs are. Higher values mean stronger springs.
Type: System.Nullable`1[System.Double]
Parameter Sets: HierarchicalRepulsion
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HierarchicalRepulsionDamping
Accepted range: [0 .. 1]. The damping factor is how much of the velocity from the previous physics simulation iteration carries over to the next iteration.
Type: System.Nullable`1[System.Double]
Parameter Sets: HierarchicalRepulsion
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HierarchicalRepulsionAvoidOverlap
Accepted range: [0 .. 1]. When larger than 0, the size of the node is taken into account. The distance will be calculated from the radius of the encompassing circle of the node for both the gravity model. Value 1 is maximum overlap avoidance.
Type: System.Nullable`1[System.Double]
Parameter Sets: HierarchicalRepulsion
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WindX
The amount of force to be applied pushing non-fixed nodes to the right (positive value) or to the left (negative value).
Type: System.Nullable`1[System.Int32]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WindY
The amount of force to be applied pushing non-fixed nodes downwards (positive value) or upwards (negative value).
Type: System.Nullable`1[System.Int32]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
NOTES
General notes