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 | |
| format() | Text formatter function. |
| getLabel() | Returns label by index. |
| labelsCount() | 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. |
| 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. |
| maxFontSize() | Maximum font size setting. |
| minFontSize() | Minimum font size setting. |
| vAlign() | Text vertical align settings. |
| Coloring | |
| background() | Background settings. |
| connectorStroke() | 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 | |
| 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. |
| Text Settings | |
| textSettings() | Text settings. |
Methods Description
adjustFontSize
Getter for the current adjust font size.
Returns:
Object - The current adjust font size settings.Try it:
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:
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.LabelsFactory - Self instance for method chaining.Try it:
anchor
Getter for the current labels anchor settings.
Returns:
anychart.enums.Anchor - The current labels anchor setting.Try it:
Setter for the labels anchor settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.enums.Anchor | string | "center" | Labels anchor settings. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it:
background
Getter for the current labels background settings.
Returns:
anychart.core.ui.Background - The current labels background.Try it:
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 |
|---|---|---|---|
| value | string | Object | null | boolean | false | Background object to set. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.connectorStroke
Getter for connector stroke settings.
Returns:
anychart.graphics.vector.Stroke - Connector stroke settings. See listing.
var mapLabels = series.labels(); var currentStroke = mapLabels.connectorStroke();
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:
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.ui.LabelsFactory - Self instance for method chaining.Try it:
enabled
Getter for the current 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 - The current element state.Try it:
Setter for the element enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | null | boolean | true | Value to set. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it:
fontColor
Setter for the text font color.
https://www.w3schools.com/html/html_colors.asp
https://www.w3schools.com/html/html_colors.asp
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | string | "#7c868e" | Value to set. |
Returns:
anychart.core.ui.LabelsFactory - 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.ui.LabelsFactory - Self instance for method chaining.Try it:
fontFamily
Setter for font family.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | string | "Verdana", Helvetica, Arial, sans-serif | Value to set. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it:
fontOpacity
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.ui.LabelsFactory - 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.ui.LabelsFactory - 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.ui.LabelsFactory - 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.ui.LabelsFactory - 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
https://www.w3schools.com/cssref/pr_font_weight.asp
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | string | number | "normal" | Value to set. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it:
format
Getter for the current labels text formatter.
Returns:
function | string - Text formatter.Setter for the labels text formatter.
Learn more about using format() method.
Learn more about using 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:
Setter for the labels text formatter using function.
Learn more about using format() method.
Learn more about using 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:
getLabel
Returns label by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Label index. |
Returns:
anychart.core.ui.LabelsFactory.Label - Already existing label.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.ui.LabelsFactory - Self instance for method chaining.Try it:
height
Getter for the current labels height settings.
Returns:
number | string | null - The current labels height.Try it:
Setter for the labels height settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Height value to set. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it:
labelsCount
letterSpacing
Getter for the text letter spacing.
Returns:
string | number - The current letter spacing.Try it:
Setter for the text letter spacing.
https://www.w3schools.com/cssref/pr_text_letter-spacing.asp
https://www.w3schools.com/cssref/pr_text_letter-spacing.asp
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | string | number | "normal" | Value to set. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it:
lineHeight
Getter for the text line height.
Returns:
string | number - The current text line height.Try it:
Setter for the text line height.
https://www.w3schools.com/cssref/pr_dim_line-height.asp
https://www.w3schools.com/cssref/pr_dim_line-height.asp
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | string | number | "normal" | Value to set. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it:
listen
Adds an event listener to an implementing object.
Detailed description
The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
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.
Detailed description
After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
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:
maxFontSize
Getter for the current maximum font size setting for adjust text to.
Returns:
number - The current maximum font size setting.Try it:
Setter for the current maximum font size setting for adjust text to.
Detailed description
Works only with anychart.core.ui.LabelsFactory#adjustFontSize in value true.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | 72 | Maximum font size to set. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it:
minFontSize
Getter for the current minimum font size setting for adjust text from.
Returns:
number - The current minimum font size setting.Try it:
Setter for the minimum font size setting for adjust text from.
Detailed description
Works only with anychart.core.ui.LabelsFactory#adjustFontSize in value true.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | 8 | Minimum font size to set. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it:
offsetX
Getter for the current labels offsetX settings.
Returns:
number | string - The current labels offsetX value.Try it:
Setter for the labels offsetX settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | 0 | Labels offsetX settings to set. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it:
offsetY
Getter for the current labels offsetY settings.
Returns:
number | string - The current labels offsetY value.Try it:
Setter for the labels offsetY settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | 0 | Labels offsetY settings to set. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it:
padding
Getter for labels padding setting.
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 - The current labels padding.Try it:
Setter for labels padding in pixels using a single value.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | 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:
Setter for labels padding setting in pixels using several value.
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:
position
Getter for the current labels position settings.
Returns:
string - The current labels position settings.Try it:
Setter for the labels position settings.
Detailed description
These settings are processed by the factory handler (for example a series,
or an axis) and can have different meanings from handler to handler. Try using anychart.enums.Position values.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | string | "centerTop" | Labels position settings. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it:
positionFormatter
Getter for the current labels position formatter function.
Returns:
function - The current labels position formatter function.Setter for the labels position formatter function.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | function | function() {return this['value'];} | Labels position formatter function. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it:
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:
rotation
Getter for the current rotation angle around an anchor.
Returns:
number - The current rotation angle in degrees.Try it:
Setter for the rotation angle around an anchor.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 0 | Rotation angle in degrees. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it:
selectable
Getter for the text selectable option.
Returns:
boolean - The current text selectable option.Try it:
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 |
|---|---|---|---|
| value | boolean | false | Value to set. |
Returns:
anychart.core.ui.LabelsFactory - 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.ui.LabelsFactory - Self instance for method chaining.Try it:
textIndent
Setter for the text indent.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 0 | Value to set. |
Returns:
anychart.core.ui.LabelsFactory - 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.ui.LabelsFactory - 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.
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 the setting.Try it:
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,
"textWrap": smth,
"textOverflow": smth,
"selectable": smth,
"useHtml": smth
}. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it:
Setter for the text appearance settings.
Detailed description
Overrides text setting Value by its Name.
Params:
| Name | Type | Description |
|---|---|---|
| name | string | Setting name. |
| value | string | number | boolean | function | Settings value. |
Returns:
anychart.core.ui.LabelsFactory - 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.ui.LabelsFactory - 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
Setter for flag useHTML.
Detailed description
This property defines whether HTML text should be parsed.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | false | Value to set. |
Returns:
anychart.core.ui.LabelsFactory - 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.ui.LabelsFactory - Self instance for method chaining.Try it:
width
Getter for the current labels width settings.
Returns:
number | string | null - The current labels width settingsTry it:
Setter for the labels width settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Width value to set. |
Returns:
anychart.core.ui.LabelsFactory - 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.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 0 | Value to set. |
Returns:
anychart.core.ui.LabelsFactory - Self instance for method chaining.Try it: