AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.ui.LegendItem Improve this Doc

Extends: anychart.core.Text

Inner class for representing legend item.

Methods Overview

Specific settings
getTextElement()Legend item text element.
iconType()Getter/setter for icon type.
text()Getter/setter for legend item text.
x()Getter/setter for X coordinate of legend item.
y()Getter/setter for Y coordinate of legend item.
Advanced Text Settings
fontVariant()Font variant settings.
letterSpacing()Text letter spacing settings.
textDirection()Text direction settings.
textIndent()Text indent settings.
textOverflow()Text overflow settings.
useHtml()Text useHtml settings.
wordBreak()Word break mode.
wordWrap()Word-wrap mode.
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
iconFill()Getter/setter for icon fill setting.
iconHatchFill()Hatch fill settings.
iconStroke()Getter/setter for icon stroke setting.
Events
disablePointerEvents()Pointer events settings.
Interactivity
enabled()Element state (enabled or disabled).
selectable()Text selectable option.
Size and Position
getContentBounds()Return legend item content bounds.
getHeight()Calculating actual height of legend item independently of enabled state.
getWidth()Calculating actual width of legend item independently of enabled state.
iconTextSpacing()Getter/setter for iconTextSpacing setting.
maxHeight()Legend item maximum width.
maxWidth()Legend item maximum width.
zIndex()Z-index of the element.
Text Settings
textSettings()Text settings.
Miscellaneous
draw()Draws legend item.

Methods Description

disablePointerEvents

Getter for the pointer events.

Returns:

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

Params:

NameTypeDefaultDescription
enabledboolean
false
Enabled state to set.

Returns:

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

draw

Draws legend item.

Returns:

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

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

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

fontColor

Getter for the text font color.

Returns:

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

Params:

NameTypeDefaultDescription
colorstring
'#7c868e'
Value to set.

Returns:

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

fontDecoration

Getter for the text font decoration.

Returns:

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

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.Decoration | string
'none'
Font decoration to set.

Returns:

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

fontFamily

Getter for the font family.

Returns:

string - Font family.
Setter for the font family.

Params:

NameTypeDefaultDescription
familystring
'Verdana', Helvetica, Arial, sans-serif
Font family to set.

Returns:

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

fontOpacity

Getter for the text font opacity.

Returns:

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

Params:

NameTypeDefaultDescription
opacitynumber
1
Value to set.

Returns:

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

fontSize

Getter for the text font size.

Returns:

string | number - Font size.
Setter for the text font size.

Params:

NameTypeDefaultDescription
sizestring | number
16
Font size to set.

Returns:

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

fontStyle

Getter for the text font style.

Returns:

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

Params:

NameTypeDefaultDescription
styleanychart.graphics.vector.Text.FontStyle | string
'normal'
Font style to set.

Returns:

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

fontVariant

Getter for the text font variant.

Returns:

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

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.FontVariant | string
'normal'
Font variant to set.

Returns:

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

fontWeight

Getter for the text font weight.

Returns:

string | number - Font weight.

Params:

NameTypeDefaultDescription
weightstring | number
'normal'
Font weight to set.

Returns:

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

getContentBounds

Return legend item content bounds.

Returns:

anychart.math.Rect - Content bounds.

getHeight

Calculating actual height of legend item independently of enabled state.

Returns:

number - Height.

getTextElement

Legend item text element.

Returns:

anychart.graphics.vector.Text - Text element.

getWidth

Calculating actual width of legend item independently of enabled state.

Returns:

number - Width.

hAlign

Getter for the text horizontal align.

Returns:

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

Params:

NameTypeDefaultDescription
alignanychart.graphics.vector.Text.HAlign | string
'start'
Value to set.

Returns:

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

iconFill

Getter/setter for icon fill setting.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillIcon fill setting.

Returns:

anychart.graphics.vector.Fill | anychart.core.ui.LegendItem - Icon fill setting or self for method chaining.

iconHatchFill

Getter for icon hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The icon hatch fill setings.
Setter for icon hatch fill settings.

Params:

NameTypeDescription
patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | stringPatternFill or HatchFill instance or type of hatch fill.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

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

iconStroke

Getter/setter for icon stroke setting.

Params:

NameTypeDescription
valueanychart.graphics.vector.StrokeIcon stroke setting.

Returns:

anychart.graphics.vector.Stroke | anychart.core.ui.LegendItem - Icon stroke setting or self for method chaining.

iconTextSpacing

Getter/setter for iconTextSpacing setting.

Params:

NameTypeDescription
valuenumberValue of spacing between icon and text.

Returns:

anychart.core.ui.LegendItem | number - Spacing between icon and text or self for method chaining.

iconType

Getter/setter for icon type.

Params:

NameTypeDescription
valuestring | functionIcon type or custom drawer function.

Returns:

string | function | anychart.core.ui.LegendItem - icon type or drawer function or self for method chaining.

letterSpacing

Getter for the text letter spacing.

Returns:

string | number - Letter spacing.

Params:

NameTypeDefaultDescription
spacingstring | number
'normal'
Value to set.

Returns:

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

lineHeight

Getter for the text line height.

Returns:

string | number - Text line height.

Params:

NameTypeDefaultDescription
heightstring | number
'normal'
Value to set.

Returns:

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

maxHeight

Getter for the maximal height of a legend item.

Returns:

number | string - Maximum height.
Setter for the maximal height of a legend item.

Params:

NameTypeDescription
valuenumber | stringMaximum height setting.

Returns:

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

maxWidth

Getter for the maximal width of a legend item.

Returns:

number | string - Maximum width.
Setter for the maximal width of a legend item.

Params:

NameTypeDescription
valuenumber | stringMaximum width setting.

Returns:

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

selectable

Getter for the text selectable option.

Returns:

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

Params:

NameTypeDefaultDescription
enabledboolean
false
Enabled state to set.

Returns:

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

text

Getter/setter for legend item text.

Params:

NameTypeDescription
valuestringLegend item text.

Returns:

string | anychart.core.ui.LegendItem - Legend item text or self for method chaining.

textDirection

Getter for the text direction.

Returns:

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

Params:

NameTypeDefaultDescription
directionanychart.graphics.vector.Text.Direction | string
'ltr'
Text direction to set.

Returns:

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

textIndent

Getter for the text indent.

Returns:

number - Text indent.
Setter for the text indent.

Params:

NameTypeDefaultDescription
indentnumber
0
Text indent to set.

Returns:

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

textOverflow

Getter for the text overflow settings.

Returns:

anychart.graphics.vector.Text.TextOverflow | string - Text overflow settings.
See listing
var title = chart.title();
var textOverflow = title.textOverflow();
Setter for the text overflow settings.

Params:

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

Returns:

anychart.core.ui.LegendItem - 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 settings.
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,
     'wordWrap': smth,
     'wordBreak': smth,
     'textOverflow': smth,
     'selectable': smth,
     'useHtml': smth
     'textShadow':smth
   }

Returns:

anychart.core.ui.LegendItem - Self instance for method chaining.
Setter for the text appearance settings.

Params:

NameTypeDescription
namestringSetting name.
settingsstring | number | boolean | functionText settings.

Returns:

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

useHtml

Getter for the useHTML flag.

Returns:

boolean - Value of useHTML flag.
Setter for flag useHTML.

Params:

NameTypeDefaultDescription
enabledboolean
false
Enabled state to set.

Returns:

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

vAlign

Getter for the text vertical align.

Returns:

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

Params:

NameTypeDefaultDescription
alignanychart.graphics.vector.Text.VAlign | string
'top'
Value to set.

Returns:

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

wordBreak

Getter for the word-break mode.

Returns:

anychart.enums.WordBreak | string - Word-break mode.
Setter for the word-break mode.

Params:

NameTypeDefaultDescription
modeanychart.enums.WordBreak | string
"normal"
Word-break mode to set.

Returns:

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

wordWrap

Getter for the word-wrap mode.

Returns:

anychart.enums.WordWrap | string - Word-wrap mode.
Setter for the word-wrap mode.

Params:

NameTypeDefaultDescription
modeanychart.enums.WordWrap | string
'normal'
Word-wrap mode to set.

Returns:

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

x

Getter/setter for X coordinate of legend item.

Params:

NameTypeDescription
valuenumber | stringNew x coordinate.

Returns:

number | string | anychart.core.ui.LegendItem - X coordinate or self for method chaining.

y

Getter/setter for Y coordinate of legend item.

Params:

NameTypeDescription
valuenumber | stringNew y coordinate.

Returns:

number | string | anychart.core.ui.LegendItem - Y coordinate or self for method chaining.

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

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