public abstract class PointOptions extends AbstractPlotOptions
Constructor and Description |
---|
PointOptions() |
Modifier and Type | Method and Description |
---|---|
abstract void |
addKey(String key)
Adds key to the keys array
|
abstract void |
addZone(Zones zone)
Adds zone to the zones array
|
abstract Boolean |
getAllowPointSelect() |
abstract Boolean |
getAnimation() |
abstract Number |
getAnimationLimit() |
abstract ChartType |
getChartType() |
abstract String |
getClassName() |
abstract Number |
getColorIndex() |
abstract Compare |
getCompare() |
abstract Number |
getCompareBase() |
abstract Number |
getCropThreshold() |
abstract Cursor |
getCursor() |
abstract DataGrouping |
getDataGrouping() |
abstract DataLabels |
getDataLabels() |
abstract String |
getDescription() |
abstract Boolean |
getEnableMouseTracking() |
abstract Boolean |
getExposeElementToA11y() |
abstract Dimension |
getFindNearestPointBy() |
abstract String |
getGapUnit() |
abstract Boolean |
getGetExtremesFromAll() |
abstract String[] |
getKeys() |
abstract Number |
getLegendIndex() |
abstract String |
getLinkedTo() |
abstract Marker |
getMarker() |
abstract PlotOptionsSeries |
getNavigatorOptions() |
abstract String |
getPointDescriptionFormatter() |
abstract Number |
getPointInterval() |
abstract IntervalUnit |
getPointIntervalUnit() |
abstract PointPlacement |
getPointPlacement() |
abstract Number |
getPointRange() |
abstract Number |
getPointStart() |
abstract Boolean |
getSelected() |
abstract Boolean |
getShadow() |
abstract Boolean |
getShowCheckbox() |
abstract Boolean |
getShowInLegend() |
abstract Boolean |
getShowInNavigator() |
abstract Boolean |
getSkipKeyboardNavigation() |
abstract Boolean |
getSoftThreshold() |
abstract Stacking |
getStacking() |
abstract States |
getStates() |
abstract Boolean |
getStickyTracking() |
abstract Number |
getThreshold() |
abstract SeriesTooltip |
getTooltip() |
abstract Number |
getTurboThreshold() |
abstract Boolean |
getVisible() |
abstract ZoneAxis |
getZoneAxis() |
abstract Zones[] |
getZones() |
abstract void |
removeKey(String key)
Removes first occurrence of key in keys array
|
abstract void |
removeZone(Zones zone)
Removes first occurrence of zone in zones array
|
abstract void |
setAllowPointSelect(Boolean allowPointSelect)
Allow this series' points to be selected by clicking on the markers, bars
or pie slices.
|
abstract void |
setAnimation(Boolean animation)
Enable or disable the initial animation when a series is displayed.
|
abstract 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.
|
abstract void |
setClassName(String className)
A class name to apply to the series' graphical elements.
|
abstract void |
setColorIndex(Number colorIndex)
A specific color index to use for the series, so
its graphic representations are given the class name
highcharts-color-{n} . |
abstract void |
setCompare(Compare compare)
Compare the values of the series against the first non-null, non-zero
value in the visible range.
|
abstract void |
setCompareBase(Number compareBase)
This option dictates whether to use 0 or 100 as the
base of comparison.
|
abstract 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.
|
abstract 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.
|
abstract 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
charts.
|
abstract void |
setDataLabels(DataLabels dataLabels)
Specific data labels configuration for a series type
|
abstract void |
setDescription(String description)
A description of the series to add to the screen reader information about
the series.
|
abstract void |
setEnableMouseTracking(Boolean enableMouseTracking)
Enable or disable the mouse tracking for a specific series.
|
abstract void |
setExposeElementToA11y(Boolean exposeElementToA11y)
By default, series are exposed to screen readers as regions.
|
abstract 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.
|
abstract void |
setGapUnit(String gapUnit)
Together with
gapSize , this option defines where to draw
gaps in the graph. |
abstract 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.
|
abstract void |
setKeys(String... keys)
An array specifying which option maps to which key in the data point
array.
|
abstract void |
setLegendIndex(Number legendIndex)
The sequential index of the series within the legend.
|
abstract void |
setLinkedTo(String linkedTo)
The ID of another series to link to.
|
abstract void |
setMarker(Marker marker)
Options for the point markers of line-like series.
|
abstract void |
setNavigatorOptions(PlotOptionsSeries navigatorOptions)
Options for the corresponding navigator series if
showInNavigator is true for this series. |
abstract void |
setPointDescriptionFormatter(String _fn_pointDescriptionFormatter) |
abstract void |
setPointInterval(Number pointInterval)
If no x values are given for the points in a series, pointInterval
defines the interval of the x values.
|
abstract void |
setPointIntervalUnit(IntervalUnit pointIntervalUnit)
On datetime series, this allows for setting the pointInterval to irregular
time units,
day , month and year . |
abstract void |
setPointPlacement(PointPlacement pointPlacement)
Possible values:
null , "on" ,
"between" . |
abstract void |
setPointRange(Number pointRange)
The width of each point on the x axis.
|
abstract void |
setPointStart(Date date)
Deprecated.
|
abstract void |
setPointStart(Instant instant) |
abstract void |
setPointStart(Number pointStart)
If no x values are given for the points in a series, pointStart defines
on what value to start.
|
abstract void |
setSelected(Boolean selected)
Whether to select the series initially.
|
abstract void |
setShadow(Boolean shadow)
Whether to apply a drop shadow to the graph line.
|
abstract void |
setShowCheckbox(Boolean showCheckbox)
If true, a checkbox is displayed next to the legend item to allow
selecting the series.
|
abstract void |
setShowInLegend(Boolean showInLegend)
Whether to display this particular series or series type in the legend.
|
abstract void |
setShowInNavigator(Boolean showInNavigator)
Whether or not to show the series in the navigator.
|
abstract void |
setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
Whether or not to skip past the
points in this series for keyboard navigation.
|
abstract void |
setSoftThreshold(Boolean softThreshold)
When this is true, the series will not cause the Y axis to cross the zero
plane unless the data actually crosses the plane.
|
abstract void |
setStacking(Stacking stacking)
Whether to stack the values of each series on top of each other.
|
abstract void |
setStates(States states)
A wrapper object for all the series options in specific states.
|
abstract void |
setStickyTracking(Boolean stickyTracking)
Sticky tracking of mouse events.
|
abstract void |
setThreshold(Number threshold)
The threshold, also called zero level or base level.
|
abstract void |
setTooltip(SeriesTooltip tooltip)
A configuration object for the tooltip rendering of each single series.
|
abstract 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.
|
abstract void |
setVisible(Boolean visible)
Set the initial visibility of the series.
|
abstract void |
setZoneAxis(ZoneAxis zoneAxis)
Defines the Axis on which the zones are applied.
|
abstract void |
setZones(Zones... zones)
An array defining zones within a series.
|
public abstract ChartType getChartType()
getChartType
in class AbstractPlotOptions
public abstract Boolean getAllowPointSelect()
setAllowPointSelect(Boolean)
public abstract void setAllowPointSelect(Boolean allowPointSelect)
public abstract Boolean getAnimation()
setAnimation(Boolean)
public abstract void setAnimation(Boolean animation)
Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself.
Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
public abstract Number getAnimationLimit()
setAnimationLimit(Number)
public abstract void setAnimationLimit(Number animationLimit)
animationLimit
to Infinity
.public abstract String getClassName()
setClassName(String)
public abstract void setClassName(String className)
public abstract Number getColorIndex()
setColorIndex(Number)
public abstract void setColorIndex(Number colorIndex)
highcharts-color-{n}
.public abstract Number getCropThreshold()
setCropThreshold(Number)
public abstract void setCropThreshold(Number cropThreshold)
public abstract Cursor getCursor()
setCursor(Cursor)
public abstract void setCursor(Cursor cursor)
public abstract DataLabels getDataLabels()
setDataLabels(DataLabels)
public abstract void setDataLabels(DataLabels dataLabels)
dataLabels
- public abstract String getDescription()
setDescription(String)
public abstract void setDescription(String description)
public abstract Boolean getEnableMouseTracking()
setEnableMouseTracking(Boolean)
public abstract void setEnableMouseTracking(Boolean enableMouseTracking)
public abstract Boolean getExposeElementToA11y()
setExposeElementToA11y(Boolean)
public abstract void setExposeElementToA11y(Boolean exposeElementToA11y)
public abstract Dimension getFindNearestPointBy()
setFindNearestPointBy(Dimension)
public abstract 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 abstract Boolean getGetExtremesFromAll()
setGetExtremesFromAll(Boolean)
public abstract void setGetExtremesFromAll(Boolean getExtremesFromAll)
public abstract String[] getKeys()
setKeys(String...)
public abstract void setKeys(String... keys)
public abstract void addKey(String key)
key
- to addsetKeys(String...)
public abstract void removeKey(String key)
key
- to removesetKeys(String...)
public abstract String getLinkedTo()
setLinkedTo(String)
public abstract void setLinkedTo(String linkedTo)
public abstract Marker getMarker()
setMarker(Marker)
public abstract void setMarker(Marker marker)
public abstract String getPointDescriptionFormatter()
public abstract void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
public abstract Number getPointInterval()
setPointInterval(Number)
public abstract 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.
It can be combined with pointIntervalUnit
to draw irregular
intervals.
public abstract IntervalUnit getPointIntervalUnit()
setPointIntervalUnit(IntervalUnit)
public abstract 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 abstract Number getPointStart()
setPointStart(Number)
public abstract void setPointStart(Number pointStart)
public abstract Boolean getSelected()
setSelected(Boolean)
public abstract void setSelected(Boolean selected)
showCheckbox
is
true, the checkbox next to the series name will be checked for a selected
series.public abstract Boolean getShadow()
setShadow(Boolean)
public abstract void setShadow(Boolean shadow)
public abstract Boolean getShowCheckbox()
setShowCheckbox(Boolean)
public abstract void setShowCheckbox(Boolean showCheckbox)
selected
option.public abstract Boolean getShowInLegend()
setShowInLegend(Boolean)
public abstract void setShowInLegend(Boolean showInLegend)
true
for standalone series,
false
for linked series.public abstract Boolean getSkipKeyboardNavigation()
setSkipKeyboardNavigation(Boolean)
public abstract void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
public abstract Boolean getSoftThreshold()
setSoftThreshold(Boolean)
public abstract void setSoftThreshold(Boolean softThreshold)
When this is true, the series will not cause the Y axis to cross the zero plane 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.
public abstract States getStates()
setStates(States)
public abstract void setStates(States states)
public abstract Boolean getStickyTracking()
setStickyTracking(Boolean)
public abstract 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.public abstract Number getThreshold()
setThreshold(Number)
public abstract void setThreshold(Number threshold)
public abstract SeriesTooltip getTooltip()
setTooltip(SeriesTooltip)
public abstract void setTooltip(SeriesTooltip tooltip)
public abstract Number getTurboThreshold()
setTurboThreshold(Number)
public abstract void setTurboThreshold(Number turboThreshold)
0
disable.public abstract Boolean getVisible()
setVisible(Boolean)
public abstract void setVisible(Boolean visible)
public abstract ZoneAxis getZoneAxis()
setZoneAxis(ZoneAxis)
public abstract void setZoneAxis(ZoneAxis zoneAxis)
public abstract Zones[] getZones()
setZones(Zones...)
public abstract void setZones(Zones... zones)
zoneAxis
option.public abstract void addZone(Zones zone)
zone
- to addsetZones(Zones...)
public abstract void removeZone(Zones zone)
zone
- to removesetZones(Zones...)
public abstract Compare getCompare()
setCompare(Compare)
public abstract 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.public abstract Number getCompareBase()
setCompareBase(Number)
public abstract void setCompareBase(Number compareBase)
public abstract DataGrouping getDataGrouping()
setDataGrouping(DataGrouping)
public abstract void setDataGrouping(DataGrouping dataGrouping)
public abstract String getGapUnit()
setGapUnit(String)
public abstract void setGapUnit(String gapUnit)
gapSize
, this option defines where to draw
gaps in the graph.public abstract Number getLegendIndex()
setLegendIndex(Number)
public abstract void setLegendIndex(Number legendIndex)
public abstract PlotOptionsSeries getNavigatorOptions()
setNavigatorOptions(PlotOptionsSeries)
public abstract void setNavigatorOptions(PlotOptionsSeries navigatorOptions)
showInNavigator
is true
for this series.public abstract PointPlacement getPointPlacement()
setPointPlacement(PointPlacement)
public abstract 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.
Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.
public abstract Number getPointRange()
setPointRange(Number)
public abstract void setPointRange(Number pointRange)
public abstract Boolean getShowInNavigator()
setShowInNavigator(Boolean)
public abstract void setShowInNavigator(Boolean showInNavigator)
public abstract Stacking getStacking()
setStacking(Stacking)
public abstract void setStacking(Stacking stacking)
@Deprecated public abstract void setPointStart(Date date)
setPointStart(Number)
public abstract void setPointStart(Instant instant)
setPointStart(Number)
Copyright © 2019. All rights reserved.