Top

class anychart.core.ui.LegendItem Improve this Doc

Extends: anychart.core.Text

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.
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()Getter/setter for icon fill setting.
iconHatchFill()Hatch fill settings.
iconStroke()Getter/setter for icon stroke setting.
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
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

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:

draw

Draws legend item.

Returns:

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

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:

getContentBounds

Return legend item content bounds.

Returns:

anychart.math.Rect - Content bounds.

getHeight

Calculating actual height of legend item independently of enabled state.

Returns:

number - Height.

getTextElement

Legend item text element.

Returns:

anychart.graphics.vector.Text - Text element.

getWidth

Calculating actual width of legend item independently of enabled state.

Returns:

number - Width.

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:

iconFill

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

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

iconStroke

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

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

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

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

listenOnce

Adds an event listener to an implementing object.

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:

maxHeight

Getter for the maximal height of a legend item.

Returns:

number string - Maximum height.
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

Getter for the maximal width of a legend item.

Returns:

number string - Maximum width.
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.

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

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

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:

x

Getter/setter for X coordinate of legend item.

Params:

Name Type Description
value number | string New x coordinate.

Returns:

number string anychart.core.ui.LegendItem - X coordinate or self for method chaining.

y

Getter/setter for Y coordinate of legend item.

Params:

Name Type Description
value number | string New y coordinate.

Returns:

number string anychart.core.ui.LegendItem - Y coordinate or self for method chaining.

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: