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

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.
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
iconFill()Getter/setter for icon fill setting.
iconHatchFill()Hatch fill settings.
iconStroke()Getter/setter for icon stroke setting.
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).
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 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.LegendItem - Self instance for method chaining.

draw

Draws legend item.

Returns:

anychart.core.ui.LegendItem - 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.LegendItem - 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.LegendItem - 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.LegendItem - 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.LegendItem - 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.LegendItem - 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.LegendItem - 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.LegendItem - 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.LegendItem - 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.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 - 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.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.
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 - The current letter spacing.

Params:

NameTypeDefaultDescription
valuestring | 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 - The current text line height.

Params:

NameTypeDefaultDescription
valuestring | number
"normal"
Value to set.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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 }.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

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.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
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.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 - Current text direction.
Setter for the text direction.

Params:

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

Returns:

anychart.core.ui.LegendItem - 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.LegendItem - 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.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 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.LegendItem - Self instance for method chaining.
Setter for the text appearance settings.

Params:

NameTypeDescription
namestringSetting name.
valuestring | number | boolean | functionSettings value.

Returns:

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

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object 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.LegendItem - 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.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 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.LegendItem - Self instance for method chaining.