class anychart.core.ui.LegendItem Improve this Doc

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

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

Try it:

Usage sample

draw

draw()

Draws legend item.

Returns:

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

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

Try it:

Usage sample

getContentBounds

getContentBounds()

Return legend item content bounds.

Returns:

anychart.math.Rect - Content bounds.

getHeight

getHeight()

Calculating actual height of legend item independently of enabled state.

Returns:

number - Height.

getTextElement

getTextElement()

Legend item text element.

Returns:

anychart.graphics.vector.Text - Text element.

getWidth

getWidth()

Calculating actual width of legend item independently of enabled state.

Returns:

number - Width.

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

Try it:

Usage sample

iconFill

iconFill(value)

Getter/setter for icon fill setting.

Params:

Name	Type	Description
value	anychart.graphics.vector.Fill	Icon fill setting.

Returns:

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

iconHatchFill

iconHatchFill()

Getter for icon hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Current hatch fill.

iconHatchFill(patternFillOrType, color, thickness, size)

Setter for icon hatch fill settings.

Params:

Name	Type	Description
patternFillOrType	anychart.graphics.vector.PatternFill \| anychart.graphics.vector.HatchFill \| function \| anychart.graphics.vector.HatchFill.HatchFillType \| string	PatternFill or HatchFill instance or type of hatch fill.
color	string	Color.
thickness	number	Thickness.
size	number	Pattern size.

Returns:

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

iconStroke

iconStroke(value)

Getter/setter for icon stroke setting.

Params:

Name	Type	Description
value	anychart.graphics.vector.Stroke	Icon stroke setting.

Returns:

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

iconTextSpacing

iconTextSpacing(value)

Getter/setter for iconTextSpacing setting.

Params:

Name	Type	Description
value	number	Value of spacing between icon and text.

Returns:

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

iconType

iconType(value)

Getter/setter for icon type.

Params:

Name	Type	Description
value	string \| function	Icon type or custom drawer function.

Returns:

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

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.LegendItem - 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.LegendItem - 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

maxHeight

maxHeight()

Getter for the maximal height of a legend item.

Returns:

number | string - Maximum height.

maxHeight(value)

Setter for the maximal height of a legend item.

Params:

Name	Type	Description
value	number \| string	Maximum height setting.

Returns:

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

maxWidth

maxWidth()

Getter for the maximal width of a legend item.

Returns:

number | string - Maximum width.

maxWidth(value)

Setter for the maximal width of a legend item.

Params:

Name	Type	Description
value	number \| string	Maximum width setting.

Returns:

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

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

Try it:

Usage sample

text

text(value)

Getter/setter for legend item text.

Params:

Name	Type	Description
value	string	Legend item text.

Returns:

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

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

Try it:

Usage sample

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.