Packages

object SeriesFlags

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SeriesFlags
  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, animationLimit: UndefOr[Double] = js.undefined, className: UndefOr[String] = js.undefined, color: UndefOr[|[String, Object]] = js.undefined, colors: UndefOr[Array[|[String, Object]]] = js.undefined, compareBase: UndefOr[Double] = js.undefined, cropThreshold: UndefOr[Double] = js.undefined, cursor: UndefOr[String] = js.undefined, data: UndefOr[Array[CleanJsObject[SeriesFlagsData]]] = js.undefined, dataLabels: UndefOr[CleanJsObject[SeriesFlagsDataLabels]] = js.undefined, description: UndefOr[String] = js.undefined, enableMouseTracking: UndefOr[Boolean] = js.undefined, events: UndefOr[CleanJsObject[SeriesFlagsEvents]] = 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, linkedTo: UndefOr[String] = js.undefined, maxPointWidth: UndefOr[Double] = js.undefined, name: UndefOr[String] = js.undefined, navigatorOptions: UndefOr[Object] = js.undefined, negativeColor: UndefOr[|[String, Object]] = js.undefined, onKey: UndefOr[String] = js.undefined, onSeries: UndefOr[String] = js.undefined, point: UndefOr[CleanJsObject[SeriesFlagsPoint]] = js.undefined, pointIntervalUnit: UndefOr[String] = js.undefined, selected: UndefOr[Boolean] = js.undefined, shadow: UndefOr[|[Boolean, Object]] = js.undefined, shape: UndefOr[String] = js.undefined, showCheckbox: UndefOr[Boolean] = js.undefined, showInLegend: UndefOr[Boolean] = js.undefined, showInNavigator: UndefOr[Boolean] = js.undefined, softThreshold: UndefOr[Boolean] = js.undefined, stack: UndefOr[String] = js.undefined, stackDistance: UndefOr[Double] = js.undefined, states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]] = js.undefined, stickyTracking: UndefOr[Boolean] = js.undefined, style: UndefOr[Object] = js.undefined, textAlign: UndefOr[String] = js.undefined, threshold: UndefOr[Double] = js.undefined, title: UndefOr[Any] = js.undefined, tooltip: UndefOr[CleanJsObject[SeriesFlagsTooltip]] = js.undefined, type: String = "flags", useHTML: UndefOr[Boolean] = js.undefined, visible: UndefOr[Boolean] = js.undefined, xAxis: UndefOr[|[Double, String]] = js.undefined, y: UndefOr[Double] = js.undefined, yAxis: UndefOr[|[Double, String]] = js.undefined, zIndex: UndefOr[Double] = js.undefined, zoneAxis: UndefOr[String] = js.undefined, zones: UndefOr[Array[CleanJsObject[SeriesFlagsZones]]] = js.undefined): SeriesFlags

    allowPointSelect

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

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

    colors

    A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.

    compareBase

    When compare is percent, this option dictates whether to use 0 or 100 as the base of comparison.

    cropThreshold

    When the series contains less points than the crop threshold, all points are drawn, event 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.

    data

    An array of data points for the series. For the flags series type, points can be given in the following ways:. . - 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,.     title: "A",.     text: "First event". }, {.     x: 1,.     title: "B",.     text: "Second event". }]

    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. When using shared tooltips (default in stock charts), mouse tracking is not required. For large datasets it improves performance.

    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

    The color of the line/border of the flag.. . In styled mode, the stroke is set in the .highcharts-flag-series .highcharts-point rule.

    lineWidth

    The pixel width of the candlestick line/border. Defaults to 1.

    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.

    maxPointWidth

    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.

    name

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

    navigatorOptions

    Options for the corresponding navigator series if showInNavigator is true for this series. Available options are the same as any series, documented at plotOptions and series.. . These options are merged with options in navigator.series, and will take precedence if the same option is defined both places.

    negativeColor

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

    onKey

    In case the flag is placed on a series, on what point key to place it. Line and columns have one key, y. In range or OHLC-type series, however, the flag can optionally be placed on the open, high, low or close key.

    onSeries

    The id of the series that the flags should be drawn on. If no id is given, the flags are drawn on the x axis.

    point

    Properties for each single point

    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.

    selected

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

    shadow

    Whether to apply a drop shadow to the graph line. Since 1.1.7 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

    shape

    The shape of the marker. Can be one of "flag", "circlepin", "squarepin", or an image on the format url(/path-to-image.jpg). Individual shapes can also be set for each point.

    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.

    showInNavigator

    Whether or not to show the series in the navigator. Takes precedence over navigator.baseSeries if defined.

    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.

    stackDistance

    When multiple flags in the same series fall on the same value, this number determines the vertical. offset between them.

    states

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

    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 not shared. When stickyTracking 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, candlesticks etc.

    style

    The text styles of the flag.. . In styled mode, the styles are set in the .highcharts-flag-series .highcharts-point rule.

    textAlign

    Text alignment for the text inside the flag.

    threshold

    The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.

    title

    The text to display on each flag. This can be defined on series level, or individually for each point. Defaults to "A".

    tooltip

    Specific tooltip options for flag series. Flag series tooltips are different from most other types in that a flag doesn't have a data value, so the tooltip rather displays the text option for each point.

    useHTML

    Whether to use HTML to render the flag texts. Using HTML allows for advanced formatting, images and reliable bi-directional text rendering. Note that exported images won't respect the HTML, and that HTML won't respect Z-index settings.

    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.

    y

    The y position of the top left corner of the flag relative to either the series (if onSeries is defined), or the x axis. Defaults to -30.

    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