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 align: UndefOr[String]

   The horizontal alignment of the legend box within the chart area.

   The horizontal alignment of the legend box within the chart area. Valid values are left, center and right.

   In the case that the legend is aligned in a corner position, the layout option will determine whether to place it above/below or on the side of the plot area.

   Example:

   1. Legend alignment

5.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

6.  val backgroundColor: UndefOr[|[String, Object]]

   The background color of the legend.

   The background color of the legend.

   Example:

   1. Border and background options

7.  val borderColor: UndefOr[|[String, Object]]

   The color of the drawn border around the legend.

   The color of the drawn border around the legend.

   Example:

   1. Border and background options

8.  val borderRadius: UndefOr[Double]

   The border corner radius of the legend.

   The border corner radius of the legend.

   Example:

   1. Border and background options

9.  val borderWidth: UndefOr[Double]

   The width of the drawn border around the legend.

   The width of the drawn border around the legend.

   Example:

   1. Border and background options

10.  def clone(): AnyRef

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

11.  val enabled: UndefOr[Boolean]

    Enable or disable the legend.

    Enable or disable the legend.

    Example:

    1. Legend disabled

12.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

13.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

14.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

15.  val floating: UndefOr[Boolean]

    When the legend is floating, the plot area ignores it and is allowed to be placed below it.

    When the legend is floating, the plot area ignores it and is allowed to be placed below it.

    Example:

    1. Floating legend

16.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

17.  def hasOwnProperty(v: String): Boolean

    Definition Classes

    Object

18.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

19.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

20.  def isPrototypeOf(v: Object): Boolean

    Definition Classes

    Object

21.  val itemDistance: UndefOr[Double]

    In a legend with horizontal layout, the itemDistance defines the pixel distance between each item.

22.  val itemHiddenStyle: UndefOr[Object]

    CSS styles for each legend item when the corresponding series or point is hidden.

    CSS styles for each legend item when the corresponding series or point is hidden. Only a subset of CSS is supported, notably those options related to text. Properties are inherited from style unless overridden here.

23.  val itemHoverStyle: UndefOr[Object]

    CSS styles for each legend item in hover mode.

    CSS styles for each legend item in hover mode. Only a subset of CSS is supported, notably those options related to text. Properties are inherited from style unless overridden here.

    Example:

    1. Item text styles

24.  val itemMarginBottom: UndefOr[Double]

    The pixel bottom margin for each legend item.

    The pixel bottom margin for each legend item.

    Example:

    1. Padding and item margins demonstrated

25.  val itemMarginTop: UndefOr[Double]

    The pixel top margin for each legend item.

    The pixel top margin for each legend item.

    Example:

    1. Padding and item margins demonstrated

26.  val itemStyle: UndefOr[Object]

    CSS styles for each legend item.

    CSS styles for each legend item. Only a subset of CSS is supported, notably those options related to text.

    Example:

    1. Item text styles

27.  val itemWidth: UndefOr[Double]

    The width for each legend item.

    The width for each legend item. This is useful in a horizontal layout with many items when you want the items to align vertically. .

28.  val labelFormat: UndefOr[String]

    A format string for each legend label.

    A format string for each legend label. Available variables relates to properties on the series, or the point in case of pies.

29.  val labelFormatter: UndefOr[Function]

    Callback function to format each of the series' labels.

    Callback function to format each of the series' labels. The this keyword refers to the series object, or the axis or data class object in case of color axes. By default the series or item name is printed.

    Example:

    1. Data classes with label formatter

30.  val layout: UndefOr[String]

    The layout of the legend items.

    The layout of the legend items. Can be one of "horizontal" or "vertical".

    Example:

    1. Vertical with data classes, vertical with color axis gradient.

31.  val margin: UndefOr[Double]

    If the plot area sized is calculated automatically and the legend is not floating, the legend margin is the space between the legend and the axis labels or plot area.

32.  val maxHeight: UndefOr[Double]

    Maximum pixel height for the legend.

    Maximum pixel height for the legend. When the maximum height is extended, navigation will show.

33.  val navigation: UndefOr[CleanJsObject[LegendNavigation]]

    Options for the paging or navigation appearing when the legend is overflown.

    Options for the paging or navigation appearing when the legend is overflown. When legend.useHTML is enabled, navigation is disabled.

    For demo cases, see the legend.navigation options for basic Highcharts.

34.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

35.  final def notify(): Unit

    Definition Classes

    AnyRef

36.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

37.  val padding: UndefOr[Double]

    The inner padding of the legend box.

    The inner padding of the legend box.

    Example:

    1. Padding and item margins demonstrated

38.  def propertyIsEnumerable(v: String): Boolean

    Definition Classes

    Object

39.  val reversed: UndefOr[Boolean]

    Whether to reverse the order of the legend items compared to the order of the series or data classes as defined in the configuration object.

40.  val rtl: UndefOr[Boolean]

    Whether to show the symbol on the right side of the text rather than the left side.

    Whether to show the symbol on the right side of the text rather than the left side. This is common in Arabic and Hebraic.

41.  val shadow: UndefOr[|[Boolean, Object]]

    Whether to apply a drop shadow to the legend.

    Whether to apply a drop shadow to the legend. A backgroundColor also needs to be applied for this to take effect. The shadow can also be an object configuration containing color, offsetX, offsetY, opacity and width.

    Example:

    1. Border and background options

42.  val squareSymbol: UndefOr[Boolean]

    When this is true, the legend symbol width will be the same as the symbol height, which in turn defaults to the font size of the legend items.

    When this is true, the legend symbol width will be the same as the symbol height, which in turn defaults to the font size of the legend items.

    Since

    5.0.0

43.  val symbolHeight: UndefOr[Double]

    The pixel height of the legend item symbol.

    The pixel height of the legend item symbol. Defaults to font size for regular item symbols as well as for gradient symbols on horizontal color axis and 200 for gradient symbols on vertical color axis.

    Example:

    1. Sized vertical gradient. No distance between data classes.

44.  val symbolPadding: UndefOr[Double]

    The pixel padding between the legend item symbol and the legend item text.

45.  val symbolRadius: UndefOr[Double]

    The border radius of the symbol for series types that use a rectangle in the legend.

    The border radius of the symbol for series types that use a rectangle in the legend. Defaults to half the symbolHeight.

    Example:

    1. Round symbols

46.  val symbolWidth: UndefOr[Double]

    The pixel width of the legend item symbol.

    The pixel width of the legend item symbol. When the squareSymbol option is set, this defaults to the symbolHeight, otherwise 16.

    Gradient symbols default to 200 on horizontal color axis and 12 for gradient symbols on vertical color axis.

    Example:

    1. Padding and item margins demonstrated. Sized vertical gradient.

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

    Definition Classes

    AnyRef

48.  val title: UndefOr[CleanJsObject[LegendTitle]]

    A title to be added on top of the legend.

    A title to be added on top of the legend.

    Example:

    1. Legend with title

49.  def toLocaleString(): String

    Definition Classes

    Object

50.  def toString(): String

    Definition Classes

    AnyRef → Any

51.  val useHTML: UndefOr[Boolean]

    Whether to use HTML to render the legend item texts.

    Whether to use HTML to render the legend item texts. Prior to 1.1.7, when using HTML, legend.navigation was disabled.

52.  def valueOf(): Any

    Definition Classes

    Object

53.  val verticalAlign: UndefOr[String]

    The vertical alignment of the legend box.

    The vertical alignment of the legend box. Can be one of top, middle or bottom. Vertical position can be further determined by the y option.

    In the case that the legend is aligned in a corner position, the layout option will determine whether to place it above/below or on the side of the plot area.

    Example:

    1. Legend alignment

54.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

56.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

57.  val width: UndefOr[Double]

    The width of the legend box.

58.  val x: UndefOr[Double]

    The x offset of the legend relative to its horizontal alignment align within chart.spacingLeft and chart.spacingRight.

    The x offset of the legend relative to its horizontal alignment align within chart.spacingLeft and chart.spacingRight. Negative x moves it to the left, positive x moves it to the right.

59.  val y: UndefOr[Double]

    The vertical offset of the legend relative to it's vertical alignment verticalAlign within chart.spacingTop and chart.spacingBottom.

    The vertical offset of the legend relative to it's vertical alignment verticalAlign within chart.spacingTop and chart.spacingBottom. Negative y moves it up, positive y moves it down.

    Example:

    1. Legend alignment