class anychart.core.ui.LabelsFactory Improve this Doc

Extends: anychart.core.Text

Class for creation of sets of similar labels and management of such sets. Any individual label can be changed after all labels are displayed.

Methods Overview

Specific settings
clip()	Labels clip settings.
format()	Text formatter function.
getLabel()	Returns label by index.
getLabelsCount()	Gets labels count.
Advanced Text Settings
adjustFontSize()	Adjusting 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.
maxFontSize()	Maximum font size setting.
maxLength()	Maximum text length.
minFontSize()	Minimum font size setting.
textShadow()	Text shadow settings.
vAlign()	Text vertical align settings.
Coloring
background()	Background settings.
connectorStroke()	Stroke settings.
Events
disablePointerEvents()	Pointer events settings.
Interactivity
enabled()	Element state (enabled or disabled).
selectable()	Text selectable option.
Size and Position
anchor()	Anchor settings.
height()	Height settings.
offsetX()	Offset by X.
offsetY()	Offset by Y.
padding()	Padding settings.
position()	Position settings.
positionFormatter()	Position formatter function.
rotation()	Rotation settings.
width()	Width settings.
zIndex()	Z-index of the element.

Methods Description

adjustFontSize

adjustFontSize()

Getter for the adjust font size.

Returns:

Object - Adjust font size settings.

Try it:

Usage sample

adjustFontSize(adjustByWidth, adjustByHeight)

Setter for the adjusting font size by two parameters width and height.

Params:

Name	Type	Default	Description
adjustByWidth	boolean	false	Enables adjusting by width. Is font needs to be adjusted by width.
adjustByHeight	boolean	false	Enables adjusting by height. Is font needs to be adjusted by height.

Returns:

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

Try it:

Usage sample

adjustFontSize(settings)

Setter for the adjusting font size by one parameter.

Params:

Name	Type	Default	Description
settings	Object \| Array.<boolean> \| boolean	false	Enables adjusting by width and height. Adjusting flag, object or array.

Returns:

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

Try it:

Usage sample

anchor

anchor()

Getter for the labels anchor settings.

Returns:

anychart.enums.Anchor | string - Labels anchor setting.

Try it:

Usage sample

anchor(anchor)

Setter for the labels anchor settings.

Params:

Name	Type	Default	Description
anchor	anychart.enums.Anchor \| string	'center'	Labels anchor settings.

Returns:

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

Try it:

Usage sample

background

background()

Getter for the labels background settings.

Returns:

anychart.core.ui.Background - Labels background.

Try it:

Usage sample

background(settings)

Setter for the labels background settings.

Detailed description

Sets labels background settings depending on parameter type:

null/boolean - disable or enable labels background.
string - sets labels background color value.
object - sets labels background settings.

Params:

Name	Type	Default	Description
settings	string \| Object \| null \| boolean	false	Background settings to set.

Returns:

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

Try it:

clip

clip()

Getter for labels clip settings.

Returns:

anychart.graphics.vector.Shape | string | anychart.graphics.vector.Clip | anychart.math.Rect - Clip settings.

clip(clipSettings)

Setter for labels clip settings. Clips visible part of labels by a rectangle or shape.

Params:

Name	Type	Description
clipSettings	anychart.graphics.vector.Shape \| string \| anychart.graphics.vector.Clip \| anychart.math.Rect	Labels clip settings.

Returns:

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

connectorStroke

connectorStroke()Since version 7.11.0

Getter for connector stroke settings.

Returns:

anychart.graphics.vector.Stroke - Connector stroke settings.

See listing.

var mapLabels = series.labels();
var stroke = mapLabels.connectorStroke();

connectorStroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 7.11.0

Getter for connector stroke settings.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| 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 joint style.
lineCap	anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

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

Try it:

Usage sample

connectorStroke(settings)Since version 7.11.0

Setter for connector stroke using an object.

Params:

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

Returns:

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

Try it:

Usage sample

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

Try it:

Usage sample

enabled

enabled()

Getter for the element state.

Detailed description

True, false and null states. True and false are self-explanatory. Null state means that element is enabled, but if it depends on other entities (like, for example, labels() and hoverLabels() in series), then factory works in auto mode. For example, if series normal labels are enable, and hover labels are in null state, then upon hover hoverLabels become enabled because of normal. But if you disable normal labels - hoverLabels are disabled too.

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	null \| boolean	true	Enabled state to set.

Returns:

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

Try it:

Usage sample

fontColor

fontColor()

Getter for the text font color.

Returns:

string - Font color.

See listing

var fontColor = labels.fontColor();

fontColor(color)

Setter for the text font color.
https://www.w3schools.com/html/html_colors.asp

Params:

Name	Type	Description
color	string	Font color to set.

Returns:

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

Try it:

Usage sample

Name	Type	Default	Description
size	string \| number	12	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.ui.LabelsFactory - 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.ui.LabelsFactory - Self instance for method chaining.

Try it:

Usage sample

fontWeight

fontWeight()

Getter for the text font weight.

Returns:

string | number - Font weight.

See listing

var fontWeight = labels.fontWeight();

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

Try it:

Usage sample

format

format()

Getter for the labels text formatter.

Returns:

function | string - Text formatter.

format(token)

Setter for the labels text formatter.
Learn more about using the format() method.

Params:

Name	Type	Description
token	string	String token to format content label text.

Returns:

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

Try it:

Usage sample

format(function)

Setter for the labels text formatter using function.
Learn more about using the format() method.

Params:

Name	Type	Description
function	function	Function to format content label text.

Returns:

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

Try it:

Usage sample

getLabel

getLabel(index)Since version 7.13.1

Returns label by index.

Params:

Name	Type	Description
index	number	Label index.

Returns:

anychart.core.ui.LabelsFactory.Label - Already existing label.

Try it:

Usage sample

getLabelsCount

getLabelsCount()Since version 7.13.1

Gets labels count.

Returns:

number - Returns labels count.

Try it:

Usage sample

hAlign

hAlign()

Getter for the text horizontal align.

Returns:

anychart.graphics.vector.Text.HAlign | string - Text horizontal align.

See listing

var hAlign = labels.hAlign();

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

Try it:

Usage sample

height

height()

Getter for labels height settings.

Returns:

number | string | null - Labels height.

Try it:

Usage sample

height(height)

Setter for labels height settings.

Params:

Name	Type	Default	Description
height	number \| string	null	Height value to set.

Returns:

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

Try it:

Usage sample

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

Try it:

Usage sample

maxFontSize

maxFontSize()

Getter for maximum font size settings for adjust text to.

Returns:

number - Maximum font size setting.

Try it:

Usage sample

maxFontSize(size)

Setter for maximum font size settings for adjust text to.

Detailed description

Works only with anychart.core.ui.LabelsFactory#adjustFontSize in value true.

Params:

Name	Type	Default	Description
size	number \| string	72	Maximum font size to set.

Returns:

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

Try it:

Usage sample

maxLength

maxLength()

Getter for maximum text length.

Returns:

number | null - Maximum length of text.

See listing

var maxLengthValue = chart.labels().maxLength(); // null by default.

Try it:

Usage sample

maxLength(maxLength)

Setter for maximum text length.

Params:

Name	Type	Default	Description
maxLength	number \| null	null	Maximum text length to set.

Returns:

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

See listing

chart.labels().maxLength(20); // Limit characters count of all chart labels.

Try it:

minFontSize

minFontSize()

Getter for minimum font size settings for adjust text from.

Returns:

number - Minimum font size settings.

Try it:

Usage sample

minFontSize(size)

Setter for the minimum font size settings for adjust text from.

Detailed description

Works only with anychart.core.ui.LabelsFactory#adjustFontSize in value true.

Params:

Name	Type	Default	Description
size	number \| string	8	Minimum font size to set.

Returns:

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

Try it:

Usage sample

offsetX

offsetX()

Getter for the labels offsetX settings.

Returns:

number | string - Labels offsetX value.

Try it:

Usage sample

offsetX(offset)

Setter for the labels offsetX settings.

Params:

Name	Type	Default	Description
offset	number \| string	0	Labels offsetX settings to set.

Returns:

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

Try it:

Usage sample

offsetY

offsetY()

Getter for the labels offsetY settings.

Returns:

number | string - Labels offsetY value.

Try it:

Usage sample

offsetY(offset)

Setter for the labels offsetY settings.

Params:

Name	Type	Default	Description
offset	number \| string	0	Labels offsetY settings to set.

Returns:

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

Try it:

Usage sample

padding

padding()

Getter for labels padding settings.

Detailed description

Also, you can use anychart.core.utils.Padding#bottom, anychart.core.utils.Padding#left, anychart.core.utils.Padding#right, anychart.core.utils.Padding#top methods to setting paddings.

Returns:

anychart.core.utils.Padding - Labels padding.

Try it:

Usage sample

padding(padding)

Setter for labels padding in pixels using a single value.

Params:

Name	Type	Default	Description
padding	Array.<(number\|string)> \| Object \| number \| string	{top: 2, right: 4, bottom: 2, left: 4}	Space value, object or array.

Returns:

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

Try it:

Usage sample

padding(value1, value2, value3, value4)

Setter for labels padding settings in pixels using several values.

Params:

Name	Type	Default	Description
value1	string \| number	2	Top or top-bottom space.
value2	string \| number	4	Right or right-left space.
value3	string \| number	2	Bottom space.
value4	string \| number	4	Left space.

Returns:

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

Try it:

Usage sample

position

position()

Getter for the labels position settings.

Returns:

string - Labels position settings.

Try it:

Usage sample

position(position)

Setter for the labels position settings.
The default value and the list of available values can be different depending on where the labels are used, e.g. with axes of different types or with different charts. Find more information in the detailed description.

Detailed description

Class	Default value	Available value
anychart.charts.TreeMap	'left-top'	'left-top'
anychart.charts.Cartesian	value not set	anychart.enums.Position\|string
anychart.charts.Polar
anychart.charts.Scatter
anychart.charts.Pareto
anychart.charts.Venn
anychart.charts.Cartesian3d
anychart.charts.Sparkline
anychart.charts.Radar
anychart.charts.HeatMap	'center'	'center'
anychart.charts.Pie	'inside'	'inside', 'outside'
anychart.charts.Funnel	'outside-left-in-column'	anychart.enums.PyramidLabelsPosition\|string
anychart.charts.Map	value not set	'start', 'middle', 'end' for connector maps only
anychart.charts.Pyramid	'outside-left-in-column'	anychart.enums.PyramidLabelsPosition\|string
anychart.core.axes.Polar	'by-path'	'by-path', 'normal'
anychart.core.axes.Circular	'inside'	anychart.enums.SidePosition\|string
anychart.core.axes.Linear	'outside'	anychart.enums.SidePosition\|string
anychart.core.axes.LinearGauge	'outside'	anychart.enums.SidePosition\|string
anychart.core.axes.Map	'outside'	anychart.enums.SidePosition\|string
anychart.core.axes.Radar	'outside'	anychart.enums.SidePosition\|string
anychart.core.axes.Radial	'outside'	anychart.enums.SidePosition\|string
anychart.core.axes.StockDateTime	'outside'	anychart.enums.SidePosition\|string
anychart.core.cartesian.series.Box	'higest'	'higest', 'median', 'lowest', 'q1', 'q3', custom values from data
anychart.core.cartesian.series.SplineArea	'value'	"zero", 'value', custom values from data
anychart.core.cartesian.series.Spline	'value'	'value', custom values from data
anychart.core.cartesian.series.RangeStepArea	'high'	'high', 'low', 'x', custom values from data
anychart.core.cartesian.series.StepArea	'value'	"zero", 'value', custom values from data
anychart.core.cartesian.series.RangeBar	'high'	'high', 'low', 'x', custom values from data
anychart.core.cartesian.series.Column3d	'value'	"zero", 'value', custom values from data
anychart.core.cartesian.series.Area
anychart.core.cartesian.series.Stick
anychart.core.cartesian.series.Bubble	'value'	"zero", 'value', 'x', 'size' custom values from data
anychart.core.cartesian.series.Bar	'value'	"zero", 'value', 'x', 'size' custom values from data
anychart.core.cartesian.series.Area3d	'value'	"zero", 'value', custom values from data
anychart.core.cartesian.series.OHLC	'high'	'high', 'low', 'open', 'close', 'x', custom values from data
anychart.core.cartesian.series.Candlestick	'high'	'high', 'low', 'open', 'close', 'x', custom values from data
anychart.core.cartesian.series.Column	'value'	"zero", 'value', custom values from data
anychart.core.cartesian.series.RangeArea	'high'	'high', 'low', 'x', custom values from data
anychart.core.cartesian.series.JumpLine	'value'	"zero", 'value', custom values from data
anychart.core.cartesian.series.StepLine	'value'	"zero", 'value', custom values from data
anychart.core.cartesian.series.Line	'value'	"zero", 'value', custom values from data
anychart.core.cartesian.series.RangeColumn	'high'	'high', 'low', 'x', custom values from data
anychart.core.cartesian.series.RangeSplineArea	'high'	'high', 'low', 'x', custom values from data
anychart.core.cartesian.series.Hilo	'high'	'high', 'low', 'x', custom values from data
anychart.core.cartesian.series.Marker	'value'	"zero", 'value', custom values from data
anychart.core.cartesian.series.Bar3d	'value'	"zero", 'value', 'x', 'size' custom values from data
anychart.core.map.series.Choropleth	'value'	'value'
anychart.core.map.series.Bubble	'value'	'value'
anychart.core.map.series.Connector	'middle'	'middle', 'end', 'start'
anychart.core.map.series.Marker	'value'	'value'
anychart.core.mekko.series.Mekko	'value'	'value', anychart.enums.Position\|string
anychart.core.polar.series.Polyline
anychart.core.polar.series.Area
anychart.core.polar.series.Column
anychart.core.polar.series.Line
anychart.core.polar.series.RangeColumn	'high'	'high', 'low', 'x', custom values from data
anychart.core.polar.series.Marker	'value'	'value', anychart.enums.Position\|string
anychart.core.polar.series.Polygon
anychart.core.radar.series.Area
anychart.core.radar.series.Line
anychart.core.radar.series.Marker
anychart.core.scatter.series.Bubble
anychart.core.scatter.series.Line
anychart.core.scatter.series.Marker
anychart.core.waterfall.series.Waterfall
anychart.core.ui.Timeline	'right-center'	anychart.enums.Position\|string
anychart.standalones.ProjectTimeline
anychart.standalones.ResourceTimeline
anychart.core.resource.Activities	'left-top'	anychart.enums.Position\|string
anychart.standalones.axes.Polar	'by-path'	'by-path', 'normal'

Params:

Name	Type	Default	Description
position	string	N/A	Labels position settings.

Returns:

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

Try it:

positionFormatter

positionFormatter()

Getter for the labels position formatter function.

Returns:

function - Labels position formatter function.

positionFormatter(formatter)

Setter for the labels position formatter function.

Params:

Name	Type	Default	Description
formatter	function	function() {return this['value'];}	Labels position formatter function.

Returns:

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

Try it:

Usage sample

rotation

rotation()

Getter for the rotation angle around an anchor.

Returns:

number - Rotation angle in degrees.

Try it:

Usage sample

rotation(angle)

Setter for the rotation angle around an anchor.

Params:

Name	Type	Default	Description
angle	number	0	Rotation angle in degrees.

Returns:

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

Try it:

Usage sample

textShadow

textShadow()

Getter for the text shadow.

Returns:

string - String representation of text shadow.

See listing

var textShadow = labels.textShadow();

textShadow(textShadow)

Setter for the text font color.

Params:

Name	Type	Default	Description
textShadow	anychart.graphics.vector.TextShadow \| string	'none'	Text shadow to set.

Returns:

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

Try it:

Usage sample

useHtml

useHtml()

Getter for the useHTML flag.

Returns:

boolean - Value of useHTML flag.

Try it:

Usage sample

useHtml(enabled)

Setter for flag useHTML.

Detailed description

This property defines whether HTML text should be parsed.

Params:

Name	Type	Default	Description
enabled	boolean	false	Enabled state to set.

Returns:

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

Try it:

Usage sample

vAlign

vAlign()

Getter for the text vertical align.

Returns:

anychart.graphics.vector.Text.VAlign | string - Text vertical align.

Try it:

Usage sample

vAlign(align)

Setter for the text vertical align.

Params:

Name	Type	Default	Description
align	anychart.graphics.vector.Text.VAlign \| string	'top'	Value to set.

Returns:

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

Try it:

Usage sample

width

width()

Getter for labels width settings.

Returns:

number | string | null - Labels width.

Try it:

Usage sample

width(width)

Setter for labels width settings.

Params:

Name	Type	Default	Description
width	number \| string	null	Labels width to set.

Returns:

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

Try it:

Usage sample

wordBreak

wordBreak()Since version 8.0.0

Getter for the word-break mode.

Returns:

anychart.enums.WordBreak | string - Word-break mode.

Try it:

Usage sample

wordBreak(mode)Since version 8.0.0

Setter for the word-break mode.

Params:

Name	Type	Default	Description
mode	anychart.enums.WordBreak \| string	"normal"	Word-break mode to set.

Returns:

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

Try it:

Usage sample

wordWrap

wordWrap()Since version 8.0.0

Getter for the word-wrap mode.

Returns:

anychart.enums.WordWrap | string - Word-wrap mode.

Try it:

Usage sample

wordWrap(mode)Since version 8.0.0

Setter for the word-wrap mode.

Params:

Name	Type	Default	Description
mode	anychart.enums.WordWrap \| string	'normal'	Word-wrap mode to set.

Returns:

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

Try it:

Usage sample

zIndex

zIndex()

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Usage sample

zIndex(zIndex)

Setter for the Z-index of the element.

Detailed description

The bigger the index - the higher the element position is.

Params:

Name	Type	Default	Description
zIndex	number	0	Value to set.

Returns:

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

Try it:

Usage sample

class anychart.core.ui.LabelsFactory Improve this Doc

Methods Overview

Methods Description

adjustFontSize

anchor

background

clip

connectorStroke

disablePointerEvents

enabled

fontColor

fontDecoration

fontFamily

fontOpacity

fontSize

fontStyle

fontVariant

fontWeight

format

getLabel

getLabelsCount

hAlign

height

letterSpacing

lineHeight

maxFontSize

maxLength

minFontSize

offsetX

offsetY

padding

position

positionFormatter

rotation

selectable

textDirection

textIndent

textOverflow

textShadow

useHtml

vAlign

width

wordBreak

wordWrap

zIndex