com.highsoft.highcharts.common.hichartsclasses

Class HIWordcloud

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HISeries

com.highsoft.highcharts.common.hichartsclasses.HIWordcloud

public class HIWordcloud
extends HISeries

A `wordcloud` series. If the `type` option is not specified, it is inherited from `chart.type`. In TypeScript the `type` option must always be set. Configuration options for the series are given in three levels: 1. Options for all series in a chart are defined in the `plotOptions.series` object. 2. Options for all `wordcloud` series are defined in `plotOptions.wordcloud`. 3. Options for one single series are given in `the series instance array`. ``` Highcharts.chart('container', { plotOptions: { series: { // general options for all series }, wordcloud: { // shared options for all wordcloud series } }, series: [{ // specific options for this series instance type: 'wordcloud' }] }); ```

Constructor Summary

Constructors

Constructor and Description
HIWordcloud()

Method Summary

Modifier and Type	Method and Description
HIColor	getBorderColor()
HIBorderRadiusOptionsObject	getBorderRadius()
java.lang.Number	getBorderWidth()
java.lang.Boolean	getCenterInCategory()
java.lang.Boolean	getColorByPoint()
java.util.ArrayList<java.lang.String>	getColors()
java.lang.Number	getEdgeWidth()
java.lang.Number	getMaxFontSize()
java.lang.Number	getMinFontSize()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.String	getPlacementStrategy()
HIRotation	getRotation()
java.lang.String	getSpiral()
HICSSObject	getStyle()
void	setBorderColor(HIColor borderColor) The color of the border surrounding each column or bar.
void	setBorderRadius(HIBorderRadiusOptionsObject borderRadius) The corner radius of the border surrounding each column or bar.
void	setBorderWidth(java.lang.Number borderWidth) /** * description: The width of the border surrounding each column or bar.
void	setCenterInCategory(java.lang.Boolean centerInCategory) When `true`, the columns will center in the category, ignoring null or missing points.
void	setColorByPoint(java.lang.Boolean colorByPoint) /** * description: When using automatic point colors pulled from the global `colors` or series-specific `plotOptions.column.colors` collections, this option determines whether the chart should receive one color per series or one color per point.
void	setColors(java.util.ArrayList<java.lang.String> colors) A series specific or series type specific color set to apply instead of the global `colors` when `colorByPoint` is true.
void	setEdgeWidth(java.lang.Number edgeWidth) 3D columns only.
void	setMaxFontSize(java.lang.Number maxFontSize) The word with the largest weight will have a font size equal to this value.
void	setMinFontSize(java.lang.Number minFontSize) A threshold determining the minimum font size that can be applied to a word.
void	setPlacementStrategy(java.lang.String placementStrategy) This option decides which algorithm is used for placement, and rotation of a word.
void	setRotation(HIRotation rotation) Rotation options for the words in the wordcloud.
void	setSpiral(java.lang.String spiral) Spiral used for placing a word after the initial position experienced a collision with either another word or the borders.
void	setStyle(HICSSObject style) CSS styles for the words.

Methods inherited from class com.highsoft.highcharts.common.hichartsclasses.HISeries

addPoint, addPoint, addPoint, addPoint, animate, drawGraph, drawPoints, getAccessibility, getAllowPointSelect, getAnimation, getAnimationLimit, getBoostBlending, getBoostThreshold, getClassName, getClip, getColor, getColorAxis, getColorIndex, getColorKey, getConnectEnds, getConnectNulls, getCrisp, getCropThreshold, getCursor, getCustom, getDashStyle, getData, getDataLabels, getDataSorting, getDefinition, getDescribeSingleSeries, getDescriptionFormat, getDescriptionFormatter, getDragDrop, getEnableMouseTracking, getEvents, getFindNearestPointBy, getGetExtremesFromAll, getId, getInactiveOtherPoints, getIncludeInDataExport, getIndex, getKeys, getLabel, getLegendIndex, getLegendSymbol, getLinecap, getLineWidth, getLinkedTo, getMarker, getName, getNegativeColor, getNullPointValue, getOnPoint, getOpacity, getPoint, getPointAnnotationsDescription, getPointDescriptionEnabledThreshold, getPointDescriptionFormat, getPointDescriptionFormatter, getPointInterval, getPointIntervalUnit, getPointPlacement, getPointStart, getRelativeXValue, getSelected, getShadow, getShowCheckbox, getShowInLegend, getSkipKeyboardNavigation, getSoftThreshold, getSonification, getStack, getStacking, getStates, getStep, getStickyTracking, getSummary, getThreshold, getTooltip, getTurboThreshold, getType, getVisible, getXAxis, getXAxisDescription, getYAxis, getYAxisDescription, getZIndex, getZoneAxis, getZones, hide, onMouseOut, onMouseOver, remove, remove, remove, remove, removePoint, removePoint, removePoint, render, select, select, setAccessibility, setAllowPointSelect, setAnimation, setAnimationLimit, setBoostBlending, setBoostThreshold, setClassName, setClip, setColor, setColorAxis, setColorIndex, setColorKey, setConnectEnds, setConnectNulls, setCrisp, setCropThreshold, setCursor, setCustom, setDashStyle, setData, setDataLabels, setDataSorting, setDefinition, setDescribeSingleSeries, setDescriptionFormat, setDescriptionFormatter, setDragDrop, setEnableMouseTracking, setEvents, setFindNearestPointBy, setGetExtremesFromAll, setId, setInactiveOtherPoints, setIncludeInDataExport, setIndex, setKeys, setLabel, setLegendIndex, setLegendSymbol, setLinecap, setLineWidth, setLinkedTo, setMarker, setName, setNegativeColor, setNullPointValue, setOnPoint, setOpacity, setOptions, setPoint, setPointAnnotationsDescription, setPointDescriptionEnabledThreshold, setPointDescriptionFormat, setPointDescriptionFormatter, setPointInterval, setPointIntervalUnit, setPointPlacement, setPointStart, setProperty, setRelativeXValue, setSelected, setSeriesData, setSeriesData, setSeriesData, setSeriesData, setSeriesVisible, setSeriesVisible, setSeriesVisible, setShadow, setShowCheckbox, setShowInLegend, setSkipKeyboardNavigation, setSoftThreshold, setSonification, setStack, setStacking, setState, setState, setStates, setStep, setStickyTracking, setSummary, setThreshold, setTooltip, setTurboThreshold, setType, setVisible, setXAxis, setXAxisDescription, setYAxis, setYAxisDescription, setZIndex, setZoneAxis, setZones, show, sonify, translate, update, update

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

HIWordcloud

public HIWordcloud()

Method Detail

getBorderColor

public HIColor getBorderColor()

getBorderRadius

public HIBorderRadiusOptionsObject getBorderRadius()

getBorderWidth

public java.lang.Number getBorderWidth()

getCenterInCategory

public java.lang.Boolean getCenterInCategory()

getColorByPoint

public java.lang.Boolean getColorByPoint()

getColors

public java.util.ArrayList<java.lang.String> getColors()

getEdgeWidth

public java.lang.Number getEdgeWidth()

getMaxFontSize

public java.lang.Number getMaxFontSize()

getMinFontSize

public java.lang.Number getMinFontSize()

getParams

public java.util.HashMap<java.lang.String,java.lang.Object> getParams()

Overrides:

getParams in class HISeries

getPlacementStrategy

public java.lang.String getPlacementStrategy()

getRotation

public HIRotation getRotation()

getSpiral

public java.lang.String getSpiral()

getStyle

public HICSSObject getStyle()

setBorderColor

public void setBorderColor(HIColor borderColor)

The color of the border surrounding each column or bar. In styled mode, the border stroke can be set with the `.highcharts-point` rule.

defaults:

 #ffffff

setBorderRadius

public void setBorderRadius(HIBorderRadiusOptionsObject borderRadius)

The corner radius of the border surrounding each column or bar. A number signifies pixels. A percentage string, like for example `50%`, signifies a relative size. For columns this is relative to the column width, for pies it is relative to the radius and the inner radius.

defaults:

 3

setBorderWidth

public void setBorderWidth(java.lang.Number borderWidth)

/** * description: The width of the border surrounding each column or bar. Defaults to `1` when there is room for a border, but to `0` when the columns are so dense that a border would cover the next column. In styled mode, the stroke width can be set with the `.highcharts-point` rule. * demo: * [2px black border](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/column-borderwidth/)

setCenterInCategory

public void setCenterInCategory(java.lang.Boolean centerInCategory)

When `true`, the columns will center in the category, ignoring null or missing points. When `false`, space will be reserved for null or missing points.

setColorByPoint

public void setColorByPoint(java.lang.Boolean colorByPoint)

/** * description: When using automatic point colors pulled from the global `colors` or series-specific `plotOptions.column.colors` collections, this option determines whether the chart should receive one color per series or one color per point. In styled mode, the `colors` or `series.colors` arrays are not supported, and instead this option gives the points individual color class names on the form `highcharts-color-{n}`. * demo: * [False by defaults](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/column-colorbypoint-false/) * [True](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/column-colorbypoint-true/) defaults: True

setColors

public void setColors(java.util.ArrayList<java.lang.String> colors)

A series specific or series type specific color set to apply instead of the global `colors` when `colorByPoint` is true.

setEdgeWidth

public void setEdgeWidth(java.lang.Number edgeWidth)

3D columns only. The width of the colored edges.

defaults:

 1

setMaxFontSize

public void setMaxFontSize(java.lang.Number maxFontSize)

The word with the largest weight will have a font size equal to this value. The font size of a word is the ratio between its weight and the largest occuring weight, multiplied with the value of maxFontSize.

defaults:

 25

setMinFontSize

public void setMinFontSize(java.lang.Number minFontSize)

A threshold determining the minimum font size that can be applied to a word.

defaults:

 1

setPlacementStrategy

public void setPlacementStrategy(java.lang.String placementStrategy)

This option decides which algorithm is used for placement, and rotation of a word. The choice of algorith is therefore a crucial part of the resulting layout of the wordcloud. It is possible for users to add their own custom placement strategies for use in word cloud. Read more about it in our [documentation](https://www.highcharts.com/docs/chart-and-series-types/word-cloud-series#custom-placement-strategies)

defaults:

 center

setRotation

public void setRotation(HIRotation rotation)

Rotation options for the words in the wordcloud.

setSpiral

public void setSpiral(java.lang.String spiral)

Spiral used for placing a word after the initial position experienced a collision with either another word or the borders. It is possible for users to add their own custom spiralling algorithms for use in word cloud. Read more about it in our [documentation](https://www.highcharts.com/docs/chart-and-series-types/word-cloud-series#custom-spiralling-algorithm)

defaults:

 rectangular

setStyle

public void setStyle(HICSSObject style)

CSS styles for the words.

defaults:

 {"fontFamily":"sans-serif", "fontWeight": "900"}