class Legend extends Object
- Annotations
- @RawJSType() @ScalaJSDefined()
- Note
JavaScript name:
legend
- Alphabetic
- By Inheritance
- Legend
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Legend()
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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,centerandright.In the case that the legend is aligned in a corner position, the
layoutoption will determine whether to place it above/below or on the side of the plot area.Example: -
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
val
backgroundColor: UndefOr[|[String, Object]]
The background color of the legend.
The background color of the legend.
Example: -
val
borderColor: UndefOr[|[String, Object]]
The color of the drawn border around the legend.
The color of the drawn border around the legend.
Example: -
val
borderRadius: UndefOr[Double]
The border corner radius of the legend.
-
val
borderWidth: UndefOr[Double]
The width of the drawn border around the legend.
The width of the drawn border around the legend.
Example: -
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
enabled: UndefOr[Boolean]
Enable or disable the legend.
Enable or disable the legend.
Example: -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
val
floating: UndefOr[Boolean]
When the legend is floating, the plot area ignores it and is allowed to be placed below it.
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
-
val
itemDistance: UndefOr[Double]
In a legend with horizontal layout, the itemDistance defines the pixel distance between each item.
In a legend with horizontal layout, the itemDistance defines the pixel distance between each item.
- Since
1.3.3
Example: -
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
styleunless overridden here. -
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
styleunless overridden here. -
val
itemMarginBottom: UndefOr[Double]
The pixel bottom margin for each legend item.
The pixel bottom margin for each legend item.
- Since
1.1
-
val
itemMarginTop: UndefOr[Double]
The pixel top margin for each legend item.
The pixel top margin for each legend item.
- Since
1.1
-
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.
-
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. .
-
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.
- Since
3.0
-
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 point object in case of pie charts. By default the series or point name is printed.
-
val
layout: UndefOr[String]
The layout of the legend items.
The layout of the legend items. Can be one of "horizontal" or "vertical".
Example: -
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.
-
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.
- Since
1.2.0
-
val
navigation: UndefOr[CleanJsObject[LegendNavigation]]
Options for the paging or navigation appearing when the legend is overflown.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
val
padding: UndefOr[Double]
The inner padding of the legend box.
The inner padding of the legend box.
- Since
1.1
-
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
-
val
reversed: UndefOr[Boolean]
Whether to reverse the order of the legend items compared to the order of the series or points as defined in the configuration object.
-
val
shadow: UndefOr[|[Boolean, Object]]
Whether to apply a drop shadow to the legend.
Whether to apply a drop shadow to the legend. A
backgroundColoralso needs to be applied for this to take effect. Since 1.1.7 the shadow can be an object configuration containingcolor,offsetX,offsetY,opacityandwidth.Example: -
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
-
val
style: UndefOr[Object]
CSS styles for the legend area.
CSS styles for the legend area. In the 1.x versions the position of the legend area was determined by CSS. In 2.x, the position is determined by properties like
align,verticalAlign,xandy, but the styles are still parsed for backwards compatibility. -
val
symbolHeight: UndefOr[Double]
The pixel height of the symbol for series types that use a rectangle in the legend.
The pixel height of the symbol for series types that use a rectangle in the legend. Defaults to the font size of legend items.
- Since
3.0.8
-
val
symbolPadding: UndefOr[Double]
The pixel padding between the legend item symbol and the legend item text.
-
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: -
val
symbolWidth: UndefOr[Double]
The pixel width of the legend item symbol.
The pixel width of the legend item symbol. When the
squareSymboloption is set, this defaults to thesymbolHeight, otherwise 16. -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
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
- Since
1.3
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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 2.1.7, when using HTML, legend.navigation was disabled.
-
def
valueOf(): Any
- Definition Classes
- Object
-
val
verticalAlign: UndefOr[String]
The vertical alignment of the legend box.
The vertical alignment of the legend box. Can be one of
top,middleorbottom. Vertical position can be further determined by theyoption.In the case that the legend is aligned in a corner position, the
layoutoption will determine whether to place it above/below or on the side of the plot area.Example: -
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
width: UndefOr[Double]
The width of the legend box.
-
val
x: UndefOr[Double]
The x offset of the legend relative to its horizontal alignment
alignwithin chart.spacingLeft and chart.spacingRight.The x offset of the legend relative to its horizontal alignment
alignwithin chart.spacingLeft and chart.spacingRight. Negative x moves it to the left, positive x moves it to the right. -
val
y: UndefOr[Double]
The vertical offset of the legend relative to it's vertical alignment
verticalAlignwithin chart.spacingTop and chart.spacingBottom.The vertical offset of the legend relative to it's vertical alignment
verticalAlignwithin chart.spacingTop and chart.spacingBottom. Negative y moves it up, positive y moves it down.Example: