class anychart.core.ui.Legend Improve this Doc

Legend element.

Methods Overview

Specific settings
iconSize()	Icon size.
inverted()	Inverted settings.
items()	Custom items.
itemsFormat()	Items text formatter.
itemsFormatter()	Items formatter.
itemsSourceMode()	Items source mode.
paginator()	Paginator settings.
title()	Title settings.
titleFormat()	Title format function.
titleSeparator()	Title separator settings.
Advanced Text Settings
fontVariant()	Font variant settings.
letterSpacing()	Text letter spacing settings.
textDirection()	Text direction settings.
textIndent()	Text indent settings.
textOverflow()	Text overflow settings.
textWrap()	Text wrap settings.
useHtml()	Text useHtml settings.
Base Text Settings
fontColor()	Font color settings.
fontDecoration()	Font decoration settings.
fontFamily()	Font family settings.
fontOpacity()	Font opacity settings.
fontSize()	Font size settings.
fontStyle()	Font style settings.
fontWeight()	Font weight settings.
hAlign()	Text horizontal align settings.
lineHeight()	Text line height settings.
vAlign()	Text vertical align settings.
Coloring
background()	Background settings.
Events
disablePointerEvents()	Pointer events settings.
listen()	Adds an event listener.
listenOnce()	Adds a single time event listener.
removeAllListeners()	Removes all listeners.
unlisten()	Removes the listener.
unlistenByKey()	Removes the listener by the key.
Export
print()	Prints all elements.
Interactivity
drag()	Enable/disable drag for a legend.
enabled()	Element state (enabled or disabled).
hoverCursor()	Cursor settings in hover mode.
selectable()	Text selectable option.
tooltip()	Tooltip settings
Size and Position
align()	Align settings.
getPixelBounds()	Returns pixel bounds of the legend.
getRemainingBounds()	Getter for remain bounds after legend.
height()	Height settings.
iconTextSpacing()	Spacing between icon and text.
itemsLayout()	Items layout settings.
itemsSpacing()	Items spacing settings.
margin()	Margin settings.
maxHeight()	Maximum height.
maxWidth()	Maximum width.
padding()	Padding settings.
position()	Position settings.
positionMode()	Position mode settings.
width()	Width settings.
zIndex()	Z-index of the element.
Text Settings
textSettings()	Text settings.

Methods Description

align

align()

Getter for legend align settings.

Returns:

anychart.enums.Align | string - Legend align.

Try it:

Usage sample

align(value)

Setter for legend align settings.

Params:

Name	Type	Default	Description
value	anychart.enums.Align \| string	"center"	Value to set.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

background

background()

Getter for legend background.

Returns:

anychart.core.ui.Background - Current background settings.

background(value)

Setter for legend background.

Detailed description

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
value	string \| Object \| null \| boolean	true	Background setting.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

disablePointerEvents

disablePointerEvents()

Getter for the current pointer events.

Returns:

boolean - Flag of the current state.

Try it:

Usage sample

disablePointerEvents(value)

Setter for the pointer events.

Params:

Name	Type	Default	Description
value	boolean	false	Value to set.

Returns:

anychart.core.ui.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.

See listing.

var drag = legend.drag();

drag(value)Since version 7.13.0

Allows to use drag for legend.

Params:

Name	Type	Description
value	boolean	Allows dragging of the legend.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.

Try it:

Usage sample

Name	Type	Default	Description
value	boolean	true	Value to set.

fontColor

fontColor()

Getter for the text font color.

Returns:

string - The current font color.

Try it:

Usage sample

fontColor(value)

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

Params:

Name	Type	Default	Description
value	string	"#7c868e"	Value to set.

Returns:

anychart.core.ui.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 - The current 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"	Value to set.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

fontFamily

fontFamily()

Getter for the current font family.

Returns:

string - The current font family.

Try it:

Usage sample

fontFamily(value)

Setter for font family.

Params:

Name	Type	Default	Description
value	string	"Verdana", Helvetica, Arial, sans-serif	Value to set.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

fontOpacity

fontOpacity()

Getter for the text font opacity.

Returns:

number - The current font opacity.

Try it:

Usage sample

fontOpacity(value)

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

Params:

Name	Type	Default	Description
value	number	1	Value to set.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

Name	Type	Default	Description
value	string \| number	16	Value to set.

fontStyle

fontStyle()

Getter for the text font style.

Returns:

anychart.graphics.vector.Text.FontStyle | string - The current font style.

Try it:

Usage sample

fontStyle(value)

Setter for the text font style.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.FontStyle \| string	"normal"	Value to set.

Returns:

anychart.core.ui.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 - The current 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"	Value to set.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

fontWeight

fontWeight()

Getter for the text font weight.

Returns:

string | number - The current font weight.

Try it:

Usage sample

fontWeight(value)

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

Params:

Name	Type	Default	Description
value	string \| number	"normal"	Value to set.

Returns:

anychart.core.ui.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.

Detailed description

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 - The current text horizontal align.

Try it:

Usage sample

hAlign(value)

Setter for the text horizontal align.

Params:

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

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

height

height()

Getter for legend height.

Returns:

number | string | null - Current height.

Try it:

Usage sample

height(value)

Setter for legend height.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.ui.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(value)

Setter for hover cursor settings.

Params:

Name	Type	Default	Description
value	anychart.enums.Cursor \| string	"pointer"	Hover cursor setting.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

iconSize

iconSize()

Getter for icon size.

Returns:

number - Icon size setting.

Try it:

Usage sample

iconSize(value)

Setter for icon size.

Params:

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

Returns:

anychart.core.ui.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(value)

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

Params:

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

Returns:

anychart.core.ui.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(value)

Setter for inverted settings.

Params:

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

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

items

items()

Getter for custom items.

Returns:

Array.<anychart.core.ui.Legend.LegendItemProvider> - Current custom item.

items(value)

Setter for custom items.

Params:

Name	Type	Default	Description
value	Array.<anychart.core.ui.Legend.LegendItemProvider>	null	Items.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

itemsFormat

itemsFormat()

Getter for items text formatter.

Returns:

function - Items text formatter function.

itemsFormat(value)

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

Params:

Name	Type	Description
value	function	Items text formatter function.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

itemsFormatter

itemsFormatter()

Getter for items formatter.

Returns:

function - Formatter function.

itemsFormatter(value)

Setter for items formatter.

Params:

Name	Type	Default	Description
value	function	function (a){return a}	Formatter function.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

itemsLayout

itemsLayout()

Getter for items layout.

Returns:

anychart.enums.LegendLayout | string - Current items layout.

Try it:

Usage sample

itemsLayout(value)

Setter for items layout.

Params:

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

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

itemsSourceMode

itemsSourceMode()

Getter for items source mode.

Returns:

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

Try it:

Usage sample

itemsSourceMode(value)

Setter for items source mode.

Detailed description

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

Params:

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

Returns:

anychart.core.ui.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(value)

Setter for items spacing settings.

Params:

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

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

letterSpacing

letterSpacing()

Getter for the text letter spacing.

Returns:

string | number - The current letter spacing.

Try it:

Usage sample

letterSpacing(value)

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

Params:

Name	Type	Default	Description
value	string \| number	"normal"	Value to set.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

lineHeight

lineHeight()

Getter for the text line height.

Returns:

string | number - The current text line height.

Try it:

Usage sample

lineHeight(value)

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

Params:

Name	Type	Default	Description
value	string \| number	"normal"	Value to set.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method. Function that looks like `function(event){ // event.actualTarget - actual event target // event.currentTarget - current event target // event.iterator - event iterator // event.originalEvent - original event // event.point - event point // event.pointIndex - event point index }`.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

margin

margin()

Getter for margin settings.

Detailed description

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(value)

Setter for legend margin in pixels using a single value.

Params:

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

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

margin(value1, value2, value3, value4)

Setter for 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.core.ui.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.

See listing.

var maxHeight = legend.maxHeight();

maxHeight(value)Since version 7.13.0

Setter for the maximum height.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.ui.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.

See listing.

var maxWidth = legend.maxWidth();

maxWidth(value)Since version 7.13.0

Setter for the maximum width.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

padding

padding()

Getter for legend padding settings.

Detailed description

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(value)

Setter for legend padding in pixels using a single value.

Params:

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

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

padding(value1, value2, value3, value4)

Setter for legend padding setting in pixels using a several value.

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.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

paginator

paginator()

Getter for paginator setting.

Returns:

anychart.core.ui.Paginator - Current settings.

paginator(value)

Setter for paginator setting.

Detailed description

Sets title separator settings depending on parameter type:

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

Params:

Name	Type	Default	Description
value	Object \| boolean \| null	true	Value to set.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Using object

position

position()

Getter for legend position setting.

Returns:

anychart.enums.Orientation | string - Legend position.

Try it:

Usage sample

position(value)

Setter for legend position setting.

Params:

Name	Type	Default	Description
value	anychart.enums.Orientation \| string	"bottom"	Legend position.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

positionMode

positionMode()Since version 7.13.0

Getter for the position mode.

Returns:

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

See listing.

var positionMode = legend.positionMode();

positionMode(value)Since version 7.13.0

Setter for position mode.

Params:

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

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

print

print(paperSizeOrOptions, landscape)

Prints all elements on related stage.

Params:

Name	Type	Default	Description
paperSizeOrOptions	anychart.graphics.vector.PaperSize \| Object		Paper size or object with options.
landscape	boolean	false	Flag of landscape.

Try it:

Usage sample

removeAllListeners

removeAllListeners(type)

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

Name	Type	Description
type	string	Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

Usage sample

selectable

selectable()

Getter for the text selectable option.

Returns:

boolean - The current text selectable option.

Try it:

Usage sample

selectable(value)

Setter for the text selectable.

Detailed description

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

Params:

Name	Type	Default	Description
value	boolean	false	Value to set.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

textDirection

textDirection()

Getter for the text direction.

Returns:

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

Try it:

Usage sample

textDirection(value)

Setter for the text direction.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.Direction \| string	"ltr"	Value to set.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

textIndent

textIndent()

Getter for the text indent.

Returns:

number - The current text indent.

Try it:

Usage sample

textIndent(value)

Setter for the text indent.

Params:

Name	Type	Default	Description
value	number	0	Value to set.

Returns:

anychart.core.ui.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 - The current text overflow settings.

Try it:

Usage sample

textOverflow(value)

Setter for the text overflow settings.

Params:

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

Returns:

anychart.core.ui.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.

Detailed description

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 the setting.

Try it:

Usage sample

textSettings(objectWithSettings)

Setter for text appearance settings.

Detailed description

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, "textWrap": smth, "textOverflow": smth, "selectable": smth, "useHtml": smth }`.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

textSettings(name, value)

Setter for the text appearance settings.

Detailed description

Overrides text setting Value by its Name.

Params:

Name	Type	Description
name	string	Setting name.
value	string \| number \| boolean \| function	Settings value.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

textWrap

textWrap()

Getter for the text wrap settings.

Returns:

anychart.graphics.vector.Text.TextWrap | string - The current text wrap settings.

Try it:

Usage sample

textWrap(value)

Setter for the text wrap settings.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.TextWrap \| string	"byLetter"	Value to set.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

title

title()

Getter for legend title.

Returns:

anychart.core.ui.Title - Title settings.

title(value)

Setter for legend title.

Detailed description

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
value	null \| boolean \| Object \| string	false	Value to set.

Returns:

anychart.core.ui.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(value)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
value	string \| function	Token or function to format title.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

Usage sample

titleSeparator

titleSeparator()

Getter for title separator setting.

Returns:

anychart.core.ui.Separator - Current settings.

titleSeparator(value)

Setter for title separator setting.

Detailed description

Sets title separator settings depending on parameter type:

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

Params:

Name	Type	Default	Description
value	Object \| boolean \| null	false	Value to set.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

tooltip()

tooltip(value)

Setter for legend tooltip.

Detailed description

Params:

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

Returns:

anychart.core.ui.Legend - Self instance for method chaining.

Try it:

unlisten

unlisten(type, listener, useCapture, listenerScope)

Removes a listener added using listen() or listenOnce() methods.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.