public interface PlotPriceenvelopesOptions extends Any
linkedTo
option to be set and should be loaded after the
stock/indicators/indicators.js
file.
Configuration options for the series are given in three levels:
priceenvelopes
series are defined in
plotOptions.priceenvelopes.
Modifier and Type | Interface and Description |
---|---|
static class |
PlotPriceenvelopesOptions.DashStyle |
static class |
PlotPriceenvelopesOptions.FindNearestPointBy |
static class |
PlotPriceenvelopesOptions.GapUnit |
static class |
PlotPriceenvelopesOptions.Linecap |
static interface |
PlotPriceenvelopesOptions.PointDescriptionFormatter |
static class |
PlotPriceenvelopesOptions.Step |
Modifier and Type | Method and Description |
---|---|
boolean |
getAllowPointSelect()
(Highstock) Allow this series' points to be selected by clicking on the
graphic (columns, point markers, pie slices, map areas etc).
|
Unknown |
getAnimation()
(Highstock) Enable or disable the initial animation when a series is
displayed.
|
double |
getAnimationLimit()
(Highstock) 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.
|
double |
getBoostThreshold()
(Highstock) Set the point threshold for when a series should enter boost
mode.
|
String |
getBorderColor()
(Highmaps, Highcharts) The border color of the map areas.
|
double |
getBorderWidth()
(Highmaps, Highcharts) The border width of each map area.
|
PlotPriceenvelopesBottomLineOptions |
getBottomLine()
(Highstock) Bottom line options.
|
String |
getClassName()
(Highstock) An additional class name to apply to the series' graphical
elements.
|
boolean |
getClip()
(Highstock) Disable this option to allow series rendering in the whole
plotting area.
|
Unknown |
getColor()
(Highstock) The main color of the series.
|
double |
getColorIndex()
(Highstock) Styled mode only.
|
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.
|
boolean |
getConnectNulls()
(Highcharts, Highstock) Whether to connect a graph line across null
points, or render a gap between the two points on either side of the
null.
|
PlotPriceenvelopesConnectorsOptions |
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()
(Highstock) 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.
|
PlotPriceenvelopesOptions.DashStyle |
getDashStyle()
(Highstock) A name for the dash style to use for the graph, or for some
series types the outline of each shape.
|
PlotPriceenvelopesDataGroupingOptions |
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.
|
PlotPriceenvelopesDataLabelsOptions |
getDataLabels()
(Highstock) Options for the series data labels, appearing next to each
data point.
|
String |
getDescription()
(Highstock) Requires the Accessibility module.
|
PlotPriceenvelopesDragDropOptions |
getDragDrop()
(Highstock) The draggable-points module allows points to be moved around
or modified in the chart.
|
boolean |
getEnableMouseTracking()
(Highstock) Enable or disable the mouse tracking for a specific series.
|
PlotPriceenvelopesEventsOptions |
getEvents()
(Highstock) General event handlers for the series items.
|
boolean |
getExposeElementToA11y()
(Highstock) By default, series are exposed to screen readers as regions.
|
PlotPriceenvelopesOptions.FindNearestPointBy |
getFindNearestPointBy()
(Highstock) 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.
|
PlotPriceenvelopesOptions.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.
|
PlotPriceenvelopesLabelOptions |
getLabel()
(Highcharts, Highstock, Gantt) Series labels are placed as close to the
series as possible in a natural way, seeking to avoid other series.
|
PlotPriceenvelopesOptions.Linecap |
getLinecap()
(Highcharts, Highstock) The SVG value used for the
stroke-linecap and
stroke-linejoin of a line graph. |
double |
getLineWidth()
(Highcharts, Highstock) Pixel width of the graph line.
|
String |
getLinkedTo()
(Highcharts, Highstock, Gantt) The main series ID that indicator will be
based on.
|
PlotPriceenvelopesMarkerOptions |
getMarker()
(Highstock) Options for the point markers of line-like series.
|
String |
getName()
(Highstock) The name of the series as shown in the legend, tooltip etc.
|
Unknown |
getNegativeColor()
(Highstock) The color for the parts of the graph or points that are below
the threshold.
|
PlotPriceenvelopesParamsOptions |
getParams() |
PlotPriceenvelopesPointOptions |
getPoint()
(Highstock) Properties for each single point.
|
PlotPriceenvelopesOptions.PointDescriptionFormatter |
getPointDescriptionFormatter()
(Highstock) Same as accessibility.pointDescriptionFormatter, but for an
individual series.
|
boolean |
getSelected()
(Highstock) Whether to select the series initially.
|
Unknown |
getShadow()
(Highstock) Whether to apply a drop shadow to the graph line.
|
boolean |
getShowCheckbox()
(Highstock) If true, a checkbox is displayed next to the legend item to
allow selecting the series.
|
boolean |
getShowInLegend()
(Highstock) Whether to display this particular series or series type in
the legend.
|
boolean |
getSkipKeyboardNavigation()
(Highstock) 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.
|
PlotPriceenvelopesStatesOptions |
getStates()
(Highstock) A wrapper object for all the series options in specific
states.
|
PlotPriceenvelopesOptions.Step |
getStep()
(Highcharts, Highstock) Whether to apply steps to the line.
|
boolean |
getStickyTracking()
(Highstock) Sticky tracking of mouse events.
|
double |
getThreshold()
(Highcharts, Highstock) The threshold, also called zero level or base
level.
|
PlotPriceenvelopesTooltipOptions |
getTooltip()
(Highstock) A configuration object for the tooltip rendering of each
single series.
|
PlotPriceenvelopesTopLineOptions |
getTopLine()
(Highstock) Top line options.
|
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()
(Highstock) 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<PlotPriceenvelopesZonesOptions> |
getZones()
(Highcharts, Highstock) An array defining zones within a series.
|
void |
setAllowPointSelect(boolean value)
(Highstock) Allow this series' points to be selected by clicking on the
graphic (columns, point markers, pie slices, map areas etc).
|
void |
setAnimation(AnimationOptionsObject value)
(Highstock) Enable or disable the initial animation when a series is
displayed.
|
void |
setAnimation(boolean value)
(Highstock) Enable or disable the initial animation when a series is
displayed.
|
void |
setAnimation(PlotPriceenvelopesAnimationOptions value)
(Highstock) Enable or disable the initial animation when a series is
displayed.
|
void |
setAnimationLimit(double value)
(Highstock) 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 |
setBoostThreshold(double value)
(Highstock) Set the point threshold for when a series should enter boost
mode.
|
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 |
setBottomLine(PlotPriceenvelopesBottomLineOptions value)
(Highstock) Bottom line options.
|
void |
setClassName(String value)
(Highstock) An additional class name to apply to the series' graphical
elements.
|
void |
setClip(boolean value)
(Highstock) Disable this option to allow series rendering in the whole
plotting area.
|
void |
setColor(Any value)
(Highstock) The main color of the series.
|
void |
setColor(GradientColorObject value)
(Highstock) The main color of the series.
|
void |
setColor(String value)
(Highstock) The main color of the series.
|
void |
setColorIndex(double value)
(Highstock) Styled mode only.
|
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 |
setConnectNulls(boolean value)
(Highcharts, Highstock) Whether to connect a graph line across null
points, or render a gap between the two points on either side of the
null.
|
void |
setConnectors(PlotPriceenvelopesConnectorsOptions 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)
(Highstock) 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)
(Highstock) 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(PlotPriceenvelopesOptions.DashStyle value)
(Highstock) A name for the dash style to use for the graph, or for some
series types the outline of each shape.
|
void |
setDataGrouping(PlotPriceenvelopesDataGroupingOptions 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(PlotPriceenvelopesDataLabelsOptions value)
(Highstock) Options for the series data labels, appearing next to each
data point.
|
void |
setDescription(String value)
(Highstock) Requires the Accessibility module.
|
void |
setDragDrop(PlotPriceenvelopesDragDropOptions value)
(Highstock) The draggable-points module allows points to be moved around
or modified in the chart.
|
void |
setEnableMouseTracking(boolean value)
(Highstock) Enable or disable the mouse tracking for a specific series.
|
void |
setEvents(PlotPriceenvelopesEventsOptions value)
(Highstock) General event handlers for the series items.
|
void |
setExposeElementToA11y(boolean value)
(Highstock) By default, series are exposed to screen readers as regions.
|
void |
setFindNearestPointBy(PlotPriceenvelopesOptions.FindNearestPointBy value)
(Highstock) 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(PlotPriceenvelopesOptions.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 |
setLabel(PlotPriceenvelopesLabelOptions 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(PlotPriceenvelopesOptions.Linecap value)
(Highcharts, Highstock) The SVG value used for the
stroke-linecap and
stroke-linejoin of a line graph. |
void |
setLineWidth(double value)
(Highcharts, Highstock) Pixel width of the graph line.
|
void |
setLinkedTo(String value)
(Highcharts, Highstock, Gantt) The main series ID that indicator will be
based on.
|
void |
setMarker(PlotPriceenvelopesMarkerOptions value)
(Highstock) Options for the point markers of line-like series.
|
void |
setName(String value)
(Highstock) The name of the series as shown in the legend, tooltip etc.
|
void |
setNegativeColor(Any value)
(Highstock) The color for the parts of the graph or points that are below
the threshold.
|
void |
setNegativeColor(GradientColorObject value)
(Highstock) The color for the parts of the graph or points that are below
the threshold.
|
void |
setNegativeColor(String value)
(Highstock) The color for the parts of the graph or points that are below
the threshold.
|
void |
setParams(PlotPriceenvelopesParamsOptions value) |
void |
setPoint(PlotPriceenvelopesPointOptions value)
(Highstock) Properties for each single point.
|
void |
setPointDescriptionFormatter(PlotPriceenvelopesOptions.PointDescriptionFormatter value)
(Highstock) Same as accessibility.pointDescriptionFormatter, but for an
individual series.
|
void |
setSelected(boolean value)
(Highstock) Whether to select the series initially.
|
void |
setShadow(boolean value)
(Highstock) Whether to apply a drop shadow to the graph line.
|
void |
setShadow(ShadowOptionsObject value)
(Highstock) Whether to apply a drop shadow to the graph line.
|
void |
setShowCheckbox(boolean value)
(Highstock) If true, a checkbox is displayed next to the legend item to
allow selecting the series.
|
void |
setShowInLegend(boolean value)
(Highstock) Whether to display this particular series or series type in
the legend.
|
void |
setSkipKeyboardNavigation(boolean value)
(Highstock) 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(PlotPriceenvelopesStatesOptions value)
(Highstock) A wrapper object for all the series options in specific
states.
|
void |
setStep(PlotPriceenvelopesOptions.Step value)
(Highcharts, Highstock) Whether to apply steps to the line.
|
void |
setStickyTracking(boolean value)
(Highstock) Sticky tracking of mouse events.
|
void |
setThreshold(double value)
(Highcharts, Highstock) The threshold, also called zero level or base
level.
|
void |
setTooltip(PlotPriceenvelopesTooltipOptions value)
(Highstock) A configuration object for the tooltip rendering of each
single series.
|
void |
setTopLine(PlotPriceenvelopesTopLineOptions value)
(Highstock) Top line options.
|
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)
(Highstock) 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<PlotPriceenvelopesZonesOptions> value)
(Highcharts, Highstock) An array defining zones within a series.
|
boolean getAllowPointSelect()
void setAllowPointSelect(boolean value)
@Nullable Unknown getAnimation()
void setAnimation(PlotPriceenvelopesAnimationOptions value)
void setAnimation(boolean value)
void setAnimation(AnimationOptionsObject value)
double getAnimationLimit()
animationLimit
to Infinity
.void setAnimationLimit(double value)
animationLimit
to Infinity
.double getBoostThreshold()
boostThreshold
to 0. Setting
it to 1 will force boosting.
Note that the cropThreshold also affects this setting. When zooming in on
a series that has fewer points than the cropThreshold
, all points are
rendered although outside the visible plot area, and the boostThreshold
won't take effect.
Requires modules/boost.js
.void setBoostThreshold(double value)
boostThreshold
to 0. Setting
it to 1 will force boosting.
Note that the cropThreshold also affects this setting. When zooming in on
a series that has fewer points than the cropThreshold
, all points are
rendered although outside the visible plot area, and the boostThreshold
won't take effect.
Requires modules/boost.js
.@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 PlotPriceenvelopesBottomLineOptions getBottomLine()
void setBottomLine(PlotPriceenvelopesBottomLineOptions value)
@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.double getColorIndex()
highcharts-color-{n}
.void setColorIndex(double value)
highcharts-color-{n}
.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)
boolean getConnectNulls()
void setConnectNulls(boolean value)
@Nullable PlotPriceenvelopesConnectorsOptions getConnectors()
void setConnectors(PlotPriceenvelopesConnectorsOptions value)
double getCropThreshold()
void setCropThreshold(double value)
@Nullable Unknown getCursor()
void setCursor(CursorType value)
void setCursor(String value)
@Nullable PlotPriceenvelopesOptions.DashStyle getDashStyle()
void setDashStyle(PlotPriceenvelopesOptions.DashStyle value)
@Nullable PlotPriceenvelopesDataGroupingOptions 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(PlotPriceenvelopesDataGroupingOptions 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 PlotPriceenvelopesDataLabelsOptions getDataLabels()
.highcharts-data-label-box
and .highcharts-data-label
class names
(see example).void setDataLabels(PlotPriceenvelopesDataLabelsOptions value)
.highcharts-data-label-box
and .highcharts-data-label
class names
(see example).@Nullable String getDescription()
void setDescription(String value)
@Nullable PlotPriceenvelopesDragDropOptions 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(PlotPriceenvelopesDragDropOptions 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 PlotPriceenvelopesEventsOptions getEvents()
Highcharts.addEvent
function.void setEvents(PlotPriceenvelopesEventsOptions value)
Highcharts.addEvent
function.boolean getExposeElementToA11y()
void setExposeElementToA11y(boolean value)
@Nullable PlotPriceenvelopesOptions.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(PlotPriceenvelopesOptions.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 PlotPriceenvelopesOptions.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(PlotPriceenvelopesOptions.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)
@Nullable PlotPriceenvelopesLabelOptions getLabel()
graph
or an
area
.
Requires the series-label.js
module.void setLabel(PlotPriceenvelopesLabelOptions value)
graph
or an
area
.
Requires the series-label.js
module.@Nullable PlotPriceenvelopesOptions.Linecap getLinecap()
stroke-linecap
and
stroke-linejoin
of a line graph. Round means that lines are rounded in
the ends and bends.void setLinecap(PlotPriceenvelopesOptions.Linecap value)
stroke-linecap
and
stroke-linejoin
of a line graph. Round means that lines are rounded in
the ends and bends.double getLineWidth()
void setLineWidth(double value)
@Nullable String getLinkedTo()
void setLinkedTo(String value)
@Nullable PlotPriceenvelopesMarkerOptions 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(PlotPriceenvelopesMarkerOptions 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 String getName()
void setName(String value)
@Nullable Unknown getNegativeColor()
void setNegativeColor(GradientColorObject value)
void setNegativeColor(String value)
void setNegativeColor(Any value)
@Nullable PlotPriceenvelopesParamsOptions getParams()
void setParams(PlotPriceenvelopesParamsOptions value)
@Nullable PlotPriceenvelopesPointOptions getPoint()
void setPoint(PlotPriceenvelopesPointOptions value)
@Nullable PlotPriceenvelopesOptions.PointDescriptionFormatter getPointDescriptionFormatter()
void setPointDescriptionFormatter(PlotPriceenvelopesOptions.PointDescriptionFormatter 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 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 PlotPriceenvelopesStatesOptions getStates()
void setStates(PlotPriceenvelopesStatesOptions value)
@Nullable PlotPriceenvelopesOptions.Step getStep()
left
, center
and right
.void setStep(PlotPriceenvelopesOptions.Step value)
left
, center
and right
.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()
void setThreshold(double value)
@Nullable PlotPriceenvelopesTooltipOptions getTooltip()
void setTooltip(PlotPriceenvelopesTooltipOptions value)
@Nullable PlotPriceenvelopesTopLineOptions getTopLine()
void setTopLine(PlotPriceenvelopesTopLineOptions 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<PlotPriceenvelopesZonesOptions> 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<PlotPriceenvelopesZonesOptions> 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.