public class PlotOptionsAreaspline extends AreaOptions
LINECAP_ROUND, LINKED_TO_PREVIOUS
Constructor and Description |
---|
PlotOptionsAreaspline() |
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() |
Boolean |
getClip() |
Color |
getColor() |
Number |
getColorIndex() |
String |
getColorKey() |
Compare |
getCompare() |
Number |
getCompareBase() |
Boolean |
getConnectEnds() |
Boolean |
getConnectNulls() |
Boolean |
getCrisp() |
Number |
getCropThreshold() |
Cursor |
getCursor() |
DashStyle |
getDashStyle() |
DataGrouping |
getDataGrouping() |
DataLabels |
getDataLabels() |
String |
getDescription() |
Boolean |
getEnableMouseTracking() |
Boolean |
getExposeElementToA11y() |
Color |
getFillColor() |
Number |
getFillOpacity() |
Dimension |
getFindNearestPointBy() |
Number |
getGapSize() |
String |
getGapUnit() |
Boolean |
getGetExtremesFromAll() |
String[] |
getKeys() |
Number |
getLegendIndex() |
String |
getLinecap() |
Color |
getLineColor() |
Number |
getLineWidth() |
String |
getLinkedTo() |
Marker |
getMarker() |
PlotOptionsSeries |
getNavigatorOptions() |
Color |
getNegativeColor() |
Color |
getNegativeFillColor() |
Number |
getOpacity() |
String |
getPointDescriptionFormatter() |
Number |
getPointInterval() |
IntervalUnit |
getPointIntervalUnit() |
PointPlacement |
getPointPlacement() |
Number |
getPointRange() |
Number |
getPointStart() |
Boolean |
getSelected() |
Boolean |
getShadow() |
Boolean |
getShowCheckbox() |
Boolean |
getShowInLegend() |
Boolean |
getShowInNavigator() |
Boolean |
getSkipKeyboardNavigation() |
Boolean |
getSoftThreshold() |
Stacking |
getStacking() |
States |
getStates() |
Boolean |
getStickyTracking() |
Number |
getThreshold() |
SeriesTooltip |
getTooltip() |
Boolean |
getTrackByArea() |
Number |
getTurboThreshold() |
Boolean |
getVisible() |
ZoneAxis |
getZoneAxis() |
Zones[] |
getZones() |
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 |
setClip(Boolean clip)
Disable this option to allow series rendering in the whole plotting area.
|
void |
setColor(Color color)
The main color or the series.
|
void |
setColorIndex(Number colorIndex)
Styled mode only.
|
void |
setColorKey(String colorKey)
Determines what data value should be used to calculate point color if
colorAxis is used. |
void |
setCompare(Compare compare)
Compare the values of the series against the first non-null, non-zero
value in the visible range.
|
void |
setCompareBase(Number compareBase)
When compare is
percent , this option dictates whether to use 0 or 100 as the
base of comparison. |
void |
setConnectEnds(Boolean connectEnds)
Polar charts only.
|
void |
setConnectNulls(Boolean connectNulls)
Whether to connect a graph line across null points.
|
void |
setCrisp(Boolean crisp)
When true, each point or column edge is rounded to its nearest pixel in
order to render sharp on screen.
|
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 |
setDashStyle(DashStyle dashStyle)
A name for the dash style to use for the graph.
|
void |
setDataGrouping(DataGrouping dataGrouping)
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(DataLabels dataLabels)
Options for the series data labels, appearing next to each data point.
|
void |
setDescription(String description)
Requires Accessibility module
|
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 |
setFillColor(Color fillColor)
Fill color or gradient for the area.
|
void |
setFillOpacity(Number fillOpacity)
Fill opacity for the area.
|
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 |
setGapSize(Number gapSize)
Defines when to display a gap in the graph.
|
void |
setGapUnit(String gapUnit)
Together with
gapSize , this option defines where to draw
gaps in the graph. |
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 |
setLegendIndex(Number legendIndex)
The sequential index of the series within the legend.
|
void |
setLinecap(String linecap)
The line cap used for line ends and line joins on the graph.
|
void |
setLineColor(Color lineColor)
A separate color for the graph line.
|
void |
setLineWidth(Number lineWidth)
Pixel with of the graph line.
|
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 |
setNavigatorOptions(PlotOptionsSeries navigatorOptions)
Options for the corresponding navigator series if
showInNavigator is true for this series. |
void |
setNegativeColor(Color negativeColor)
The color for the parts of the graph or points that are below the
threshold.
|
void |
setNegativeFillColor(Color negativeFillColor)
A separate color for the negative part of the area.
|
void |
setOpacity(Number opacity)
Opacity of a series parts: line, fill (e.g.
|
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 |
setPointPlacement(PointPlacement pointPlacement)
Possible values:
null , "on" ,
"between" . |
void |
setPointRange(Number pointRange)
The width of each point on the x axis.
|
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 |
setShowInNavigator(Boolean showInNavigator)
Whether or not to show the series in the navigator.
|
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 |
setStacking(Stacking stacking)
Whether to stack the values of each series on top of each other.
|
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 Y axis value to serve as the base for the area, for distinguishing
between values above and below a threshold.
|
void |
setTooltip(SeriesTooltip tooltip)
A configuration object for the tooltip rendering of each single series.
|
void |
setTrackByArea(Boolean trackByArea)
Whether the whole area or just the line should respond to mouseover
tooltips and other mouse or touch events.
|
void |
setTurboThreshold(Number turboThreshold)
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 visible)
Set the initial visibility of the series.
|
void |
setZoneAxis(ZoneAxis zoneAxis)
Defines the Axis on which the zones are applied.
|
void |
setZones(Zones... zones)
An array defining zones within a series.
|
public ChartType getChartType()
getChartType
in class AreaOptions
public Boolean getAllowPointSelect()
getAllowPointSelect
in class AreaOptions
setAllowPointSelect(Boolean)
public void setAllowPointSelect(Boolean allowPointSelect)
Defaults to: false
setAllowPointSelect
in class AreaOptions
public Boolean getAnimation()
getAnimation
in class AreaOptions
setAnimation(Boolean)
public void setAnimation(Boolean animation)
ChartModel.setAnimation(Boolean)
setAnimation
in class AreaOptions
public Number getAnimationLimit()
getAnimationLimit
in class AreaOptions
setAnimationLimit(Number)
public void setAnimationLimit(Number animationLimit)
animationLimit
to Infinity
.setAnimationLimit
in class AreaOptions
public String getClassName()
getClassName
in class AreaOptions
setClassName(String)
public void setClassName(String className)
setClassName
in class AreaOptions
public Boolean getClip()
getClip
in class AreaOptions
setClip(Boolean)
public void setClip(Boolean clip)
Defaults to true
.
setClip
in class AreaOptions
public Color getColor()
setColor(Color)
public void setColor(Color color)
The main color or 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.
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.
public Number getColorIndex()
getColorIndex
in class AreaOptions
setColorIndex(Number)
public void setColorIndex(Number colorIndex)
highcharts-color-{n}
.setColorIndex
in class AreaOptions
public String getColorKey()
getColorKey
in class AreaOptions
setColorKey(String)
public void setColorKey(String colorKey)
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'.
Defaults to y
.
setColorKey
in class AreaOptions
public Boolean getConnectEnds()
setConnectEnds(Boolean)
public void setConnectEnds(Boolean connectEnds)
Defaults to: true
public Boolean getConnectNulls()
getConnectNulls
in class AreaOptions
setConnectNulls(Boolean)
public void setConnectNulls(Boolean connectNulls)
Defaults to: false
setConnectNulls
in class AreaOptions
public Boolean getCrisp()
getCrisp
in class AreaOptions
setCrisp(Boolean)
public void setCrisp(Boolean crisp)
crisp
to false
may look better, even though each column is
rendered blurry.
Defaults to true
.
setCrisp
in class AreaOptions
public Number getCropThreshold()
getCropThreshold
in class AreaOptions
setCropThreshold(Number)
public void setCropThreshold(Number cropThreshold)
Defaults to: 300
setCropThreshold
in class AreaOptions
public Cursor getCursor()
getCursor
in class AreaOptions
setCursor(Cursor)
public void setCursor(Cursor cursor)
setCursor
in class AreaOptions
public DashStyle getDashStyle()
getDashStyle
in class AreaOptions
setDashStyle(DashStyle)
public void setDashStyle(DashStyle dashStyle)
line
, spline
,
area
and scatter
in case it has a
lineWidth
. The value for the dashStyle
include:
Defaults to: Solid
setDashStyle
in class AreaOptions
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()
getDescription
in class AreaOptions
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
setDescription
in class AreaOptions
public Boolean getEnableMouseTracking()
getEnableMouseTracking
in class AreaOptions
setEnableMouseTracking(Boolean)
public void setEnableMouseTracking(Boolean enableMouseTracking)
Defaults to: true
setEnableMouseTracking
in class AreaOptions
public Boolean getExposeElementToA11y()
getExposeElementToA11y
in class AreaOptions
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
setExposeElementToA11y
in class AreaOptions
public Color getFillColor()
getFillColor
in class AreaOptions
setFillColor(Color)
public void setFillColor(Color fillColor)
null
, the series'
color
is used with the series' fillOpacity
.setFillColor
in class AreaOptions
public Number getFillOpacity()
getFillOpacity
in class AreaOptions
setFillOpacity(Number)
public void setFillOpacity(Number fillOpacity)
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.
Defaults to: 0.75
setFillOpacity
in class AreaOptions
public Dimension getFindNearestPointBy()
getFindNearestPointBy
in class AreaOptions
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.
setFindNearestPointBy
in class AreaOptions
public Boolean getGetExtremesFromAll()
getGetExtremesFromAll
in class AreaOptions
setGetExtremesFromAll(Boolean)
public void setGetExtremesFromAll(Boolean getExtremesFromAll)
Defaults to: false
setGetExtremesFromAll
in class AreaOptions
public String[] getKeys()
getKeys
in class AreaOptions
setKeys(String...)
public void setKeys(String... keys)
setKeys
in class AreaOptions
public void addKey(String key)
addKey
in class AreaOptions
key
- to addsetKeys(String...)
public void removeKey(String key)
removeKey
in class AreaOptions
key
- to removesetKeys(String...)
public Color getLineColor()
getLineColor
in class AreaOptions
setLineColor(Color)
public void setLineColor(Color lineColor)
color
of the series, but the lineColor setting allows
setting a separate color for the line without altering the
fillColor
.setLineColor
in class AreaOptions
public Number getLineWidth()
getLineWidth
in class AreaOptions
setLineWidth(Number)
public void setLineWidth(Number lineWidth)
Defaults to: 2
setLineWidth
in class AreaOptions
public String getLinecap()
getLinecap
in class AreaOptions
setLinecap(String)
public void setLinecap(String linecap)
Defaults to: round
setLinecap
in class AreaOptions
public String getLinkedTo()
getLinkedTo
in class AreaOptions
setLinkedTo(String)
public void setLinkedTo(String linkedTo)
setLinkedTo
in class AreaOptions
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 Color getNegativeColor()
getNegativeColor
in class AreaOptions
setNegativeColor(Color)
public void setNegativeColor(Color negativeColor)
Defaults to: null
setNegativeColor
in class AreaOptions
public Color getNegativeFillColor()
getNegativeFillColor
in class AreaOptions
setNegativeFillColor(Color)
public void setNegativeFillColor(Color negativeFillColor)
setNegativeFillColor
in class AreaOptions
public Number getOpacity()
getOpacity
in class AreaOptions
setOpacity(Number)
public void setOpacity(Number opacity)
Defaults to 1
.
setOpacity
in class AreaOptions
public String getPointDescriptionFormatter()
getPointDescriptionFormatter
in class AreaOptions
public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
setPointDescriptionFormatter
in class AreaOptions
public Number getPointInterval()
getPointInterval
in class AreaOptions
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
setPointInterval
in class AreaOptions
public IntervalUnit getPointIntervalUnit()
getPointIntervalUnit
in class AreaOptions
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.setPointIntervalUnit
in class AreaOptions
public PointPlacement getPointPlacement()
getPointPlacement
in class AreaOptions
setPointPlacement(PointPlacement)
public void setPointPlacement(PointPlacement pointPlacement)
Possible values: null
, "on"
,
"between"
.
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.
Defaults to null
in cartesian charts, "between"
in polar charts.
setPointPlacement
in class AreaOptions
public Number getPointStart()
getPointStart
in class AreaOptions
setPointStart(Number)
public void setPointStart(Number pointStart)
Defaults to: 0
setPointStart
in class AreaOptions
public Boolean getSelected()
getSelected
in class AreaOptions
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
setSelected
in class AreaOptions
public Boolean getShadow()
getShadow
in class AreaOptions
setShadow(Boolean)
public void setShadow(Boolean shadow)
color
,
offsetX
, offsetY
, opacity
and
width
.
Defaults to: false
setShadow
in class AreaOptions
public Boolean getShowCheckbox()
getShowCheckbox
in class AreaOptions
setShowCheckbox(Boolean)
public void setShowCheckbox(Boolean showCheckbox)
selected
option.
Defaults to: false
setShowCheckbox
in class AreaOptions
public Boolean getShowInLegend()
getShowInLegend
in class AreaOptions
setShowInLegend(Boolean)
public void setShowInLegend(Boolean showInLegend)
true
for standalone series,
false
for linked series.
Defaults to: true
setShowInLegend
in class AreaOptions
public Boolean getSkipKeyboardNavigation()
getSkipKeyboardNavigation
in class AreaOptions
setSkipKeyboardNavigation(Boolean)
public void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
True
, the accessibility module will skip past the
points in this series for keyboard navigation.setSkipKeyboardNavigation
in class AreaOptions
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 Stacking getStacking()
getStacking
in class AreaOptions
setStacking(Stacking)
public void setStacking(Stacking stacking)
setStacking
in class AreaOptions
public States getStates()
getStates
in class AreaOptions
setStates(States)
public void setStates(States states)
setStates
in class AreaOptions
public Boolean getStickyTracking()
getStickyTracking
in class AreaOptions
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 true for line and area type series, but to false for columns,
pies etc.
Defaults to: true
setStickyTracking
in class AreaOptions
public Number getThreshold()
setThreshold(Number)
public void setThreshold(Number threshold)
null
, the
area behaves like a line series with fill between the graph and the Y
axis minimum.
Defaults to: 0
public SeriesTooltip getTooltip()
getTooltip
in class AreaOptions
setTooltip(SeriesTooltip)
public void setTooltip(SeriesTooltip tooltip)
setTooltip
in class AreaOptions
public Boolean getTrackByArea()
getTrackByArea
in class AreaOptions
setTrackByArea(Boolean)
public void setTrackByArea(Boolean trackByArea)
Defaults to: false
setTrackByArea
in class AreaOptions
public Number getTurboThreshold()
getTurboThreshold
in class AreaOptions
setTurboThreshold(Number)
public void setTurboThreshold(Number turboThreshold)
0
disable.
Defaults to: 1000
setTurboThreshold
in class AreaOptions
public Boolean getVisible()
getVisible
in class AreaOptions
setVisible(Boolean)
public void setVisible(Boolean visible)
Defaults to: true
setVisible
in class AreaOptions
public ZoneAxis getZoneAxis()
getZoneAxis
in class AreaOptions
setZoneAxis(ZoneAxis)
public void setZoneAxis(ZoneAxis zoneAxis)
Defaults to: y
setZoneAxis
in class AreaOptions
public Zones[] getZones()
getZones
in class AreaOptions
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).
setZones
in class AreaOptions
public void addZone(Zones zone)
addZone
in class AreaOptions
zone
- to addsetZones(Zones...)
public void removeZone(Zones zone)
removeZone
in class AreaOptions
zone
- to removesetZones(Zones...)
public Compare getCompare()
getCompare
in class AreaOptions
setCompare(Compare)
public void setCompare(Compare compare)
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.
Defaults to: undefined
setCompare
in class AreaOptions
public Number getCompareBase()
getCompareBase
in class AreaOptions
setCompareBase(Number)
public void setCompareBase(Number compareBase)
percent
, this option dictates whether to use 0 or 100 as the
base of comparison.
Defaults to: 0
setCompareBase
in class AreaOptions
public DataGrouping getDataGrouping()
getDataGrouping
in class AreaOptions
setDataGrouping(DataGrouping)
public void setDataGrouping(DataGrouping dataGrouping)
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. Highstock by default applies data grouping when the
points become closer than a certain pixel value, determined by the
groupPixelWidth
option.
If data grouping is applied, the grouping information of grouped points can be read from the Point.dataGroup.
setDataGrouping
in class AreaOptions
public Number getGapSize()
getGapSize
in class AreaOptions
setGapSize(Number)
public void setGapSize(Number gapSize)
Defines when to display a gap in the graph. 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.
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.
Defaults to: 0
setGapSize
in class AreaOptions
public String getGapUnit()
getGapUnit
in class AreaOptions
setGapUnit(String)
public void setGapUnit(String gapUnit)
gapSize
, this option defines where to draw
gaps in the graph.
Defaults to: relative
setGapUnit
in class AreaOptions
public Number getLegendIndex()
getLegendIndex
in class AreaOptions
setLegendIndex(Number)
public void setLegendIndex(Number legendIndex)
Defaults to: 0
setLegendIndex
in class AreaOptions
public PlotOptionsSeries getNavigatorOptions()
getNavigatorOptions
in class AreaOptions
setNavigatorOptions(PlotOptionsSeries)
public void setNavigatorOptions(PlotOptionsSeries navigatorOptions)
Options for the corresponding navigator series if
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.
Defaults to: undefined
setNavigatorOptions
in class AreaOptions
public Number getPointRange()
getPointRange
in class AreaOptions
setPointRange(Number)
public void setPointRange(Number pointRange)
Defaults to: 0
setPointRange
in class AreaOptions
public Boolean getShowInNavigator()
getShowInNavigator
in class AreaOptions
setShowInNavigator(Boolean)
public void setShowInNavigator(Boolean showInNavigator)
Defaults to: undefined
setShowInNavigator
in class AreaOptions
@Deprecated public void setPointStart(Date date)
setPointStart(Instant)
setPointStart
in class AreaOptions
public void setPointStart(Instant instant)
setPointStart
in class AreaOptions
setPointStart(Number)
Copyright © 2022. All rights reserved.