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

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

   

   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>

   Example:

   1. Updating with no animation, with a longer duration, with a jQuery UI easing.

6. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

7. val backgroundColor: String

   

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

   

   The color of the outer chart border.

   The color of the outer chart border.

   Example:

   1. Brown border

9. val borderRadius: Double

   

   The corner radius of the outer chart border.

   The corner radius of the outer chart border.

   Example:

   1. 20px radius

10. val borderWidth: Double

    

    The pixel width of the outer chart border.

    The pixel width of the outer chart border.

    Example:

    1. 5px border

11. val className: 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 defaultSeriesType: String

    

    Alias of type.

    Alias of type.

    Example:

    1. Bar

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

    

    Definition Classes

    AnyRef

15. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

16. val events: ChartEvents

    

    Event listeners for the chart.

17. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

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

    

    Definition Classes

    AnyRef → Any

19. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

20. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

21. val height: Double

    

    An explicit height for the chart.

    An explicit height for the chart. By default 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. 500px height

22. val ignoreHiddenSeries: 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, true with stack

    Since

    1.2.0

23. val inverted: 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. If a bar series is present in the chart, it will be inverted automatically.

    Example:

    1. Inverted line

24. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

25. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

26. val margin: 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.

    Since version 2.1, the margin is 0 by default. 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

27. val marginBottom: 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

    Since

    2.0

28. val marginLeft: 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

    Since

    2.0

29. val marginRight: 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

    Since

    2.0

30. val marginTop: 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

    Since

    2.0

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

    

    Definition Classes

    AnyRef

32. final def notify(): Unit

    

    Definition Classes

    AnyRef

33. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

34. val options3d: ChartOptions3d

    

    Options to render charts in 3 dimensions.

    Options to render charts in 3 dimensions. This feature requires highcharts-3d.js, found in the download package or online at code.highcharts.com/highcharts-3d.js.

    Example:

    1. Basic 3D columns, basic 3D pie, basic 3D scatter chart.

    Since

    4.0

35. val panKey: String

    

    Allows setting a key to switch between zooming and panning.

    Allows setting a key to switch between zooming and panning.

    Example:

    1. Hold down shift to pan

    Since

    4.0.3

36. val panning: Boolean

    

    Allow panning in a chart.

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

    Example:

    1. Zooming and panning

    Since

    4.0.3

37. val pinchType: 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.

    Since

    3.0

38. val plotBackgroundColor: String

    

    The background color or gradient for the plot area.

    The background color or gradient for the plot area.

    Example:

    1. Color, gradient

39. val plotBackgroundImage: 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

40. val plotBorderColor: String

    

    The color of the inner chart or plot area border.

    The color of the inner chart or plot area border.

    Example:

    1. Blue border

41. val plotBorderWidth: Double

    

    The pixel width of the plot area border.

    The pixel width of the plot area border.

    Example:

    1. 1px border

42. val plotShadow: Any

    

    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. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

    Example:

    1. Plot shadow

43. val polar: Boolean

    

    When true, cartesian charts like line, spline, area and column are transformed into the polar coordinate system.

    When true, cartesian charts like line, spline, area and column are transformed into the polar coordinate system. Requires highcharts-more.js.

    Example:

    1. Polar line, polar area, polar column, combined series types, spider chart, wind rose.

    Since

    2.3.0

44. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

45. val reflow: 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.

    Since

    2.1

46. val renderTo: Any

    

    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.

    Example:

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

47. val resetZoomButton: ChartResetZoomButton

    

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

48. val selectionMarkerFill: String

    

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

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

    Since

    2.1.7

49. val shadow: Any

    

    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. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

    Example:

    1. Shadow

50. val showAxes: Boolean

    

    Whether to show the axes initially.

    Whether to show the axes initially. This only applies to empty charts where series are added dynamically, as axes are automatically added to cartesian series.

    Example:

    1. False by default, true

    Since

    1.2.5

51. val spacing: Array[Double]

    

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

    The distance between the outer edge of the chart and the content, like title, legend, axis title or labels. 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

    3.0.6

52. val spacingBottom: 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.

    Since

    2.1

53. val spacingLeft: 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

    Since

    2.1

54. val spacingRight: 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, legend in right position with default spacing

    Since

    2.1

55. val spacingTop: 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, floating chart title makes the plot area align to the default spacingTop of 10..

    Since

    2.1

56. val style: 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. Defaults to:

    style: {
    	fontFamily: '"Lucida Grande", "Lucida Sans Unicode", Verdana, Arial, Helvetica, sans-serif', // default font
    	fontSize: '12px'
    }
    

    Example:

    1. Using a serif type font

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

    

    Definition Classes

    AnyRef

58. def toLocaleString(): String

    

    Definition Classes

    Object

59. def toString(): String

    

    Definition Classes

    AnyRef → Any

60. val type: 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. Bar

    Since

    2.1.0

61. def valueOf(): Any

    

    Definition Classes

    Object

62. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

65. val width: Double

    

    An explicit width for the chart.

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

    Example:

    1. 800px wide

66. val zoomType: 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