Packages

class PlotOptionsSeries extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: plotOptions-series

Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PlotOptionsSeries
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PlotOptionsSeries()

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 allAreas: UndefOr[Boolean]

    Whether all areas of the map defined in mapData should be rendered.

    Whether all areas of the map defined in mapData should be rendered. If true, areas which don't correspond to a data point, are rendered as null points. If false, those areas are skipped.

    Example:

    1. All areas set to false

  5. val allowPointSelect: UndefOr[Boolean]

    Allow this series' points to be selected by clicking on the shapes.

    Allow this series' points to be selected by clicking on the shapes. Selected points can be read through the Chart.getSelectedPoints() method.

    Example:

    1. Allow select on map area, map bubble

  6. 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 map series, but enabled on mapbubble series.

    Example:

    1. Animation enabled on map series, disabled on mapbubble series

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

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. val borderColor: UndefOr[|[String, Object]]

    The border color of the map areas.

    The border color of the map areas.

    In styled mode, the border stroke is given in the .highcharts-point class.

    Example:

    1. Borders demo

  10. val borderWidth: UndefOr[Double]

    The border width of each map area.

    The border width of each map area.

    In styled mode, the border stroke width is given in the .highcharts-point class.

    Example:

    1. Borders demo

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

  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. val color: UndefOr[|[String, Object]]

    The main color of the series.

    The main color of the series. In maps, this color is rarely used, as most choropleth maps use the color to denote the value of each point. The series color can however be used in a map with multiple series holding categorized data. 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.

    Example:

    1. Category map by multiple series

  14. val colorAxis: UndefOr[Boolean]

    Set this option to false to prevent a series from connecting to the global color axis.

    Set this option to false to prevent a series from connecting to the global color axis. This will cause the series to have its own legend item.

  15. 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 map area, map bubble

  16. val dashStyle: UndefOr[String]

    A name for the dash style to use for the map area outline or the map line.

    A name for the dash style to use for the map area outline or the map line. The value for the dashStyle include:

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

    1. Possible values demonstrated, dotted borders on a map.

  17. val dataLabels: UndefOr[CleanJsObject[PlotOptionsSeriesDataLabels]]

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

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

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

  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  22. val events: UndefOr[CleanJsObject[PlotOptionsSeriesEvents]]
  23. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  25. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  29. val joinBy: UndefOr[|[String, Array[String]]]

    What property to join the mapData to the value data.

    What property to join the mapData to the value data. For example, if joinBy is "code", the mapData items with a specific code is merged into the data with the same code. For maps loaded from GeoJSON, the keys may be held in each point's properties object.

    The joinBy option can also be an array of two values, where the first points to a key in the mapData, and the second points to another key in the data.

    When joinBy is null, the map items are joined by their position in the array, which performs much better in maps with many data points. This is the recommended option if you are printing more than a thousand data points and have a backend that can preprocess the data into a parallel array of the mapData.

    Example:

    1. Joined by "code", GeoJSON joined by an array, simple data joined by null.

  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. 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

  32. final def notify(): Unit
    Definition Classes
    AnyRef
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  34. val point: UndefOr[CleanJsObject[PlotOptionsSeriesPoint]]

    Properties for each single point

  35. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  36. 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.

  37. val shadow: UndefOr[|[Boolean, Object]]

    Whether to apply a drop shadow to the shapes.

    Whether to apply a drop shadow to the shapes. The shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

  38. val showCheckbox: UndefOr[Boolean]

    If true, and the series has a unique legend item, a checkbox is displayed next to the legend item to allow selecting the series.

    If true, and the series has a unique legend item, 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. Note that if a colorAxis is defined, the color axis is represented in the legend, not the series.

  39. 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. Note that if a colorAxis is defined, the color axis is represented in the legend, not the series.

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

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

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

  42. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  43. def toLocaleString(): String
    Definition Classes
    Object
  44. def toString(): String
    Definition Classes
    AnyRef → Any
  45. val tooltip: UndefOr[CleanJsObject[PlotOptionsSeriesTooltip]]

    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.

  46. def valueOf(): Any
    Definition Classes
    Object
  47. val visible: UndefOr[Boolean]

    Set the initial visibility of the series.

  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. val zIndex: UndefOr[Double]

    Define the z index of the series.

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped