class anychart.standalones.Legend Improve this Doc

var background = legend.background();

background(settings)

Setter for the legend background.

Sets legend background settings depending on parameter type:

null/boolean - disable or enable legend background.
string - sets legend background color value.
object - sets legend background settings.

Params:

Name	Type	Default	Description
settings	string \| Object \| null \| boolean	true	Background settings.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

container

container()

Getter for the legend container.

Returns:

anychart.graphics.vector.Layer | anychart.graphics.vector.Stage - Legend container.

container(element)

Setter for the legend container.

Params:

Name	Type	Description
element	anychart.graphics.vector.Layer \| anychart.graphics.vector.Stage	The value to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

disablePointerEvents

disablePointerEvents()

Getter for the pointer events.

Returns:

boolean - Flag of the state.

Try it:

Usage sample

disablePointerEvents(enabled)

Setter for the pointer events.

Params:

Name	Type	Default	Description
enabled	boolean	false	Enabled state to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

drag

drag()Since version 7.13.0

Gets a value for dragging.

Returns:

boolean - The dragging value.

var drag = legend.drag();

drag(enabled)Since version 7.13.0

Allows to use drag for legend.

Params:

Name	Type	Description
enabled	boolean	Allows dragging of the legend.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

draw

draw()

Draws legend.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

Getter for the legend state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the legend enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

fontColor

fontColor()

Getter for the text font color.

Returns:

string - Font color.

Try it:

Usage sample

fontColor(color)

Setter for the text font color.
https://www.w3schools.com/html/html_colors.asp

Params:

Name	Type	Default	Description
color	string	'#7c868e'	Value to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

fontDecoration

fontDecoration()

Getter for the text font decoration.

Returns:

anychart.graphics.vector.Text.Decoration | string - Font decoration.

Try it:

Usage sample

fontDecoration(value)

Setter for the text font decoration.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.Decoration \| string	'none'	Font decoration to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

fontFamily

fontFamily()

Getter for the font family.

Returns:

string - Font family.

Try it:

Usage sample

fontFamily(family)

Setter for the font family.

Params:

Name	Type	Default	Description
family	string	'Verdana', Helvetica, Arial, sans-serif	Font family to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

fontOpacity

fontOpacity()

Getter for the text font opacity.

Returns:

number - Font opacity.

Try it:

Usage sample

fontOpacity(opacity)

Setter for the text font opacity. Double value from 0 to 1.

Params:

Name	Type	Default	Description
opacity	number	1	Value to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

Name	Type	Default	Description
size	string \| number	12	Font size to set.

fontStyle

fontStyle()

Getter for the text font style.

Returns:

anychart.graphics.vector.Text.FontStyle | string - Font style.

Try it:

Usage sample

fontStyle(style)

Setter for the text font style.

Params:

Name	Type	Default	Description
style	anychart.graphics.vector.Text.FontStyle \| string	'normal'	Font style to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

fontVariant

fontVariant()

Getter for the text font variant.

Returns:

anychart.graphics.vector.Text.FontVariant | string - Font variant.

Try it:

Usage sample

fontVariant(value)

Setter for the text font variant.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.FontVariant \| string	'normal'	Font variant to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

fontWeight

fontWeight()

Getter for the text font weight.

Returns:

string | number - Font weight.

Try it:

Usage sample

fontWeight(weight)

Setter for the text font weight.
https://www.w3schools.com/cssref/pr_font_weight.asp

Params:

Name	Type	Default	Description
weight	string \| number	'normal'	Font weight to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

getPixelBounds

getPixelBounds()Since version 7.14.0

Returns pixel bounds of the legend.

Returns:

anychart.math.Rect - Pixel bounds of the legend.

Try it:

Usage sample

getRemainingBounds

getRemainingBounds()

Getter for remain bounds after legend.

Works only after anychart.standalones.Legend#draw is called.

Returns:

anychart.math.Rect - Bounds that remain after legend.

Try it:

Usage sample

hAlign

hAlign()

Getter for the text horizontal align.

Returns:

anychart.graphics.vector.Text.HAlign | string - Text horizontal align.

Try it:

Usage sample

hAlign(align)

Setter for the text horizontal align.

Params:

Name	Type	Default	Description
align	anychart.graphics.vector.Text.HAlign \| string	'start'	Value to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

height

height()

Getter for the legend height.

Returns:

number | string | null - Legend height.

Try it:

Usage sample

height(height)

Setter for the legend height.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Legend height to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

hoverCursor

hoverCursor()

Getter for hover cursor settings.

Returns:

anychart.enums.Cursor | string - Hover cursor settings.

Try it:

Usage sample

hoverCursor(cursorTypr)

Setter for hover cursor settings.

Params:

Name	Type	Default	Description
cursorTypr	anychart.enums.Cursor \| string	'pointer'	Hover cursor setting.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

iconSize

iconSize()

Getter for the icon size.

Returns:

number - Icon size.

Try it:

Usage sample

iconSize(size)

Setter for the icon size.

Params:

Name	Type	Description
size	number \| string	Icon size setting.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

iconTextSpacing

iconTextSpacing()

Getter for spacing between icon and text in a legend item.

Returns:

number - Spacing settings.

Try it:

Usage sample

iconTextSpacing(spacing)

Setter for spacing between icon and text in a legend item.

Params:

Name	Type	Default	Description
spacing	string \| number	5	Spacing settings.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

inverted

inverted()

Getter for inverted settings.

Returns:

boolean - Inverted settings.

Try it:

Usage sample

inverted(enabled)

Setter for inverted settings.

Params:

Name	Type	Default	Description
enabled	boolean	false	Whether item list should be inverted or not.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

items

items()

Getter for custom items.

Returns:

Array.<anychart.core.ui.Legend.LegendItemProvider> - Custom item.

var items = legend.items();

items(itemsList)

Setter for custom items.

Params:

Name	Type	Default	Description
itemsList	Array.<anychart.core.ui.Legend.LegendItemProvider>	null	Items array to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

itemsFormat

itemsFormat()

Getter for items text formatter.

Returns:

function - Items text formatter function.

var itemsFormat = legend.itemsFormat();

itemsFormat(format)

Setter for items text formatter.
Learn more about using itemsFormat() method.

Params:

Name	Type	Description
format	function(value:Object):string \| string	Items text formatter function.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

itemsFormatter

itemsFormatter()

Getter for items formatter.

Returns:

function(items:Array.<anychart.core.ui.Legend.LegendItemProvider>):Array.<anychart.core.ui.Legend.LegendItemProvider> - Formatter function.

var itemsFormatter = legend.itemsFormatter();

itemsFormatter(formatterFunction)

Setter for items formatter.

Params:

Name	Type	Default	Description
formatterFunction	function(items:Array.<anychart.core.ui.Legend.LegendItemProvider>):Array.<anychart.core.ui.Legend.LegendItemProvider>	function (a){return a}	Formatter function.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

itemsLayout

itemsLayout()

Getter for items layout.

Returns:

anychart.enums.LegendLayout | string - Items layout.

Try it:

Usage sample

itemsLayout(layout)

Setter for items layout.

Params:

Name	Type	Default	Description
layout	anychart.enums.LegendLayout \| string	'horizontal'	Layout type for legend items.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

itemsSource

itemsSource()

Getter for items source.

Returns:

anychart.core.SeparateChart | Array.<anychart.core.SeparateChart> - Items source.

itemsSource(source)

Setter for items source.

Params:

Name	Type	Description
source	anychart.core.SeparateChart \| Array.<anychart.core.SeparateChart>	Items source to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

itemsSourceMode

itemsSourceMode()

Getter for items source mode.

Returns:

anychart.enums.LegendItemsSourceMode | string - Items source mode.

Try it:

Usage sample

itemsSourceMode(mode)

Setter for items source mode.

Modes for data collection: default and categories. A categories mode works only with an ordinal scale.

Params:

Name	Type	Default	Description
mode	anychart.enums.LegendItemsSourceMode \| string	'default'	Items source mode.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

itemsSpacing

itemsSpacing()

Getter for items spacing settings.

Returns:

string | number - Items spacing settings.

Try it:

Usage sample

itemsSpacing(spacing)

Setter for items spacing settings.

Params:

Name	Type	Default	Description
spacing	string \| number	15	Value to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

letterSpacing

letterSpacing()

Getter for the text letter spacing.

Returns:

string | number - Letter spacing.

Try it:

Usage sample

letterSpacing(spacing)

Setter for the text letter spacing.
https://www.w3schools.com/cssref/pr_text_letter-spacing.asp

Params:

Name	Type	Default	Description
spacing	string \| number	'normal'	Value to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

lineHeight

lineHeight()

Getter for the text line height.

Returns:

string | number - Text line height.

Try it:

Usage sample

lineHeight(height)

Setter for the text line height.
https://www.w3schools.com/cssref/pr_dim_line-height.asp

Params:

Name	Type	Default	Description
height	string \| number	'normal'	Value to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

margin

margin()

Getter for margin settings.

Also, you can use anychart.core.utils.Margin#bottom, anychart.core.utils.Margin#left, anychart.core.utils.Margin#right, anychart.core.utils.Margin#top methods to setting paddings.

Returns:

anychart.core.utils.Margin - Legend margin.

Try it:

Usage sample

margin(margin)

Setter for the legend margin in pixels using a single value.

Params:

Name	Type	Default	Description
margin	Array.<(number\|string)> \| Object \| number \| string	{top: 4, right: 4, bottom: 4, left: 4}	Space value, object or array.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

margin(value1, value2, value3, value4)

Setter for the legend margin in pixels using a single simple values.

Params:

Name	Type	Default	Description
value1	string \| number	4	Top or top-bottom space.
value2	string \| number	4	Right or right-left space.
value3	string \| number	4	Bottom space.
value4	string \| number	4	Left space.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

maxHeight

maxHeight()Since version 7.13.0

Getter for the maximum height.

Returns:

number | string | null - The maximum height.

var maxHeight = legend.maxHeight();

maxHeight(height)Since version 7.13.0

Setter for the maximum height.

Params:

Name	Type	Default	Description
height	number \| string	null	Maximum height to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

maxWidth

maxWidth()Since version 7.13.0

Getter for the maximum width.

Returns:

number | string | null - The maximum width.

var maxWidth = legend.maxWidth();

maxWidth(width)Since version 7.13.0

Setter for the maximum width.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Maximum width to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

padding

padding()

Getter for legend padding settings.

Also, you can use anychart.core.utils.Padding#bottom, anychart.core.utils.Padding#left, anychart.core.utils.Padding#right, anychart.core.utils.Padding#top methods to setting paddings.

Returns:

anychart.core.utils.Padding - Legend padding.

Try it:

Usage sample

padding(padding)

Setter for the legend padding in pixels using a single value.

Params:

Name	Type	Default	Description
padding	Array.<(number\|string)> \| Object \| number \| string	{top: 7, right: 7, bottom: 7, left: 7}	Space value, object or array.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

padding(value1, value2, value3, value4)

Setter for the legend padding setting in pixels using a several values.

Params:

Name	Type	Default	Description
value1	string \| number	7	Top or top-bottom space.
value2	string \| number	7	Right or right-left space.
value3	string \| number	7	Bottom space.
value4	string \| number	7	Left space.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

paginator

paginator()

Getter for paginator settings.

Returns:

anychart.core.ui.Paginator - Paginator settings.

var paginator = legend.paginator();

paginator(settings)

Setter for paginator settings.

Sets title separator settings depending on parameter type:

null/boolean - disable or enable legend separator.
object - sets separator settings.

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null	true	Paginator settings to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Using object

parentBounds

parentBounds()

Getter for parent bounds.
As a getter falls back to stage bounds.

Returns:

anychart.math.Rect - Parent bounds.

parentBounds(bounds)

Setter for bounds using single value.

Params:

Name	Type	Description
bounds	anychart.math.Rect \| Object \| null	Parent bounds to set

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

parentBounds(left, top, width, height)

Setter for bounds using several values.

Params:

Name	Type	Description
left	number	Left space.
top	number	Top space.
width	number	A width for a legend.
height	number	A height for a legend.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

position

position()

Getter for legend position settings.

Returns:

anychart.enums.Orientation | string - Legend position.

Try it:

Usage sample

position(position)

Setter for legend position setting.

Params:

Name	Type	Default	Description
position	anychart.enums.Orientation \| string	'bottom'	Legend position to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

positionMode

positionMode()Since version 7.13.0

Getter for the position mode.

Returns:

anychart.enums.LegendPositionMode | string - Legend position mode.

var positionMode = legend.positionMode();

positionMode(mode)Since version 7.13.0

Setter for the position mode.

Params:

Name	Type	Description
mode	anychart.enums.LegendPositionMode \| string	Legend position mode.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

selectable

selectable()

Getter for the text selectable option.

Returns:

boolean - The text selectable option.

Try it:

Usage sample

selectable(enabled)

Setter for the text selectable.

This options defines whether the text can be selected. If set to false one can't select the text.

Params:

Name	Type	Default	Description
enabled	boolean	false	Enabled state to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

textDirection

textDirection()

Getter for the text direction.

Returns:

anychart.graphics.vector.Text.Direction | string - Text direction.

Try it:

Usage sample

textDirection(direction)

Setter for the text direction.

Params:

Name	Type	Default	Description
direction	anychart.graphics.vector.Text.Direction \| string	'ltr'	Text direction to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

textIndent

textIndent()

Getter for the text indent.

Returns:

number - Text indent.

Try it:

Usage sample

textIndent(indent)

Setter for the text indent.

Params:

Name	Type	Default	Description
indent	number	0	Text indent to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

textOverflow

textOverflow()

Getter for the text overflow settings.

Returns:

anychart.graphics.vector.Text.TextOverflow | string - Text overflow settings.

var title = chart.title();
var textOverflow = title.textOverflow();

textOverflow(value)

Setter for the text overflow settings.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.TextOverflow \| string	""	Text overflow settings to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

textSettings

textSettings()

Getter for the full text appearance settings.

Returns:

Object - A copy of settings object.

Try it:

Usage sample

textSettings(name)

Getter for all text appearance settings.

Note: Returns undefined if the name of the setting is wrong.

Params:

Name	Type	Description
name	string	Setting name.

Returns:

string | number | boolean | undefined - Value of settings.

Try it:

Usage sample

textSettings(objectWithSettings)

Setter for text appearance settings.

Overrides current text settings by passed settings object.

Params:

Name	Type	Description
objectWithSettings	Object	Settings object. Complete object looks like this: { 'fontSize': smth, 'fontFamily': smth, 'fontColor': smth, 'fontOpacity': smth, 'fontDecoration': smth, 'fontStyle': smth, 'fontVariant': smth, 'fontWeight': smth, 'letterSpacing': smth, 'textDirection': smth, 'lineHeight': smth, 'textIndent': smth, 'vAlign': smth, 'hAlign': smth, 'wordWrap': smth, 'wordBreak': smth, 'textOverflow': smth, 'selectable': smth, 'useHtml': smth 'textShadow':smth }

Name

Type

Description

objectWithSettings

Object

Settings object. Complete object looks like this:

   {
     'fontSize': smth,
     'fontFamily': smth,
     'fontColor': smth,
     'fontOpacity': smth,
     'fontDecoration': smth,
     'fontStyle': smth,
     'fontVariant': smth,
     'fontWeight': smth,
     'letterSpacing': smth,
     'textDirection': smth,
     'lineHeight': smth,
     'textIndent': smth,
     'vAlign': smth,
     'hAlign': smth,
     'wordWrap': smth,
     'wordBreak': smth,
     'textOverflow': smth,
     'selectable': smth,
     'useHtml': smth
     'textShadow':smth
   }

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

textSettings(name, settings)

Setter for the text appearance settings.

Overrides text setting Value by its Name.

Params:

Name	Type	Description
name	string	Setting name.
settings	string \| number \| boolean \| function	Text settings.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

title

title()

Getter for the legend title.

Returns:

anychart.core.ui.Title - Title settings.

var title = legend.title();

title(settings)

Setter for the legend title.

Sets legend title settings depending on parameter type:

null/boolean - disable or enable legend title.
string - sets legend title text value.
object - sets legend title settings.

Params:

Name	Type	Default	Description
settings	null \| boolean \| Object \| string	false	Title settings to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

titleFormat

titleFormat()Since version 7.7.0

Getter for the legend title format function.

Returns:

string | function - Token or function to format title.

Try it:

Usage sample

titleFormat(format)Since version 7.7.0

Setter for the legend title format function. If set, formats title. Currently supported in Stock only. Learn more about using titleFormat() method.

Params:

Name	Type	Description
format	string \| function	Token or function to format title.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

titleSeparator

titleSeparator()

Getter for title separator settings.

Returns:

anychart.core.ui.Separator - Title separator settings.

var titleSeparator = legend.titleSeparator();

titleSeparator(settings)

Setter for title separator settings.

Sets title separator settings depending on parameter type:

null/boolean - disable or enable title separator.
object - sets separator settings.

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null	false	Title separator settings to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

tooltip()

tooltip(settings)

Setter for legend tooltip.

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null	true	Tooltip settings to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

useHtml

useHtml()

Getter for the useHTML flag.

Returns:

boolean - Value of useHTML flag.

Try it:

Usage sample

useHtml(enabled)

Setter for flag useHTML.

This property defines whether HTML text should be parsed.

Params:

Name	Type	Default	Description
enabled	boolean	false	Enabled state to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

vAlign

vAlign()

Getter for the text vertical align.

Returns:

anychart.graphics.vector.Text.VAlign | string - Text vertical align.

Try it:

Usage sample

vAlign(align)

Setter for the text vertical align.

Params:

Name	Type	Default	Description
align	anychart.graphics.vector.Text.VAlign \| string	'top'	Value to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

width

width()

Getter for the legend width.

Returns:

number | string | null - Legend width.

Try it:

Usage sample

width(width)

Setter for the legend width.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Legend width to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

wordBreak

wordBreak()Since version 8.0.0

Getter for the word-break mode.

Returns:

anychart.enums.WordBreak | string - Word-break mode.

Try it:

Usage sample

wordBreak(mode)Since version 8.0.0

Setter for the word-break mode.

Params:

Name	Type	Default	Description
mode	anychart.enums.WordBreak \| string	"normal"	Word-break mode to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

wordWrap

wordWrap()Since version 8.0.0

Getter for the word-wrap mode.

Returns:

anychart.enums.WordWrap | string - Word-wrap mode.

Try it:

Usage sample

wordWrap(mode)Since version 8.0.0

Setter for the word-wrap mode.

Params:

Name	Type	Default	Description
mode	anychart.enums.WordWrap \| string	'normal'	Word-wrap mode to set.

Returns:

anychart.standalones.Legend - Self instance for method chaining.

Try it:

Usage sample

zIndex

zIndex()

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Usage sample

zIndex(zIndex)

Setter for the Z-index of the element.