Legend

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: 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 at the right of the chart
Since
2.0
final def asInstanceOf[T0]: T0

Definition Classes
Any
val backgroundColor: String

The background color of the legend.
The background color of the legend.
Example:
1. Yellowish background
val borderColor: String

The color of the drawn border around the legend.
The color of the drawn border around the legend.
Example:
1. Brown border
val borderRadius: Double

The border corner radius of the legend.
The border corner radius of the legend.
Example:
1. Square by default, 5px rounded
val borderWidth: Double

The width of the drawn border around the legend.
The width of the drawn border around the legend.
Example:
1. 2px border width
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val enabled: Boolean

Enable or disable the legend.
Enable or disable the legend.
Example:
1. Legend disabled
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: 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. False by default, true.
Since
2.1
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: 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.
Example:
1. 50px item distance
Since
3.0.3
val itemHiddenStyle: 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. Defaults to:
```
itemHiddenStyle: {
	color: '#CCC'
}
```
Example:
1. Darker gray color
val itemHoverStyle: 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. Defaults to:
```
itemHoverStyle: {
	color: '#000'
}
```
Example:
1. Red on hover
val itemMarginBottom: Double

The pixel bottom margin for each legend item.
The pixel bottom margin for each legend item.
Example:
1. Padding and item margins demonstrated
Since
2.2.0
val itemMarginTop: Double

The pixel top margin for each legend item.
The pixel top margin for each legend item.
Example:
1. Padding and item margins demonstrated
Since
2.2.0
val itemStyle: 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. Bold black text
val itemWidth: 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. .
Example:
1. Null by default, 80 for aligned legend items
Since
2.0
val labelFormat: 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
1.3
val labelFormatter: 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.
Example:
1. Add text
val layout: String

The layout of the legend items.
The layout of the legend items. Can be one of "horizontal" or "vertical".
Example:
1. Horizontal by default, vertical
val lineHeight: Double

Line height for the legend items.
Line height for the legend items. Deprecated as of 2.1. Instead, the line height for each item can be set using itemStyle.lineHeight, and the padding between items using itemMarginTop and itemMarginBottom.
Example:
1. Setting padding.
Since
2.0
val margin: 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.
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.
Example:
1. 12 pixels by default, 30 pixels.
Since
2.1
val maxHeight: Double

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

Since
2.3.0
val navigation: 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: Double

The inner padding of the legend box.
The inner padding of the legend box.
Example:
1. Padding and item margins demonstrated
Since
2.2.0
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
val reversed: 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.
Whether to reverse the order of the legend items compared to the order of the series or points as defined in the configuration object.
Example:
1. Stacked bar with reversed legend
Since
1.2.5
val rtl: 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.
Example:
1. Symbol to the right
Since
2.2
val shadow: Any

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. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
Example:
1. White background and drop shadow
val style: 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, x and y, but the styles are still parsed for backwards compatibility.
val symbolHeight: 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: Double

The pixel padding between the legend item symbol and the legend item text.
The pixel padding between the legend item symbol and the legend item text.
Example:
1. Greater symbol width and padding
val symbolRadius: 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.
Example:
1. Round symbols
Since
3.0.8
val symbolWidth: Double

The pixel width of the legend item symbol.
The pixel width of the legend item symbol.
Example:
1. Greater symbol width and padding
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val title: LegendTitle

A title to be added on top of the legend.
A title to be added on top of the legend.
Example:
1. Legend title
Since
3.0
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
val useHTML: Boolean

Whether to use HTML to render the legend item texts.
Whether to use HTML to render the legend item texts. Prior to 4.1.7, when using HTML, legend.navigation was disabled.
def valueOf(): Any

Definition Classes
Object
val verticalAlign: 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 100px from the top of the chart
Since
2.0
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: Double

The width of the legend box.
The width of the legend box.
Example:
1. Aligned to the plot area
Since
2.0
val x: 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.
Example:
1. Aligned to the plot area
Since
2.0
val y: 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 100px from the top of the chart
Since
2.0

Related Doc: package config

class Legend extends Object

Instance Constructors

new Legend()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val align: String

final def asInstanceOf[T0]: T0

val backgroundColor: String

val borderColor: String

val borderRadius: Double

val borderWidth: Double

def clone(): AnyRef

val enabled: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

val floating: Boolean

final def getClass(): Class[_]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

val itemDistance: Double

val itemHiddenStyle: Object

val itemHoverStyle: Object

val itemMarginBottom: Double

val itemMarginTop: Double

val itemStyle: Object

val itemWidth: Double

val labelFormat: String

val labelFormatter: Function

val layout: String

val lineHeight: Double

val margin: Double

val maxHeight: Double

val navigation: LegendNavigation

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val padding: Double

def propertyIsEnumerable(v: String): Boolean

val reversed: Boolean

val rtl: Boolean

val shadow: Any

val style: Object

val symbolHeight: Double

val symbolPadding: Double

val symbolRadius: Double

val symbolWidth: Double

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

val title: LegendTitle

def toLocaleString(): String

def toString(): String

val useHTML: Boolean

def valueOf(): Any

val verticalAlign: String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

val width: Double

val x: Double

val y: Double

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped