class anychart.core.utils.LegendItemSettings Improve this Doc

Extends: anychart.core.Text

Legend items are child elements of a legend.
The LegendItemSettings class contains different settings for an icon in the legend item.
Such as text spacing, type, fill, stroke, hatch fill, size, icon marker settings, etc.

Methods Overview

Specific settings
format()	Item text.
text()	Item text.
Icon settings
iconEnabled()	Settings showing icons.
iconFill()	Icon fill settings
iconHatchFill()	Icon hatch fill settings
iconMarkerFill()	Icon marker fill settings.
iconMarkerStroke()	Icon marker stroke settings.
iconMarkerType()	Marker type.
iconSize()	Icon size.
iconStroke()	Icon stroke settings
iconTextSpacing()	Spacing between icon and text
iconType()	Icon type 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.
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.
Events
disablePointerEvents()	Pointer events settings.
Interactivity
disabled()	State settings.
enabled()	Element state (enabled or disabled).
selectable()	Text selectable option.
Size and Position
zIndex()	Z-index of the element.
Text Settings
textSettings()	Text settings.

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

Try it:

Usage sample

disabled

disabled()

Getter for disabled settings.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

boolean - Disabled setting.

Try it:

Usage sample

disabled(enabled)

Setter for disabled settings.

Params:

Name	Type	Description
enabled	boolean	Enabled state to set.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

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

Try it:

Usage sample

format

format()

Getter for legend item format settings.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

string - Legend item format.

format(format)

Setter for legend item format settings.
Learn more about using the format() method.

Detailed description

This method is a simlink for anychart.core.utils.LegendItemSettings#text.

Params:

Name	Type	Description
format	string \| function	Function or string token to format legend item text.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

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

Try it:

Usage sample

iconEnabled

iconEnabled()

Getter for settings showing icons.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

boolean - IconEnabled settings.

Try it:

Usage sample

iconEnabled(enabled)

Setter for settings showing icons.

Params:

Name	Type	Description
enabled	boolean	Whether to show item icon or not.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

iconFill

iconFill()

Getter for legend item icon fill settings.

Returns:

anychart.graphics.vector.Fill | function - Icon fill settings.

iconFill(color)

Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

Name	Type	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	Color as an array, an object or a string.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

iconFill(color, opacity)

Fill color with opacity.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

Name	Type	Description
color	string	Color as a string.
opacity	number	Color opacity.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

iconFill(keys, angle, mode, opacity)

Linear gradient fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Gradient keys.
angle	number	Gradient angle.
mode	boolean \| anychart.graphics.vector.Rect \| Object	Gradient mode.
opacity	number	Gradient opacity.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

iconFill(keys, cx, cy, mode, opacity, fx, fy)

Radial gradient fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Color-stop gradient keys.
cx	number	X ratio of center radial gradient.
cy	number	Y ratio of center radial gradient.
mode	anychart.graphics.math.Rect	If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity	number	Gradient opacity.
fx	number	X ratio of focal point.
fy	number	Y ratio of focal point.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

iconHatchFill

iconHatchFill()

Getter for icon hatch fill settings.

Returns:

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

iconHatchFill(type, color, thickness, size)

Setter for icon hatch fill settings.

Params:

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

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

iconHatchFill(iconHatchFillFunction)

Setter for hatch fill settings using function. Learn more about coloring.

Params:

Name	Type	Description
iconHatchFillFunction	function	HatchFill function.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

iconHatchFill(patternFill)

Setter for hatch fill settings using pattern fill. Learn more about coloring.

Params:

Name	Type	Description
patternFill	anychart.graphics.vector.PatternFill	Pattern fill to set.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

iconHatchFill(settings)

Setter for hatch fill settings using an instance. Learn more about coloring.

Params:

Name	Type	Description
settings	anychart.graphics.vector.HatchFill	Hatch fill instance.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

iconMarkerFill

iconMarkerFill()

Getter for icon marker fill settings.

Returns:

anychart.graphics.vector.Fill | string - Fill settings.

iconMarkerFill(color)

Setter for icon marker fill settings using a string. Learn more about coloring.

Detailed description

Also you can use a fill with opacity, radial and linear gradients.

Params:

Name	Type	Description
color	anychart.graphics.vector.Fill	Color as a string.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

iconMarkerFill(color, opacity)

Icon marker fill color with opacity.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

Name	Type	Description
color	string	Color as a string.
opacity	number	Color opacity.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

iconMarkerFill(keys, angle, mode, opacity)

Linear gradient fill for icon marker. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Gradient keys.
angle	number	Gradient angle.
mode	boolean \| anychart.graphics.vector.Rect \| Object	Gradient mode.
opacity	number	Gradient opacity.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

iconMarkerFill(keys, cx, cy, mode, opacity, fx, fy)

Radial gradient fill for icon marker. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Color-stop gradient keys.
cx	number	X ratio of center radial gradient.
cy	number	Y ratio of center radial gradient.
mode	anychart.graphics.math.Rect	If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity	number	Opacity of the gradient.
fx	number	X ratio of focal point.
fy	number	Y ratio of focal point.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

iconMarkerFill(imageSettings)

Image fill for icon marker. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

iconMarkerStroke

iconMarkerStroke()

Getter for icon marker stroke settings.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.Stroke | string - Icon marker stroke settings.

Try it:

Usage sample

iconMarkerStroke(color, thickness, dashpattern, lineJoin, lineCap)

Setter for icon marker stroke settings.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null		Stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	string \| anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	string \| anychart.graphics.vector.StrokeLineCap		Style of line cap.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

iconMarkerType

iconMarkerType()

Getter for the marker type.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.enums.MarkerType | string | function - Icon marker type.

Try it:

Usage sample

iconMarkerType(type)

Setter for the marker type.

Detailed description

Usable with line, spline, step line icon types.

Params:

Name	Type	Description
type	anychart.enums.MarkerType \| string \| function	Marker type to set.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

iconSize

iconSize()

Getter for the icon size of legend item.

Returns:

number - Icon size setting.

Try it:

Usage sample

iconSize(size)

Setter for the icon size of legend item.

Params:

Name	Type	Description
size	number \| string	Icon size to set.

Returns:

anychart.core.utils.LegendItemSettings - Self for method chaining.

Try it:

Usage sample

iconStroke

iconStroke()

Getter for legend item icon stroke settings.

Returns:

function | anychart.graphics.vector.Stroke - Icon stroke.

iconStroke(strokeFunction)

Setter for legend item icon stroke using a function. Learn more about stroke settings.

Params:

Name	Type	Description
strokeFunction	function():anychart.graphics.vector.Stroke\|anychart.graphics.vector.ColoredFill	Function that looks like: function(){ // this.sourceColor - color returned by fill() getter. return strokeValue; // type anychart.graphics.vector.Fill or anychart.graphics.vector.Stroke }

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

iconStroke(color, thickness, dashpattern, lineJoin, lineCap)

Setter for legend item icon stroke settings. Learn more about stroke settings.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null	null	Stroke settings.
thickness	number		Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	string \| anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	string \| anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

iconStroke(settings)

Setter for legend item icon stroke using an object.

Params:

Name	Type	Description
settings	Object	Stroke settings from anychart.graphics.vector.Stroke.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

iconTextSpacing

iconTextSpacing()

Getter for a spacing between icon and text.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

number - Spacing between icon and text.

Try it:

Usage sample

iconTextSpacing(spacing)

Setter for a spacing between icon and text.

Params:

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

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

iconType

iconType()

Getter for the icon type.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.enums.LegendItemIconType | string | function - Icon type or drawer function.

Try it:

Usage sample

iconType(type)

Setter for the icon type.

Params:

Name	Type	Default	Description
type	anychart.enums.LegendItemIconType \| string \| function(path:anychart.graphics.vector.Path, size:number)	'square'	Icon type or custom drawer function. Function for a custom icon should look like this: function(path, size){ // path - anychart.graphics.vector.Path // size - icon size ... //do something }

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

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

Try it:

Usage sample

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

Try it:

Usage sample

text

text()

Getter for the legend item text.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

string - Legend item text.

Try it:

Usage sample

text(text)

Setter for the legend item text.

Detailed description

The same as anychart.core.utils.LegendItemSettings#format.

Params:

Name	Type	Description
text	string \| function	Legend item text.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.

Try it:

Usage sample

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

Try it: