HILayoutAlgorithm

java.lang.Object
- java.util.Observable
- - com.highsoft.highcharts.core.HIFoundation
  - - com.highsoft.highcharts.common.hichartsclasses.HILayoutAlgorithm

public class HILayoutAlgorithm
extends HIFoundation

Constructor Summary

Constructors
Constructor and Description

HILayoutAlgorithm()

Constructors
Constructor and Description
`HILayoutAlgorithm()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getApproximation()`
`HIFunction`	`getAttractiveForce()`
`java.lang.Number`	`getBubblePadding()`
`java.lang.Object`	`getDistance()`
`java.lang.Boolean`	`getDragBetweenSeries()`
`java.lang.Boolean`	`getEnableSimulation()`
`java.lang.Number`	`getFriction()`
`java.lang.Number`	`getGravitationalConstant()`
`java.lang.Object`	`getGridSize()`
`java.lang.Number`	`getInitialPositionRadius()`
`java.lang.String`	`getInitialPositions()`
`java.lang.String`	`getIntegration()`
`java.lang.Number`	`getIterations()`
`java.lang.Number`	`getKmeansThreshold()`
`java.lang.Number`	`getLinkLength()`
`java.lang.Number`	`getMaxIterations()`
`java.lang.Number`	`getMaxSpeed()`
`java.util.HashMap<java.lang.String,java.lang.Object>`	`getParams()`
`java.lang.Boolean`	`getParentNodeLimit()`
`HIParentNodeOptions`	`getParentNodeOptions()`
`HIFunction`	`getRepulsiveForce()`
`java.lang.Boolean`	`getSeriesInteraction()`
`java.lang.Boolean`	`getSplitSeries()`
`java.lang.Number`	`getTheta()`
`java.lang.String`	`getType()`
`void`	`setApproximation(java.lang.String approximation)` Approximation used to calculate repulsive forces affecting nodes.
`void`	`setAttractiveForce(HIFunction attractiveForce)` Attraction force applied on a node which is conected to another node by a link.
`void`	`setBubblePadding(java.lang.Number bubblePadding)` The distance between two bubbles, when the algorithm starts to treat two bubbles as overlapping.
`void`	`setDistance(java.lang.Object distance)` When `type` is set to `kmeans`, `distance` is a maximum distance between point and cluster center so that this point will be inside the cluster.
`void`	`setDragBetweenSeries(java.lang.Boolean dragBetweenSeries)` In case of split series, this option allows user to drag and drop points between series, for changing point related series.
`void`	`setEnableSimulation(java.lang.Boolean enableSimulation)` /** * description: Experimental.
`void`	`setFriction(java.lang.Number friction)` /** * description: Friction applied on forces to prevent nodes rushing to fast to the desired positions.
`void`	`setGravitationalConstant(java.lang.Number gravitationalConstant)` /** * description: Gravitational const used in the barycenter force of the algorithm. * demo: * [Custom forces with Euler integration](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/series-networkgraph/forces/) defaults: 0.01
`void`	`setGridSize(java.lang.Object gridSize)` When `type` is set to the `grid`, `gridSize` is a size of a grid square element either as a number defining pixels, or a percentage defining a percentage of the plot area width.
`void`	`setInitialPositionRadius(java.lang.Number initialPositionRadius)` /** * description: When `initialPositions` are set to 'circle', `initialPositionRadius` is a distance from the center of circle, in which nodes are created. * demo: * [Initial radius set to 200](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/series-packedbubble/initial-radius/) defaults: 1
`void`	`setInitialPositions(java.lang.String initialPositions)` /** * description: Initial layout algorithm for positioning nodes.
`void`	`setIntegration(java.lang.String integration)` Integration type.
`void`	`setIterations(java.lang.Number iterations)` When `type` is set to `kmeans`, `iterations` are the number of iterations that this algorithm will be repeated to find clusters positions.
`void`	`setKmeansThreshold(java.lang.Number kmeansThreshold)` When `type` is set to `undefined` and there are more visible points than the kmeansThreshold the `grid` algorithm is used to find clusters, otherwise `kmeans`.
`void`	`setLinkLength(java.lang.Number linkLength)` Ideal length (px) of the link between two nodes.
`void`	`setMaxIterations(java.lang.Number maxIterations)` /** * description: Max number of iterations before algorithm will stop.
`void`	`setMaxSpeed(java.lang.Number maxSpeed)` /** * description: Max speed that node can get in one iteration.
`void`	`setParentNodeLimit(java.lang.Boolean parentNodeLimit)` Whether bubbles should interact with their parentNode to keep them inside.
`void`	`setParentNodeOptions(HIParentNodeOptions parentNodeOptions)` Layout algorithm options for parent nodes.
`void`	`setRepulsiveForce(HIFunction repulsiveForce)` Repulsive force applied on a node.
`void`	`setSeriesInteraction(java.lang.Boolean seriesInteraction)` Whether series should interact with each other or not.
`void`	`setSplitSeries(java.lang.Boolean splitSeries)` Whether to split series into individual groups or to mix all series together.
`void`	`setTheta(java.lang.Number theta)` Barnes-Hut approximation only.
`void`	`setType(java.lang.String type)` Type of the algorithm used when positioning nodes.

Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HILayoutAlgorithm
```
public HILayoutAlgorithm()
```
- Method Detail
  - getApproximation
```
public java.lang.String getApproximation()
```
  - getAttractiveForce
```
public HIFunction getAttractiveForce()
```
  - getBubblePadding
```
public java.lang.Number getBubblePadding()
```
  - getDistance
```
public java.lang.Object getDistance()
```
  - getDragBetweenSeries
```
public java.lang.Boolean getDragBetweenSeries()
```
  - getEnableSimulation
```
public java.lang.Boolean getEnableSimulation()
```
  - getFriction
```
public java.lang.Number getFriction()
```
  - getGravitationalConstant
```
public java.lang.Number getGravitationalConstant()
```
  - getGridSize
```
public java.lang.Object getGridSize()
```
  - getInitialPositionRadius
```
public java.lang.Number getInitialPositionRadius()
```
  - getInitialPositions
```
public java.lang.String getInitialPositions()
```
  - getIntegration
```
public java.lang.String getIntegration()
```
  - getIterations
```
public java.lang.Number getIterations()
```
  - getKmeansThreshold
```
public java.lang.Number getKmeansThreshold()
```
  - getLinkLength
```
public java.lang.Number getLinkLength()
```
  - getMaxIterations
```
public java.lang.Number getMaxIterations()
```
  - getMaxSpeed
```
public java.lang.Number getMaxSpeed()
```
  - getParams
```
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
```
    Specified by:
    
    getParams in class HIFoundation
  - getParentNodeLimit
```
public java.lang.Boolean getParentNodeLimit()
```
  - getParentNodeOptions
```
public HIParentNodeOptions getParentNodeOptions()
```
  - getRepulsiveForce
```
public HIFunction getRepulsiveForce()
```
  - getSeriesInteraction
```
public java.lang.Boolean getSeriesInteraction()
```
  - getSplitSeries
```
public java.lang.Boolean getSplitSeries()
```
  - getTheta
```
public java.lang.Number getTheta()
```
  - getType
```
public java.lang.String getType()
```
  - setApproximation
```
public void setApproximation(java.lang.String approximation)
```
    Approximation used to calculate repulsive forces affecting nodes. By defaults, when calculating net force, nodes are compared against each other, which gives O(N^2) complexity. Using Barnes-Hut approximation, we decrease this to O(N log N), but the resulting graph will have different layout. Barnes-Hut approximation divides space into rectangles via quad tree, where forces exerted on nodes are calculated directly for nearby cells, and for all others, cells are treated as a separate node with center of mass.
    
    defaults:
    
    none
  - setAttractiveForce
```
public void setAttractiveForce(HIFunction attractiveForce)
```
    Attraction force applied on a node which is conected to another node by a link. Passed are two arguments: - `d` - which is current distance between two nodes - `k` - which is desired distance between two nodes In `verlet` integration, defaultss to: `function (d, k) { return (k-d) / d; }`
    
    defaults:
    
    function (d, k) { return k * k / d; }
  - setBubblePadding
```
public void setBubblePadding(java.lang.Number bubblePadding)
```
    The distance between two bubbles, when the algorithm starts to treat two bubbles as overlapping. The `bubblePadding` is also the expected distance between all the bubbles on simulation end.
    
    defaults:
    
    5
  - setDistance
```
public void setDistance(java.lang.Object distance)
```
    When `type` is set to `kmeans`, `distance` is a maximum distance between point and cluster center so that this point will be inside the cluster. The distance is either a number defining pixels or a percentage defining a percentage of the plot area width.
    
    defaults:
    
    40
  - setDragBetweenSeries
```
public void setDragBetweenSeries(java.lang.Boolean dragBetweenSeries)
```
    In case of split series, this option allows user to drag and drop points between series, for changing point related series.
  - setEnableSimulation
```
public void setEnableSimulation(java.lang.Boolean enableSimulation)
```
    /** * description: Experimental. Enables live simulation of the algorithm implementation. All nodes are animated as the forces applies on them. * demo: * [Live simulation enabled](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/demo/network-graph/) defaults: True
  - setFriction
```
public void setFriction(java.lang.Number friction)
```
    /** * description: Friction applied on forces to prevent nodes rushing to fast to the desired positions. defaults: -0.981
  - setGravitationalConstant
```
public void setGravitationalConstant(java.lang.Number gravitationalConstant)
```
    /** * description: Gravitational const used in the barycenter force of the algorithm. * demo: * [Custom forces with Euler integration](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/series-networkgraph/forces/) defaults: 0.01
  - setGridSize
```
public void setGridSize(java.lang.Object gridSize)
```
    When `type` is set to the `grid`, `gridSize` is a size of a grid square element either as a number defining pixels, or a percentage defining a percentage of the plot area width.
    
    defaults:
    
    50
  - setInitialPositionRadius
```
public void setInitialPositionRadius(java.lang.Number initialPositionRadius)
```
    /** * description: When `initialPositions` are set to 'circle', `initialPositionRadius` is a distance from the center of circle, in which nodes are created. * demo: * [Initial radius set to 200](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/series-packedbubble/initial-radius/) defaults: 1
  - setInitialPositions
```
public void setInitialPositions(java.lang.String initialPositions)
```
    /** * description: Initial layout algorithm for positioning nodes. Can be one of the built-in options ("circle", "random") or a function where positions should be set on each node (`this.nodes`) as `node.plotX` and `node.plotY`. * demo: * [Initial positions with callback](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/series-networkgraph/initial-positions/) defaults: circle
  - setIntegration
```
public void setIntegration(java.lang.String integration)
```
    Integration type. Available options are `'euler'` and `'verlet'`. Integration determines how forces are applied on particles. In Euler integration, force is applied direct as `newPosition += velocity;`. In Verlet integration, new position is based on a previous position without velocity: `newPosition += previousPosition - newPosition`. Note that different integrations give different results as forces are different. In Highcharts v7.0.x only `'euler'` integration was supported.
    
    defaults:
    
    euler
  - setIterations
```
public void setIterations(java.lang.Number iterations)
```
    When `type` is set to `kmeans`, `iterations` are the number of iterations that this algorithm will be repeated to find clusters positions.
  - setKmeansThreshold
```
public void setKmeansThreshold(java.lang.Number kmeansThreshold)
```
    When `type` is set to `undefined` and there are more visible points than the kmeansThreshold the `grid` algorithm is used to find clusters, otherwise `kmeans`. It ensures good performance on large datasets and better clusters arrangement after the zoom.
    
    defaults:
    
    100
  - setLinkLength
```
public void setLinkLength(java.lang.Number linkLength)
```
    Ideal length (px) of the link between two nodes. When not defined, length is calculated as: `Math.pow(availableWidth * availableHeight / nodesLength, 0.4);` Note: Because of the algorithm specification, length of each link might be not exactly as specified.
  - setMaxIterations
```
public void setMaxIterations(java.lang.Number maxIterations)
```
    /** * description: Max number of iterations before algorithm will stop. In general, algorithm should find positions sooner, but when rendering huge number of nodes, it is recommended to increase this value as finding perfect graph positions can require more time. defaults: 1000
  - setMaxSpeed
```
public void setMaxSpeed(java.lang.Number maxSpeed)
```
    /** * description: Max speed that node can get in one iteration. In terms of simulation, it's a maximum translation (in pixels) that a node can move (in both, x and y, dimensions). While `friction` is applied on all nodes, max speed is applied only for nodes that move very fast, for example small or disconnected ones. defaults: 5
  - setParentNodeLimit
```
public void setParentNodeLimit(java.lang.Boolean parentNodeLimit)
```
    Whether bubbles should interact with their parentNode to keep them inside.
  - setParentNodeOptions
```
public void setParentNodeOptions(HIParentNodeOptions parentNodeOptions)
```
    Layout algorithm options for parent nodes.
  - setRepulsiveForce
```
public void setRepulsiveForce(HIFunction repulsiveForce)
```
    Repulsive force applied on a node. Passed are two arguments: - `d` - which is current distance between two nodes - `k` - which is desired distance between two nodes In `verlet` integration, defaultss to: `function (d, k) { return (k-d) / d * (k > d ? 1 : 0) }`
    
    defaults:
    
    function (d, k) { return k * k / d; }
  - setSeriesInteraction
```
public void setSeriesInteraction(java.lang.Boolean seriesInteraction)
```
    Whether series should interact with each other or not. When `parentNodeLimit` is set to true, thi option should be set to false to avoid sticking points in wrong series parentNode.
    
    defaults:
    
    True
  - setSplitSeries
```
public void setSplitSeries(java.lang.Boolean splitSeries)
```
    Whether to split series into individual groups or to mix all series together.
    
    defaults:
    
    false
  - setTheta
```
public void setTheta(java.lang.Number theta)
```
    Barnes-Hut approximation only. Deteremines when distance between cell and node is small enough to calculate forces. Value of `theta` is compared directly with quotient `s / d`, where `s` is the size of the cell, and `d` is distance between center of cell's mass and currently compared node.
    
    defaults:
    
    0.5
  - setType
```
public void setType(java.lang.String type)
```
    Type of the algorithm used when positioning nodes.
    
    defaults:
    
    reingold-fruchterman

Class HILayoutAlgorithm

Constructor Summary

Method Summary

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Constructor Detail

HILayoutAlgorithm

Method Detail

getApproximation

getAttractiveForce

getBubblePadding

getDistance

getDragBetweenSeries

getEnableSimulation

getFriction

getGravitationalConstant

getGridSize

getInitialPositionRadius

getInitialPositions

getIntegration

getIterations

getKmeansThreshold

getLinkLength

getMaxIterations

getMaxSpeed

getParams

getParentNodeLimit

getParentNodeOptions

getRepulsiveForce

getSeriesInteraction

getSplitSeries

getTheta

getType

setApproximation

setAttractiveForce

setBubblePadding

setDistance

setDragBetweenSeries

setEnableSimulation

setFriction

setGravitationalConstant

setGridSize

setInitialPositionRadius

setInitialPositions

setIntegration

setIterations

setKmeansThreshold

setLinkLength

setMaxIterations

setMaxSpeed

setParentNodeLimit

setParentNodeOptions

setRepulsiveForce

setSeriesInteraction

setSplitSeries

setTheta

setType