Chart

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

   

   When using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks, as if tickAmount were specified.

   When using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks, as if tickAmount were specified.

   This can be prevented by setting alignTicks to false. If the grid lines look messy, it's a good idea to hide them for the secondary axis by setting gridLineWidth to 0.

   Example:

   1. True by default, false.

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

   

   Set the overall animation for all chart updating.

   Set the overall animation for all chart updating. Animation can be disabled throughout the chart by setting it to false here. It can be overridden for each individual API method as a function parameter. The only animation not affected by this option is the initial series animation, see plotOptions.series.animation.

   The animation can either be set as a boolean or a configuration object. If true, it will use the 'swing' jQuery easing and a duration of 500 ms. If used as a configuration object, 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>

6. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

7. val backgroundColor: UndefOr[|[String, Object]]

   

   The background color or gradient for the outer chart area.

   The background color or gradient for the outer chart area.

   Example:

   1. Color, gradient

8. val borderColor: UndefOr[|[String, Object]]

   

   The color of the outer chart border.

   The color of the outer chart border.

   Example:

   1. Brown border

9. val borderRadius: UndefOr[Double]

   

   The corner radius of the outer chart border.

   The corner radius of the outer chart border.

   Example:

   1. 10px radius

10. val borderWidth: UndefOr[Double]

    

    The pixel width of the outer chart border.

    The pixel width of the outer chart border.

    Example:

    1. 2px border

11. val className: UndefOr[String]

    

    A CSS class name to apply to the charts container div, allowing unique CSS styling for each chart.

    A CSS class name to apply to the charts container div, allowing unique CSS styling for each chart.

12. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

13. val colorCount: UndefOr[Double]

    

    In styled mode, this sets how many colors the class names should rotate between.

    In styled mode, this sets how many colors the class names should rotate between. With ten colors, series (or points) are given class names like highcharts-color-0, highcharts-color-0 [...] highcharts-color-9. The equivalent in non-styled mode is to set colors using the colors setting.

    Since

    5.0.0

14. val description: UndefOr[String]

    

    A text description of the chart.

    A text description of the chart.

    If the Accessibility module is loaded, this is included by default as a long description of the chart and its contents in the hidden screen reader information region.

    Example:

    1. Accessible line chart

    Since

    5.0.0

15. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

16. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

17. val events: UndefOr[CleanJsObject[ChartEvents]]

    

    Event listeners for the chart.

18. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

19. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

20. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

21. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

22. val height: UndefOr[|[Double, String]]

    

    An explicit height for the chart.

    An explicit height for the chart. If a number, the height is given in pixels. If given a percentage string (for example '56%'), the height is given as the percentage of the actual chart width. This allows for preserving the aspect ratio across responsive sizes.

    By default (when null) the height is calculated from the offset height of the containing element, or 400 pixels if the containing element's height is 0.

    Example:

    1. 300px height. Highcharts with percentage height.

23. val ignoreHiddenSeries: UndefOr[Boolean]

    

    If true, the axes will scale to the remaining visible series once one series is hidden.

    If true, the axes will scale to the remaining visible series once one series is hidden. If false, hiding and showing a series will not affect the axes or the other series. For stacks, once one series within the stack is hidden, the rest of the stack will close in around it even if the axis is not affected.

    Example:

    1. True by default, false

24. val inverted: UndefOr[Boolean]

    

    Whether to invert the axes so that the x axis is vertical and y axis is horizontal.

    Whether to invert the axes so that the x axis is vertical and y axis is horizontal. When true, the x axis is reversed by default.

    Example:

    1. Inverted stock chart

    Since

    5.0.7

25. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

26. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

27. val margin: UndefOr[Array[Any]]

    

    The margin between the outer edge of the chart and the plot area.

    The margin between the outer edge of the chart and the plot area. The numbers in the array designate top, right, bottom and left respectively. Use the options marginTop, marginRight, marginBottom and marginLeft for shorthand setting of one option.

    By default there is no margin. The actual space is dynamically calculated from the offset of axis labels, axis title, title, subtitle and legend in addition to the spacingTop, spacingRight, spacingBottom and spacingLeft options. Defaults to [null].

    Example:

    1. Zero margins

28. val marginBottom: UndefOr[Double]

    

    The margin between the bottom outer edge of the chart and the plot area.

    The margin between the bottom outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingBottom.

    Example:

    1. 100px bottom margin

29. val marginLeft: UndefOr[Double]

    

    The margin between the left outer edge of the chart and the plot area.

    The margin between the left outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingLeft.

    Example:

    1. 150px left margin

30. val marginRight: UndefOr[Double]

    

    The margin between the right outer edge of the chart and the plot area.

    The margin between the right outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingRight.

    Example:

    1. 100px right margin

31. val marginTop: UndefOr[Double]

    

    The margin between the top outer edge of the chart and the plot area.

    The margin between the top outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingTop.

    Example:

    1. 100px top margin

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

    

    Definition Classes

    AnyRef

33. final def notify(): Unit

    

    Definition Classes

    AnyRef

34. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

35. val panning: UndefOr[Boolean]

    

    Allow panning in a chart.

    Allow panning in a chart. Best used with panKey to combine zooming and panning.

    On touch devices, when the tooltip.followTouchMove option is true (default), panning requires two fingers. To allow panning with one finger, set followTouchMove to false.

36. val pinchType: UndefOr[String]

    

    Equivalent to zoomType, but for multitouch gestures only.

    Equivalent to zoomType, but for multitouch gestures only. By default, the pinchType is the same as the zoomType setting. However, pinching can be enabled separately in some cases, for example in stock charts where a mouse drag pans the chart, while pinching is enabled. When tooltip.followTouchMove is true, pinchType only applies to two-finger touches.

    Since

    1.3

37. val plotBackgroundColor: UndefOr[|[String, Object]]

    

    The background color or gradient for the plot area.

    The background color or gradient for the plot area.

    Example:

    1. Color, gradient

38. val plotBackgroundImage: UndefOr[String]

    

    The URL for an image to use as the plot background.

    The URL for an image to use as the plot background. To set an image as the background for the entire chart, set a CSS background image to the container element. Note that for the image to be applied to exported charts, its URL needs to be accessible by the export server.

    Example:

    1. Skies

39. val plotBorderColor: UndefOr[|[String, Object]]

    

    The color of the inner chart or plot area border.

    The color of the inner chart or plot area border.

    Example:

    1. Blue border

40. val plotBorderWidth: UndefOr[Double]

    

    The pixel width of the plot area border.

    The pixel width of the plot area border.

    Example:

    1. 2px border

41. val plotShadow: UndefOr[|[Boolean, Object]]

    

    Whether to apply a drop shadow to the plot area.

    Whether to apply a drop shadow to the plot area. Requires that plotBackgroundColor be set. The shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

    Example:

    1. Plot shadow

42. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

43. val reflow: UndefOr[Boolean]

    

    Whether to reflow the chart to fit the width of the container div on resizing the window.

    Whether to reflow the chart to fit the width of the container div on resizing the window.

    Example:

    1. Move the bar between the JavaScript frame and the Preview frame to see the effect: True by default, false.

44. val renderTo: UndefOr[|[String, Object]]

    

    The HTML element where the chart will be rendered.

    The HTML element where the chart will be rendered. If it is a string, the element by that id is used. The HTML element can also be passed by direct reference, or as the first argument of the chart constructor, in which case the option is not needed.

    Example:

    1. String, object reference, object reference through jQuery,

45. val resetZoomButton: UndefOr[CleanJsObject[ChartResetZoomButton]]

    

    The button that appears after a selection zoom, allowing the user to reset zoom.

46. val selectionMarkerFill: UndefOr[|[String, Object]]

    

    The background color of the marker square when selecting (zooming in on) an area of the chart.

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

    

    Whether to apply a drop shadow to the outer chart area.

    Whether to apply a drop shadow to the outer chart area. Requires that backgroundColor be set. The shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

    Example:

    1. Shadow

48. val spacing: UndefOr[Array[Double]]

    

    The distance between the outer edge of the chart and the content, like title or legend, or axis title or labels if present.

    The distance between the outer edge of the chart and the content, like title or legend, or axis title or labels if present. The numbers in the array designate top, right, bottom and left respectively. Use the options spacingTop, spacingRight, spacingBottom and spacingLeft options for shorthand setting of one option.

    Since

    1.3.6

49. val spacingBottom: UndefOr[Double]

    

    The space between the bottom edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).

    The space between the bottom edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).

    Example:

    1. Spacing bottom set to 100.

50. val spacingLeft: UndefOr[Double]

    

    The space between the left edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).

    The space between the left edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).

    Example:

    1. Spacing left set to 100

51. val spacingRight: UndefOr[Double]

    

    The space between the right edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).

    The space between the right edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).

    Example:

    1. Spacing set to 100

52. val spacingTop: UndefOr[Double]

    

    The space between the top edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).

    The space between the top edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).

    Example:

    1. A top spacing of 100

53. val style: UndefOr[Object]

    

    Additional CSS styles to apply inline to the container div.

    Additional CSS styles to apply inline to the container div. Note that since the default font styles are applied in the renderer, it is ignorant of the individual chart options and must be set globally.

    Example:

    1. Using a serif type font

54. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

55. def toLocaleString(): String

    

    Definition Classes

    Object

56. def toString(): String

    

    Definition Classes

    AnyRef → Any

57. val type: UndefOr[String]

    

    The default series type for the chart.

    The default series type for the chart. Can be any of the chart types listed under plotOptions.

    Example:

    1. Areaspline

58. val typeDescription: UndefOr[String]

    

    A text description of the chart type.

    A text description of the chart type.

    If the Accessibility module is loaded, this will be included in the description of the chart in the screen reader information region.

    Highcharts will by default attempt to guess the chart type, but for more complex charts it is recommended to specify this property for clarity.

    Example:

    1. Accessible complex chart

    Since

    5.0.0

59. def valueOf(): Any

    

    Definition Classes

    Object

60. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

61. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

62. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

63. val width: UndefOr[Double]

    

    An explicit width for the chart.

    An explicit width for the chart. By default (when null) the width is calculated from the offset width of the containing element.

    Example:

    1. 800px wide

64. val zoomType: UndefOr[String]

    

    Decides in what dimensions the user can zoom by dragging the mouse.

    Decides in what dimensions the user can zoom by dragging the mouse. Can be one of x, y or xy.

    Example:

    1. None by default, x, y, xy