HighchartsLegendBubbleLegendOptions class

The bubble legend is an additional element in legend which presents the scale of the bubble series. Individual bubble ranges can be defined by user or calculated from series. In the case of automatically calculated ranges, a 1px margin of error is permitted.

API Docs: https://api.highcharts.com/highcharts/legend.bubbleLegend

Inheritance

Constructors

HighchartsLegendBubbleLegendOptions.new({String? borderColor, double? borderWidth, String? className, String? color, String? connectorClassName, String? connectorColor, double? connectorDistance, double? connectorWidth, bool? enabled, HighchartsLegendBubbleLegendLabelsOptions? labels, double? legendIndex, double? maxSize, double? minSize, List<HighchartsLegendBubbleLegendRangesOptions>? ranges, String? sizeBy, bool? sizeByAbsoluteValue, double? zIndex, double? zThreshold})
The bubble legend is an additional element in legend which presents the scale of the bubble series. Individual bubble ranges can be defined by user or calculated from series. In the case of automatically calculated ranges, a 1px margin of error is permitted.

Properties

borderColor ↔ String?
The color of the ranges borders, can be also defined for an individual range.
getter/setter pair
borderWidth ↔ double?
The width of the ranges borders in pixels, can be also defined for an individual range.
getter/setter pair
className ↔ String?
An additional class name to apply to the bubble legend' circle graphical elements. This option does not replace default class names of the graphical element.
getter/setter pair
color ↔ String?
The main color of the bubble legend. Applies to ranges, if individual color is not defined.
getter/setter pair
connectorClassName ↔ String?
An additional class name to apply to the bubble legend's connector graphical elements. This option does not replace default class names of the graphical element.
getter/setter pair
connectorColor ↔ String?
The color of the connector, can be also defined for an individual range.
getter/setter pair
connectorDistance ↔ double?
The length of the connectors in pixels. If labels are centered, the distance is reduced to 0.
getter/setter pair
connectorWidth ↔ double?
The width of the connectors in pixels.
getter/setter pair
enabled ↔ bool?
Enable or disable the bubble legend.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
labels ↔ HighchartsLegendBubbleLegendLabelsOptions?
Options for the bubble legend labels.
getter/setter pair
legendIndex ↔ double?
The position of the bubble legend in the legend.
getter/setter pair
maxSize ↔ double?
Maximum bubble legend range size. If values for ranges are not specified, the minSize and the maxSize are calculated from bubble series.
getter/setter pair
minSize ↔ double?
Minimum bubble legend range size. If values for ranges are not specified, the minSize and the maxSize are calculated from bubble series.
getter/setter pair
ranges ↔ List<HighchartsLegendBubbleLegendRangesOptions>?
Options for specific range. One range consists of bubble, label and connector.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sizeBy ↔ String?
Whether the bubble legend range value should be represented by the area or the width of the bubble. The default, area, corresponds best to the human perception of the size of each bubble.
getter/setter pair
sizeByAbsoluteValue ↔ bool?
When this is true, the absolute value of z determines the size of the bubble. This means that with the default zThreshold of 0, a bubble of value -1 will have the same size as a bubble of value 1, while a bubble of value 0 will have a smaller size according to minSize.
getter/setter pair
zIndex ↔ double?
Define the visual z index of the bubble legend.
getter/setter pair
zThreshold ↔ double?
Ranges with lower value than zThreshold are skipped.
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