class anychart.core.ui.LabelsFactory.Label Improve this Doc
Extends: anychart.core.Text
Class for a 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. |
height() | Height settings. |
measureWithText() | Measures the text with the current labels 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
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.Label - Self instance for method chaining.Try it:
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.LabelsFactory.Label - Self instance for method chaining.Try it:
anchor
Returns:
anychart.enums.Anchor | string - Label anchor settings.Try it:
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:
background
- 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.LabelsFactory.Label - Self instance for method chaining.disablePointerEvents
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Enabled state to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
enabled
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | null | boolean | false | Value to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
fontColor
https://www.w3schools.com/html/html_colors.asp
Params:
Name | Type | Default | Description |
---|---|---|---|
color | string | '#7c868e' | Value to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
fontDecoration
Returns:
anychart.graphics.vector.Text.Decoration | string - Font decoration.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.graphics.vector.Text.Decoration | string | 'none' | Font decoration to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
fontFamily
Params:
Name | Type | Default | Description |
---|---|---|---|
family | string | 'Verdana', Helvetica, Arial, sans-serif | Font family to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
fontOpacity
Params:
Name | Type | Default | Description |
---|---|---|---|
opacity | number | 1 | Value to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
fontSize
Params:
Name | Type | Default | Description |
---|---|---|---|
size | string | number | 16 | Font size to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
fontStyle
Returns:
anychart.graphics.vector.Text.FontStyle | string - Font style.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
style | anychart.graphics.vector.Text.FontStyle | string | 'normal' | Font style to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
fontVariant
Returns:
anychart.graphics.vector.Text.FontVariant | string - Font variant.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.graphics.vector.Text.FontVariant | string | 'normal' | Font variant to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
fontWeight
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.Label - Self instance for method chaining.Try it:
getIndex
hAlign
Returns:
anychart.graphics.vector.Text.HAlign | string - Text horizontal align.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
align | anychart.graphics.vector.Text.HAlign | string | 'start' | Value to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
height
Params:
Name | Type | Description |
---|---|---|
height | number | string | Label height to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
letterSpacing
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.Label - Self instance for method chaining.Try it:
lineHeight
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.Label - Self instance for method chaining.Try it:
maxFontSize
Returns:
number - Returns the maximum font size setting.Try it:
Params:
Name | Type | Description |
---|---|---|
size | number | string | Maximum font size to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
measureWithText
Params:
Name | Type | Description |
---|---|---|
text | string | Text to measure. |
Returns:
anychart.math.Rect - Returns the labels bounds.Try it:
minFontSize
Returns:
number - Font size setting.Try it:
Params:
Name | Type | Description |
---|---|---|
size | number | string | Minimum font size to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
offsetX
Returns:
number | string - Label offsetX settings.Try it:
Params:
Name | Type | Description |
---|---|---|
offset | number | string | Offset by X to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
offsetY
Returns:
number | string - Label offsetY settings.Try it:
Params:
Name | Type | Description |
---|---|---|
offset | number | string | Offset by Y to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
padding
Returns:
anychart.core.utils.Padding - Label padding.Params:
Name | Type | Description |
---|---|---|
padding | Array.<(number|string)> | Object | number | string | Space value, object or array. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
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.LabelsFactory.Label - Self instance for method chaining.Try it:
position
Params:
Name | Type | Description |
---|---|---|
position | string | Label position to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
positionFormatter
Returns:
* - Position formatter.Params:
Name | Type | Description |
---|---|---|
formatter | * | Position formatter. |
Returns:
* - Self instance for method chaining.Try it:
rotation
Returns:
number - Rotation angle in degrees.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
angle | number | 0 | Rotation angle in degrees. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
selectable
Returns:
boolean - The text selectable option.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Enabled state to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
textDirection
Returns:
anychart.graphics.vector.Text.Direction | string - Text direction.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
direction | anychart.graphics.vector.Text.Direction | string | 'ltr' | Text direction to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
textIndent
Params:
Name | Type | Default | Description |
---|---|---|---|
indent | number | 0 | Text indent to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
textOverflow
Returns:
anychart.graphics.vector.Text.TextOverflow | string - Text overflow settings.var title = chart.title(); var textOverflow = title.textOverflow();
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.graphics.vector.Text.TextOverflow | string | "" | Text overflow settings to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
textSettings
Returns:
Object - A copy of settings object.Try it:
Params:
Name | Type | Description |
---|---|---|
name | string | Setting name. |
Returns:
string | number | boolean | undefined - Value of settings.Try it:
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 } |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
name | string | Setting name. |
settings | string | number | boolean | function | Text settings. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
useHtml
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Enabled state to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
vAlign
Returns:
anychart.graphics.vector.Text.VAlign | string - Text vertical align.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
align | anychart.graphics.vector.Text.VAlign | string | 'top' | Value to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
width
Params:
Name | Type | Description |
---|---|---|
width | number | string | Label width to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
wordBreak
Params:
Name | Type | Default | Description |
---|---|---|---|
mode | anychart.enums.WordBreak | string | "normal" | Word-break mode to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
wordWrap
Params:
Name | Type | Default | Description |
---|---|---|---|
mode | anychart.enums.WordWrap | string | 'normal' | Word-wrap mode to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it:
zIndex
Params:
Name | Type | Default | Description |
---|---|---|---|
zIndex | number | 0 | Value to set. |
Returns:
anychart.core.ui.LabelsFactory.Label - Self instance for method chaining.Try it: