public interface PlotBellcurveOptions extends Any
bellcurve
series are defined in plotOptions.bellcurve.
Modifier and Type | Interface and Description |
---|---|
static class |
PlotBellcurveOptions.CompareBase |
static class |
PlotBellcurveOptions.DashStyle |
static class |
PlotBellcurveOptions.FindNearestPointBy |
static class |
PlotBellcurveOptions.GapUnit |
static class |
PlotBellcurveOptions.Linecap |
static interface |
PlotBellcurveOptions.PointDescriptionFormatter |
Modifier and Type | Method and Description |
---|---|
boolean |
getAllAreas()
(Highmaps) Whether all areas of the map defined in
mapData should be
rendered. |
boolean |
getAllowPointSelect()
(Highcharts) Allow this series' points to be selected by clicking on the
graphic (columns, point markers, pie slices, map areas etc).
|
Unknown |
getAnimation()
(Highcharts) Enable or disable the initial animation when a series is
displayed.
|
double |
getAnimationLimit()
(Highcharts) 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.
|
String |
getBorderColor()
(Highmaps, Highcharts) The border color of the map areas.
|
double |
getBorderWidth()
(Highmaps, Highcharts) The border width of each map area.
|
String |
getClassName()
(Highcharts) An additional class name to apply to the series' graphical
elements.
|
boolean |
getClip()
(Highcharts) Disable this option to allow series rendering in the whole
plotting area.
|
Unknown |
getColor()
(Highcharts) The main color of the series.
|
boolean |
getColorAxis()
(Highmaps) Set this option to
false to prevent a series from connecting
to the global color axis. |
double |
getColorIndex()
(Highcharts) Styled mode only.
|
String |
getCompare()
(Highstock) Compare the values of the series against the first non-null,
non- zero value in the visible range.
|
PlotBellcurveOptions.CompareBase |
getCompareBase()
(Highstock) When compare is
percent , this option dictates whether to
use 0 or 100 as the base of comparison. |
boolean |
getCompareStart()
(Highstock) Defines if comparison should start from the first point
within the visible range or should start from the first point (see online
documentation for example) the range.
|
boolean |
getConnectEnds()
(Highcharts) Polar charts only.
|
PlotBellcurveConnectorsOptions |
getConnectors()
(Gantt) Override Pathfinder connector options for a series.
|
double |
getCropThreshold()
(Highcharts, Highstock) 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.
|
Unknown |
getCursor()
(Highcharts) 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.
|
PlotBellcurveOptions.DashStyle |
getDashStyle()
(Highcharts) A name for the dash style to use for the graph, or for some
series types the outline of each shape.
|
PlotBellcurveDataGroupingOptions |
getDataGrouping()
(Highstock) Data grouping is the concept of sampling the data values into
larger blocks in order to ease readability and increase performance of
the JavaScript charts.
|
PlotBellcurveDataLabelsOptions |
getDataLabels()
(Highcharts) Options for the series data labels, appearing next to each
data point.
|
String |
getDescription()
(Highcharts) Requires the Accessibility module.
|
PlotBellcurveDragDropOptions |
getDragDrop()
(Highcharts) The draggable-points module allows points to be moved around
or modified in the chart.
|
boolean |
getEnableMouseTracking()
(Highcharts) Enable or disable the mouse tracking for a specific series.
|
PlotBellcurveEventsOptions |
getEvents()
(Highcharts) General event handlers for the series items.
|
boolean |
getExposeElementToA11y()
(Highcharts) By default, series are exposed to screen readers as regions.
|
Unknown |
getFillColor()
(Highcharts, Highstock) Fill color or gradient for the area.
|
double |
getFillOpacity()
(Highcharts, Highstock) Fill opacity for the area.
|
PlotBellcurveOptions.FindNearestPointBy |
getFindNearestPointBy()
(Highcharts) Determines whether the series should look for the nearest
point in both dimensions or just the x-dimension when hovering the
series.
|
double |
getGapSize()
(Highstock) Defines when to display a gap in the graph, together with the
gapUnit option.
|
PlotBellcurveOptions.GapUnit |
getGapUnit()
(Highstock) Together with gapSize, this option defines where to draw gaps
in the graph.
|
boolean |
getGetExtremesFromAll()
(Highcharts, Highstock, Gantt) 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.
|
double |
getIntervals()
(Highcharts) This option allows to define the length of the bell curve.
|
Unknown |
getJoinBy()
(Highmaps) What property to join the
mapData to the value data. |
String[] |
getKeys()
(Highcharts) An array specifying which option maps to which key in the
data point array.
|
PlotBellcurveLabelOptions |
getLabel()
(Highcharts, Highstock, Gantt) Series labels are placed as close to the
series as possible in a natural way, seeking to avoid other series.
|
PlotBellcurveOptions.Linecap |
getLinecap()
(Highcharts, Highstock) The SVG value used for the
stroke-linecap and
stroke-linejoin of a line graph. |
String |
getLineColor()
(Highcharts, Highstock) A separate color for the graph line.
|
double |
getLineWidth()
(Highcharts, Highstock) Pixel width of the graph line.
|
String |
getLinkedTo()
(Highcharts, Highstock, Gantt) The id of another series to link to.
|
PlotBellcurveMarkerOptions |
getMarker()
(Highcharts) Options for the point markers of line-like series.
|
PlotSeriesOptions |
getNavigatorOptions()
(Highstock) Options for the corresponding navigator series if
showInNavigator is true for this series. |
Unknown |
getNegativeColor()
(Highcharts) The color for the parts of the graph or points that are
below the threshold.
|
Unknown |
getNegativefillColor()
(Highcharts) A separate color for the negative part of the area.
|
PlotBellcurvePointOptions |
getPoint()
(Highcharts) Properties for each single point.
|
PlotBellcurveOptions.PointDescriptionFormatter |
getPointDescriptionFormatter()
(Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
individual series.
|
Unknown |
getPointPlacement()
(Highcharts, Highstock, Gantt) Possible values:
"on" , "between" ,
number . |
double |
getPointRange()
(Highstock) The width of each point on the x axis.
|
double |
getPointsInInterval()
(Highcharts) Defines how many points should be plotted within 1 interval.
|
double |
getPointStart()
(Highcharts, Highstock, Gantt) If no x values are given for the points in
a series, pointStart defines on what value to start.
|
boolean |
getSelected()
(Highcharts) Whether to select the series initially.
|
Unknown |
getShadow()
(Highcharts) Whether to apply a drop shadow to the graph line.
|
boolean |
getShowCheckbox()
(Highcharts) If true, a checkbox is displayed next to the legend item to
allow selecting the series.
|
boolean |
getShowInLegend()
(Highcharts) Whether to display this particular series or series type in
the legend.
|
boolean |
getShowInNavigator()
(Highstock) Whether or not to show the series in the navigator.
|
boolean |
getSkipKeyboardNavigation()
(Highcharts) If set to
true , the accessibility module will skip past
the points in this series for keyboard navigation. |
boolean |
getSoftThreshold()
(Highcharts, Highstock) 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.
|
PlotBellcurveStatesOptions |
getStates()
(Highcharts) A wrapper object for all the series options in specific
states.
|
boolean |
getStickyTracking()
(Highcharts) Sticky tracking of mouse events.
|
double |
getThreshold()
(Highcharts, Highstock) The Y axis value to serve as the base for the
area, for distinguishing between values above and below a threshold.
|
PlotBellcurveTooltipOptions |
getTooltip()
(Highcharts) A configuration object for the tooltip rendering of each
single series.
|
boolean |
getTrackByArea()
(Highcharts, Highstock) Whether the whole area or just the line should
respond to mouseover tooltips and other mouse or touch events.
|
double |
getTurboThreshold()
(Highcharts, Highstock, Gantt) When a series contains a data array that
is longer than this, only one dimensional arrays of numbers, or two
dimensional arrays with x and y values are allowed.
|
boolean |
getVisible()
(Highcharts) Set the initial visibility of the series.
|
double |
getZIndex()
(Highmaps) Define the z index of the series.
|
String |
getZoneAxis()
(Highcharts, Highstock) Defines the Axis on which the zones are applied.
|
Array<PlotBellcurveZonesOptions> |
getZones()
(Highcharts, Highstock) An array defining zones within a series.
|
void |
setAllAreas(boolean value)
(Highmaps) Whether all areas of the map defined in
mapData should be
rendered. |
void |
setAllowPointSelect(boolean value)
(Highcharts) Allow this series' points to be selected by clicking on the
graphic (columns, point markers, pie slices, map areas etc).
|
void |
setAnimation(AnimationOptionsObject value)
(Highcharts) Enable or disable the initial animation when a series is
displayed.
|
void |
setAnimation(boolean value)
(Highcharts) Enable or disable the initial animation when a series is
displayed.
|
void |
setAnimation(PlotBellcurveAnimationOptions value)
(Highcharts) Enable or disable the initial animation when a series is
displayed.
|
void |
setAnimationLimit(double value)
(Highcharts) 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 |
setBorderColor(String value)
(Highmaps, Highcharts) The border color of the map areas.
|
void |
setBorderWidth(double value)
(Highmaps, Highcharts) The border width of each map area.
|
void |
setClassName(String value)
(Highcharts) An additional class name to apply to the series' graphical
elements.
|
void |
setClip(boolean value)
(Highcharts) Disable this option to allow series rendering in the whole
plotting area.
|
void |
setColor(Any value)
(Highcharts) The main color of the series.
|
void |
setColor(GradientColorObject value)
(Highcharts) The main color of the series.
|
void |
setColor(String value)
(Highcharts) The main color of the series.
|
void |
setColorAxis(boolean value)
(Highmaps) Set this option to
false to prevent a series from connecting
to the global color axis. |
void |
setColorIndex(double value)
(Highcharts) Styled mode only.
|
void |
setCompare(String value)
(Highstock) Compare the values of the series against the first non-null,
non- zero value in the visible range.
|
void |
setCompareBase(PlotBellcurveOptions.CompareBase value)
(Highstock) When compare is
percent , this option dictates whether to
use 0 or 100 as the base of comparison. |
void |
setCompareStart(boolean value)
(Highstock) Defines if comparison should start from the first point
within the visible range or should start from the first point (see online
documentation for example) the range.
|
void |
setConnectEnds(boolean value)
(Highcharts) Polar charts only.
|
void |
setConnectors(PlotBellcurveConnectorsOptions value)
(Gantt) Override Pathfinder connector options for a series.
|
void |
setCropThreshold(double value)
(Highcharts, Highstock) 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(CursorType value)
(Highcharts) 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 |
setCursor(String value)
(Highcharts) 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 |
setDashStyle(PlotBellcurveOptions.DashStyle value)
(Highcharts) A name for the dash style to use for the graph, or for some
series types the outline of each shape.
|
void |
setDataGrouping(PlotBellcurveDataGroupingOptions value)
(Highstock) Data grouping is the concept of sampling the data values into
larger blocks in order to ease readability and increase performance of
the JavaScript charts.
|
void |
setDataLabels(PlotBellcurveDataLabelsOptions value)
(Highcharts) Options for the series data labels, appearing next to each
data point.
|
void |
setDescription(String value)
(Highcharts) Requires the Accessibility module.
|
void |
setDragDrop(PlotBellcurveDragDropOptions value)
(Highcharts) The draggable-points module allows points to be moved around
or modified in the chart.
|
void |
setEnableMouseTracking(boolean value)
(Highcharts) Enable or disable the mouse tracking for a specific series.
|
void |
setEvents(PlotBellcurveEventsOptions value)
(Highcharts) General event handlers for the series items.
|
void |
setExposeElementToA11y(boolean value)
(Highcharts) By default, series are exposed to screen readers as regions.
|
void |
setFillColor(Any value)
(Highcharts, Highstock) Fill color or gradient for the area.
|
void |
setFillColor(GradientColorObject value)
(Highcharts, Highstock) Fill color or gradient for the area.
|
void |
setFillColor(String value)
(Highcharts, Highstock) Fill color or gradient for the area.
|
void |
setFillOpacity(double value)
(Highcharts, Highstock) Fill opacity for the area.
|
void |
setFindNearestPointBy(PlotBellcurveOptions.FindNearestPointBy value)
(Highcharts) Determines whether the series should look for the nearest
point in both dimensions or just the x-dimension when hovering the
series.
|
void |
setGapSize(double value)
(Highstock) Defines when to display a gap in the graph, together with the
gapUnit option.
|
void |
setGapUnit(PlotBellcurveOptions.GapUnit value)
(Highstock) Together with gapSize, this option defines where to draw gaps
in the graph.
|
void |
setGetExtremesFromAll(boolean value)
(Highcharts, Highstock, Gantt) 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 |
setIntervals(double value)
(Highcharts) This option allows to define the length of the bell curve.
|
void |
setJoinBy(String value)
(Highmaps) What property to join the
mapData to the value data. |
void |
setJoinBy(String[] value)
(Highmaps) What property to join the
mapData to the value data. |
void |
setKeys(String[] value)
(Highcharts) An array specifying which option maps to which key in the
data point array.
|
void |
setLabel(PlotBellcurveLabelOptions value)
(Highcharts, Highstock, Gantt) Series labels are placed as close to the
series as possible in a natural way, seeking to avoid other series.
|
void |
setLinecap(PlotBellcurveOptions.Linecap value)
(Highcharts, Highstock) The SVG value used for the
stroke-linecap and
stroke-linejoin of a line graph. |
void |
setLineColor(String value)
(Highcharts, Highstock) A separate color for the graph line.
|
void |
setLineWidth(double value)
(Highcharts, Highstock) Pixel width of the graph line.
|
void |
setLinkedTo(String value)
(Highcharts, Highstock, Gantt) The id of another series to link to.
|
void |
setMarker(PlotBellcurveMarkerOptions value)
(Highcharts) Options for the point markers of line-like series.
|
void |
setNavigatorOptions(PlotSeriesOptions value)
(Highstock) Options for the corresponding navigator series if
showInNavigator is true for this series. |
void |
setNegativeColor(Any value)
(Highcharts) The color for the parts of the graph or points that are
below the threshold.
|
void |
setNegativeColor(GradientColorObject value)
(Highcharts) The color for the parts of the graph or points that are
below the threshold.
|
void |
setNegativeColor(String value)
(Highcharts) The color for the parts of the graph or points that are
below the threshold.
|
void |
setNegativefillColor(Any value)
(Highcharts) A separate color for the negative part of the area.
|
void |
setNegativefillColor(GradientColorObject value)
(Highcharts) A separate color for the negative part of the area.
|
void |
setNegativefillColor(String value)
(Highcharts) A separate color for the negative part of the area.
|
void |
setPoint(PlotBellcurvePointOptions value)
(Highcharts) Properties for each single point.
|
void |
setPointDescriptionFormatter(PlotBellcurveOptions.PointDescriptionFormatter value)
(Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
individual series.
|
void |
setPointPlacement(double value)
(Highcharts, Highstock, Gantt) Possible values:
"on" , "between" ,
number . |
void |
setPointPlacement(String value)
(Highcharts, Highstock, Gantt) Possible values:
"on" , "between" ,
number . |
void |
setPointRange(double value)
(Highstock) The width of each point on the x axis.
|
void |
setPointsInInterval(double value)
(Highcharts) Defines how many points should be plotted within 1 interval.
|
void |
setPointStart(double value)
(Highcharts, Highstock, Gantt) If no x values are given for the points in
a series, pointStart defines on what value to start.
|
void |
setSelected(boolean value)
(Highcharts) Whether to select the series initially.
|
void |
setShadow(boolean value)
(Highcharts) Whether to apply a drop shadow to the graph line.
|
void |
setShadow(ShadowOptionsObject value)
(Highcharts) Whether to apply a drop shadow to the graph line.
|
void |
setShowCheckbox(boolean value)
(Highcharts) If true, a checkbox is displayed next to the legend item to
allow selecting the series.
|
void |
setShowInLegend(boolean value)
(Highcharts) Whether to display this particular series or series type in
the legend.
|
void |
setShowInNavigator(boolean value)
(Highstock) Whether or not to show the series in the navigator.
|
void |
setSkipKeyboardNavigation(boolean value)
(Highcharts) If set to
true , the accessibility module will skip past
the points in this series for keyboard navigation. |
void |
setSoftThreshold(boolean value)
(Highcharts, Highstock) 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(PlotBellcurveStatesOptions value)
(Highcharts) A wrapper object for all the series options in specific
states.
|
void |
setStickyTracking(boolean value)
(Highcharts) Sticky tracking of mouse events.
|
void |
setThreshold(double value)
(Highcharts, Highstock) The Y axis value to serve as the base for the
area, for distinguishing between values above and below a threshold.
|
void |
setTooltip(PlotBellcurveTooltipOptions value)
(Highcharts) A configuration object for the tooltip rendering of each
single series.
|
void |
setTrackByArea(boolean value)
(Highcharts, Highstock) Whether the whole area or just the line should
respond to mouseover tooltips and other mouse or touch events.
|
void |
setTurboThreshold(double value)
(Highcharts, Highstock, Gantt) When a series contains a data array that
is longer than this, only one dimensional arrays of numbers, or two
dimensional arrays with x and y values are allowed.
|
void |
setVisible(boolean value)
(Highcharts) Set the initial visibility of the series.
|
void |
setZIndex(double value)
(Highmaps) Define the z index of the series.
|
void |
setZoneAxis(String value)
(Highcharts, Highstock) Defines the Axis on which the zones are applied.
|
void |
setZones(Array<PlotBellcurveZonesOptions> value)
(Highcharts, Highstock) An array defining zones within a series.
|
boolean getAllAreas()
mapData
should be
rendered. If true
, areas which don't correspond to a data point, are
rendered as null
points. If false
, those areas are skipped.void setAllAreas(boolean value)
mapData
should be
rendered. If true
, areas which don't correspond to a data point, are
rendered as null
points. If false
, those areas are skipped.boolean getAllowPointSelect()
void setAllowPointSelect(boolean value)
@Nullable Unknown getAnimation()
void setAnimation(boolean value)
void setAnimation(PlotBellcurveAnimationOptions value)
void setAnimation(AnimationOptionsObject value)
double getAnimationLimit()
animationLimit
to Infinity
.void setAnimationLimit(double value)
animationLimit
to Infinity
.@Nullable String getBorderColor()
.highcharts-point
class.void setBorderColor(String value)
.highcharts-point
class.double getBorderWidth()
.highcharts-point
class.void setBorderWidth(double value)
.highcharts-point
class.@Nullable String getClassName()
void setClassName(String value)
boolean getClip()
void setClip(boolean value)
@Nullable Unknown getColor()
options.colors
array.
In styled mode, the color can be defined by the colorIndex option. Also,
the series color can be set with the .highcharts-series
,
.highcharts-color-{n}
, .highcharts-{type}-series
or
.highcharts-series-{n}
class, or individual classes given by the
className
option.void setColor(GradientColorObject value)
options.colors
array.
In styled mode, the color can be defined by the colorIndex option. Also,
the series color can be set with the .highcharts-series
,
.highcharts-color-{n}
, .highcharts-{type}-series
or
.highcharts-series-{n}
class, or individual classes given by the
className
option.void setColor(String value)
options.colors
array.
In styled mode, the color can be defined by the colorIndex option. Also,
the series color can be set with the .highcharts-series
,
.highcharts-color-{n}
, .highcharts-{type}-series
or
.highcharts-series-{n}
class, or individual classes given by the
className
option.void setColor(Any value)
options.colors
array.
In styled mode, the color can be defined by the colorIndex option. Also,
the series color can be set with the .highcharts-series
,
.highcharts-color-{n}
, .highcharts-{type}-series
or
.highcharts-series-{n}
class, or individual classes given by the
className
option.boolean getColorAxis()
false
to prevent a series from connecting
to the global color axis. This will cause the series to have its own
legend item.void setColorAxis(boolean value)
false
to prevent a series from connecting
to the global color axis. This will cause the series to have its own
legend item.double getColorIndex()
highcharts-color-{n}
.void setColorIndex(double value)
highcharts-color-{n}
.@Nullable String getCompare()
compare
is set to "percent"
or
"value"
. When this is applied to multiple series, it allows comparing
the development of the series against each other. Adds a change
field
to every point object.void setCompare(String value)
compare
is set to "percent"
or
"value"
. When this is applied to multiple series, it allows comparing
the development of the series against each other. Adds a change
field
to every point object.@Nullable PlotBellcurveOptions.CompareBase getCompareBase()
percent
, this option dictates whether to
use 0 or 100 as the base of comparison.void setCompareBase(PlotBellcurveOptions.CompareBase value)
percent
, this option dictates whether to
use 0 or 100 as the base of comparison.boolean getCompareStart()
compareStart=true
) or should have been already calculated according to
the previous point (compareStart=false
).void setCompareStart(boolean value)
compareStart=true
) or should have been already calculated according to
the previous point (compareStart=false
).boolean getConnectEnds()
void setConnectEnds(boolean value)
@Nullable PlotBellcurveConnectorsOptions getConnectors()
void setConnectors(PlotBellcurveConnectorsOptions value)
double getCropThreshold()
void setCropThreshold(double value)
@Nullable Unknown getCursor()
void setCursor(CursorType value)
void setCursor(String value)
@Nullable PlotBellcurveOptions.DashStyle getDashStyle()
void setDashStyle(PlotBellcurveOptions.DashStyle value)
@Nullable PlotBellcurveDataGroupingOptions getDataGrouping()
groupPixelWidth
option.
If data grouping is applied, the grouping information of grouped points
can be read from the Point.dataGroup. If point options other than the
data itself are set, for example name
or color
or custom properties,
the grouping logic doesn't know how to group it. In this case the options
of the first point instance are copied over to the group point. This can
be altered through a custom approximation
callback function.void setDataGrouping(PlotBellcurveDataGroupingOptions value)
groupPixelWidth
option.
If data grouping is applied, the grouping information of grouped points
can be read from the Point.dataGroup. If point options other than the
data itself are set, for example name
or color
or custom properties,
the grouping logic doesn't know how to group it. In this case the options
of the first point instance are copied over to the group point. This can
be altered through a custom approximation
callback function.@Nullable PlotBellcurveDataLabelsOptions getDataLabels()
.highcharts-data-label-box
and .highcharts-data-label
class names
(see example).void setDataLabels(PlotBellcurveDataLabelsOptions value)
.highcharts-data-label-box
and .highcharts-data-label
class names
(see example).@Nullable String getDescription()
void setDescription(String value)
@Nullable PlotBellcurveDragDropOptions getDragDrop()
dragDrop
API structure, the module fires three events, point.dragStart,
point.drag and point.drop.
It requires the modules/draggable-points.js
file to be loaded.void setDragDrop(PlotBellcurveDragDropOptions value)
dragDrop
API structure, the module fires three events, point.dragStart,
point.drag and point.drop.
It requires the modules/draggable-points.js
file to be loaded.boolean getEnableMouseTracking()
void setEnableMouseTracking(boolean value)
@Nullable PlotBellcurveEventsOptions getEvents()
Highcharts.addEvent
function.void setEvents(PlotBellcurveEventsOptions value)
Highcharts.addEvent
function.boolean getExposeElementToA11y()
void setExposeElementToA11y(boolean value)
@Nullable Unknown getFillColor()
null
,
the series' color
is used with the series' fillOpacity
.
In styled mode, the fill color can be set with the .highcharts-area
class name.void setFillColor(GradientColorObject value)
null
,
the series' color
is used with the series' fillOpacity
.
In styled mode, the fill color can be set with the .highcharts-area
class name.void setFillColor(String value)
null
,
the series' color
is used with the series' fillOpacity
.
In styled mode, the fill color can be set with the .highcharts-area
class name.void setFillColor(Any value)
null
,
the series' color
is used with the series' fillOpacity
.
In styled mode, the fill color can be set with the .highcharts-area
class name.double getFillOpacity()
fillColor
, the fillOpacity
is not applied. Instead, you
should define the opacity in the fillColor
with an rgba color
definition. The fillOpacity
setting, also the default setting,
overrides the alpha component of the color
setting.
In styled mode, the fill opacity can be set with the .highcharts-area
class name.void setFillOpacity(double value)
fillColor
, the fillOpacity
is not applied. Instead, you
should define the opacity in the fillColor
with an rgba color
definition. The fillOpacity
setting, also the default setting,
overrides the alpha component of the color
setting.
In styled mode, the fill opacity can be set with the .highcharts-area
class name.@Nullable PlotBellcurveOptions.FindNearestPointBy getFindNearestPointBy()
'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.void setFindNearestPointBy(PlotBellcurveOptions.FindNearestPointBy value)
'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.double getGapSize()
dataGrouping
is enabled, points can be grouped into a
larger time span. This can make the grouped points to have a greater
distance than the absolute value of gapSize
property, which will result
in disappearing graph completely. To prevent this situation the mentioned
distance between grouped points is used instead of previously defined
gapSize
.
In practice, this option is most often used to visualize gaps in time
series. In a stock chart, intraday data is available for daytime hours,
while gaps will appear in nights and weekends.void setGapSize(double value)
dataGrouping
is enabled, points can be grouped into a
larger time span. This can make the grouped points to have a greater
distance than the absolute value of gapSize
property, which will result
in disappearing graph completely. To prevent this situation the mentioned
distance between grouped points is used instead of previously defined
gapSize
.
In practice, this option is most often used to visualize gaps in time
series. In a stock chart, intraday data is available for daytime hours,
while gaps will appear in nights and weekends.@Nullable PlotBellcurveOptions.GapUnit getGapUnit()
gapUnit
is relative
(default), a gap size of 5 means that if
the distance between two points is greater than five times that of the
two closest points, the graph will be broken.
When the gapUnit
is value
, the gap is based on absolute axis values,
which on a datetime axis is milliseconds. This also applies to the
navigator series that inherits gap options from the base series.void setGapUnit(PlotBellcurveOptions.GapUnit value)
gapUnit
is relative
(default), a gap size of 5 means that if
the distance between two points is greater than five times that of the
two closest points, the graph will be broken.
When the gapUnit
is value
, the gap is based on absolute axis values,
which on a datetime axis is milliseconds. This also applies to the
navigator series that inherits gap options from the base series.boolean getGetExtremesFromAll()
void setGetExtremesFromAll(boolean value)
double getIntervals()
void setIntervals(double value)
@Nullable Unknown getJoinBy()
mapData
to the value data. For
example, if joinBy is "code", the mapData items with a specific code is
merged into the data with the same code. For maps loaded from GeoJSON,
the keys may be held in each point's properties
object.
The joinBy option can also be an array of two values, where the first
points to a key in the mapData
, and the second points to another key in
the data
.
When joinBy is null
, the map items are joined by their position in the
array, which performs much better in maps with many data points. This is
the recommended option if you are printing more than a thousand data
points and have a backend that can preprocess the data into a parallel
array of the mapData.void setJoinBy(String value)
mapData
to the value data. For
example, if joinBy is "code", the mapData items with a specific code is
merged into the data with the same code. For maps loaded from GeoJSON,
the keys may be held in each point's properties
object.
The joinBy option can also be an array of two values, where the first
points to a key in the mapData
, and the second points to another key in
the data
.
When joinBy is null
, the map items are joined by their position in the
array, which performs much better in maps with many data points. This is
the recommended option if you are printing more than a thousand data
points and have a backend that can preprocess the data into a parallel
array of the mapData.void setJoinBy(String[] value)
mapData
to the value data. For
example, if joinBy is "code", the mapData items with a specific code is
merged into the data with the same code. For maps loaded from GeoJSON,
the keys may be held in each point's properties
object.
The joinBy option can also be an array of two values, where the first
points to a key in the mapData
, and the second points to another key in
the data
.
When joinBy is null
, the map items are joined by their position in the
array, which performs much better in maps with many data points. This is
the recommended option if you are printing more than a thousand data
points and have a backend that can preprocess the data into a parallel
array of the mapData.@Nullable String[] getKeys()
void setKeys(String[] value)
@Nullable PlotBellcurveLabelOptions getLabel()
graph
or an
area
.
Requires the series-label.js
module.void setLabel(PlotBellcurveLabelOptions value)
graph
or an
area
.
Requires the series-label.js
module.@Nullable PlotBellcurveOptions.Linecap getLinecap()
stroke-linecap
and
stroke-linejoin
of a line graph. Round means that lines are rounded in
the ends and bends.void setLinecap(PlotBellcurveOptions.Linecap value)
stroke-linecap
and
stroke-linejoin
of a line graph. Round means that lines are rounded in
the ends and bends.@Nullable String getLineColor()
color
of the series, but the lineColor setting
allows setting a separate color for the line without altering the
fillColor
.
In styled mode, the line stroke can be set with the .highcharts-graph
class name.void setLineColor(String value)
color
of the series, but the lineColor setting
allows setting a separate color for the line without altering the
fillColor
.
In styled mode, the line stroke can be set with the .highcharts-graph
class name.double getLineWidth()
void setLineWidth(double value)
@Nullable String getLinkedTo()
void setLinkedTo(String value)
@Nullable PlotBellcurveMarkerOptions getMarker()
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.void setMarker(PlotBellcurveMarkerOptions value)
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.@Nullable PlotSeriesOptions getNavigatorOptions()
showInNavigator
is true
for this series. Available options are the
same as any series, documented at plotOptions and series.
These options are merged with options in navigator.series, and will take
precedence if the same option is defined both places.void setNavigatorOptions(PlotSeriesOptions value)
showInNavigator
is true
for this series. Available options are the
same as any series, documented at plotOptions and series.
These options are merged with options in navigator.series, and will take
precedence if the same option is defined both places.@Nullable Unknown getNegativeColor()
void setNegativeColor(GradientColorObject value)
void setNegativeColor(String value)
void setNegativeColor(Any value)
@Nullable Unknown getNegativefillColor()
.highcharts-negative
class name.void setNegativefillColor(GradientColorObject value)
.highcharts-negative
class name.void setNegativefillColor(String value)
.highcharts-negative
class name.void setNegativefillColor(Any value)
.highcharts-negative
class name.@Nullable PlotBellcurvePointOptions getPoint()
void setPoint(PlotBellcurvePointOptions value)
@Nullable PlotBellcurveOptions.PointDescriptionFormatter getPointDescriptionFormatter()
void setPointDescriptionFormatter(PlotBellcurveOptions.PointDescriptionFormatter value)
@Nullable Unknown getPointPlacement()
"on"
, "between"
,
number
.
In a column chart, when pointPlacement is "on"
, the point will not
create any padding of the X axis. In a polar column chart this means that
the first column points directly north. If the pointPlacement is
"between"
, the columns will be laid out between ticks. This is useful
for example for visualising an amount between two points in time or in a
certain sector of a polar chart.
Since Highcharts 3.0.2, the point placement can also be numeric, where 0
is on the axis value, -0.5 is between this value and the previous, and
0.5 is between this value and the next. Unlike the textual options,
numeric point placement options won't affect axis padding.
Note that pointPlacement needs a pointRange to work. For column series
this is computed, but for line-type series it needs to be set.
For the xrange
series type and gantt charts, if the Y axis is a
category axis, the pointPlacement
applies to the Y axis rather than the
(typically datetime) X axis.
Defaults to undefined
in cartesian charts, "between"
in polar charts.void setPointPlacement(double value)
"on"
, "between"
,
number
.
In a column chart, when pointPlacement is "on"
, the point will not
create any padding of the X axis. In a polar column chart this means that
the first column points directly north. If the pointPlacement is
"between"
, the columns will be laid out between ticks. This is useful
for example for visualising an amount between two points in time or in a
certain sector of a polar chart.
Since Highcharts 3.0.2, the point placement can also be numeric, where 0
is on the axis value, -0.5 is between this value and the previous, and
0.5 is between this value and the next. Unlike the textual options,
numeric point placement options won't affect axis padding.
Note that pointPlacement needs a pointRange to work. For column series
this is computed, but for line-type series it needs to be set.
For the xrange
series type and gantt charts, if the Y axis is a
category axis, the pointPlacement
applies to the Y axis rather than the
(typically datetime) X axis.
Defaults to undefined
in cartesian charts, "between"
in polar charts.void setPointPlacement(String value)
"on"
, "between"
,
number
.
In a column chart, when pointPlacement is "on"
, the point will not
create any padding of the X axis. In a polar column chart this means that
the first column points directly north. If the pointPlacement is
"between"
, the columns will be laid out between ticks. This is useful
for example for visualising an amount between two points in time or in a
certain sector of a polar chart.
Since Highcharts 3.0.2, the point placement can also be numeric, where 0
is on the axis value, -0.5 is between this value and the previous, and
0.5 is between this value and the next. Unlike the textual options,
numeric point placement options won't affect axis padding.
Note that pointPlacement needs a pointRange to work. For column series
this is computed, but for line-type series it needs to be set.
For the xrange
series type and gantt charts, if the Y axis is a
category axis, the pointPlacement
applies to the Y axis rather than the
(typically datetime) X axis.
Defaults to undefined
in cartesian charts, "between"
in polar charts.double getPointRange()
void setPointRange(double value)
double getPointsInInterval()
plotOptions.bellcurve.intervals
.void setPointsInInterval(double value)
plotOptions.bellcurve.intervals
.double getPointStart()
void setPointStart(double value)
boolean getSelected()
showCheckbox
is
true, the checkbox next to the series name in the legend will be checked
for a selected series.void setSelected(boolean value)
showCheckbox
is
true, the checkbox next to the series name in the legend will be checked
for a selected series.@Nullable Unknown getShadow()
color
, offsetX
,
offsetY
, opacity
and width
.void setShadow(ShadowOptionsObject value)
color
, offsetX
,
offsetY
, opacity
and width
.void setShadow(boolean value)
color
, offsetX
,
offsetY
, opacity
and width
.boolean getShowCheckbox()
selected
option.void setShowCheckbox(boolean value)
selected
option.boolean getShowInLegend()
true
for standalone series, false
for linked series.void setShowInLegend(boolean value)
true
for standalone series, false
for linked series.boolean getShowInNavigator()
void setShowInNavigator(boolean value)
boolean getSkipKeyboardNavigation()
true
, the accessibility module will skip past
the points in this series for keyboard navigation.void setSkipKeyboardNavigation(boolean value)
true
, the accessibility module will skip past
the points in this series for keyboard navigation.boolean getSoftThreshold()
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.void setSoftThreshold(boolean value)
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.@Nullable PlotBellcurveStatesOptions getStates()
void setStates(PlotBellcurveStatesOptions value)
boolean getStickyTracking()
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 not shared. When
stickyTracking
is false and tooltip.shared
is false, the tooltip will
be hidden when moving the mouse between series. Defaults to true for line
and area type series, but to false for columns, pies etc.void setStickyTracking(boolean value)
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 not shared. When
stickyTracking
is false and tooltip.shared
is false, the tooltip will
be hidden when moving the mouse between series. Defaults to true for line
and area type series, but to false for columns, pies etc.double getThreshold()
null
, the scaling behaves like a line series with fill between the
graph and the Y axis minimum.
Infinity
or -Infinity
, the area between the graph and the
corresponing Y axis extreme is filled (since v6.1.0).
void setThreshold(double value)
null
, the scaling behaves like a line series with fill between the
graph and the Y axis minimum.
Infinity
or -Infinity
, the area between the graph and the
corresponing Y axis extreme is filled (since v6.1.0).
@Nullable PlotBellcurveTooltipOptions getTooltip()
void setTooltip(PlotBellcurveTooltipOptions value)
boolean getTrackByArea()
void setTrackByArea(boolean value)
double getTurboThreshold()
0
disable.void setTurboThreshold(double value)
0
disable.boolean getVisible()
void setVisible(boolean value)
double getZIndex()
void setZIndex(double value)
@Nullable String getZoneAxis()
void setZoneAxis(String value)
@Nullable Array<PlotBellcurveZonesOptions> getZones()
zoneAxis
option. The zone definitions have to be in ascending order
regarding to the value.
In styled mode, the color zones are styled with the
.highcharts-zone-{n}
class, or custom classed from the className
option (view live demo).void setZones(Array<PlotBellcurveZonesOptions> value)
zoneAxis
option. The zone definitions have to be in ascending order
regarding to the value.
In styled mode, the color zones are styled with the
.highcharts-zone-{n}
class, or custom classed from the className
option (view live demo).Copyright © 2020. All rights reserved.