object Legend
- Alphabetic
- By Inheritance
- Legend
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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
-
def
apply(align: UndefOr[String] = js.undefined, backgroundColor: UndefOr[|[String, Object]] = js.undefined, borderColor: UndefOr[|[String, Object]] = js.undefined, borderRadius: UndefOr[Double] = js.undefined, borderWidth: UndefOr[Double] = js.undefined, enabled: UndefOr[Boolean] = js.undefined, floating: UndefOr[Boolean] = js.undefined, itemDistance: UndefOr[Double] = js.undefined, itemHiddenStyle: UndefOr[Object] = js.undefined, itemHoverStyle: UndefOr[Object] = js.undefined, itemMarginBottom: UndefOr[Double] = js.undefined, itemMarginTop: UndefOr[Double] = js.undefined, itemStyle: UndefOr[Object] = js.undefined, itemWidth: UndefOr[Double] = js.undefined, labelFormat: UndefOr[String] = js.undefined, labelFormatter: UndefOr[Function] = js.undefined, layout: UndefOr[String] = js.undefined, margin: UndefOr[Double] = js.undefined, maxHeight: UndefOr[Double] = js.undefined, navigation: UndefOr[CleanJsObject[LegendNavigation]] = js.undefined, padding: UndefOr[Double] = js.undefined, reversed: UndefOr[Boolean] = js.undefined, rtl: UndefOr[Boolean] = js.undefined, shadow: UndefOr[|[Boolean, Object]] = js.undefined, squareSymbol: UndefOr[Boolean] = js.undefined, symbolHeight: UndefOr[Double] = js.undefined, symbolPadding: UndefOr[Double] = js.undefined, symbolRadius: UndefOr[Double] = js.undefined, symbolWidth: UndefOr[Double] = js.undefined, title: UndefOr[CleanJsObject[LegendTitle]] = js.undefined, useHTML: UndefOr[Boolean] = js.undefined, verticalAlign: UndefOr[String] = js.undefined, width: UndefOr[Double] = js.undefined, x: UndefOr[Double] = js.undefined, y: UndefOr[Double] = js.undefined): Legend
- align
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, thelayoutoption will determine whether to place it above/below or on the side of the plot area.- backgroundColor
The background color of the legend.
- borderColor
The color of the drawn border around the legend.
- borderRadius
The border corner radius of the legend.
- borderWidth
The width of the drawn border around the legend.
- enabled
Enable or disable the legend.
- floating
When the legend is floating, the plot area ignores it and is allowed to be placed below it.
- itemDistance
In a legend with horizontal layout, the itemDistance defines the pixel distance between each item.
- itemHiddenStyle
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.- itemHoverStyle
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.- itemMarginBottom
The pixel bottom margin for each legend item.
- itemMarginTop
The pixel top margin for each legend item.
- itemStyle
CSS styles for each legend item. Only a subset of CSS is supported, notably those options related to text.
- itemWidth
The width for each legend item. This is useful in a horizontal layout with many items when you want the items to align vertically. .
- labelFormat
A format string for each legend label. Available variables relates to properties on the series, or the point in case of pies.
- labelFormatter
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.
- layout
The layout of the legend items. Can be one of "horizontal" or "vertical".
- margin
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.
- maxHeight
Maximum pixel height for the legend. When the maximum height is extended, navigation will show.
- navigation
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.
- padding
The inner padding of the legend box.
- reversed
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.
- rtl
Whether to show the symbol on the right side of the text rather than the left side. This is common in Arabic and Hebraic.
- shadow
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 containingcolor,offsetX,offsetY,opacityandwidth.- squareSymbol
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.
- symbolHeight
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
200for gradient symbols on vertical color axis.- symbolPadding
The pixel padding between the legend item symbol and the legend item text.
- symbolRadius
The border radius of the symbol for series types that use a rectangle in the legend. Defaults to half the
symbolHeight.- symbolWidth
The pixel width of the legend item symbol. When the
squareSymboloption is set, this defaults to thesymbolHeight, otherwise 16.. . Gradient symbols default to200on horizontal color axis and12for gradient symbols on vertical color axis.- title
A title to be added on top of the legend.
- useHTML
Whether to use HTML to render the legend item texts. Prior to 1.1.7, when using HTML, legend.navigation was disabled.
- verticalAlign
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, thelayoutoption will determine whether to place it above/below or on the side of the plot area.- width
The width of the legend box.
- x
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.- y
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.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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( ... )