trait PointSeries extends Object with XYSeries
- Annotations
- @ScalaJSDefined() @RawJSType()
- Alphabetic
- By Inheritance
- PointSeries
- XYSeries
- StandardSeries
- Series
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
abstract
type
Data
- Definition Classes
- Series
-
abstract
type
DataLabels <: BaseSeriesDataLabels
- Definition Classes
- Series
-
abstract
type
States <: SeriesStates[_]
- Definition Classes
- StandardSeries
Concrete 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, bars or pie slices.
Allow this series' points to be selected by clicking on the markers, bars or pie slices.
- Definition Classes
- StandardSeries
- Annotations
- @JSOptional()
-
val
animation: UndefOr[|[Boolean, Object]]
Enable or disable the initial animation when a series is displayed.
Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself. For other animations, see chart.animation and the animation parameter under the API methods. The following properties are supported: <dl> <dt>duration</dt>
- The duration of the animation in milliseconds.
<dt>easing</dt>- A string reference to an easing function set on the
</dl>Mathobject. See the easing demo.Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
- Definition Classes
- Series
- Annotations
- @JSOptional()
Example: -
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
animationLimittoInfinity.- Definition Classes
- Series
- Annotations
- @JSOptional()
-
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.
- Definition Classes
- Series
- Annotations
- @JSOptional()
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
val
color: UndefOr[|[String, Object]]
The main color or the series.
The main color or 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.colorsarray.- Definition Classes
- Series
- Annotations
- @JSOptional()
Example: -
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.
- Definition Classes
- Series
- Annotations
- @JSOptional()
Pointer cursor on line graph, on columns, on scatter markers
Example: -
val
data: UndefOr[Data]
An array of data points for the series.
An array of data points for the series. For the
areaseries type, points can be given in the following ways:- An array of numerical values. In this case, the numerical values will
be interpreted as
yoptions. Thexvalues will be automatically calculated, either starting at 0 and incremented by 1, or frompointStartandpointIntervalgiven in the series options. If the axis has categories, these will be used. Example:data: [0, 5, 3, 5]
-
An array of arrays with 2 values. In this case, the values correspond to
x,y. If the first value is a string, it is applied as the name of the point, and thexvalue is inferred.data: [ [0, 9], [1, 7], [2, 6] ]
-
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, y: 9, name: "Point2", color: "#00FF00" }, { x: 1, y: 6, name: "Point1", color: "#FF00FF" }]- Definition Classes
- Series
- Annotations
- @JSOptional()
The demos use a line series, but the principle is the same for all types.
Example: - An array of numerical values. In this case, the numerical values will
be interpreted as
-
val
dataLabels: UndefOr[DataLabels]
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-boxand.highcharts-data-labelclass names (see example).- Definition Classes
- Series
- Annotations
- @JSOptional()
-
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.
- Definition Classes
- Series
- Annotations
- @JSOptional()
Example: -
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. For large datasets it improves performance.
- Definition Classes
- Series
- Annotations
- @JSOptional()
Example: -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
events: UndefOr[SeriesEvents]
- Definition Classes
- Series
- Annotations
- @JSOptional()
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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.
- Definition Classes
- Series
- Annotations
- @JSOptional()
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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().- Definition Classes
- Series
- Annotations
- @JSOptional()
Example: -
val
index: UndefOr[Double]
The index of the series in the chart, affecting the internal index in the
chart.seriesarray, 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.seriesarray, the visible Z index as well as the order in the legend.- Definition Classes
- Series
- Annotations
- @JSOptional()
-
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.
- Definition Classes
- Series
- Annotations
- @JSOptional()
Example: -
val
legendIndex: UndefOr[Double]
The sequential index of the series in the legend.
- Definition Classes
- Series
- Annotations
- @JSOptional()
-
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.
- Definition Classes
- Series
- Annotations
- @JSOptional()
Example: -
val
name: UndefOr[String]
The name of the series as shown in the legend, tooltip etc.
The name of the series as shown in the legend, tooltip etc.
- Definition Classes
- Series
- Annotations
- @JSOptional()
Example: -
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
val
point: UndefOr[SeriesPoint]
Properties for each single point
Properties for each single point
- Definition Classes
- Series
- Annotations
- @JSOptional()
-
val
pointInterval: UndefOr[Double]
If no x values are given for the points in a series, pointInterval defines the interval of the x values.
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
pointIntervalUnitto draw irregular intervals.- Annotations
- @JSOptional()
Example: -
val
pointIntervalUnit: UndefOr[String]
On datetime series, this allows for setting the pointInterval to irregular time units,
day,monthandyear.On datetime series, this allows for setting the pointInterval to irregular time units,
day,monthandyear. 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 withpointIntervalto draw weeks, quarters, 6 months, 10 years etc.- Annotations
- @JSOptional()
Example: -
val
pointStart: UndefOr[Double]
If no x values are given for the points in a series, pointStart defines on what value to start.
-
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
showCheckboxis true, the checkbox next to the series name will be checked for a selected series.- Definition Classes
- Series
- Annotations
- @JSOptional()
Example: -
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 2.3 the shadow can be an object configuration containing
color,offsetX,offsetY,opacityandwidth.- Definition Classes
- StandardSeries
- Annotations
- @JSOptional()
Example: -
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
selectedoption.- Definition Classes
- Series
- Annotations
- @JSOptional()
Example: -
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
truefor standalone series,falsefor linked series.- Definition Classes
- Series
- Annotations
- @JSOptional()
Example: -
val
states: UndefOr[States]
A wrapper object for all the series options in specific states.
A wrapper object for all the series options in specific states.
- Definition Classes
- StandardSeries
- Annotations
- @JSOptional()
-
val
stickyTracking: UndefOr[Boolean]
Sticky tracking of mouse events.
Sticky tracking of mouse events. When true, the
mouseOutevent on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, themouseOutevent on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. WhenstickyTrackingis false andtooltip.sharedis 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.- Definition Classes
- Series
- Annotations
- @JSOptional()
Example: -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
val
tooltip: UndefOr[SeriesTooltip]
A configuration object for the tooltip rendering of each single series.
-
def
valueOf(): Any
- Definition Classes
- Object
-
val
visible: UndefOr[Boolean]
Set the initial visibility of the series.
Set the initial visibility of the series.
- Definition Classes
- Series
- Annotations
- @JSOptional()
-
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
- @native() @throws( ... )
-
val
xAxis: UndefOr[|[Int, String]]
When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.
-
val
yAxis: UndefOr[|[Int, String]]
When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.
-
val
zIndex: UndefOr[Int]
Define the visual z index of the series.
Define the visual z index of the series.
- Definition Classes
- Series
- Annotations
- @JSOptional()
-
val
zoneAxis: UndefOr[String]
Defines the Axis on which the zones are applied.
Defines the Axis on which the zones are applied.
- Definition Classes
- StandardSeries
- Annotations
- @JSOptional()
Example: -
val
zones: UndefOr[Array[SeriesZone]]
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
zoneAxisoption.- Definition Classes
- StandardSeries
- Annotations
- @JSOptional()
Example: