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

disablePointerEvents()

Getter for the pointer events.

Returns:

boolean - Flag of the state.

Try it:

Usage sample

disablePointerEvents(enabled)

Setter for the pointer events.

Params:

Name	Type	Default	Description
enabled	boolean	false	Enabled state 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 element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

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

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

fontColor

fontColor()

Getter for the text font color.

Returns:

string - Font color.

Try it:

Usage sample

fontColor(color)

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

Params:

Name	Type	Default	Description
color	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 - 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'	Font decoration to set.

Returns:

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

Try it:

Usage sample

fontFamily

fontFamily()

Getter for the font family.

Returns:

string - Font family.

Try it:

Usage sample

fontFamily(family)

Setter for the font family.

Params:

Name	Type	Default	Description
family	string	'Verdana', Helvetica, Arial, sans-serif	Font family 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 - Font opacity.

Try it:

Usage sample

fontOpacity(opacity)

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

Params:

Name	Type	Default	Description
opacity	number	1	Value to set.

Returns:

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

Try it:

Usage sample

Name	Type	Default	Description
size	string \| number	16	Font size to set.

fontStyle

fontStyle()

Getter for the text font style.

Returns:

anychart.graphics.vector.Text.FontStyle | string - Font style.

Try it:

Usage sample

fontStyle(style)

Setter for the text font style.

Params:

Name	Type	Default	Description
style	anychart.graphics.vector.Text.FontStyle \| string	'normal'	Font style 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 - 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'	Font variant 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 - Font weight.

Try it:

Usage sample

fontWeight(weight)

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

Params:

Name	Type	Default	Description
weight	string \| number	'normal'	Font weight 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 - Text horizontal align.

Try it:

Usage sample

hAlign(align)

Setter for the text horizontal align.

Params:

Name	Type	Default	Description
align	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 - The icon hatch fill setings.

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 - Letter spacing.

Try it:

Usage sample

letterSpacing(spacing)

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

Params:

Name	Type	Default	Description
spacing	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 - Text line height.

Try it:

Usage sample

lineHeight(height)

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

Params:

Name	Type	Default	Description
height	string \| number	'normal'	Value to set.

Returns:

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

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.

selectable

selectable()

Getter for the text selectable option.

Returns:

boolean - The text selectable option.

Try it:

Usage sample

selectable(enabled)

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
enabled	boolean	false	Enabled state 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 - Text direction.

Try it:

Usage sample

textDirection(direction)

Setter for the text direction.

Params:

Name	Type	Default	Description
direction	anychart.graphics.vector.Text.Direction \| string	'ltr'	Text direction 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 - Text indent.

Try it:

Usage sample

textIndent(indent)

Setter for the text indent.

Params:

Name	Type	Default	Description
indent	number	0	Text indent 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 - Text overflow settings.

See listing

var title = chart.title();
var textOverflow = title.textOverflow();

textOverflow(value)

Setter for the text overflow settings.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.TextOverflow \| string	""	Text overflow settings 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 settings.

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, 'wordWrap': smth, 'wordBreak': smth, 'textOverflow': smth, 'selectable': smth, 'useHtml': smth 'textShadow':smth }

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,
     'wordWrap': smth,
     'wordBreak': smth,
     'textOverflow': smth,
     'selectable': smth,
     'useHtml': smth
     'textShadow':smth
   }

Returns:

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

Try it: