@Generated(value="This class is generated and shouldn\'t be modified", comments="Incorrect and missing API should be reported to https://github.com/vaadin/vaadin-charts-flow/issues/new") public class PlotOptionsSpline extends PointOptions
Constructor and Description |
---|
PlotOptionsSpline() |
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() |
Compare |
getCompare() |
Number |
getCompareBase() |
Boolean |
getConnectEnds() |
Boolean |
getConnectNulls() |
Number |
getCropThreshold() |
Cursor |
getCursor() |
DataGrouping |
getDataGrouping() |
DataLabels |
getDataLabels() |
String |
getDescription() |
Boolean |
getEnableMouseTracking() |
Boolean |
getExposeElementToA11y() |
Dimension |
getFindNearestPointBy() |
Number |
getGapSize() |
String |
getGapUnit() |
Boolean |
getGetExtremesFromAll() |
String[] |
getKeys() |
Number |
getLegendIndex() |
String |
getLinecap() |
String |
getLinkedTo() |
Marker |
getMarker() |
PlotOptionsSeries |
getNavigatorOptions() |
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() |
Number |
getTurboThreshold() |
Boolean |
getVisible() |
ZoneAxis |
getZoneAxis() |
Zones[] |
getZones() |
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 |
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 |
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 |
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 |
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 |
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(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 |
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 threshold, also called zero level or base level.
|
void |
setTooltip(SeriesTooltip tooltip)
A configuration object for the tooltip rendering of each single series.
|
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 PointOptions
public Boolean getAllowPointSelect()
getAllowPointSelect
in class PointOptions
setAllowPointSelect(Boolean)
public void setAllowPointSelect(Boolean allowPointSelect)
Defaults to: false
setAllowPointSelect
in class PointOptions
public Boolean getAnimation()
getAnimation
in class PointOptions
setAnimation(Boolean)
public void setAnimation(Boolean animation)
ChartModel.setAnimation(Boolean)
setAnimation
in class PointOptions
public Number getAnimationLimit()
getAnimationLimit
in class PointOptions
setAnimationLimit(Number)
public void setAnimationLimit(Number animationLimit)
animationLimit
to Infinity
.setAnimationLimit
in class PointOptions
public String getClassName()
getClassName
in class PointOptions
setClassName(String)
public void setClassName(String className)
setClassName
in class PointOptions
public Number getColorIndex()
getColorIndex
in class PointOptions
setColorIndex(Number)
public void setColorIndex(Number colorIndex)
highcharts-color-{n}
.setColorIndex
in class PointOptions
public Boolean getConnectEnds()
setConnectEnds(Boolean)
public void setConnectEnds(Boolean connectEnds)
Defaults to: true
public Boolean getConnectNulls()
setConnectNulls(Boolean)
public void setConnectNulls(Boolean connectNulls)
Defaults to: false
public Number getCropThreshold()
getCropThreshold
in class PointOptions
setCropThreshold(Number)
public void setCropThreshold(Number cropThreshold)
Defaults to: 300
setCropThreshold
in class PointOptions
public Cursor getCursor()
getCursor
in class PointOptions
setCursor(Cursor)
public void setCursor(Cursor cursor)
setCursor
in class PointOptions
public DataLabels getDataLabels()
getDataLabels
in class PointOptions
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).
setDataLabels
in class PointOptions
public String getDescription()
getDescription
in class PointOptions
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 PointOptions
public Boolean getEnableMouseTracking()
getEnableMouseTracking
in class PointOptions
setEnableMouseTracking(Boolean)
public void setEnableMouseTracking(Boolean enableMouseTracking)
Defaults to: true
setEnableMouseTracking
in class PointOptions
public Boolean getExposeElementToA11y()
getExposeElementToA11y
in class PointOptions
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 PointOptions
public Dimension getFindNearestPointBy()
getFindNearestPointBy
in class PointOptions
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 PointOptions
public Boolean getGetExtremesFromAll()
getGetExtremesFromAll
in class PointOptions
setGetExtremesFromAll(Boolean)
public void setGetExtremesFromAll(Boolean getExtremesFromAll)
Defaults to: false
setGetExtremesFromAll
in class PointOptions
public String[] getKeys()
getKeys
in class PointOptions
setKeys(String...)
public void setKeys(String... keys)
setKeys
in class PointOptions
public void addKey(String key)
addKey
in class PointOptions
key
- to addsetKeys(String...)
public void removeKey(String key)
removeKey
in class PointOptions
key
- to removesetKeys(String...)
public String getLinecap()
setLinecap(String)
public void setLinecap(String linecap)
Defaults to: round
public String getLinkedTo()
getLinkedTo
in class PointOptions
setLinkedTo(String)
public void setLinkedTo(String linkedTo)
setLinkedTo
in class PointOptions
public Marker getMarker()
getMarker
in class PointOptions
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.
setMarker
in class PointOptions
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()
getPointDescriptionFormatter
in class PointOptions
public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
setPointDescriptionFormatter
in class PointOptions
public Number getPointInterval()
getPointInterval
in class PointOptions
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 PointOptions
public IntervalUnit getPointIntervalUnit()
getPointIntervalUnit
in class PointOptions
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 PointOptions
public PointPlacement getPointPlacement()
getPointPlacement
in class PointOptions
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 PointOptions
public Number getPointStart()
getPointStart
in class PointOptions
setPointStart(Number)
public void setPointStart(Number pointStart)
Defaults to: 0
setPointStart
in class PointOptions
public Boolean getSelected()
getSelected
in class PointOptions
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 PointOptions
public Boolean getShadow()
getShadow
in class PointOptions
setShadow(Boolean)
public void setShadow(Boolean shadow)
color
,
offsetX
, offsetY
, opacity
and
width
.
Defaults to: false
setShadow
in class PointOptions
public Boolean getShowCheckbox()
getShowCheckbox
in class PointOptions
setShowCheckbox(Boolean)
public void setShowCheckbox(Boolean showCheckbox)
selected
option.
Defaults to: false
setShowCheckbox
in class PointOptions
public Boolean getShowInLegend()
getShowInLegend
in class PointOptions
setShowInLegend(Boolean)
public void setShowInLegend(Boolean showInLegend)
true
for standalone series,
false
for linked series.
Defaults to: true
setShowInLegend
in class PointOptions
public Boolean getSkipKeyboardNavigation()
getSkipKeyboardNavigation
in class PointOptions
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 PointOptions
public Boolean getSoftThreshold()
getSoftThreshold
in class PointOptions
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: true
setSoftThreshold
in class PointOptions
public Stacking getStacking()
getStacking
in class PointOptions
setStacking(Stacking)
public void setStacking(Stacking stacking)
setStacking
in class PointOptions
public States getStates()
getStates
in class PointOptions
setStates(States)
public void setStates(States states)
setStates
in class PointOptions
public Boolean getStickyTracking()
getStickyTracking
in class PointOptions
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 PointOptions
public Number getThreshold()
getThreshold
in class PointOptions
setThreshold(Number)
public void setThreshold(Number threshold)
Defaults to: 0
setThreshold
in class PointOptions
public SeriesTooltip getTooltip()
getTooltip
in class PointOptions
setTooltip(SeriesTooltip)
public void setTooltip(SeriesTooltip tooltip)
setTooltip
in class PointOptions
public Number getTurboThreshold()
getTurboThreshold
in class PointOptions
setTurboThreshold(Number)
public void setTurboThreshold(Number turboThreshold)
0
disable.
Defaults to: 1000
setTurboThreshold
in class PointOptions
public Boolean getVisible()
getVisible
in class PointOptions
setVisible(Boolean)
public void setVisible(Boolean visible)
Defaults to: true
setVisible
in class PointOptions
public ZoneAxis getZoneAxis()
getZoneAxis
in class PointOptions
setZoneAxis(ZoneAxis)
public void setZoneAxis(ZoneAxis zoneAxis)
Defaults to: y
setZoneAxis
in class PointOptions
public Zones[] getZones()
getZones
in class PointOptions
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 PointOptions
public void addZone(Zones zone)
addZone
in class PointOptions
zone
- to addsetZones(Zones...)
public void removeZone(Zones zone)
removeZone
in class PointOptions
zone
- to removesetZones(Zones...)
public Compare getCompare()
getCompare
in class PointOptions
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 PointOptions
public Number getCompareBase()
getCompareBase
in class PointOptions
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 PointOptions
public DataGrouping getDataGrouping()
getDataGrouping
in class PointOptions
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 PointOptions
public Number getGapSize()
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
public String getGapUnit()
getGapUnit
in class PointOptions
setGapUnit(String)
public void setGapUnit(String gapUnit)
gapSize
, this option defines where to draw
gaps in the graph.
Defaults to: relative
setGapUnit
in class PointOptions
public Number getLegendIndex()
getLegendIndex
in class PointOptions
setLegendIndex(Number)
public void setLegendIndex(Number legendIndex)
Defaults to: 0
setLegendIndex
in class PointOptions
public PlotOptionsSeries getNavigatorOptions()
getNavigatorOptions
in class PointOptions
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 PointOptions
public Number getPointRange()
getPointRange
in class PointOptions
setPointRange(Number)
public void setPointRange(Number pointRange)
Defaults to: 0
setPointRange
in class PointOptions
public Boolean getShowInNavigator()
getShowInNavigator
in class PointOptions
setShowInNavigator(Boolean)
public void setShowInNavigator(Boolean showInNavigator)
Defaults to: undefined
setShowInNavigator
in class PointOptions
@Deprecated public void setPointStart(Date date)
setPointStart(Instant)
setPointStart
in class PointOptions
PointOptions.setPointStart(Number)
public void setPointStart(Instant instant)
setPointStart
in class PointOptions
setPointStart(Number)
Copyright © 2019. All rights reserved.