Trait

io.udash.wrappers.highcharts.config.series

BoxSeries

Related Doc: package series

Permalink

trait BoxSeries extends Object with PointSeries

Annotations
@ScalaJSDefined() @RawJSType()
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BoxSeries
  2. PointSeries
  3. XYSeries
  4. StandardSeries
  5. Series
  6. Object
  7. Any
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Data

    Permalink
    Definition Classes
    Series
  2. abstract type DataLabels <: BaseSeriesDataLabels

    Permalink
    Definition Classes
    Series
  3. abstract type States <: SeriesStates[_]

    Permalink
    Definition Classes
    StandardSeries

Abstract Value Members

  1. abstract val type: String

    Permalink
    Definition Classes
    Series

Concrete Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. val allowPointSelect: UndefOr[Boolean]

    Permalink

    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()
    Example:
    1. Line, column, pie

  5. val animation: UndefOr[|[Boolean, Object]]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  6. val animationLimit: UndefOr[Double]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. val className: UndefOr[String]

    Permalink

    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()
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val color: UndefOr[|[String, Object]]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  11. val colorByPoint: UndefOr[Boolean]

    Permalink

    When using automatic point colors pulled from the options.colors collection, this option determines whether the chart should receive one color per series or one color per point.

    When using automatic point colors pulled from the options.colors collection, this option determines whether the chart should receive one color per series or one color per point.

    Annotations
    @JSOptional()
  12. val colors: UndefOr[Array[|[String, Object]]]

    Permalink

    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.

    Annotations
    @JSOptional()
  13. val crisp: UndefOr[Boolean]

    Permalink

    When true, each column edge is rounded to its nearest pixel in order to render sharp on screen.

    When true, each column edge is rounded to its nearest pixel in order to render sharp on screen. In some cases, when there are a lot of densely packed columns, this leads to visible difference in column widths or distance between columns. In these cases, setting crisp to false may look better, even though each column is rendered blurry. Defaults to true.

    Annotations
    @JSOptional()
  14. val cursor: UndefOr[String]

    Permalink

    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()
    Example:
    1. Pointer cursor on line graph, on columns, on scatter markers

  15. val data: UndefOr[Data]

    Permalink

    An array of data points for the series.

    An array of data points for the series. For the area 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, 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()
    Example:
    1. The demos use a line series, but the principle is the same for all types.

  16. val dataLabels: UndefOr[DataLabels]

    Permalink

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

    Definition Classes
    Series
    Annotations
    @JSOptional()
  17. val depth: UndefOr[Double]

    Permalink

    Depth of the columns in a 3D column chart.

    Depth of the columns in a 3D column chart. Requires highcharts-3d.js.

    Annotations
    @JSOptional()
  18. val description: UndefOr[String]

    Permalink

    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()
  19. val edgeColor: UndefOr[|[String, Object]]

    Permalink

    3D columns only.

    3D columns only. The color of the edges. Similar to borderColor, except it defaults to the same color as the column.

    Annotations
    @JSOptional()
  20. val edgeWidth: UndefOr[Double]

    Permalink

    3D columns only.

    3D columns only. The width of the colored edges.

    Annotations
    @JSOptional()
  21. val enableMouseTracking: UndefOr[Boolean]

    Permalink

    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()
  22. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  24. val events: UndefOr[SeriesEvents]

    Permalink
    Definition Classes
    Series
    Annotations
    @JSOptional()
  25. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  27. val getExtremesFromAll: UndefOr[Boolean]

    Permalink

    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()
  28. val groupPadding: UndefOr[Double]

    Permalink

    Padding between each value groups, in x axis units.

    Padding between each value groups, in x axis units.

    Annotations
    @JSOptional()
  29. val groupZPadding: UndefOr[Double]

    Permalink

    The spacing between columns on the Z Axis in a 3D chart.

    The spacing between columns on the Z Axis in a 3D chart. Requires highcharts-3d.js.

    Annotations
    @JSOptional()
  30. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  31. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  32. val id: UndefOr[String]

    Permalink

    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()
  33. val index: UndefOr[Double]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  34. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  35. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  36. val keys: UndefOr[Array[String]]

    Permalink

    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()
  37. val legendIndex: UndefOr[Double]

    Permalink

    The sequential index of the series in the legend.

    The sequential index of the series in the legend.

    Try it:

    Legend in opposite order .

    Definition Classes
    Series
    Annotations
    @JSOptional()
  38. val linkedTo: UndefOr[String]

    Permalink

    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:
    1. Linked series

  39. val maxPointWidth: UndefOr[Double]

    Permalink

    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.

    Annotations
    @JSOptional()
    Example:
    1. Limited to 50

  40. val name: UndefOr[String]

    Permalink

    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:
    1. Series name

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

    Permalink
    Definition Classes
    AnyRef
  42. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  43. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  44. val point: UndefOr[SeriesPoint]

    Permalink

    Properties for each single point

    Properties for each single point

    Definition Classes
    Series
    Annotations
    @JSOptional()
  45. val pointInterval: UndefOr[Double]

    Permalink

    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.

    Definition Classes
    PointSeries
    Annotations
    @JSOptional()
    Example:
    1. Datetime X axis

  46. val pointIntervalUnit: UndefOr[String]

    Permalink

    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.

    Definition Classes
    PointSeries
    Annotations
    @JSOptional()
  47. val pointPadding: UndefOr[Double]

    Permalink

    Padding between each column or bar, in x axis units.

    Padding between each column or bar, in x axis units.

    Annotations
    @JSOptional()
  48. val pointPlacement: UndefOr[|[String, Double]]

    Permalink

    Possible values: null, "on", "between".

    Possible values: null, "on", "between".

    In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.

    Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.

    Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.

    Defaults to null in cartesian charts, "between" in polar charts.

    Annotations
    @JSOptional()
  49. val pointRange: UndefOr[Double]

    Permalink

    The X axis range that each point is valid for.

    The X axis range that each point is valid for. This determines the width of the column. On a categorized axis, the range will be 1 by default (one category unit). On linear and datetime axes, the range will be computed as the distance between the two closest data points.

    Annotations
    @JSOptional()
  50. val pointStart: UndefOr[Double]

    Permalink

    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.

    Definition Classes
    PointSeries
    Annotations
    @JSOptional()
    Example:
    1. Linear, datetime X axis

  51. val pointWidth: UndefOr[Double]

    Permalink

    A pixel value specifying a fixed width for each column or bar.

    A pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the pointPadding and groupPadding.

    Annotations
    @JSOptional()
  52. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  53. val selected: UndefOr[Boolean]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  54. val shadow: UndefOr[|[Boolean, Object]]

    Permalink

    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.

    Definition Classes
    StandardSeries
    Annotations
    @JSOptional()
    Example:
    1. Shadow enabled

  55. val showCheckbox: UndefOr[Boolean]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
    Example:
    1. Show select box

  56. val showInLegend: UndefOr[Boolean]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  57. val states: UndefOr[States]

    Permalink

    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()
  58. val stickyTracking: UndefOr[Boolean]

    Permalink

    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. Defaults to true for line and area type series, but to false for columns, pies etc.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  59. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  60. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  61. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  62. val tooltip: UndefOr[SeriesTooltip]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  63. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  64. val visible: UndefOr[Boolean]

    Permalink

    Set the initial visibility of the series.

    Set the initial visibility of the series.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  65. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  68. val xAxis: UndefOr[|[Int, String]]

    Permalink

    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.

    Definition Classes
    XYSeries
    Annotations
    @JSOptional()
  69. val yAxis: UndefOr[|[Int, String]]

    Permalink

    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.

    Definition Classes
    XYSeries
    Annotations
    @JSOptional()
  70. val zIndex: UndefOr[Int]

    Permalink

    Define the visual z index of the series.

    Define the visual z index of the series.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  71. val zoneAxis: UndefOr[String]

    Permalink

    Defines the Axis on which the zones are applied.

    Defines the Axis on which the zones are applied.

    Definition Classes
    StandardSeries
    Annotations
    @JSOptional()
  72. val zones: UndefOr[Array[SeriesZone]]

    Permalink

    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.

    Definition Classes
    StandardSeries
    Annotations
    @JSOptional()
    Example:
    1. Color zones

Inherited from PointSeries

Inherited from XYSeries

Inherited from StandardSeries

Inherited from Series

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped