Packages

object SeriesArea

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SeriesArea
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def apply(allowPointSelect: UndefOr[Boolean] = js.undefined, animation: UndefOr[Boolean] = js.undefined, animationLimit: UndefOr[Double] = js.undefined, className: UndefOr[String] = js.undefined, color: UndefOr[|[String, Object]] = js.undefined, connectEnds: UndefOr[Boolean] = js.undefined, connectNulls: UndefOr[Boolean] = js.undefined, cropThreshold: UndefOr[Double] = js.undefined, cursor: UndefOr[String] = js.undefined, dashStyle: UndefOr[String] = js.undefined, data: UndefOr[Array[|[|[CleanJsObject[SeriesAreaData], Array[Any]], Double]]] = js.undefined, dataLabels: UndefOr[CleanJsObject[SeriesAreaDataLabels]] = js.undefined, description: UndefOr[String] = js.undefined, enableMouseTracking: UndefOr[Boolean] = js.undefined, events: UndefOr[CleanJsObject[SeriesAreaEvents]] = js.undefined, fillColor: UndefOr[|[String, Object]] = js.undefined, fillOpacity: UndefOr[Double] = js.undefined, getExtremesFromAll: UndefOr[Boolean] = js.undefined, id: UndefOr[String] = js.undefined, index: UndefOr[Double] = js.undefined, keys: UndefOr[Array[String]] = js.undefined, legendIndex: UndefOr[Double] = js.undefined, lineColor: UndefOr[|[String, Object]] = js.undefined, lineWidth: UndefOr[Double] = js.undefined, linecap: UndefOr[String] = js.undefined, linkedTo: UndefOr[String] = js.undefined, marker: UndefOr[CleanJsObject[SeriesAreaMarker]] = js.undefined, name: UndefOr[String] = js.undefined, negativeColor: UndefOr[|[String, Object]] = js.undefined, negativeFillColor: UndefOr[|[String, Object]] = js.undefined, point: UndefOr[CleanJsObject[SeriesAreaPoint]] = js.undefined, pointInterval: UndefOr[Double] = js.undefined, pointIntervalUnit: UndefOr[String] = js.undefined, pointPlacement: UndefOr[|[String, Double]] = js.undefined, pointStart: UndefOr[Double] = js.undefined, selected: UndefOr[Boolean] = js.undefined, shadow: UndefOr[|[Boolean, Object]] = js.undefined, showCheckbox: UndefOr[Boolean] = js.undefined, showInLegend: UndefOr[Boolean] = js.undefined, softThreshold: UndefOr[Boolean] = js.undefined, stack: UndefOr[String] = js.undefined, stacking: UndefOr[String] = js.undefined, states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]] = js.undefined, step: UndefOr[String] = js.undefined, stickyTracking: UndefOr[Boolean] = js.undefined, threshold: UndefOr[Double] = js.undefined, tooltip: UndefOr[CleanJsObject[SeriesAreaTooltip]] = js.undefined, trackByArea: UndefOr[Boolean] = js.undefined, turboThreshold: UndefOr[Double] = js.undefined, type: String = "area", visible: UndefOr[Boolean] = js.undefined, xAxis: UndefOr[|[Double, String]] = js.undefined, yAxis: UndefOr[|[Double, String]] = js.undefined, zIndex: UndefOr[Double] = js.undefined, zoneAxis: UndefOr[String] = js.undefined, zones: UndefOr[Array[CleanJsObject[SeriesAreaZones]]] = js.undefined): SeriesArea

    allowPointSelect

    Allow this series' points to be selected by clicking on the markers, bars or pie slices.

    animation

    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.

    animationLimit

    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.

    className

    A class name to apply to the series' graphical elements.

    color

    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.

    connectEnds

    Polar charts only. Whether to connect the ends of a line series plot across the extremes.

    connectNulls

    Whether to connect a graph line across null points.

    cropThreshold

    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.

    cursor

    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.

    dashStyle

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

    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". }]
    dataLabels

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

    description

    Requires Accessibility module. A description of the series to add to the screen reader information about the series.

    enableMouseTracking

    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.

    fillColor

    Fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity.

    fillOpacity

    Fill opacity for the area. Note that when you set an explicit fillColor, the fillOpacity is not applied. Instead, you should define the opacity in the fillColor with an rgba color definition.

    getExtremesFromAll

    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.

    id

    An id for the series. This can be used after render time to get a pointer to the series object through chart.get().

    index

    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.

    keys

    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.

    legendIndex

    The sequential index of the series in the legend. Try it: Legend in opposite order .

    lineColor

    A separate color for the graph line. By default the line takes the color of the series, but the lineColor setting allows setting a separate color for the line without altering the fillColor.

    lineWidth

    Pixel with of the graph line.

    linecap

    The line cap used for line ends and line joins on the graph.

    linkedTo

    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.

    marker

    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.

    name

    The name of the series as shown in the legend, tooltip etc.

    negativeColor

    The color for the parts of the graph or points that are below the threshold.

    negativeFillColor

    A separate color for the negative part of the area.

    point

    Properties for each single point

    pointInterval

    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.

    pointIntervalUnit

    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.

    pointPlacement

    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.

    pointStart

    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.

    selected

    Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.

    shadow

    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.

    showCheckbox

    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.

    showInLegend

    Whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.

    softThreshold

    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.

    stack

    This option allows grouping series in a stacked chart. The stack option can be a string or a number or anything else, as long as the grouped series' stack options match each other.

    stacking

    Whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent". When stacking is enabled, data must be sorted in ascending X order.

    states

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

    step

    Whether to apply steps to the line. Possible values are left, center and right. Prior to 2.3.5, only left was supported.

    stickyTracking

    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.

    threshold

    The Y axis value to serve as the base for the area, for distinguishing between values above and below a threshold. If null, the area behaves. like a line series with fill between the graph and the Y axis minimum.

    tooltip

    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.

    trackByArea

    Whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.

    turboThreshold

    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.

    visible

    Set the initial visibility of the series.

    xAxis

    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.

    yAxis

    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.

    zIndex

    Define the visual z index of the series.

    zoneAxis

    Defines the Axis on which the zones are applied.

    zones

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

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped