HighchartsWordcloudSeriesOptions class

A wordcloud series. If the type option is not specified, it is inherited from chart.type.

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.

API Docs: https://api.highcharts.com/highcharts/series.wordcloud

Inheritance

Constructors

HighchartsWordcloudSeriesOptions.new({HighchartsSeriesAccessibilityOptions? accessibility, bool? allowPointSelect, HighchartsWordcloudSeriesAnimationOptions? animation, double? animationLimit, String? borderColor, Map<String, dynamic>? borderRadius, double? borderWidth, bool? centerInCategory, String? className, String? color, bool? colorByPoint, double? colorIndex, String? colorKey, List? colors, String? cursor, Map<String, dynamic>? custom, String? dashStyle, String? description, double? edgeWidth, bool? enableMouseTracking, HighchartsSeriesEventsOptions? events, String? id, bool? inactiveOtherPoints, bool? includeInDataExport, double? index, List<String>? keys, HighchartsSeriesLabelOptions? label, double? legendIndex, String? legendSymbol, String? legendSymbolColor, String? linkedTo, double? maxFontSize, double? minFontSize, bool? nullInteraction, HighchartsSeriesOnPointOptions? onPoint, double? opacity, String? placementStrategy, HighchartsSeriesPointOptions? point, dynamic pointDescriptionFormat, dynamic pointDescriptionFormatter, bool? relativeXValue, HighchartsWordcloudSeriesRotationOptions? rotation, bool? selected, bool? showInLegend, bool? skipKeyboardNavigation, HighchartsSeriesSonificationOptions? sonification, String? spiral, dynamic stack, HighchartsWordcloudSeriesStatesOptions? states, bool? stickyTracking, Map<String, String>? style, HighchartsWordcloudSeriesTooltipOptions? tooltip, double? turboThreshold, bool? visible, dynamic xAxis, dynamic yAxis, double? zIndex})
A wordcloud series. If the type option is not specified, it is inherited from chart.type.

Properties

accessibility ↔ HighchartsSeriesAccessibilityOptions?
Accessibility options for a series.
getter/setter pair
allowPointSelect ↔ bool?
Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
getter/setter pair
animation ↔ HighchartsWordcloudSeriesAnimationOptions?
Highcharts Options Widget.
getter/setter pair
animationLimit ↔ double?
For some series, there is a limit that shuts down animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation does not run if there is more than 250 points totally. To disable this cap, set animationLimit to Infinity. This option works if animation is fired on individual points, not on a group of points like e.g. during the initial animation.
getter/setter pair
borderColor ↔ String?
The color of the border surrounding each column or bar.
getter/setter pair
borderRadius ↔ Map<String, dynamic>?
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.
getter/setter pair
borderWidth ↔ double?
Highcharts Options Widget.
getter/setter pair
centerInCategory ↔ bool?
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.
getter/setter pair
className ↔ String?
An additional class name to apply to the series' graphical elements. This option does not replace default class names of the graphical element. Changes to the series' color will also be reflected in a chart's legend and tooltip.
getter/setter pair
color ↔ String?
The main color of the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the options.colors array.
getter/setter pair
colorByPoint ↔ bool?
Highcharts Options Widget.
getter/setter pair
colorIndex ↔ double?
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
getter/setter pair
colorKey ↔ String?
Determines what data value should be used to calculate point color if colorAxis is used. Requires to set min and max if some custom point property is used or if approximation for data grouping is set to 'sum'.
getter/setter pair
colors ↔ List?
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
getter/setter pair
cursor ↔ String?
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
getter/setter pair
custom ↔ Map<String, dynamic>?
A reserved subspace to store options and values for customized functionality. Here you can add additional data for your own event callbacks and formatter callbacks.
getter/setter pair
dashStyle ↔ String?
Name of the dash style to use for the graph, or for some series types the outline of each shape.
getter/setter pair
description ↔ String?
A description of the series to add to the screen reader information about the series.
getter/setter pair
edgeWidth ↔ double?
3D columns only. The width of the colored edges.
getter/setter pair
enableMouseTracking ↔ bool?
Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.
getter/setter pair
events ↔ HighchartsSeriesEventsOptions?
General event handlers for the series items. These event hooks can also be attached to the series at run time using the Highcharts.addEvent function.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
id ↔ String?
An id for the series. This can be used after render time to get a pointer to the series object through chart.get().
getter/setter pair
inactiveOtherPoints ↔ bool?
Highlight only the hovered point and fade the remaining points.
getter/setter pair
includeInDataExport ↔ bool?
When set to false will prevent the series data from being included in any form of data export.
getter/setter pair
index ↔ double?
The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
getter/setter pair
keys ↔ List<String>?
An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.
getter/setter pair
label ↔ HighchartsSeriesLabelOptions?
Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series. The goal of this feature is to make the chart more easily readable, like if a human designer placed the labels in the optimal position.
getter/setter pair
legendIndex ↔ double?
The sequential index of the series in the legend.
getter/setter pair
legendSymbol ↔ String?
What type of legend symbol to render for this series. Can be one of areaMarker, lineMarker or rectangle.
getter/setter pair
legendSymbolColor ↔ String?
Defines the color of the legend symbol for this series. Defaults to undefined, in which case the series color is used. Does not work with styled mode.
getter/setter pair
linkedTo ↔ String?
The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
getter/setter pair
maxFontSize ↔ double?
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.
getter/setter pair
minFontSize ↔ double?
A threshold determining the minimum font size that can be applied to a word.
getter/setter pair
nullInteraction ↔ bool?
Whether or not data-points with the value of null should be interactive. When this is set to true, tooltips may highlight these points, and this option also enables keyboard navigation for such points. Format options for such points include nullFormat and nullFormater. Works for these series: line, spline, area, area-spline, column, bar, and* timeline.
getter/setter pair
onPoint ↔ HighchartsSeriesOnPointOptions?
Options for the Series on point feature. Only pie and sunburst series are supported at this moment.
getter/setter pair
opacity ↔ double?
Opacity of a series parts: line, fill (e.g. area) and dataLabels.
getter/setter pair
placementStrategy ↔ String?
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
getter/setter pair
point ↔ HighchartsSeriesPointOptions?
Properties for each single point.
getter/setter pair
pointDescriptionFormat ↔ dynamic
Same as accessibility.point.descriptionFormat, but for an individual series. Overrides the chart wide configuration.
getter/setter pair
pointDescriptionFormatter ↔ dynamic
Same as accessibility.series.descriptionFormatter, but for an individual series. Overrides the chart wide configuration.
getter/setter pair
relativeXValue ↔ bool?
When true, X values in the data set are relative to the current pointStart, pointInterval and pointIntervalUnit settings. This allows compression of the data for datasets with irregular X values.
getter/setter pair
rotation ↔ HighchartsWordcloudSeriesRotationOptions?
Rotation options for the words in the wordcloud.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selected ↔ bool?
Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name in the legend will be checked for a selected series.
getter/setter pair
showInLegend ↔ bool?
Highcharts Options Widget.
getter/setter pair
skipKeyboardNavigation ↔ bool?
If set to true, the accessibility module will skip past the points in this series for keyboard navigation.
getter/setter pair
sonification ↔ HighchartsSeriesSonificationOptions?
Sonification/audio chart options for a series.
getter/setter pair
spiral ↔ String?
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
getter/setter pair
stack ↔ dynamic
This option allows grouping series in a stacked chart. The stack option can be a string or anything else, as long as the grouped series' stack options match each other after conversion into a string.
getter/setter pair
states ↔ HighchartsWordcloudSeriesStatesOptions?
Highcharts Options Widget.
getter/setter pair
stickyTracking ↔ bool?
Highcharts Options Widget.
getter/setter pair
style ↔ Map<String, String>?
CSS styles for the words.
getter/setter pair
tooltip ↔ HighchartsWordcloudSeriesTooltipOptions?
Highcharts Options Widget.
getter/setter pair
turboThreshold ↔ double?
When a series contains a data array that is longer than this, the Series class looks for data configurations of plain numbers or arrays of numbers. The first and last valid points are checked. If found, the rest of the data is assumed to be the same. This saves expensive data checking and indexing in long series, and makes data-heavy charts render faster.
getter/setter pair
visible ↔ bool?
Set the initial visibility of the series.
getter/setter pair
xAxis ↔ dynamic
When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.
getter/setter pair
yAxis ↔ dynamic
When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first.
getter/setter pair
zIndex ↔ double?
Define the visual z index of the series.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJSON() → String
Serializes the settings to a JSON string.
inherited
toOptionsJSON(StringBuffer buffer) → void
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited