SeriesFlags

Companion object SeriesFlags

class SeriesFlags extends Object

Annotations: @RawJSType() @ScalaJSDefined()
Note: JavaScript name: series<flags>

Linear Supertypes

Object, Any, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

SeriesFlags
Object
Any
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new SeriesFlags()

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val allowPointSelect: UndefOr[Boolean]
Allow this series' points to be selected by clicking on the markers or bars.
val animationLimit: UndefOr[Double]
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.
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. For example, for a column chart and its derivatives, animation doesn't run if there is more than 250 points totally. To disable this cap, set animationLimit to Infinity.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val className: UndefOr[String]
A class name to apply to the series' graphical elements.
A class name to apply to the series' graphical elements.

Since
5.0.0
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val color: UndefOr[|[String, Object]]
The main color of the series.
The main color of the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the options.colors array.
In styled mode, the 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.
val colors: UndefOr[Array[|[String, Object]]]
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.

Since
1.3
val compareBase: UndefOr[Double]
When compare is percent, this option dictates whether to use 0 or 100 as the base of comparison.
When compare is percent, this option dictates whether to use 0 or 100 as the base of comparison.
Example:
1. Compare base is 100
Since
5.0.6
val cropThreshold: UndefOr[Double]
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.
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. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series. .
val cursor: UndefOr[String]
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.
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.
Example:
1. Pointer on a line graph
val data: UndefOr[Array[CleanJsObject[SeriesFlagsData]]]
An array of data points for the series.
An array of data points for the series. For the flags series type, points can be given in the following ways:
-
An array of objects with named values. The objects are point configuration objects as seen below. If the total number of data points exceeds the series' turboThreshold, this option is not available.
```
data: [{
    x: 1,
    title: "A",
    text: "First event"
}, {
    x: 1,
    title: "B",
    text: "Second event"
}]
```
val dataLabels: UndefOr[CleanJsObject[SeriesFlagsDataLabels]]
Options for the series data labels, appearing next to each data point.
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).
val description: UndefOr[String]
Requires Accessibility module
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Example:
1. Accessible stock chart
Since
5.0.0
val enableMouseTracking: UndefOr[Boolean]
Enable or disable the mouse tracking for a specific series.
Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. When using shared tooltips (default in stock charts), mouse tracking is not required. For large datasets it improves performance.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val events: UndefOr[CleanJsObject[SeriesFlagsEvents]]
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val getExtremesFromAll: UndefOr[Boolean]
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.
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. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.

Since
2.1.6
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
val id: UndefOr[String]
An id for the series.
An id for the series. This can be used after render time to get a pointer to the series object through chart.get().
val index: UndefOr[Double]
The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.

Since
1.2.0
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
val keys: UndefOr[Array[String]]
An array specifying which option maps to which key in the data point array.
An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.
Example:
1. An extended data array with keys
Since
2.1.6
val legendIndex: UndefOr[Double]
The sequential index of the series in the legend.
The sequential index of the series in the legend.
Try it: Legend in opposite order .
val lineColor: UndefOr[|[String, Object]]
The color of the line/border of the flag.
The color of the line/border of the flag.
In styled mode, the stroke is set in the .highcharts-flag-series .highcharts-point rule.
val lineWidth: UndefOr[Double]
The pixel width of the candlestick line/border.
The pixel width of the candlestick line/border. Defaults to 1.
val linkedTo: UndefOr[String]
The id of another series to link to.
The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
Example:
1. Linked series
Since
1.3
val maxPointWidth: UndefOr[Double]
The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.
The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.
Example:
1. Limited to 50
Since
2.1.8
val name: UndefOr[String]
The name of the series as shown in the legend, tooltip etc.
val navigatorOptions: UndefOr[Object]
Options for the corresponding navigator series if showInNavigator is true for this series.
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.

Since
5.0.0
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val negativeColor: UndefOr[|[String, Object]]
The color for the parts of the graph or points that are below the threshold.
The color for the parts of the graph or points that are below the threshold.
Example:
1. Spline, area and column - arearange.
Since
3.0
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val onKey: UndefOr[String]
In case the flag is placed on a series, on what point key to place it.
In case the flag is placed on a series, on what point key to place it. Line and columns have one key, y. In range or OHLC-type series, however, the flag can optionally be placed on the open, high, low or close key.
Example:
1. Range series, flag on high.
Since
4.2.2
val onSeries: UndefOr[String]
The id of the series that the flags should be drawn on.
The id of the series that the flags should be drawn on. If no id is given, the flags are drawn on the x axis.
Example:
1. Flags on series and on x axis
val point: UndefOr[CleanJsObject[SeriesFlagsPoint]]
Properties for each single point
val pointIntervalUnit: UndefOr[String]
On datetime series, this allows for setting the pointInterval to irregular time units, day, month and year.
On datetime series, this allows for setting the pointInterval to irregular time units, 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.
Example:
1. One point a month
Since
2.1.0
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
val selected: UndefOr[Boolean]
Whether to select the series initially.
Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name in the legend will be checked for a selected series.
val shadow: UndefOr[|[Boolean, Object]]
Whether to apply a drop shadow to the graph line.
Whether to apply a drop shadow to the graph line. Since 1.1.7 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
val shape: UndefOr[String]
The shape of the marker.
The shape of the marker. Can be one of "flag", "circlepin", "squarepin", or an image on the format url(/path-to-image.jpg). Individual shapes can also be set for each point.
Example:
1. Different shapes
val showCheckbox: UndefOr[Boolean]
If true, a checkbox is displayed next to the legend item to allow selecting the series.
If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
val showInLegend: UndefOr[Boolean]
Whether to display this particular series or series type in the legend.
Whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.
val showInNavigator: UndefOr[Boolean]
Whether or not to show the series in the navigator.
Whether or not to show the series in the navigator. Takes precedence over navigator.baseSeries if defined.
Example:
1. Multiple navigator series
Since
5.0.0
val softThreshold: UndefOr[Boolean]
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.
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.

Since
2.1.9
val stack: UndefOr[String]
This option allows grouping series in a stacked chart.
This option allows grouping series in a stacked chart. The stack option can be a string or a number or anything else, as long as the grouped series' stack options match each other.
val stackDistance: UndefOr[Double]
When multiple flags in the same series fall on the same value, this number determines the vertical offset between them.
When multiple flags in the same series fall on the same value, this number determines the vertical offset between them.
Example:
1. A greater stack distance
val states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]]
A wrapper object for all the series options in specific states.
val stickyTracking: UndefOr[Boolean]
Sticky tracking of mouse events.
Sticky tracking of mouse events. When true, the 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.
val style: UndefOr[Object]
The text styles of the flag.
The text styles of the flag.
In styled mode, the styles are set in the .highcharts-flag-series .highcharts-point rule.
Example:
1. Flags in styled mode.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val textAlign: UndefOr[String]
Text alignment for the text inside the flag.
Text alignment for the text inside the flag.

Since
5.0.0
val threshold: UndefOr[Double]
The threshold, also called zero level or base level.
The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.
val title: Any
The text to display on each flag.
The text to display on each flag. This can be defined on series level, or individually for each point. Defaults to "A".
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
val tooltip: UndefOr[CleanJsObject[SeriesFlagsTooltip]]
Specific tooltip options for flag series.
Specific tooltip options for flag series. Flag series tooltips are different from most other types in that a flag doesn't have a data value, so the tooltip rather displays the text option for each point.
val type: String
The type of series.
The type of series. Can be one of area, areaspline, bar, column, line, pie, scatter, spline, candlestick or ohlc. From version 1.1.7, arearange, areasplinerange and columnrange are supported with the highcharts-more.js component.
val useHTML: UndefOr[Boolean]
Whether to use HTML to render the flag texts.
Whether to use HTML to render the flag texts. Using HTML allows for advanced formatting, images and reliable bi-directional text rendering. Note that exported images won't respect the HTML, and that HTML won't respect Z-index settings.

Since
1.3
def valueOf(): Any

Definition Classes
Object
val visible: UndefOr[Boolean]
Set the initial visibility of the series.
Set the initial visibility of the series.
Example:
1. Hidden series
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val xAxis: UndefOr[|[Double, String]]
When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.
When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.
val y: UndefOr[Double]
The y position of the top left corner of the flag relative to either the series (if onSeries is defined), or the x axis.
The y position of the top left corner of the flag relative to either the series (if onSeries is defined), or the x axis. Defaults to -30.
val yAxis: UndefOr[|[Double, String]]
When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.
When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first.
val zIndex: UndefOr[Double]
Define the visual z index of the series.
Define the visual z index of the series.
Example:
1. With no z index, the series defined last are on top, with a z index, the series with the highest z index is on top.
val zoneAxis: UndefOr[String]
Defines the Axis on which the zones are applied.
Defines the Axis on which the zones are applied.
Example:
1. Zones on the X-Axis
Since
2.1.0
val zones: UndefOr[Array[CleanJsObject[SeriesFlagsZones]]]
An array defining zones within a series.
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).
Example:
1. Color zones
Since
2.1.0

Packages

SeriesFlags

Companion object SeriesFlags

class SeriesFlags extends Object

Instance Constructors

Value Members

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

SeriesFlags 

Companion object SeriesFlags

class SeriesFlags extends Object

Instance Constructors

Value Members

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped

SeriesFlags