HIParentNodeOptions

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

public class HIParentNodeOptions
extends HIFoundation

Constructor Summary

Constructors
Constructor and Description

HIParentNodeOptions()

Constructors
Constructor and Description
`HIParentNodeOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Number`	`getFriction()`
`java.lang.Number`	`getGravitationalConstant()`
`java.lang.Number`	`getInitialPositionRadius()`
`java.lang.String`	`getInitialPositions()`
`java.lang.String`	`getIntegration()`
`java.lang.Number`	`getLinkLength()`
`HIMarker`	`getMarker()`
`java.lang.Number`	`getMaxIterations()`
`java.lang.Number`	`getMaxSpeed()`
`java.util.HashMap<java.lang.String,java.lang.Object>`	`getParams()`
`java.lang.Boolean`	`getSeriesInteraction()`
`java.lang.String`	`getType()`
`void`	`setFriction(java.lang.Number friction)` 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.03
`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.
`void`	`setInitialPositions(java.lang.String initialPositions)` Initial layout algorithm for positioning nodes.
`void`	`setIntegration(java.lang.String integration)` Integration type.
`void`	`setLinkLength(java.lang.Number linkLength)` Ideal length (px) of the link between two nodes.
`void`	`setMarker(HIMarker marker)` Styling options for parentNodes markers.
`void`	`setMaxIterations(java.lang.Number maxIterations)` /** * description: Max number of iterations before algorithm will stop.
`void`	`setMaxSpeed(java.lang.Number maxSpeed)` /** * description: Verlet integration only.
`void`	`setSeriesInteraction(java.lang.Boolean seriesInteraction)`
`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
  - HIParentNodeOptions
```
public HIParentNodeOptions()
```
- Method Detail
  - getFriction
```
public java.lang.Number getFriction()
```
  - getGravitationalConstant
```
public java.lang.Number getGravitationalConstant()
```
  - getInitialPositionRadius
```
public java.lang.Number getInitialPositionRadius()
```
  - getInitialPositions
```
public java.lang.String getInitialPositions()
```
  - getIntegration
```
public java.lang.String getIntegration()
```
  - getLinkLength
```
public java.lang.Number getLinkLength()
```
  - getMarker
```
public HIMarker getMarker()
```
  - 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
  - getSeriesInteraction
```
public java.lang.Boolean getSeriesInteraction()
```
  - getType
```
public java.lang.String getType()
```
  - setFriction
```
public void setFriction(java.lang.Number friction)
```
    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.03
  - 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. defaults: 100
  - setInitialPositions
```
public void setInitialPositions(java.lang.String initialPositions)
```
    Initial layout algorithm for positioning nodes. Can be one of built-in options ("circle", "random") or a function where positions should be set on each node (`this.nodes`) as `node.plotX` and `node.plotY`
    
    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
  - 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.
  - setMarker
```
public void setMarker(HIMarker marker)
```
    Styling options for parentNodes markers. Similar to line.marker options.
  - 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: 400
  - setMaxSpeed
```
public void setMaxSpeed(java.lang.Number maxSpeed)
```
    /** * description: Verlet integration only. Max speed that node can get in one iteration. In terms of simulation, it's a maximum translation (in pixels) that 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: 50
  - setSeriesInteraction
```
public void setSeriesInteraction(java.lang.Boolean seriesInteraction)
```
  - setType
```
public void setType(java.lang.String type)
```
    Type of the algorithm used when positioning nodes.
    
    defaults:
    
    reingold-fruchterman

Class HIParentNodeOptions

Constructor Summary

Method Summary

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Constructor Detail

HIParentNodeOptions

Method Detail

getFriction

getGravitationalConstant

getInitialPositionRadius

getInitialPositions

getIntegration

getLinkLength

getMarker

getMaxIterations

getMaxSpeed

getParams

getSeriesInteraction

getType

setFriction

setGravitationalConstant

setInitialPositionRadius

setInitialPositions

setIntegration

setLinkLength

setMarker

setMaxIterations

setMaxSpeed

setSeriesInteraction

setType