PlotOptionsScatter

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. 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.

   Example:

   1. Line, column, pie

   Since

   1.2.0

5. val animation: UndefOr[Boolean]

   

   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 Math object. See the easing demo.

   </dl>

   Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.

   Example:

   1. Animation disabled, slower animation, custom easing function.

6. 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.

7. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

8. 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

9. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

10. 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.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.

    Example:

    1. General plot option, one specific series, area color

11. val colorIndex: UndefOr[Double]

    

    Styled mode only.

    Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.

    Since

    5.0.0

12. val cropThreshold: UndefOr[Double]

    

    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.

    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. 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.

    Since

    2.2

13. 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 cursor on line graph, on columns, on scatter markers

14. val dashStyle: UndefOr[String]

    

    A name for the dash style to use for the graph.

    A name for the dash style to use for the graph. Applies only to series type having a graph, like line, spline, area and scatter in case it has a lineWidth. The value for the dashStyle include:

    • Solid
    • ShortDash
    • ShortDot
    • ShortDashDot
    • ShortDashDotDot
    • Dot
    • Dash
    • LongDash
    • DashDot
    • LongDashDot
    • LongDashDotDot

    Example:

    1. Possible values demonstrated, chart suitable for printing in black and white

    Since

    2.1

15. val dataLabels: UndefOr[CleanJsObject[PlotOptionsScatterDataLabels]]

    

    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).

16. 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

17. 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.

    Example:

    1. No mouse tracking

18. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

19. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

20. val events: UndefOr[CleanJsObject[PlotOptionsScatterEvents]]

    

21. val exposeElementToA11y: UndefOr[Boolean]

    

    By default, series are exposed to screen readers as regions.

    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.

    Example:

    1. Accessible data visualization

    Since

    5.0.12

22. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

23. val findNearestPointBy: UndefOr[String]

    

    Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.

    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.

    Example:

    1. Different hover behaviors

    Since

    5.0.10

24. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

25. 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

    4.1.6

26. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

27. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

28. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

29. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

30. 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

    4.1.6

31. val lineWidth: UndefOr[Double]

    

    The width of the line connecting the data points.

    The width of the line connecting the data points.

    Example:

    1. 0 by default, 1px

32. 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

    3.0

33. val marker: UndefOr[CleanJsObject[PlotOptionsScatterMarker]]

    

    Options for the point markers of line-like series.

    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.

34. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

35. 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

36. final def notify(): Unit

    

    Definition Classes

    AnyRef

37. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

38. val point: UndefOr[CleanJsObject[PlotOptionsScatterPoint]]

    

    Properties for each single point

39. val pointDescriptionFormatter: UndefOr[Function]

    

    Same as accessibility.pointDescriptionFormatter, but for an individual series.

    Same as accessibility.pointDescriptionFormatter, but for an individual series. Overrides the chart wide configuration.

    Since

    5.0.12

40. 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 pointIntervalUnit to draw irregular intervals.

    Example:

    1. Datetime X axis

41. 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

    4.1.0

42. val pointStart: UndefOr[Double]

    

    If no x values are given for the points in a series, pointStart defines on what value to start.

    If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.

    Example:

    1. Linear, datetime X axis

43. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

44. 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 will be checked for a selected series.

    Example:

    1. One out of two series selected

    Since

    1.2.0

45. 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, opacity and width.

    Example:

    1. Shadow enabled

46. 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.

    Example:

    1. Show select box

    Since

    1.2.0

47. 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.

    Example:

    1. One series in the legend, one hidden

48. val skipKeyboardNavigation: UndefOr[Boolean]

    

    If set to True, the accessibility module will skip past the points in this series for keyboard navigation.

    If set to True, the accessibility module will skip past the points in this series for keyboard navigation.

    Since

    5.0.12

49. 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

    4.1.9

50. val states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]]

    

    A wrapper object for all the series options in specific states.

51. 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 stickyTracking is false and tooltip.shared is false, the tooltip will be hidden when moving the mouse between series.

52. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

53. 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.

    Since

    3.0

54. def toLocaleString(): String

    

    Definition Classes

    Object

55. def toString(): String

    

    Definition Classes

    AnyRef → Any

56. val tooltip: UndefOr[CleanJsObject[PlotOptionsScatterTooltip]]

    

    A configuration object for the tooltip rendering of each single series.

    A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.

    Since

    2.3

57. val turboThreshold: UndefOr[Double]

    

    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.

    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. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to 0 disable.

    Since

    2.2

58. def valueOf(): Any

    

    Definition Classes

    Object

59. val visible: UndefOr[Boolean]

    

    Set the initial visibility of the series.

    Set the initial visibility of the series.

    Example:

    1. Two series, one hidden and one visible

60. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

61. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

62. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

63. 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

    4.1.0

64. val zones: UndefOr[Array[CleanJsObject[PlotOptionsScatterZones]]]

    

    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

    4.1.0