public class PlotOptionsBubble extends AbstractPlotOptions
highcharts-more.js
.Constructor and Description |
---|
PlotOptionsBubble() |
Modifier and Type | Method and Description |
---|---|
void |
addKey(String key)
Adds key to the keys array
|
void |
addZone(Zones zone)
Adds zone to the zones array
|
Boolean |
getAllowPointSelect() |
Boolean |
getAnimation() |
Number |
getAnimationLimit() |
ChartType |
getChartType() |
String |
getClassName() |
Number |
getColorIndex() |
Number |
getCropThreshold() |
Cursor |
getCursor() |
DataLabels |
getDataLabels() |
String |
getDescription() |
Boolean |
getDisplayNegative() |
Boolean |
getEnableMouseTracking() |
Boolean |
getExposeElementToA11y() |
Dimension |
getFindNearestPointBy() |
Boolean |
getGetExtremesFromAll() |
String[] |
getKeys() |
String |
getLinkedTo() |
Marker |
getMarker() |
String |
getMaxSize() |
String |
getMinSize() |
String |
getPointDescriptionFormatter() |
Number |
getPointInterval() |
IntervalUnit |
getPointIntervalUnit() |
Number |
getPointStart() |
Boolean |
getSelected() |
Boolean |
getShadow() |
Boolean |
getShowCheckbox() |
Boolean |
getShowInLegend() |
String |
getSizeBy() |
Boolean |
getSizeByAbsoluteValue() |
Boolean |
getSkipKeyboardNavigation() |
Boolean |
getSoftThreshold() |
States |
getStates() |
Boolean |
getStickyTracking() |
Number |
getThreshold() |
SeriesTooltip |
getTooltip() |
Boolean |
getVisible() |
Number |
getZMax() |
Number |
getZMin() |
ZoneAxis |
getZoneAxis() |
Zones[] |
getZones() |
Number |
getZThreshold() |
boolean |
isNegativeColor() |
void |
removeKey(String key)
Removes first occurrence of key in keys array
|
void |
removeZone(Zones zone)
Removes first occurrence of zone in zones array
|
void |
setAllowPointSelect(Boolean allowPointSelect)
Allow this series' points to be selected by clicking on the markers, bars
or pie slices.
|
void |
setAnimation(Boolean animation)
Enable or disable the initial animation when a series is displayed.
|
void |
setAnimationLimit(Number animationLimit)
For some series, there is a limit that shuts down initial animation by
default when the total number of points in the chart is too high.
|
void |
setClassName(String className)
A class name to apply to the series' graphical elements.
|
void |
setColorIndex(Number colorIndex)
Styled mode only.
|
void |
setCropThreshold(Number cropThreshold)
When the series contains less points than the crop threshold, all points
are drawn, even if the points fall outside the visible plot area at the
current zoom.
|
void |
setCursor(Cursor cursor)
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.
|
void |
setDataLabels(DataLabels dataLabels)
Options for the series data labels, appearing next to each data point.
|
void |
setDescription(String description)
Requires Accessibility module
|
void |
setDisplayNegative(Boolean displayNegative)
Whether to display negative sized bubbles.
|
void |
setEnableMouseTracking(Boolean enableMouseTracking)
Enable or disable the mouse tracking for a specific series.
|
void |
setExposeElementToA11y(Boolean exposeElementToA11y)
By default, series are exposed to screen readers as regions.
|
void |
setFindNearestPointBy(Dimension findNearestPointBy)
Determines whether the series should look for the nearest point in both
dimensions or just the x-dimension when hovering the series.
|
void |
setGetExtremesFromAll(Boolean getExtremesFromAll)
Whether to use the Y extremes of the total chart width or only the zoomed
area when zooming in on parts of the X axis.
|
void |
setKeys(String... keys)
An array specifying which option maps to which key in the data point
array.
|
void |
setLinkedTo(String linkedTo)
The id of another series to link to.
|
void |
setMarker(Marker marker)
Options for the point markers of line-like series.
|
void |
setMaxSize(String maxSize)
Maximum bubble size.
|
void |
setMinSize(String minSize)
Minimum bubble size.
|
void |
setNegativeColor(boolean negativeColor)
Enable or disable the color for parts of the graph that are bellow
getThreshold() . |
void |
setPointDescriptionFormatter(String _fn_pointDescriptionFormatter) |
void |
setPointInterval(Number pointInterval)
If no x values are given for the points in a series, pointInterval
defines the interval of the x values.
|
void |
setPointIntervalUnit(IntervalUnit pointIntervalUnit)
On datetime series, this allows for setting the
pointInterval to
irregular time units,
day , month and
year . |
void |
setPointStart(Date date)
Deprecated.
as of 4.0. Use
setPointStart(Instant) |
void |
setPointStart(Instant instant) |
void |
setPointStart(Number pointStart)
If no x values are given for the points in a series, pointStart defines
on what value to start.
|
void |
setSelected(Boolean selected)
Whether to select the series initially.
|
void |
setShadow(Boolean shadow)
Whether to apply a drop shadow to the graph line.
|
void |
setShowCheckbox(Boolean showCheckbox)
If true, a checkbox is displayed next to the legend item to allow
selecting the series.
|
void |
setShowInLegend(Boolean showInLegend)
Whether to display this particular series or series type in the legend.
|
void |
setSizeBy(String sizeBy)
Whether the bubble's value should be represented by the area or the width
of the bubble.
|
void |
setSizeByAbsoluteValue(Boolean sizeByAbsoluteValue)
When this is true, the absolute value of z determines the size of the
bubble.
|
void |
setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
If set to
True , the accessibility module will skip past the
points in this series for keyboard navigation. |
void |
setSoftThreshold(Boolean softThreshold)
When this is true, the series will not cause the Y axis to cross the zero
plane (or threshold option)
unless the data actually crosses the plane.
|
void |
setStates(States states)
A wrapper object for all the series options in specific states.
|
void |
setStickyTracking(Boolean stickyTracking)
Sticky tracking of mouse events.
|
void |
setThreshold(Number threshold)
The threshold, also called zero level or base level.
|
void |
setTooltip(SeriesTooltip tooltip)
A configuration object for the tooltip rendering of each single series.
|
void |
setVisible(Boolean visible)
Set the initial visibility of the series.
|
void |
setZMax(Number zMax)
The minimum for the Z value range.
|
void |
setZMin(Number zMin)
The minimum for the Z value range.
|
void |
setZoneAxis(ZoneAxis zoneAxis)
Defines the Axis on which the zones are applied.
|
void |
setZones(Zones... zones)
An array defining zones within a series.
|
void |
setZThreshold(Number zThreshold)
When displayNegative is
false , bubbles with lower Z values are skipped. |
public ChartType getChartType()
getChartType
in class AbstractPlotOptions
public Boolean getAllowPointSelect()
setAllowPointSelect(Boolean)
public void setAllowPointSelect(Boolean allowPointSelect)
Defaults to: false
public Boolean getAnimation()
setAnimation(Boolean)
public void setAnimation(Boolean animation)
ChartModel.setAnimation(Boolean)
public Number getAnimationLimit()
setAnimationLimit(Number)
public void setAnimationLimit(Number animationLimit)
animationLimit
to Infinity
.public String getClassName()
setClassName(String)
public void setClassName(String className)
public Number getColorIndex()
setColorIndex(Number)
public void setColorIndex(Number colorIndex)
highcharts-color-{n}
.public Number getCropThreshold()
setCropThreshold(Number)
public void setCropThreshold(Number cropThreshold)
Defaults to: 300
public Cursor getCursor()
setCursor(Cursor)
public void setCursor(Cursor cursor)
public DataLabels getDataLabels()
setDataLabels(DataLabels)
public void setDataLabels(DataLabels dataLabels)
Options for the series data labels, appearing next to each data point.
In styled mode, the data labels can be styled wtih the
.highcharts-data-label-box
and
.highcharts-data-label
class names (see example).
public String getDescription()
setDescription(String)
public void setDescription(String description)
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Defaults to: undefined
public Boolean getDisplayNegative()
setDisplayNegative(Boolean)
public void setDisplayNegative(Boolean displayNegative)
Defaults to: true
public Boolean getEnableMouseTracking()
setEnableMouseTracking(Boolean)
public void setEnableMouseTracking(Boolean enableMouseTracking)
Defaults to: true
public Boolean getExposeElementToA11y()
setExposeElementToA11y(Boolean)
public void setExposeElementToA11y(Boolean exposeElementToA11y)
By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series.
Requires the Accessibility module.
Defaults to: undefined
public Dimension getFindNearestPointBy()
setFindNearestPointBy(Dimension)
public void setFindNearestPointBy(Dimension findNearestPointBy)
Determines whether the series should look for the nearest point in both
dimensions or just the x-dimension when hovering the series. Defaults to
'xy'
for scatter series and 'x'
for most other
series. If the data has duplicate x-values, it is recommended to set this
to 'xy'
to allow hovering over all points.
Applies only to series types using nearest neighbor search (not direct hover) for tooltip.
public Boolean getGetExtremesFromAll()
setGetExtremesFromAll(Boolean)
public void setGetExtremesFromAll(Boolean getExtremesFromAll)
Defaults to: false
public String[] getKeys()
setKeys(String...)
public void setKeys(String... keys)
public void addKey(String key)
key
- to addsetKeys(String...)
public void removeKey(String key)
key
- to removesetKeys(String...)
public String getLinkedTo()
setLinkedTo(String)
public void setLinkedTo(String linkedTo)
public Marker getMarker()
setMarker(Marker)
public void setMarker(Marker marker)
Options for the point markers of line-like series. Properties like
fillColor
, lineColor
and lineWidth
define the visual appearance of the markers. Other series types, like
column series, don't have markers, but have visual options on the series
level instead.
In styled mode, the markers can be styled with the
.highcharts-point
, .highcharts-point-hover
and
.highcharts-point-select
class names.
public String getMaxSize()
setMaxSize(String)
public void setMaxSize(String maxSize)
minSize
and maxSize
to reflect the
z
value of each bubble. Can be either pixels (when no unit
is given), or a percentage of the smallest one of the plot width and
height.
Defaults to: 20%
public String getMinSize()
setMinSize(String)
public void setMinSize(String minSize)
minSize
and maxSize
to reflect the
z
value of each bubble. Can be either pixels (when no unit
is given), or a percentage of the smallest one of the plot width and
height.
Defaults to: 8
public boolean isNegativeColor()
setNegativeColor(boolean)
public void setNegativeColor(boolean negativeColor)
getThreshold()
. A negative color is applied by setting this
option to true
combined with the
.highcharts-negative
class name.public String getPointDescriptionFormatter()
public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
public Number getPointInterval()
setPointInterval(Number)
public void setPointInterval(Number pointInterval)
If no x values are given for the points in a series, pointInterval defines the interval of the x values. For example, if a series contains one value every decade starting from year 0, set pointInterval to 10.
Since Highcharts 4.1, it can be combined with
pointIntervalUnit
to draw irregular intervals.
Defaults to: 1
public IntervalUnit getPointIntervalUnit()
setPointIntervalUnit(IntervalUnit)
public void setPointIntervalUnit(IntervalUnit pointIntervalUnit)
day
, month
and
year
. A day is usually the same as 24 hours, but
pointIntervalUnit also takes the DST crossover into consideration when
dealing with local time. Combine this option with
pointInterval
to draw weeks, quarters, 6 months, 10 years
etc.public Number getPointStart()
setPointStart(Number)
public void setPointStart(Number pointStart)
Defaults to: 0
public Boolean getSelected()
setSelected(Boolean)
public void setSelected(Boolean selected)
showCheckbox
is
true, the checkbox next to the series name will be checked for a selected
series.
Defaults to: false
public Boolean getShadow()
setShadow(Boolean)
public void setShadow(Boolean shadow)
color
,
offsetX
, offsetY
, opacity
and
width
.
Defaults to: false
public Boolean getShowCheckbox()
setShowCheckbox(Boolean)
public void setShowCheckbox(Boolean showCheckbox)
selected
option.
Defaults to: false
public Boolean getShowInLegend()
setShowInLegend(Boolean)
public void setShowInLegend(Boolean showInLegend)
true
for standalone series,
false
for linked series.
Defaults to: true
public String getSizeBy()
setSizeBy(String)
public void setSizeBy(String sizeBy)
area
, corresponds best to the
human perception of the size of each bubble.
Defaults to: area
public Boolean getSizeByAbsoluteValue()
setSizeByAbsoluteValue(Boolean)
public void setSizeByAbsoluteValue(Boolean sizeByAbsoluteValue)
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
.
Defaults to: false
public Boolean getSkipKeyboardNavigation()
setSkipKeyboardNavigation(Boolean)
public void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
True
, the accessibility module will skip past the
points in this series for keyboard navigation.public Boolean getSoftThreshold()
setSoftThreshold(Boolean)
public void setSoftThreshold(Boolean softThreshold)
When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.
For example, if softThreshold
is false
, a
series of 0, 1, 2, 3 will make the Y axis show negative values according
to the minPadding
option. If softThreshold
is
true
, the Y axis starts at 0.
Defaults to: false
public States getStates()
setStates(States)
public void setStates(States states)
public Boolean getStickyTracking()
setStickyTracking(Boolean)
public void setStickyTracking(Boolean stickyTracking)
mouseOut
event on a series isn't triggered until the mouse moves over another
series, or out of the plot area. When false, the mouseOut
event on a series is triggered when the mouse leaves the area around the
series' graph or markers. This also implies the tooltip. When
stickyTracking
is false and tooltip.shared
is
false, the tooltip will be hidden when moving the mouse between series.
Defaults to: false
public Number getThreshold()
setThreshold(Number)
public void setThreshold(Number threshold)
Defaults to: 0
public SeriesTooltip getTooltip()
setTooltip(SeriesTooltip)
public void setTooltip(SeriesTooltip tooltip)
public Boolean getVisible()
setVisible(Boolean)
public void setVisible(Boolean visible)
Defaults to: true
public Number getZMax()
setZMax(Number)
public void setZMax(Number zMax)
Defaults to: null
public Number getZMin()
setZMin(Number)
public void setZMin(Number zMin)
Defaults to: null
public Number getZThreshold()
setZThreshold(Number)
public void setZThreshold(Number zThreshold)
false
, bubbles with lower Z values are skipped. When
displayNegative
is true
and a
negativeColor is given,
points with lower Z is colored.
Defaults to: 0
public ZoneAxis getZoneAxis()
setZoneAxis(ZoneAxis)
public void setZoneAxis(ZoneAxis zoneAxis)
Defaults to: y
public Zones[] getZones()
setZones(Zones...)
public void setZones(Zones... zones)
An array defining zones within a series. Zones can be applied to the X
axis, Y axis or Z axis for bubbles, according to the
zoneAxis
option.
In styled mode, the color zones are styled with the
.highcharts-zone-{n}
class, or custom classed from the
className
option (view live demo).
public void addZone(Zones zone)
zone
- to addsetZones(Zones...)
public void removeZone(Zones zone)
zone
- to removesetZones(Zones...)
@Deprecated public void setPointStart(Date date)
setPointStart(Instant)
public void setPointStart(Instant instant)
setPointStart(Number)
Copyright © 2023. All rights reserved.