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

class anychart.core.utils.LegendItemSettings Improve this Doc

Extends: anychart.core.Text

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

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

disabled

Getter for disabled settings.

Returns:

boolean - Disabled setting.
Setter for disabled settings.

Params:

NameTypeDescription
valuebooleanIs this item disabled.

Returns:

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

format

Getter for legend item format settings.

Returns:

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

Params:

NameTypeDescription
valuestring | functionFunction or string token to format legend item text.

Returns:

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

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

iconEnabled

Getter for settings showing icons.

Returns:

boolean - IconEnabled settings.
Setter for settings showing icons.

Params:

NameTypeDescription
valuebooleanWhether to show item icon or not.

Returns:

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

iconFill

Getter for legend item icon fill settings.

Returns:

anychart.graphics.vector.Fill | function - Current fill settings.
Sets fill settings using an object or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an object or a string.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.
Fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.utils.LegendItemSettings - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberGradient opacity.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

iconMarkerFill

Getter for icon marker fill settings.

Returns:

anychart.graphics.vector.Fill | string - Current fill settings.
Setter for icon marker fill settings. Learn more about coloring.

Params:

NameTypeDescription
fillOrColorOrKeysanychart.graphics.vector.Fill | !Array.<(anychart.graphics.vector.GradientKey|string)> | nullFill, color or gradient keys.
opacityOrAngleOrCxnumberColor opacity or X ratio of center radial gradient.
modeOrCynumber | boolean | anychart.graphics.math.Rect | ObjectGradient mode or Y ratio of center radial gradient.
opacityOrModenumber | anychart.graphics.math.Rect | Object | nullIf defined then userSpaceOnUse mode, else objectBoundingBox. Opacity.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

iconMarkerStroke

Getter for icon marker stroke settings.

Returns:

anychart.graphics.vector.Stroke | string - Current icon marker stroke settings.
Setter for icon marker stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Style of line cap.

Returns:

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

iconMarkerType

Getter for marker type.

Returns:

anychart.enums.MarkerType | string | function - Current marker type.
Setter for marker type.

Params:

NameTypeDescription
valueanychart.enums.MarkerType | string | functionMarker type.

Returns:

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

iconSize

Getter for icon size of legend item.

Returns:

number - Icon size setting.
Setter for icon size of legend item.

Params:

NameTypeDescription
valuenumber | stringIcon size setting.

Returns:

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

iconStroke

Getter for legend item icon stroke settings.

Returns:

function | anychart.graphics.vector.Stroke - Current settings item icon.
Setter for legend item icon stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
null
Stroke settings.
thicknessnumber
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

iconTextSpacing

Getter for a spacing between icon and text.

Returns:

number - Current spacing between icon and text.
Setter for a spacing between icon and text.

Params:

NameTypeDescription
valuenumberValue of spacing between icon and text.

Returns:

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

iconType

Getter for icon type.

Returns:

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

Params:

NameTypeDescription
valueanychart.enums.LegendItemIconType | string | functionIcon type or custom drawer function.

Returns:

anychart.core.utils.LegendItemSettings - Self instance 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.utils.LegendItemSettings - 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.utils.LegendItemSettings - 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.

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

text

Getter for legend item text.

Returns:

string - Current legend item text.

Params:

NameTypeDescription
valuestring | functionLegend item text.

Returns:

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

Params:

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

Returns:

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