AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 7.9.0 version of this document. Switch to the 8.4.0 version to see the up to date information.

class anychart.core.ui.Legend Improve this Doc

Extends: anychart.core.Text

Legend element.

Methods Overview

Specific settings
iconSize()Icon size.
inverted()Inverted settings.
items()Custom items.
itemsFormatter()Items formatter.
itemsSourceMode()Items source mode.
itemsTextFormatter()Items text formatter.
paginator()Paginator settings.
textSettings()Text settings.
title()Title settings.
titleFormatter()Title formatter 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
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.
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.
padding()Padding settings.
position()Position settings.
width()Width settings.
zIndex()Z-index of the element.

Methods Description

align

Getter for legend align settings.

Returns:

anychart.enums.Align | string - Legend align.
Setter for legend align settings.

Params:

NameTypeDefaultDescription
valueanychart.enums.Align | string
"center"
Value to set.

Returns:

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

background

Getter for legend background.

Returns:

anychart.core.ui.Background - Current background settings.
Setter for legend background.

Params:

NameTypeDefaultDescription
valuestring | Object | null | boolean
true
Background setting.

Returns:

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

disablePointerEvents

Getter for the current pointer events.

Returns:

boolean - Flag of the current state.
Setter for the pointer events.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

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

enabled

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

Returns:

boolean - The current element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

anychart.core.ui.Legend - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

fontColor

Getter for the text font color.

Returns:

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

Params:

NameTypeDefaultDescription
valuestring
"#7c868e"
Value to set.

Returns:

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

fontDecoration

Getter for the text font decoration.

Returns:

anychart.graphics.vector.Text.Decoration | string - The current font decoration.
Setter for the text font decoration.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.Decoration | string
"none"
Value to set.

Returns:

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

fontFamily

Getter for the current font family.

Returns:

string - The current font family.
Setter for font family.

Params:

NameTypeDefaultDescription
valuestring
"Verdana", Helvetica, Arial, sans-serif
Value to set.

Returns:

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

fontOpacity

Getter for the text font opacity.

Returns:

number - The current font opacity.
Setter for the text font opacity. Double value from 0 to 1.

Params:

NameTypeDefaultDescription
valuenumber
1
Value to set.

Returns:

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

fontSize

Getter for the current text font size.

Returns:

string | number - Current font size.
Setter for text font size.

Params:

NameTypeDefaultDescription
valuestring | number
16
Value to set.

Returns:

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

fontStyle

Getter for the text font style.

Returns:

anychart.graphics.vector.Text.FontStyle | string - The current font style.
Setter for the text font style.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.FontStyle | string
"normal"
Value to set.

Returns:

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

fontVariant

Getter for the text font variant.

Returns:

anychart.graphics.vector.Text.FontVariant | string - The current font variant.
Setter for the text font variant.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.FontVariant | string
"normal"
Value to set.

Returns:

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

fontWeight

Getter for the text font weight.

Returns:

string | number - The current font weight.

Params:

NameTypeDefaultDescription
valuestring | number
"normal"
Value to set.

Returns:

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

getRemainingBounds

Getter for remain bounds after legend.

Returns:

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

hAlign

Getter for the text horizontal align.

Returns:

anychart.graphics.vector.Text.HAlign | string - The current text horizontal align.
Setter for the text horizontal align.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.HAlign | string
"start"
Value to set.

Returns:

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

height

Getter for legend height.

Returns:

number | string | null - Current height.
Setter for legend height.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

hoverCursor

Getter for hover cursor settings.

Returns:

anychart.enums.Cursor | string - Hover cursor settings.
Setter for hover cursor settings.

Params:

NameTypeDefaultDescription
valueanychart.enums.Cursor | string
"pointer"
Hover cursor setting.

Returns:

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

iconSize

Getter for icon size.

Returns:

number - Icon size setting.
Setter for icon size.

Params:

NameTypeDescription
valuenumber | stringIcon size setting.

Returns:

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

iconTextSpacing

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

Returns:

number - Spacing settings.
Setter for spacing between icon and text in a legend item.

Params:

NameTypeDefaultDescription
valuestring | number
5
Spacing settings.

Returns:

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

inverted

Getter for inverted settings.

Returns:

boolean - Current inverted settings.
Setter for inverted settings.

Params:

NameTypeDefaultDescription
valueboolean
false
Whether item list should be inverted or not.

Returns:

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

items

Getter for custom items.

Returns:

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

Params:

NameTypeDefaultDescription
valueArray.<anychart.core.ui.Legend.LegendItemProvider>
null
Items.

Returns:

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

itemsFormatter

Getter for items formatter.

Returns:

function - Formatter function.
Setter for items formatter.

Params:

NameTypeDefaultDescription
valuefunction
function (a){return a}
Formatter function.

Returns:

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

itemsLayout

Getter for items layout.

Returns:

anychart.enums.Layout | string - Current items layout.
Setter for items layout.

Params:

NameTypeDefaultDescription
valuestring | anychart.enums.Layout
"horizontal"
Layout type for legend items.

Returns:

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

itemsSourceMode

Getter for items source mode.

Returns:

string | anychart.enums.LegendItemsSourceMode - Items source mode.
Setter for items source mode.

Params:

NameTypeDefaultDescription
valuestring | anychart.enums.LegendItemsSourceMode
"default"
Items source mode.

Returns:

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

itemsSpacing

Getter for items spacing settings.

Returns:

string | number - Items spacing settings.
Setter for items spacing settings.

Params:

NameTypeDefaultDescription
valuestring | number
15
Value to set.

Returns:

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

itemsTextFormatter

Getter for items text formatter.

Returns:

function - Items text formatter function.
Setter for items text formatter.

Params:

NameTypeDescription
valuefunctionItems text formatter function.

Returns:

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

letterSpacing

Getter for the text letter spacing.

Returns:

string | number - The current letter spacing.

Params:

NameTypeDefaultDescription
valuestring | number
"normal"
Value to set.

Returns:

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

lineHeight

Getter for the text line height.

Returns:

string | number - The current text line height.

Params:

NameTypeDefaultDescription
valuestring | number
"normal"
Value to set.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopescopeObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopescopeObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

margin

Getter for the current margin setting.

Returns:

anychart.core.utils.Margin - Current legend margin.
Setter for legend margin in pixels using a single value.

Params:

NameTypeDefaultDescription
valueArray.<(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.
Setter for legend margin in pixels using a single simple values.

Params:

NameTypeDefaultDescription
value1string | number
4
Top or top-bottom space.
value2string | number
4
Right or right-left space.
value3string | number
4
Bottom space.
value4string | number
4
Left space.

Returns:

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

padding

Getter for legend padding setting.

Returns:

anychart.core.utils.Padding - Current legend padding.
Setter for legend padding in pixels using a single value.

Params:

NameTypeDefaultDescription
valueArray.<(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.
Setter for legend padding setting in pixels using a several value.

Params:

NameTypeDefaultDescription
value1string | number
7
Top or top-bottom space.
value2string | number
7
Right or right-left space.
value3string | number
7
Bottom space.
value4string | number
7
Left space.

Returns:

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

paginator

Getter for paginator setting.

Returns:

anychart.core.ui.Paginator - Current settings.
Setter for paginator setting.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
true
Value to set.

Returns:

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

position

Getter for legend position setting.

Returns:

anychart.enums.Orientation | string - Legend position.
Setter for legend position setting.

Params:

NameTypeDefaultDescription
valueanychart.enums.Orientation | string
"bottom"
Legend position.

Returns:

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

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeanychart.graphics.vector.PaperSize
Paper size.
landscapeboolean
false
Flag of landscape.

removeAllListeners

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

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

selectable

Getter for the text selectable option.

Returns:

boolean - The current text selectable option.
Setter for the text selectable.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

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

textDirection

Getter for the text direction.

Returns:

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

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.Direction | string
"ltr"
Value to set.

Returns:

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

textIndent

Getter for the text indent.

Returns:

number - The current text indent.
Setter for the text indent.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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

textOverflow

Getter for the text overflow settings.

Returns:

anychart.graphics.vector.Text.TextOverflow | string - The current text overflow settings.
Setter for the text overflow settings.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.TextOverflow | string
""
Value to set.

Returns:

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

textSettings

Getter for the full text appearance settings.

Returns:

Object - A copy of settings object.
Getter for all text appearance settings.

Params:

NameTypeDescription
namestringSetting name.

Returns:

string | number | boolean | undefined - Value of the setting.
Setter for text appearance settings.

Params:

NameTypeDescription
objectWithSettingsObjectSettings 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.
Setter for the text appearance settings.

Params:

NameTypeDescription
namestringSetting name.
valuestring | number | booleanSetting value.

Returns:

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

textWrap

Getter for the text wrap settings.

Returns:

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

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.TextWrap | string
"byLetter"
Value to set.

Returns:

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

title

Getter for legend title.

Returns:

anychart.core.ui.Title - Title settings.
Setter for legend title.

Params:

NameTypeDefaultDescription
valuenull | boolean | Object | string
false
Value to set.

Returns:

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

titleFormatter

Gets the current legend title formatter function.

Returns:

function - Legend title formatter function.
Sets the legend title formatter function. If set, formats title. Currently supported in Stock only.

Params:

NameTypeDefaultDescription
valuenull | function
null
Legend title formatter function.

Returns:

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

titleSeparator

Getter for title separator setting.

Returns:

anychart.core.ui.Separator - Current settings.
Setter for title separator setting.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Value to set.

Returns:

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

tooltip

Getter for legend tooltip.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Setter for legend tooltip.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
true
Tooltip settings.

Returns:

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

unlisten

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

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopescopeObject in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

useHtml

Getter for the useHTML flag.

Returns:

boolean - The current value of useHTML flag.
Setter for flag useHTML.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

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

vAlign

Getter for the text vertical align.

Returns:

anychart.graphics.vector.Text.VAlign | string - The current text vertical align.
Setter for the text vertical align.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.VAlign | string
"top"
Value to set.

Returns:

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

width

Getter for legend width.

Returns:

number | string | null - Current width.
Setter for legend width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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