@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 PlotOptionsCandlestick extends OhlcOptions
Constructor and Description |
---|
PlotOptionsCandlestick() |
Modifier and Type | Method and Description |
---|---|
void |
addKey(String key)
Adds key to the keys array
|
void |
addZone(Zones zone)
Adds zone to the zones array
|
Boolean |
getAllowPointSelect() |
Boolean |
getAnimation() |
Number |
getAnimationLimit() |
ChartType |
getChartType() |
String |
getClassName() |
Number |
getColorIndex() |
Number |
getCompareBase() |
Number |
getCropThreshold() |
Cursor |
getCursor() |
DataGrouping |
getDataGrouping() |
String |
getDescription() |
Boolean |
getEnableMouseTracking() |
Boolean |
getExposeElementToA11y() |
Dimension |
getFindNearestPointBy() |
String |
getGapUnit() |
Boolean |
getGetExtremesFromAll() |
Boolean |
getGrouping() |
Number |
getGroupPadding() |
String[] |
getKeys() |
Number |
getLegendIndex() |
String |
getLinkedTo() |
Number |
getMaxPointWidth() |
Number |
getMinPointLength() |
PlotOptionsSeries |
getNavigatorOptions() |
String |
getPointDescriptionFormatter() |
Number |
getPointInterval() |
IntervalUnit |
getPointIntervalUnit() |
Number |
getPointPadding() |
PointPlacement |
getPointPlacement() |
Number |
getPointRange() |
Number |
getPointStart() |
Number |
getPointWidth() |
Boolean |
getSelected() |
Boolean |
getShadow() |
Boolean |
getShowCheckbox() |
Boolean |
getShowInLegend() |
Boolean |
getShowInNavigator() |
Boolean |
getSkipKeyboardNavigation() |
Boolean |
getSoftThreshold() |
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 or
bars.
|
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 |
setCompareBase(Number compareBase)
When compare is
percent , this option dictates whether to use 0 or 100 as the
base of comparison. |
void |
setCropThreshold(Number cropThreshold)
When the series contains less points than the crop threshold, all points
are drawn, event 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 |
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 |
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 |
setGrouping(Boolean grouping)
Whether to group non-stacked columns or to let them render independent of
each other.
|
void |
setGroupPadding(Number groupPadding)
Padding between each value groups, in x axis units.
|
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 |
setLinkedTo(String linkedTo)
The id of another series to link to.
|
void |
setMaxPointWidth(Number maxPointWidth)
The maximum allowed pixel width for a column, translated to the height of
a bar in a bar chart.
|
void |
setMinPointLength(Number minPointLength)
The minimal height for a column or width for a bar.
|
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 in milliseconds.
|
void |
setPointIntervalUnit(IntervalUnit pointIntervalUnit)
On datetime series, this allows for setting the pointInterval to irregular
time units,
day , month and year . |
void |
setPointPadding(Number pointPadding)
Padding between each column or bar, in x axis units.
|
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 |
setPointWidth(Number pointWidth)
A pixel value specifying a fixed width for each column or bar.
|
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 |
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 OhlcOptions
public Boolean getAllowPointSelect()
getAllowPointSelect
in class OhlcOptions
setAllowPointSelect(Boolean)
public void setAllowPointSelect(Boolean allowPointSelect)
Defaults to: false
setAllowPointSelect
in class OhlcOptions
public Boolean getAnimation()
getAnimation
in class OhlcOptions
setAnimation(Boolean)
public void setAnimation(Boolean animation)
ChartModel.setAnimation(Boolean)
setAnimation
in class OhlcOptions
public Number getAnimationLimit()
getAnimationLimit
in class OhlcOptions
setAnimationLimit(Number)
public void setAnimationLimit(Number animationLimit)
animationLimit
to Infinity
.setAnimationLimit
in class OhlcOptions
public String getClassName()
getClassName
in class OhlcOptions
setClassName(String)
public void setClassName(String className)
setClassName
in class OhlcOptions
public Number getColorIndex()
getColorIndex
in class OhlcOptions
setColorIndex(Number)
public void setColorIndex(Number colorIndex)
highcharts-color-{n}
.setColorIndex
in class OhlcOptions
public Number getCompareBase()
getCompareBase
in class OhlcOptions
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 OhlcOptions
public Number getCropThreshold()
getCropThreshold
in class OhlcOptions
setCropThreshold(Number)
public void setCropThreshold(Number cropThreshold)
Defaults to: 50
setCropThreshold
in class OhlcOptions
public Cursor getCursor()
getCursor
in class OhlcOptions
setCursor(Cursor)
public void setCursor(Cursor cursor)
setCursor
in class OhlcOptions
public DataGrouping getDataGrouping()
getDataGrouping
in class OhlcOptions
setDataGrouping(DataGrouping)
public void setDataGrouping(DataGrouping dataGrouping)
OhlcOptions
setDataGrouping
in class OhlcOptions
public String getDescription()
getDescription
in class OhlcOptions
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 OhlcOptions
public Boolean getEnableMouseTracking()
getEnableMouseTracking
in class OhlcOptions
setEnableMouseTracking(Boolean)
public void setEnableMouseTracking(Boolean enableMouseTracking)
Defaults to: true
setEnableMouseTracking
in class OhlcOptions
public Boolean getExposeElementToA11y()
getExposeElementToA11y
in class OhlcOptions
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 OhlcOptions
public Dimension getFindNearestPointBy()
getFindNearestPointBy
in class OhlcOptions
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 OhlcOptions
public String getGapUnit()
getGapUnit
in class OhlcOptions
setGapUnit(String)
public void setGapUnit(String gapUnit)
gapSize
, this option defines where to draw
gaps in the graph.
Defaults to: relative
setGapUnit
in class OhlcOptions
public Boolean getGetExtremesFromAll()
getGetExtremesFromAll
in class OhlcOptions
setGetExtremesFromAll(Boolean)
public void setGetExtremesFromAll(Boolean getExtremesFromAll)
Defaults to: false
setGetExtremesFromAll
in class OhlcOptions
public Number getGroupPadding()
getGroupPadding
in class OhlcOptions
setGroupPadding(Number)
public void setGroupPadding(Number groupPadding)
Defaults to: 0.2
setGroupPadding
in class OhlcOptions
public Boolean getGrouping()
getGrouping
in class OhlcOptions
setGrouping(Boolean)
public void setGrouping(Boolean grouping)
Defaults to: true
setGrouping
in class OhlcOptions
public String[] getKeys()
getKeys
in class OhlcOptions
setKeys(String...)
public void setKeys(String... keys)
setKeys
in class OhlcOptions
public void addKey(String key)
addKey
in class OhlcOptions
key
- to addsetKeys(String...)
public void removeKey(String key)
removeKey
in class OhlcOptions
key
- to removesetKeys(String...)
public Number getLegendIndex()
getLegendIndex
in class OhlcOptions
setLegendIndex(Number)
public void setLegendIndex(Number legendIndex)
Defaults to: 0
setLegendIndex
in class OhlcOptions
public String getLinkedTo()
getLinkedTo
in class OhlcOptions
setLinkedTo(String)
public void setLinkedTo(String linkedTo)
setLinkedTo
in class OhlcOptions
public Number getMaxPointWidth()
getMaxPointWidth
in class OhlcOptions
setMaxPointWidth(Number)
public void setMaxPointWidth(Number maxPointWidth)
Defaults to: null
setMaxPointWidth
in class OhlcOptions
public Number getMinPointLength()
getMinPointLength
in class OhlcOptions
setMinPointLength(Number)
public void setMinPointLength(Number minPointLength)
Defaults to: 0
setMinPointLength
in class OhlcOptions
public PlotOptionsSeries getNavigatorOptions()
getNavigatorOptions
in class OhlcOptions
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 OhlcOptions
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 OhlcOptions
public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
setPointDescriptionFormatter
in class OhlcOptions
public Number getPointInterval()
getPointInterval
in class OhlcOptions
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 in milliseconds. For example, if a
series contains one value each day, set pointInterval to
24 * 3600 * 1000
.
Since Highstock 2.1, it can be combined with
pointIntervalUnit
to draw irregular intervals.
Defaults to: 1
setPointInterval
in class OhlcOptions
public IntervalUnit getPointIntervalUnit()
getPointIntervalUnit
in class OhlcOptions
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 OhlcOptions
public Number getPointPadding()
getPointPadding
in class OhlcOptions
setPointPadding(Number)
public void setPointPadding(Number pointPadding)
Defaults to: 0.1
setPointPadding
in class OhlcOptions
public PointPlacement getPointPlacement()
getPointPlacement
in class OhlcOptions
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.
Defaults to: null
setPointPlacement
in class OhlcOptions
public Number getPointRange()
getPointRange
in class OhlcOptions
setPointRange(Number)
public void setPointRange(Number pointRange)
Defaults to: null
setPointRange
in class OhlcOptions
public Number getPointStart()
getPointStart
in class OhlcOptions
setPointStart(Number)
public void setPointStart(Number pointStart)
Date.UTC(2011, 0, 1)
.
Defaults to: 0
setPointStart
in class OhlcOptions
public Number getPointWidth()
getPointWidth
in class OhlcOptions
setPointWidth(Number)
public void setPointWidth(Number pointWidth)
null
, the width is calculated from the
pointPadding
and groupPadding
.
Defaults to: null
setPointWidth
in class OhlcOptions
public Boolean getSelected()
getSelected
in class OhlcOptions
setSelected(Boolean)
public void setSelected(Boolean selected)
showCheckbox
is
true, the checkbox next to the series name in the legend will be checked
for a selected series.
Defaults to: false
setSelected
in class OhlcOptions
public Boolean getShadow()
getShadow
in class OhlcOptions
setShadow(Boolean)
public void setShadow(Boolean shadow)
color
,
offsetX
, offsetY
, opacity
and
width
.
Defaults to: false
setShadow
in class OhlcOptions
public Boolean getShowCheckbox()
getShowCheckbox
in class OhlcOptions
setShowCheckbox(Boolean)
public void setShowCheckbox(Boolean showCheckbox)
selected
option.
Defaults to: false
setShowCheckbox
in class OhlcOptions
public Boolean getShowInLegend()
getShowInLegend
in class OhlcOptions
setShowInLegend(Boolean)
public void setShowInLegend(Boolean showInLegend)
true
for standalone series,
false
for linked series.
Defaults to: true
setShowInLegend
in class OhlcOptions
public Boolean getShowInNavigator()
getShowInNavigator
in class OhlcOptions
setShowInNavigator(Boolean)
public void setShowInNavigator(Boolean showInNavigator)
Defaults to: undefined
setShowInNavigator
in class OhlcOptions
public Boolean getSkipKeyboardNavigation()
getSkipKeyboardNavigation
in class OhlcOptions
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 OhlcOptions
public Boolean getSoftThreshold()
getSoftThreshold
in class OhlcOptions
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
setSoftThreshold
in class OhlcOptions
public States getStates()
getStates
in class OhlcOptions
setStates(States)
public void setStates(States states)
setStates
in class OhlcOptions
public Boolean getStickyTracking()
getStickyTracking
in class OhlcOptions
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 not shared.
When stickyTracking
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, candlesticks etc.
Defaults to: true
setStickyTracking
in class OhlcOptions
public Number getThreshold()
getThreshold
in class OhlcOptions
setThreshold(Number)
public void setThreshold(Number threshold)
Defaults to: 0
setThreshold
in class OhlcOptions
public SeriesTooltip getTooltip()
getTooltip
in class OhlcOptions
setTooltip(SeriesTooltip)
public void setTooltip(SeriesTooltip tooltip)
setTooltip
in class OhlcOptions
public Number getTurboThreshold()
getTurboThreshold
in class OhlcOptions
setTurboThreshold(Number)
public void setTurboThreshold(Number turboThreshold)
0
disable.
Defaults to: 1000
setTurboThreshold
in class OhlcOptions
public Boolean getVisible()
getVisible
in class OhlcOptions
setVisible(Boolean)
public void setVisible(Boolean visible)
Defaults to: true
setVisible
in class OhlcOptions
public ZoneAxis getZoneAxis()
getZoneAxis
in class OhlcOptions
setZoneAxis(ZoneAxis)
public void setZoneAxis(ZoneAxis zoneAxis)
Defaults to: y
setZoneAxis
in class OhlcOptions
public Zones[] getZones()
getZones
in class OhlcOptions
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 OhlcOptions
public void addZone(Zones zone)
addZone
in class OhlcOptions
zone
- to addsetZones(Zones...)
public void removeZone(Zones zone)
removeZone
in class OhlcOptions
zone
- to removesetZones(Zones...)
@Deprecated public void setPointStart(Date date)
setPointStart(Instant)
setPointStart
in class OhlcOptions
public void setPointStart(Instant instant)
setPointStart
in class OhlcOptions
setPointStart(Number)
Copyright © 2019. All rights reserved.