class anychart.core.ui.CircularLabelsFactory.Label Improve this Doc

Extends: anychart.core.ui.LabelsFactory.Label

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
getIndex()	Returns label index.
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 settings.
minFontSize()	Minimum font size settings.
vAlign()	Text vertical align settings.
Coloring
background()	Background settings.
Events
disablePointerEvents()	Pointer events settings.
Interactivity
enabled()	Element state (enabled or disabled).
selectable()	Text selectable option.
Size and Position
anchor()	Anchor settings.
autoRotate()	Label rotation.
height()	Height settings.
offsetX()	Offset by X.
offsetY()	Offset by Y.
padding()	Padding settings.
position()	Position settings.
positionFormatter()	Position formatter.
rotation()	Rotation settings.
width()	Width settings.
zIndex()	Z-index of the element.
Text Settings
textSettings()	Text settings.

Methods Description

adjustFontSize

adjustFontSize()

Getter for the adjust font size.

Returns:

Object - AdjustFontSize 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.CircularLabelsFactory.Label - Self instance for method chaining.

Try it:

Usage sample

adjustFontSize(value)

Setter for the adjusting font size by one parameter.

Params:

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

Returns:

anychart.core.ui.CircularLabelsFactory.Label - Self instance for method chaining.

Try it:

Usage sample

anchor

anchor()

Getter for the label anchor settings.

Returns:

anychart.enums.Anchor | string - Label anchor settings.

Try it:

Usage sample

anchor(anchor)

Setter for the label anchor settings.

Params:

Name	Type	Default	Description
anchor	anychart.enums.Anchor \| string	'center'	Value to set.

Returns:

anychart.enums.Anchor | string - Self instance for method chaining.

Try it:

Usage sample

autoRotate

autoRotate()

Getter for the label rotation.

Returns:

boolean - Whether label auto rotate.

autoRotate(enabled)

Setter for the label rotation.
Auto rotates a label around an anchor.

Params:

Name	Type	Description
enabled	boolean	Whether label auto rotate.

Returns:

anychart.core.ui.CircularLabelsFactory.Label - Self instance for method chaining.

background

background()

Getter for label background settings.

Returns:

anychart.core.ui.Background - Label background.

Try it:

Usage sample

background(settings)

Setter for label background settings.

Detailed description

Sets label background settings depending on parameter type:

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

Params:

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

Returns:

anychart.core.ui.CircularLabelsFactory.Label - Self instance for method chaining.

Try it:

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

Try it:

Usage sample

enabled

enabled()

Getter for the element state.

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	null \| boolean	false	Value to set.

Returns:

anychart.core.ui.CircularLabelsFactory.Label - Self instance for method chaining.

Try it:

Usage sample

fontColor

fontColor()

Getter for the text font color.

Returns:

string - Font color.

Try it:

Usage sample

fontColor(color)

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

Params:

Name	Type	Default	Description
color	string	'#7c868e'	Value to set.

Returns:

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

Try it:

Usage sample

Name	Type	Default	Description
size	string \| number	16	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.CircularLabelsFactory.Label - 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.CircularLabelsFactory.Label - Self instance for method chaining.

Try it:

Usage sample

fontWeight

fontWeight()

Getter for the text font weight.

Returns:

string | number - Font weight.

Try it:

Usage sample

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

Try it:

Usage sample

getIndex

getIndex()

Returns label index.

Returns:

number - Label index.

Try it:

Usage sample

hAlign

hAlign()

Getter for the text horizontal align.

Returns:

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

Try it:

Usage sample

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

Try it:

Usage sample

height

height()

Getter for the label height.

Returns:

number | string | null - Label height.

Try it:

Usage sample

height(height)

Setter for the label height.

Params:

Name	Type	Description
height	number \| string	Label height to set.

Returns:

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

Try it:

Usage sample

maxFontSize

maxFontSize()

Getter maximum font size settings for adjust text to.

Returns:

number - Returns the 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	Description
size	number \| string	Maximum font size to set.

Returns:

anychart.core.ui.CircularLabelsFactory.Label - Self instance for method chaining.

Try it:

Usage sample

minFontSize

minFontSize()

Getter for minimum font size settings for adjust text from.

Returns:

number - Font size setting.

Try it:

Usage sample

minFontSize(size)

Setter for minimum font size settings for adjust text from.

Detailed description

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

Params:

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

Returns:

anychart.core.ui.CircularLabelsFactory.Label - Self instance for method chaining.

Try it:

Usage sample

offsetX

offsetX()

Getter for label offsetX settings.

Returns:

number | string - Label offsetX settings.

Try it:

Usage sample

offsetX(offset)

Setter for label offsetX settings.

Params:

Name	Type	Description
offset	number \| string	Offset by X to set.

Returns:

anychart.core.ui.CircularLabelsFactory.Label - Self instance for method chaining.

Try it:

Usage sample

offsetY

offsetY()

Getter for label offsetY settings.

Returns:

number | string - Label offsetY settings.

Try it:

Usage sample

offsetY(offset)

Setter for label offsetY settings.

Params:

Name	Type	Description
offset	number \| string	Offset by Y to set.

Returns:

anychart.core.ui.CircularLabelsFactory.Label - Self instance for method chaining.

Try it:

Usage sample

padding

padding()

Getter for the label padding.

Returns:

anychart.core.utils.Padding - Label padding.

padding(padding)

Setter for label padding in pixels using a single value.

Params:

Name	Type	Description
padding	Array.<(number\|string)> \| Object \| number \| string	Space value, object or array.

Returns:

anychart.core.ui.CircularLabelsFactory.Label - Self instance for method chaining.

Try it:

Usage sample

padding(value1, value2, value3, value4)

Setter for label padding setting in pixels using a several values.

Params:

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

Returns:

anychart.core.ui.CircularLabelsFactory.Label - Self instance for method chaining.

Try it:

Usage sample

position

position()

Getter for the label position settings.

Returns:

string - Label position settings.

Try it:

Usage sample

position(position)

Setter for the label position settings.

Params:

Name	Type	Description
position	string	Label position to set.

Returns:

anychart.core.ui.CircularLabelsFactory.Label - Self instance for method chaining.

Try it:

Usage sample

positionFormatter

positionFormatter()

Getter for the position formatter.

Returns:

* - Position formatter.

positionFormatter(formatter)

Setter for the position formatter.

Params:

Name	Type	Description
formatter	*	Position formatter.

Returns:

* - Self instance for method chaining.

Try it:

Usage sample

rotation

rotation()

Getter for the rotate a label around an anchor.

Returns:

number - Rotation angle in degrees.

Try it:

Usage sample

rotation(angle)

Setter for the rotate a label around an anchor.

Detailed description

(anychart.graphics.vector.Element). Method resets transformation and applies a new one.

Params:

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

Returns:

anychart.core.ui.CircularLabelsFactory.Label - 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.CircularLabelsFactory.Label - 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.CircularLabelsFactory.Label - 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.CircularLabelsFactory.Label - 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.CircularLabelsFactory.Label - 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 settings.

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, 'wordWrap': smth, 'wordBreak': smth, 'textOverflow': smth, 'selectable': smth, 'useHtml': smth 'textShadow':smth }

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,
     'wordWrap': smth,
     'wordBreak': smth,
     'textOverflow': smth,
     'selectable': smth,
     'useHtml': smth
     'textShadow':smth
   }

Returns:

anychart.core.ui.CircularLabelsFactory.Label - Self instance for method chaining.

Try it: