Packages

class SeriesPolygon extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: series<polygon>

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

Instance Constructors

  1. new SeriesPolygon()

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

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

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

  14. val data: UndefOr[Array[|[CleanJsObject[SeriesPolygonData], Array[Any]]]]

    An array of data points for the series.

    An array of data points for the series. For the polygon series type, points can be given in the following ways:

    • An array of numerical values. In this case, the numerical values will be interpreted as y options. The x values will be automatically calculated, either starting at 0 and incremented by 1, or from pointStart and pointInterval given 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 the x value is inferred. 

    data: [
    [0, 10],
    [1, 3],
    [2, 1]
]

    -

    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: 1,
    name: "Point2",
    color: "#00FF00"
}, {
    x: 1,
    y: 8,
    name: "Point1",
    color: "#FF00FF"
}]

    Example:

    1. The demos use a line series, but the principle is the same for all types.

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

    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[SeriesPolygonEvents]]
  21. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  23. 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

  24. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  26. 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().

    Example:

    1. Get series by id

    Since

    1.2.0

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

    2.3.0

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

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

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

  34. val marker: UndefOr[CleanJsObject[SeriesPolygonMarker]]

    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.

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

    Example:

    1. Series name

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

  38. final def notify(): Unit
    Definition Classes
    AnyRef
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  40. val point: UndefOr[CleanJsObject[SeriesPolygonPoint]]

    Properties for each single point

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

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

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

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

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

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

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

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

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

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

  51. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  52. def toLocaleString(): String
    Definition Classes
    Object
  53. def toString(): String
    Definition Classes
    AnyRef → Any
  54. val tooltip: UndefOr[CleanJsObject[SeriesPolygonTooltip]]

    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

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

  56. val type: String

    The type of series.

    The type of series. Can be one of area, areaspline, bar, column, line, pie, scatter or spline. From version 2.3, arearange, areasplinerange and columnrange are supported with the highcharts-more.js component.

    Example:

    1. Line and column in the same chart

  57. def valueOf(): Any
    Definition Classes
    Object
  58. 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

  59. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. 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.

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

    Example:

    1. Apply the column series to the secondary Y axis

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

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

  66. val zones: UndefOr[Array[CleanJsObject[SeriesPolygonZones]]]

    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

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped