
public class Legend
extends JsObject

The Legend class contains methods for configuring standalones legend.

Constructor Summary

Constructors
Constructor	Description
`Legend(String jsChart)`

Method Summary

Modifier and Type	Method	Description
`static Legend`	`instantiate()`
`String`	`getJsBase()`
`void`	`align()`	Getter for legend align settings.
`Legend`	`align(Align align)`	Setter for legend align settings.
`Legend`	`align(String align)`	Setter for legend align settings.
`Background`	`background()`	Getter for the legend background.
`Legend`	`background(String settings)`	Setter for the legend background.
`Legend`	`background(Boolean settings)`	Setter for the legend background.
`Layer`	`container()`	Getter for the legend container.
`Legend`	`container(Layer element)`	Setter for the legend container.
`Legend`	`container(Stage element)`	Setter for the legend container.
`void`	`disablePointerEvents()`	Getter for the pointer events.
`Legend`	`disablePointerEvents(Boolean enabled)`	Setter for the pointer events.
`Legend`	`draw()`	Draws legend.
`void`	`enabled()`	Getter for the element state (enabled or disabled).
`Legend`	`enabled(Boolean enabled)`	Setter for the element enabled state.
`void`	`fontColor()`	Getter for the text font color.
`Legend`	`fontColor(String color)`	Setter for the text font color.
`void`	`fontDecoration()`	Getter for the text font decoration.
`Legend`	`fontDecoration(Decoration value)`	Setter for the text font decoration.
`Legend`	`fontDecoration(String value)`	Setter for the text font decoration.
`void`	`fontFamily()`	Getter for the font family.
`Legend`	`fontFamily(String family)`	Setter for the font family.
`void`	`fontOpacity()`	Getter for the text font opacity.
`Legend`	`fontOpacity(Number opacity)`	Setter for the text font opacity.
`void`	`fontSize()`	Getter for the text font size.
`Legend`	`fontSize(String size)`	Setter for the text font size.
`Legend`	`fontSize(Number size)`	Setter for the text font size.
`void`	`fontStyle()`	Getter for the text font style.
`Legend`	`fontStyle(FontStyle style)`	Setter for the text font style.
`Legend`	`fontStyle(String style)`	Setter for the text font style.
`void`	`fontVariant()`	Getter for the text font variant.
`Legend`	`fontVariant(FontVariant value)`	Setter for the text font variant.
`Legend`	`fontVariant(String value)`	Setter for the text font variant.
`void`	`fontWeight()`	Getter for the text font weight.
`Legend`	`fontWeight(String weight)`	Setter for the text font weight.
`Legend`	`fontWeight(Number weight)`	Setter for the text font weight.
`Rect`	`getRemainingBounds()`	Getter for remain bounds after legend.
`void`	`hAlign()`	Getter for the text horizontal align.
`Legend`	`hAlign(HAlign align)`	Setter for the text horizontal align.
`Legend`	`hAlign(String align)`	Setter for the text horizontal align.
`void`	`height()`	Getter for the legend height.
`Legend`	`height(Number height)`	Setter for the legend height.
`Legend`	`height(String height)`	Setter for the legend height.
`void`	`hoverCursor()`	Getter for hover cursor settings.
`Legend`	`hoverCursor(Cursor cursorTypr)`	Setter for hover cursor settings.
`Legend`	`hoverCursor(String cursorTypr)`	Setter for hover cursor settings.
`void`	`iconSize()`	Getter for the icon size.
`Legend`	`iconSize(Number size)`	Setter for the icon size.
`Legend`	`iconSize(String size)`	Setter for the icon size.
`void`	`iconTextSpacing()`	Getter for spacing between icon and text in a legend item.
`Legend`	`iconTextSpacing(String spacing)`	Setter for spacing between icon and text in a legend item.
`Legend`	`iconTextSpacing(Number spacing)`	Setter for spacing between icon and text in a legend item.
`void`	`inverted()`	Getter for inverted settings.
`Legend`	`inverted(Boolean enabled)`	Setter for inverted settings.
`void`	`items()`	Getter for custom items.
`Legend`	`items(Array<LegendItemProvider> itemsList)`	Setter for custom items.
`void`	`itemsFormat()`	Getter for items text formatter.
`Legend`	`itemsFormat(String format)`	Setter for items text formatter.
`void`	`itemsFormatter()`	Getter for items formatter.
`Legend`	`itemsFormatter(Array<LegendItemProvider> formatterFunction)`	Setter for items formatter.
`void`	`itemsLayout()`	Getter for items layout.
`Legend`	`itemsLayout(LegendLayout layout)`	Setter for items layout.
`Legend`	`itemsLayout(String layout)`	Setter for items layout.
`SeparateChart`	`itemsSource()`	Getter for items source.
`Legend`	`itemsSource(SeparateChart source)`	Setter for items source.
`Legend`	`itemsSource(Array<SeparateChart> source)`	Setter for items source.
`void`	`itemsSourceMode()`	Getter for items source mode.
`Legend`	`itemsSourceMode(LegendItemsSourceMode mode)`	Setter for items source mode.
`Legend`	`itemsSourceMode(String mode)`	Setter for items source mode.
`void`	`itemsSpacing()`	Getter for items spacing settings.
`Legend`	`itemsSpacing(String spacing)`	Setter for items spacing settings.
`Legend`	`itemsSpacing(Number spacing)`	Setter for items spacing settings.
`void`	`letterSpacing()`	Getter for the text letter spacing.
`Legend`	`letterSpacing(String spacing)`	Setter for the text letter spacing.
`Legend`	`letterSpacing(Number spacing)`	Setter for the text letter spacing.
`void`	`lineHeight()`	Getter for the text line height.
`Legend`	`lineHeight(String height)`	Setter for the text line height.
`Legend`	`lineHeight(Number height)`	Setter for the text line height.
`Margin`	`margin()`	Getter for margin settings.
`Legend`	`margin(Array<Number> margin)`	Setter for the legend margin in pixels using a single value.
`Legend`	`margin(Array<String> margin)`	Setter for the legend margin in pixels using a single value.
`Legend`	`margin(String margin)`	Setter for the legend margin in pixels using a single value.
`Legend`	`margin(Number margin)`	Setter for the legend margin in pixels using a single value.
`Legend`	`margin(String value1, String value2, String value3, String value4)`	Setter for the legend margin in pixels using a single simple values.
`Legend`	`margin(String value1, String value2, String value3, Number value4)`	Setter for the legend margin in pixels using a single simple values.
`Legend`	`margin(String value1, String value2, Number value3, String value4)`	Setter for the legend margin in pixels using a single simple values.
`Legend`	`margin(String value1, String value2, Number value3, Number value4)`	Setter for the legend margin in pixels using a single simple values.
`Legend`	`margin(String value1, Number value2, String value3, String value4)`	Setter for the legend margin in pixels using a single simple values.
`Legend`	`margin(String value1, Number value2, String value3, Number value4)`	Setter for the legend margin in pixels using a single simple values.
`Legend`	`margin(String value1, Number value2, Number value3, String value4)`	Setter for the legend margin in pixels using a single simple values.
`Legend`	`margin(String value1, Number value2, Number value3, Number value4)`	Setter for the legend margin in pixels using a single simple values.
`Legend`	`margin(Number value1, String value2, String value3, String value4)`	Setter for the legend margin in pixels using a single simple values.
`Legend`	`margin(Number value1, String value2, String value3, Number value4)`	Setter for the legend margin in pixels using a single simple values.
`Legend`	`margin(Number value1, String value2, Number value3, String value4)`	Setter for the legend margin in pixels using a single simple values.
`Legend`	`margin(Number value1, String value2, Number value3, Number value4)`	Setter for the legend margin in pixels using a single simple values.
`Legend`	`margin(Number value1, Number value2, String value3, String value4)`	Setter for the legend margin in pixels using a single simple values.
`Legend`	`margin(Number value1, Number value2, String value3, Number value4)`	Setter for the legend margin in pixels using a single simple values.
`Legend`	`margin(Number value1, Number value2, Number value3, String value4)`	Setter for the legend margin in pixels using a single simple values.
`Legend`	`margin(Number value1, Number value2, Number value3, Number value4)`	Setter for the legend margin in pixels using a single simple values.
`Padding`	`padding()`	Getter for legend padding settings.
`Legend`	`padding(Array<Number> padding)`	Setter for the legend padding in pixels using a single value.
`Legend`	`padding(Array<String> padding)`	Setter for the legend padding in pixels using a single value.
`Legend`	`padding(String padding)`	Setter for the legend padding in pixels using a single value.
`Legend`	`padding(Number padding)`	Setter for the legend padding in pixels using a single value.
`Legend`	`padding(String value1, String value2, String value3, String value4)`	Setter for the legend padding setting in pixels using a several value.
`Legend`	`padding(String value1, String value2, String value3, Number value4)`	Setter for the legend padding setting in pixels using a several value.
`Legend`	`padding(String value1, String value2, Number value3, String value4)`	Setter for the legend padding setting in pixels using a several value.
`Legend`	`padding(String value1, String value2, Number value3, Number value4)`	Setter for the legend padding setting in pixels using a several value.
`Legend`	`padding(String value1, Number value2, String value3, String value4)`	Setter for the legend padding setting in pixels using a several value.
`Legend`	`padding(String value1, Number value2, String value3, Number value4)`	Setter for the legend padding setting in pixels using a several value.
`Legend`	`padding(String value1, Number value2, Number value3, String value4)`	Setter for the legend padding setting in pixels using a several value.
`Legend`	`padding(String value1, Number value2, Number value3, Number value4)`	Setter for the legend padding setting in pixels using a several value.
`Legend`	`padding(Number value1, String value2, String value3, String value4)`	Setter for the legend padding setting in pixels using a several value.
`Legend`	`padding(Number value1, String value2, String value3, Number value4)`	Setter for the legend padding setting in pixels using a several value.
`Legend`	`padding(Number value1, String value2, Number value3, String value4)`	Setter for the legend padding setting in pixels using a several value.
`Legend`	`padding(Number value1, String value2, Number value3, Number value4)`	Setter for the legend padding setting in pixels using a several value.
`Legend`	`padding(Number value1, Number value2, String value3, String value4)`	Setter for the legend padding setting in pixels using a several value.
`Legend`	`padding(Number value1, Number value2, String value3, Number value4)`	Setter for the legend padding setting in pixels using a several value.
`Legend`	`padding(Number value1, Number value2, Number value3, String value4)`	Setter for the legend padding setting in pixels using a several value.
`Legend`	`padding(Number value1, Number value2, Number value3, Number value4)`	Setter for the legend padding setting in pixels using a several value.
`Paginator`	`paginator()`	Getter for paginator settings.
`Legend`	`paginator(String settings)`	Setter for paginator settings.
`Legend`	`paginator(Boolean settings)`	Setter for paginator settings.
`Rect`	`parentBounds()`	Getter for parent bounds.
`Legend`	`parentBounds(Rect bounds)`	Setter for bounds using single value.
`Legend`	`parentBounds(String bounds)`	Setter for bounds using single value.
`Legend`	`parentBounds(Number left, Number top, Number width, Number height)`	Setter for bounds using several values.
`void`	`position()`	Getter for legend position settings.
`Legend`	`position(Orientation position)`	Setter for legend position setting.
`Legend`	`position(String position)`	Setter for legend position setting.
`void`	`print(PaperSize paperSizeOrOptions, Boolean landscape)`	Prints all elements on related stage.
`void`	`print(String paperSizeOrOptions, Boolean landscape)`	Prints all elements on related stage.
`void`	`removeAllListeners(String type)`	Removes all listeners from an object.
`void`	`selectable()`	Getter for the text selectable option.
`Legend`	`selectable(Boolean enabled)`	Setter for the text selectable.
`void`	`textDirection()`	Getter for the text direction.
`Legend`	`textDirection(Direction direction)`	Setter for the text direction.
`Legend`	`textDirection(String direction)`	Setter for the text direction.
`void`	`textIndent()`	Getter for the text indent.
`Legend`	`textIndent(Number indent)`	Setter for the text indent.
`void`	`textOverflow()`	Getter for the text overflow settings.
`Legend`	`textOverflow(TextOverflow value)`	Setter for the text overflow settings.
`Legend`	`textOverflow(String value)`	Setter for the text overflow settings.
`void`	`textSettings()`	Getter for the full text appearance settings.
`void`	`textSettings(String name)`	Getter for all text appearance settings.
`Legend`	`textSettings(String name, String settings)`	Setter for the text appearance settings.
`Legend`	`textSettings(String name, Number settings)`	Setter for the text appearance settings.
`Legend`	`textSettings(String name, Boolean settings)`	Setter for the text appearance settings.
`Title`	`title()`	Getter for the legend title.
`Legend`	`title(Boolean settings)`	Setter for the legend title.
`Legend`	`title(String settings)`	Setter for the legend title.
`void`	`titleFormat()`	Getter for the legend title format function.
`Legend`	`titleFormat(String format)`	Setter for the legend title format function.
`Separator`	`titleSeparator()`	Getter for title separator settings.
`Legend`	`titleSeparator(String settings)`	Setter for title separator settings.
`Legend`	`titleSeparator(Boolean settings)`	Setter for title separator settings.
`Tooltip`	`tooltip()`	Getter for the legend tooltip.
`Legend`	`tooltip(String settings)`	Setter for legend tooltip.
`Legend`	`tooltip(Boolean settings)`	Setter for legend tooltip.
`void`	`setOnClickListener(ListenersInterface.OnClickListener listener)`
`void`	`setOnClickListener(ListenersInterface.OnClickListener listener, String type, String ePath)`
`void`	`unlistenByKey(String key)`	Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().
`void`	`useHtml()`	Getter for the useHTML flag.
`Legend`	`useHtml(Boolean enabled)`	Setter for flag useHTML.
`void`	`vAlign()`	Getter for the text vertical align.
`Legend`	`vAlign(VAlign align)`	Setter for the text vertical align.
`Legend`	`vAlign(String align)`	Setter for the text vertical align.
`void`	`width()`	Getter for the legend width.
`Legend`	`width(Number width)`	Setter for the legend width.
`Legend`	`width(String width)`	Setter for the legend width.
`void`	`wordBreak()`	Getter for the word-break mode.
`Legend`	`wordBreak(WordBreak mode)`	Setter for the word-break mode.
`Legend`	`wordBreak(String mode)`	Setter for the word-break mode.
`void`	`wordWrap()`	Getter for the word-wrap mode.
`Legend`	`wordWrap(WordWrap mode)`	Setter for the word-wrap mode.
`Legend`	`wordWrap(String mode)`	Setter for the word-wrap mode.
`void`	`zIndex()`	Getter for the Z-index of the element.
`Legend`	`zIndex(Number zIndex)`	Setter for the Z-index of the element.
`void`	`drag()`	Gets a value for dragging.
`Legend`	`drag(Boolean enabled)`	Allows to use drag for legend.
`Rect`	`getPixelBounds()`	Returns pixel bounds of the legend.
`void`	`maxHeight()`	Getter for the maximum height.
`Legend`	`maxHeight(Number height)`	Setter for the maximum height.
`Legend`	`maxHeight(String height)`	Setter for the maximum height.
`void`	`maxWidth()`	Getter for the maximum width.
`Legend`	`maxWidth(Number width)`	Setter for the maximum width.
`Legend`	`maxWidth(String width)`	Setter for the maximum width.
`void`	`positionMode()`	Getter for the position mode.
`Legend`	`positionMode(LegendPositionMode mode)`	Setter for the position mode.
`Legend`	`positionMode(String mode)`	Setter for the position mode.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Legend
```
Legend(String jsChart)
```
- Method Detail
  - instantiate
```
 static Legend instantiate()
```
  - getJsBase
```
 String getJsBase()
```
  - align
```
 void align()
```
    Getter for legend align settings.
  - align
```
 Legend align(Align align)
```
    Setter for legend align settings.
  - align
```
 Legend align(String align)
```
    Setter for legend align settings.
  - background
```
 Background background()
```
    Getter for the legend background.
  - background
```
 Legend background(String settings)
```
    Setter for the legend background.
  - background
```
 Legend background(Boolean settings)
```
    Setter for the legend background.
  - container
```
 Layer container()
```
    Getter for the legend container.
  - container
```
 Legend container(Layer element)
```
    Setter for the legend container.
  - container
```
 Legend container(Stage element)
```
    Setter for the legend container.
  - disablePointerEvents
```
 void disablePointerEvents()
```
    Getter for the pointer events.
  - disablePointerEvents
```
 Legend disablePointerEvents(Boolean enabled)
```
    Setter for the pointer events.
  - draw
```
 Legend draw()
```
    Draws legend.
  - enabled
```
 void enabled()
```
    Getter for the element state (enabled or disabled).
  - enabled
```
 Legend enabled(Boolean enabled)
```
    Setter for the element enabled state.
  - fontColor
```
 void fontColor()
```
    Getter for the text font color.
  - fontColor
```
 Legend fontColor(String color)
```
    Setter for the text font color.://www.w3schools.com/html/html_colors.asp
  - fontDecoration
```
 void fontDecoration()
```
    Getter for the text font decoration.
  - fontDecoration
```
 Legend fontDecoration(Decoration value)
```
    Setter for the text font decoration.
  - fontDecoration
```
 Legend fontDecoration(String value)
```
    Setter for the text font decoration.
  - fontFamily
```
 void fontFamily()
```
    Getter for the font family.
  - fontFamily
```
 Legend fontFamily(String family)
```
    Setter for the font family.
  - fontOpacity
```
 void fontOpacity()
```
    Getter for the text font opacity.
  - fontOpacity
```
 Legend fontOpacity(Number opacity)
```
    Setter for the text font opacity. Double value from 0 to 1.
  - fontSize
```
 void fontSize()
```
    Getter for the text font size.
  - fontSize
```
 Legend fontSize(String size)
```
    Setter for the text font size.
  - fontSize
```
 Legend fontSize(Number size)
```
    Setter for the text font size.
  - fontStyle
```
 void fontStyle()
```
    Getter for the text font style.
  - fontStyle
```
 Legend fontStyle(FontStyle style)
```
    Setter for the text font style.
  - fontStyle
```
 Legend fontStyle(String style)
```
    Setter for the text font style.
  - fontVariant
```
 void fontVariant()
```
    Getter for the text font variant.
  - fontVariant
```
 Legend fontVariant(FontVariant value)
```
    Setter for the text font variant.
  - fontVariant
```
 Legend fontVariant(String value)
```
    Setter for the text font variant.
  - fontWeight
```
 void fontWeight()
```
    Getter for the text font weight.
  - fontWeight
```
 Legend fontWeight(String weight)
```
    Setter for the text font weight.://www.w3schools.com/cssref/pr_font_weight.asp
  - fontWeight
```
 Legend fontWeight(Number weight)
```
    Setter for the text font weight.://www.w3schools.com/cssref/pr_font_weight.asp
  - getRemainingBounds
```
 Rect getRemainingBounds()
```
    Getter for remain bounds after legend.
  - hAlign
```
 void hAlign()
```
    Getter for the text horizontal align.
  - hAlign
```
 Legend hAlign(HAlign align)
```
    Setter for the text horizontal align.
  - hAlign
```
 Legend hAlign(String align)
```
    Setter for the text horizontal align.
  - height
```
 void height()
```
    Getter for the legend height.
  - height
```
 Legend height(Number height)
```
    Setter for the legend height.
  - height
```
 Legend height(String height)
```
    Setter for the legend height.
  - hoverCursor
```
 void hoverCursor()
```
    Getter for hover cursor settings.
  - hoverCursor
```
 Legend hoverCursor(Cursor cursorTypr)
```
    Setter for hover cursor settings.
  - hoverCursor
```
 Legend hoverCursor(String cursorTypr)
```
    Setter for hover cursor settings.
  - iconSize
```
 void iconSize()
```
    Getter for the icon size.
  - iconSize
```
 Legend iconSize(Number size)
```
    Setter for the icon size.
  - iconSize
```
 Legend iconSize(String size)
```
    Setter for the icon size.
  - iconTextSpacing
```
 void iconTextSpacing()
```
    Getter for spacing between icon and text in a legend item.
  - iconTextSpacing
```
 Legend iconTextSpacing(String spacing)
```
    Setter for spacing between icon and text in a legend item.
  - iconTextSpacing
```
 Legend iconTextSpacing(Number spacing)
```
    Setter for spacing between icon and text in a legend item.
  - inverted
```
 void inverted()
```
    Getter for inverted settings.
  - inverted
```
 Legend inverted(Boolean enabled)
```
    Setter for inverted settings.
  - items
```
 void items()
```
    Getter for custom items.
  - items
```
 Legend items(Array<LegendItemProvider> itemsList)
```
    Setter for custom items.
  - itemsFormat
```
 void itemsFormat()
```
    Getter for items text formatter.
  - itemsFormat
```
 Legend itemsFormat(String format)
```
    Setter for items text formatter. {docs:Stock_Charts/Legend#items}Learn more about using itemsFormat() method.{docs}
  - itemsFormatter
```
 void itemsFormatter()
```
    Getter for items formatter.
  - itemsFormatter
```
 Legend itemsFormatter(Array<LegendItemProvider> formatterFunction)
```
    Setter for items formatter.
  - itemsLayout
```
 void itemsLayout()
```
    Getter for items layout.
  - itemsLayout
```
 Legend itemsLayout(LegendLayout layout)
```
    Setter for items layout.
  - itemsLayout
```
 Legend itemsLayout(String layout)
```
    Setter for items layout.
  - itemsSource
```
 SeparateChart itemsSource()
```
    Getter for items source.
  - itemsSource
```
 Legend itemsSource(SeparateChart source)
```
    Setter for items source.
  - itemsSource
```
 Legend itemsSource(Array<SeparateChart> source)
```
    Setter for items source.
  - itemsSourceMode
```
 void itemsSourceMode()
```
    Getter for items source mode.
  - itemsSourceMode
```
 Legend itemsSourceMode(LegendItemsSourceMode mode)
```
    Setter for items source mode.
  - itemsSourceMode
```
 Legend itemsSourceMode(String mode)
```
    Setter for items source mode.
  - itemsSpacing
```
 void itemsSpacing()
```
    Getter for items spacing settings.
  - itemsSpacing
```
 Legend itemsSpacing(String spacing)
```
    Setter for items spacing settings.
  - itemsSpacing
```
 Legend itemsSpacing(Number spacing)
```
    Setter for items spacing settings.
  - letterSpacing
```
 void letterSpacing()
```
    Getter for the text letter spacing.
  - letterSpacing
```
 Legend letterSpacing(String spacing)
```
    Setter for the text letter spacing.://www.w3schools.com/cssref/pr_text_letter-spacing.asp
  - letterSpacing
```
 Legend letterSpacing(Number spacing)
```
    Setter for the text letter spacing.://www.w3schools.com/cssref/pr_text_letter-spacing.asp
  - lineHeight
```
 void lineHeight()
```
    Getter for the text line height.
  - lineHeight
```
 Legend lineHeight(String height)
```
    Setter for the text line height.://www.w3schools.com/cssref/pr_dim_line-height.asp
  - lineHeight
```
 Legend lineHeight(Number height)
```
    Setter for the text line height.://www.w3schools.com/cssref/pr_dim_line-height.asp
  - margin
```
 Margin margin()
```
    Getter for margin settings.
  - margin
```
 Legend margin(Array<Number> margin)
```
    Setter for the legend margin in pixels using a single value.
  - margin
```
 Legend margin(Array<String> margin)
```
    Setter for the legend margin in pixels using a single value.
  - margin
```
 Legend margin(String margin)
```
    Setter for the legend margin in pixels using a single value.
  - margin
```
 Legend margin(Number margin)
```
    Setter for the legend margin in pixels using a single value.
  - margin
```
 Legend margin(String value1, String value2, String value3, String value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - margin
```
 Legend margin(String value1, String value2, String value3, Number value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - margin
```
 Legend margin(String value1, String value2, Number value3, String value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - margin
```
 Legend margin(String value1, String value2, Number value3, Number value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - margin
```
 Legend margin(String value1, Number value2, String value3, String value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - margin
```
 Legend margin(String value1, Number value2, String value3, Number value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - margin
```
 Legend margin(String value1, Number value2, Number value3, String value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - margin
```
 Legend margin(String value1, Number value2, Number value3, Number value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - margin
```
 Legend margin(Number value1, String value2, String value3, String value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - margin
```
 Legend margin(Number value1, String value2, String value3, Number value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - margin
```
 Legend margin(Number value1, String value2, Number value3, String value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - margin
```
 Legend margin(Number value1, String value2, Number value3, Number value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - margin
```
 Legend margin(Number value1, Number value2, String value3, String value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - margin
```
 Legend margin(Number value1, Number value2, String value3, Number value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - margin
```
 Legend margin(Number value1, Number value2, Number value3, String value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - margin
```
 Legend margin(Number value1, Number value2, Number value3, Number value4)
```
    Setter for the legend margin in pixels using a single simple values.
  - padding
```
 Padding padding()
```
    Getter for legend padding settings.
  - padding
```
 Legend padding(Array<Number> padding)
```
    Setter for the legend padding in pixels using a single value.
  - padding
```
 Legend padding(Array<String> padding)
```
    Setter for the legend padding in pixels using a single value.
  - padding
```
 Legend padding(String padding)
```
    Setter for the legend padding in pixels using a single value.
  - padding
```
 Legend padding(Number padding)
```
    Setter for the legend padding in pixels using a single value.
  - padding
```
 Legend padding(String value1, String value2, String value3, String value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - padding
```
 Legend padding(String value1, String value2, String value3, Number value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - padding
```
 Legend padding(String value1, String value2, Number value3, String value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - padding
```
 Legend padding(String value1, String value2, Number value3, Number value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - padding
```
 Legend padding(String value1, Number value2, String value3, String value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - padding
```
 Legend padding(String value1, Number value2, String value3, Number value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - padding
```
 Legend padding(String value1, Number value2, Number value3, String value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - padding
```
 Legend padding(String value1, Number value2, Number value3, Number value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - padding
```
 Legend padding(Number value1, String value2, String value3, String value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - padding
```
 Legend padding(Number value1, String value2, String value3, Number value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - padding
```
 Legend padding(Number value1, String value2, Number value3, String value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - padding
```
 Legend padding(Number value1, String value2, Number value3, Number value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - padding
```
 Legend padding(Number value1, Number value2, String value3, String value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - padding
```
 Legend padding(Number value1, Number value2, String value3, Number value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - padding
```
 Legend padding(Number value1, Number value2, Number value3, String value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - padding
```
 Legend padding(Number value1, Number value2, Number value3, Number value4)
```
    Setter for the legend padding setting in pixels using a several value.
  - paginator
```
 Paginator paginator()
```
    Getter for paginator settings.
  - paginator
```
 Legend paginator(String settings)
```
    Setter for paginator settings.
  - paginator
```
 Legend paginator(Boolean settings)
```
    Setter for paginator settings.
  - parentBounds
```
 Rect parentBounds()
```
    Getter for parent bounds. As a getter falls back to stage bounds.
  - parentBounds
```
 Legend parentBounds(Rect bounds)
```
    Setter for bounds using single value.
  - parentBounds
```
 Legend parentBounds(String bounds)
```
    Setter for bounds using single value.
  - parentBounds
```
 Legend parentBounds(Number left, Number top, Number width, Number height)
```
    Setter for bounds using several values.
  - position
```
 void position()
```
    Getter for legend position settings.
  - position
```
 Legend position(Orientation position)
```
    Setter for legend position setting.
  - position
```
 Legend position(String position)
```
    Setter for legend position setting.
  - print
```
 void print(PaperSize paperSizeOrOptions, Boolean landscape)
```
    Prints all elements on related stage.
  - print
```
 void print(String paperSizeOrOptions, Boolean landscape)
```
    Prints all elements on related stage.
  - removeAllListeners
```
 void removeAllListeners(String type)
```
    Removes all listeners from an object. You can also optionally remove listeners of some particular type.
  - selectable
```
 void selectable()
```
    Getter for the text selectable option.
  - selectable
```
 Legend selectable(Boolean enabled)
```
    Setter for the text selectable.
  - textDirection
```
 void textDirection()
```
    Getter for the text direction.
  - textDirection
```
 Legend textDirection(Direction direction)
```
    Setter for the text direction.
  - textDirection
```
 Legend textDirection(String direction)
```
    Setter for the text direction.
  - textIndent
```
 void textIndent()
```
    Getter for the text indent.
  - textIndent
```
 Legend textIndent(Number indent)
```
    Setter for the text indent.
  - textOverflow
```
 void textOverflow()
```
    Getter for the text overflow settings.
  - textOverflow
```
 Legend textOverflow(TextOverflow value)
```
    Setter for the text overflow settings.
  - textOverflow
```
 Legend textOverflow(String value)
```
    Setter for the text overflow settings.
  - textSettings
```
 void textSettings()
```
    Getter for the full text appearance settings.
  - textSettings
```
 void textSettings(String name)
```
    Getter for all text appearance settings.
  - textSettings
```
 Legend textSettings(String name, String settings)
```
    Setter for the text appearance settings.
  - textSettings
```
 Legend textSettings(String name, Number settings)
```
    Setter for the text appearance settings.
  - textSettings
```
 Legend textSettings(String name, Boolean settings)
```
    Setter for the text appearance settings.
  - title
```
 Title title()
```
    Getter for the legend title.
  - title
```
 Legend title(Boolean settings)
```
    Setter for the legend title.
  - title
```
 Legend title(String settings)
```
    Setter for the legend title.
  - titleFormat
```
 void titleFormat()
```
    Getter for the legend title format function.
  - titleFormat
```
 Legend titleFormat(String format)
```
    Setter for the legend title format function. If set, formats title. Currently supported in Stock only. {docs:Common_Settings/Text_Formatters}Learn more about using titleFormat() method.{docs}
  - titleSeparator
```
 Separator titleSeparator()
```
    Getter for title separator settings.
  - titleSeparator
```
 Legend titleSeparator(String settings)
```
    Setter for title separator settings.
  - titleSeparator
```
 Legend titleSeparator(Boolean settings)
```
    Setter for title separator settings.
  - tooltip
```
 Tooltip tooltip()
```
    Getter for the legend tooltip.
  - tooltip
```
 Legend tooltip(String settings)
```
    Setter for legend tooltip.
  - tooltip
```
 Legend tooltip(Boolean settings)
```
    Setter for legend tooltip.
  - setOnClickListener
```
 void setOnClickListener(ListenersInterface.OnClickListener listener)
```
  - setOnClickListener
```
 void setOnClickListener(ListenersInterface.OnClickListener listener, String type, String ePath)
```
  - unlistenByKey
```
 void unlistenByKey(String key)
```
    Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().
  - useHtml
```
 void useHtml()
```
    Getter for the useHTML flag.
  - useHtml
```
 Legend useHtml(Boolean enabled)
```
    Setter for flag useHTML.
  - vAlign
```
 void vAlign()
```
    Getter for the text vertical align.
  - vAlign
```
 Legend vAlign(VAlign align)
```
    Setter for the text vertical align.
  - vAlign
```
 Legend vAlign(String align)
```
    Setter for the text vertical align.
  - width
```
 void width()
```
    Getter for the legend width.
  - width
```
 Legend width(Number width)
```
    Setter for the legend width.
  - width
```
 Legend width(String width)
```
    Setter for the legend width.
  - wordBreak
```
 void wordBreak()
```
    Getter for the word-break mode.
  - wordBreak
```
 Legend wordBreak(WordBreak mode)
```
    Setter for the word-break mode.
  - wordBreak
```
 Legend wordBreak(String mode)
```
    Setter for the word-break mode.
  - wordWrap
```
 void wordWrap()
```
    Getter for the word-wrap mode.
  - wordWrap
```
 Legend wordWrap(WordWrap mode)
```
    Setter for the word-wrap mode.
  - wordWrap
```
 Legend wordWrap(String mode)
```
    Setter for the word-wrap mode.
  - zIndex
```
 void zIndex()
```
    Getter for the Z-index of the element.
  - zIndex
```
 Legend zIndex(Number zIndex)
```
    Setter for the Z-index of the element.
  - drag
```
 void drag()
```
    Gets a value for dragging.
  - drag
```
 Legend drag(Boolean enabled)
```
    Allows to use drag for legend.
  - getPixelBounds
```
 Rect getPixelBounds()
```
    Returns pixel bounds of the legend.
  - maxHeight
```
 void maxHeight()
```
    Getter for the maximum height.
  - maxHeight
```
 Legend maxHeight(Number height)
```
    Setter for the maximum height.
  - maxHeight
```
 Legend maxHeight(String height)
```
    Setter for the maximum height.
  - maxWidth
```
 void maxWidth()
```
    Getter for the maximum width.
  - maxWidth
```
 Legend maxWidth(Number width)
```
    Setter for the maximum width.
  - maxWidth
```
 Legend maxWidth(String width)
```
    Setter for the maximum width.
  - positionMode
```
 void positionMode()
```
    Getter for the position mode.
  - positionMode
```
 Legend positionMode(LegendPositionMode mode)
```
    Setter for the position mode.
  - positionMode
```
 Legend positionMode(String mode)
```
    Setter for the position mode.

Class Legend

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Legend

Method Detail

instantiate

getJsBase

align

align

align

background

background

background

container

container

container

disablePointerEvents

disablePointerEvents

draw

enabled

enabled

fontColor

fontColor

fontDecoration

fontDecoration

fontDecoration

fontFamily

fontFamily

fontOpacity

fontOpacity

fontSize

fontSize

fontSize

fontStyle

fontStyle

fontStyle

fontVariant

fontVariant

fontVariant

fontWeight

fontWeight

fontWeight

getRemainingBounds

hAlign

hAlign

hAlign

height

height

height

hoverCursor

hoverCursor

hoverCursor

iconSize

iconSize

iconSize

iconTextSpacing

iconTextSpacing

iconTextSpacing

inverted

inverted

items

items

itemsFormat

itemsFormat

itemsFormatter

itemsFormatter

itemsLayout

itemsLayout

itemsLayout

itemsSource

itemsSource

itemsSource

itemsSourceMode

itemsSourceMode

itemsSourceMode

itemsSpacing

itemsSpacing

itemsSpacing