Top
You are looking at an outdated 7.13.1 version of this document. Switch to the 7.14.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.

Try it:

Setter for the pointer events.

Params:

Name Type Default Description
value boolean
false
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

disabled

Getter for disabled settings.

Returns:

boolean - Disabled setting.

Try it:

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:

enabled

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

Try it:

fontColor

Getter for the text font color.

Returns:

string - The current font color.

Try it:

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

Try it:

fontDecoration

Getter for the text font decoration.

Returns:

anychart.graphics.vector.Text.Decoration string - The current font decoration.

Try it:

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

Try it:

fontFamily

Getter for the current font family.

Returns:

string - The current font family.

Try it:

Setter for font family.

Params:

Name Type Default Description
value string
"Verdana", Helvetica, Arial, sans-serif
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

fontOpacity

Getter for the text font opacity.

Returns:

number - The current font opacity.

Try it:

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

Try it:

fontSize

Getter for the current text font size.

Returns:

string number - Current font size.

Try it:

Setter for text font size.

Params:

Name Type Default Description
value string | number
16
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

fontStyle

Getter for the text font style.

Returns:

anychart.graphics.vector.Text.FontStyle string - The current font style.

Try it:

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

Try it:

fontVariant

Getter for the text font variant.

Returns:

anychart.graphics.vector.Text.FontVariant string - The current font variant.

Try it:

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

Try it:

fontWeight

Getter for the text font weight.

Returns:

string number - The current font weight.

Try it:

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

Try it:

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:

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:

hAlign

Getter for the text horizontal align.

Returns:

anychart.graphics.vector.Text.HAlign string - The current text horizontal align.

Try it:

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

Try it:

iconEnabled

Getter for settings showing icons.

Returns:

boolean - IconEnabled settings.

Try it:

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:

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:

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.
Fill color with 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:

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:

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:

iconHatchFill

Getter for icon hatch fill settings.
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:

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:

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:

iconMarkerStroke

Getter for icon marker stroke settings.

Returns:

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

Try it:

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:

iconMarkerType

Getter for marker type.

Returns:

anychart.enums.MarkerType string function - Current marker type.

Try it:

Setter for marker type.

Params:

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

Returns:

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

Try it:

iconSize

Getter for icon size of legend item.

Returns:

number - Icon size setting.

Try it:

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:

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:

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:

iconTextSpacing

Getter for a spacing between icon and text.

Returns:

number - Current spacing between icon and text.

Try it:

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:

iconType

Getter for icon type.

Returns:

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

Try it:

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:

letterSpacing

Getter for the text letter spacing.

Returns:

string number - The current letter spacing.

Try it:

Params:

Name Type Default Description
value string | number
"normal"
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

lineHeight

Getter for the text line height.

Returns:

string number - The current text line height.

Try it:

Params:

Name Type Default Description
value string | number
"normal"
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type 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 Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

print

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:

removeAllListeners

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:

selectable

Getter for the text selectable option.

Returns:

boolean - The current text selectable option.

Try it:

Setter for the text selectable.

Params:

Name Type Default Description
value boolean
false
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

text

Getter for legend item text.

Returns:

string - Current legend item text.

Try it:

Params:

Name Type Description
value string | function Legend item text.

Returns:

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

Try it:

textDirection

Getter for the text direction.

Returns:

anychart.graphics.vector.Text.Direction string - Current text direction.

Try it:

Setter for the text direction.

Params:

Name Type Default Description
value anychart.graphics.vector.Text.Direction | string
"ltr"
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

textIndent

Getter for the text indent.

Returns:

number - The current text indent.

Try it:

Setter for the text indent.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

textOverflow

Getter for the text overflow settings.

Returns:

anychart.graphics.vector.Text.TextOverflow string - The current text overflow settings.

Try it:

Setter for the text overflow settings.

Params:

Name Type Default Description
value anychart.graphics.vector.Text.TextOverflow | string
""
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

textSettings

Getter for the full text appearance settings.

Returns:

Object - A copy of settings object.

Try it:

Getter for all text appearance settings.

Params:

Name Type Description
name string Setting name.

Returns:

string number boolean undefined - Value of the setting.

Try it:

Setter for text appearance settings.

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

Try it:

Setter for the text appearance settings.

Params:

Name Type Description
name string Setting name.
value string | number | boolean | function Settings value.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

textWrap

Getter for the text wrap settings.

Returns:

anychart.graphics.vector.Text.TextWrap string - The current text wrap settings.

Try it:

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

Try it:

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

Name Type Description
key Object The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

useHtml

Getter for the useHTML flag.

Returns:

boolean - The current value of useHTML flag.

Try it:

Setter for flag useHTML.

Params:

Name Type Default Description
value boolean
false
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

vAlign

Getter for the text vertical align.

Returns:

anychart.graphics.vector.Text.VAlign string - The current text vertical align.

Try it:

Setter for the text vertical align.

Params:

Name Type Default Description
value anychart.graphics.vector.Text.VAlign | string
"top"
Value to set.

Returns:

anychart.core.Text - Self instance for method chaining.

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it: