class anychart.core.utils.LegendItemSettings Improve this Doc

Helper class for maintaining legend item settings for series legend icon

Methods Overview

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

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.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(value)

Setter for disabled settings.

Params:

Name	Type	Description
value	boolean	Is this item disabled.

Returns:

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

Try it:

Usage sample

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.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 - 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.utils.LegendItemSettings - 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.utils.LegendItemSettings - 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.utils.LegendItemSettings - 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.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 - 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.utils.LegendItemSettings - 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.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 textFormatter.

format(value)

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

Detailed description

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

Params:

Name	Type	Description
value	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 - 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.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(value)

Setter for settings showing icons.

Params:

Name	Type	Description
value	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 - Current fill settings.

iconFill(value)

Sets fill settings using an object or a string. Learn more about coloring.

Params:

Name	Type	Description
value	anychart.graphics.vector.Fill	Color as 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 - 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.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 - Current fill settings.

iconMarkerFill(fillOrColorOrKeys, opacityOrAngleOrCx, modeOrCy, opacityOrMode, opacity, fx, fy)

Setter for icon marker fill settings. Learn more about coloring.

Detailed description

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

Params:

Name	Type	Description
fillOrColorOrKeys	anychart.graphics.vector.Fill \| !Array.<(anychart.graphics.vector.GradientKey\|string)> \| null	Fill, color or gradient keys.
opacityOrAngleOrCx	number	Color opacity or X ratio of center radial gradient.
modeOrCy	number \| boolean \| anychart.graphics.math.Rect \| Object	Gradient mode or Y ratio of center radial gradient.
opacityOrMode	number \| anychart.graphics.math.Rect \| Object \| null	If defined then userSpaceOnUse mode, else objectBoundingBox. Opacity.
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.

Try it:

Usage sample

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 - Current 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	anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	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 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 - Current marker type.

Try it:

Usage sample

iconMarkerType(value)

Setter for marker type.

Detailed description

Usable with line, spline, step line icon types.

Params:

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

Returns:

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

Try it:

Usage sample

iconSize

iconSize()

Getter for icon size of legend item.

Returns:

number - Icon size setting.

Try it:

Usage sample

iconSize(value)

Setter for icon size of legend item.

Params:

Name	Type	Description
value	number \| string	Icon size setting.

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 - Current settings item icon.

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

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

Params:

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

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 - Current spacing between icon and text.

Try it:

Usage sample

iconTextSpacing(value)

Setter for a spacing between icon and text.

Params:

Name	Type	Description
value	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 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(value)

Setter for icon type.

Params:

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

Returns:

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

Try it:

Usage sample

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

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

Try it:

Usage sample

text

text()

Getter for legend item text.

Detailed description

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

Returns:

string - Current legend item text.

Try it:

Usage sample

text(value)

Setter for legend item text.

Detailed description

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

Params:

Name	Type	Description
value	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 - 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.utils.LegendItemSettings - 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.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 - 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.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 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.utils.LegendItemSettings - 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.utils.LegendItemSettings - 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.utils.LegendItemSettings - 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.