AnyChart
API Reference
Still have questions?
Contact support
    Top

    class anychart.core.Text Improve this Doc

    Extends: anychart.core.VisualBase

    This class is responsible of the text formatting, it processes the plain text and the text in HTML format.

    Methods Overview

    Advanced Text 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.
    textShadow()Text shadow settings.
    vAlign()Text vertical align settings.
    Events
    disablePointerEvents()Pointer events settings.
    Interactivity
    enabled()Element state (enabled or disabled).
    selectable()Text selectable option.
    Size and Position
    zIndex()Z-index of the element.
    Text Settings
    textSettings()Text settings.

    Methods Description

    disablePointerEvents

    disablePointerEvents()

    Getter for the pointer events.

    Returns:

    boolean - Flag of the state.

    Try it:

    disablePointerEvents(enabled)

    Setter for the pointer events.

    Params:

    NameTypeDefaultDescription
    enabledboolean
    false
    		 Enabled state to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    enabled

    enabled()

    Getter for the element state (enabled or disabled).

    Returns:

    boolean - Element state.

    Try it:

    enabled(enabled)

    Setter for the element enabled state.

    Params:

    NameTypeDefaultDescription
    enabledboolean
    true
    		 Enabled state to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.
    Example.
    if (!element.enabled())
   element.enabled(true);

    Try it:

    fontColor

    fontColor()

    Getter for the text font color.

    Returns:

    string - Font color.

    Try it:

    fontColor(color)

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

    Params:

    NameTypeDefaultDescription
    colorstring
    '#7c868e'
    		 Value to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    fontDecoration

    fontDecoration()

    Getter for the text font decoration.

    Returns:

    anychart.graphics.vector.Text.Decoration | string - Font decoration.

    Try it:

    fontDecoration(value)

    Setter for the text font decoration.

    Params:

    NameTypeDefaultDescription
    valueanychart.graphics.vector.Text.Decoration | string
    'none'
    		 Font decoration to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    fontFamily

    fontFamily()

    Getter for the font family.

    Returns:

    string - Font family.

    Try it:

    fontFamily(family)

    Setter for the font family.

    Params:

    NameTypeDefaultDescription
    familystring
    'Verdana', Helvetica, Arial, sans-serif
    		 Font family to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    fontOpacity

    fontOpacity()

    Getter for the text font opacity.

    Returns:

    number - Font opacity.

    Try it:

    fontOpacity(opacity)

    Setter for the text font opacity. Double value from 0 to 1.

    Params:

    NameTypeDefaultDescription
    opacitynumber
    1
    		 Value to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    fontSize

    fontSize()

    Getter for the text font size.

    Returns:

    string | number - Font size.

    Try it:

    fontSize(size)

    Setter for the text font size.

    Params:

    NameTypeDefaultDescription
    sizestring | number
    16
    		 Font size to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    fontStyle

    fontStyle()

    Getter for the text font style.

    Returns:

    anychart.graphics.vector.Text.FontStyle | string - Font style.

    Try it:

    fontStyle(style)

    Setter for the text font style.

    Params:

    NameTypeDefaultDescription
    styleanychart.graphics.vector.Text.FontStyle | string
    'normal'
    		 Font style to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    fontVariant

    fontVariant()

    Getter for the text font variant.

    Returns:

    anychart.graphics.vector.Text.FontVariant | string - Font variant.

    Try it:

    fontVariant(value)

    Setter for the text font variant.

    Params:

    NameTypeDefaultDescription
    valueanychart.graphics.vector.Text.FontVariant | string
    'normal'
    		 Font variant to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    fontWeight

    fontWeight()

    Getter for the text font weight.

    Returns:

    string | number - Font weight.

    Try it:

    fontWeight(weight)

    Setter for the text font weight.
    https://www.w3schools.com/cssref/pr_font_weight.asp

    Params:

    NameTypeDefaultDescription
    weightstring | number
    'normal'
    		 Font weight to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    hAlign

    hAlign()

    Getter for the text horizontal align.

    Returns:

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

    Try it:

    hAlign(align)

    Setter for the text horizontal align.

    Params:

    NameTypeDefaultDescription
    alignanychart.graphics.vector.Text.HAlign | string
    'start'
    		 Value to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    letterSpacing

    letterSpacing()

    Getter for the text letter spacing.

    Returns:

    string | number - Letter spacing.

    Try it:

    letterSpacing(spacing)

    Setter for the text letter spacing.
    https://www.w3schools.com/cssref/pr_text_letter-spacing.asp

    Params:

    NameTypeDefaultDescription
    spacingstring | number
    'normal'
    		 Value to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    lineHeight

    lineHeight()

    Getter for the text line height.

    Returns:

    string | number - Text line height.

    Try it:

    lineHeight(height)

    Setter for the text line height.
    https://www.w3schools.com/cssref/pr_dim_line-height.asp

    Params:

    NameTypeDefaultDescription
    heightstring | number
    'normal'
    		 Value to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    selectable

    selectable()

    Getter for the text selectable option.

    Returns:

    boolean - The text selectable option.

    Try it:

    selectable(enabled)

    Setter for the text selectable.

    Params:

    NameTypeDefaultDescription
    enabledboolean
    false
    		 Enabled state to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    textDirection

    textDirection()

    Getter for the text direction.

    Returns:

    anychart.graphics.vector.Text.Direction | string - Text direction.

    Try it:

    textDirection(direction)

    Setter for the text direction.

    Params:

    NameTypeDefaultDescription
    directionanychart.graphics.vector.Text.Direction | string
    'ltr'
    		 Text direction to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    textIndent

    textIndent()

    Getter for the text indent.

    Returns:

    number - Text indent.

    Try it:

    textIndent(indent)

    Setter for the text indent.

    Params:

    NameTypeDefaultDescription
    indentnumber
    0
    		 Text indent to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    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:

    NameTypeDefaultDescription
    valueanychart.graphics.vector.Text.TextOverflow | string
    ""
    		 Text overflow settings to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    textSettings

    textSettings()

    Getter for the full text appearance settings.

    Returns:

    Object - A copy of settings object.

    Try it:

    textSettings(name)

    Getter for all text appearance settings.

    Params:

    NameTypeDescription
    namestringSetting name.

    Returns:

    string | number | boolean | undefined - Value of settings.

    Try it:

    textSettings(objectWithSettings)

    Setter for text appearance settings.

    Params:

    NameTypeDescription
    objectWithSettingsObjectSettings 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.Text - Self instance for method chaining.

    Try it:

    textSettings(name, settings)

    Setter for the text appearance settings.

    Params:

    NameTypeDescription
    namestringSetting name.
    settingsstring | number | boolean | functionText settings.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    textShadow

    textShadow()

    Getter for the text shadow.

    Returns:

    string - String representation of text shadow.

    Try it:

    textShadow(textShadow)

    Setter for the text shadow.

    Params:

    NameTypeDefaultDescription
    textShadowanychart.graphics.vector.TextShadow | string
    'none'
    		 Text shadow to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    useHtml

    useHtml()

    Getter for the useHTML flag.

    Returns:

    boolean - Value of useHTML flag.

    Try it:

    useHtml(enabled)

    Setter for flag useHTML.

    Params:

    NameTypeDefaultDescription
    enabledboolean
    false
    		 Enabled state to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    vAlign

    vAlign()

    Getter for the text vertical align.

    Returns:

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

    Try it:

    vAlign(align)

    Setter for the text vertical align.

    Params:

    NameTypeDefaultDescription
    alignanychart.graphics.vector.Text.VAlign | string
    'top'
    		 Value to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    wordBreak

    wordBreak()Since version 8.0.0

    Getter for the word-break mode.

    Returns:

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

    Try it:

    wordBreak(mode)Since version 8.0.0

    Setter for the word-break mode.

    Params:

    NameTypeDefaultDescription
    modeanychart.enums.WordBreak | string
    "normal"
    		 Word-break mode to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    wordWrap

    wordWrap()Since version 8.0.0

    Getter for the word-wrap mode.

    Returns:

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

    Try it:

    wordWrap(mode)Since version 8.0.0

    Setter for the word-wrap mode.

    Params:

    NameTypeDefaultDescription
    modeanychart.enums.WordWrap | string
    'normal'
    		 Word-wrap mode to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    zIndex

    zIndex()

    Getter for the Z-index of the element.

    Returns:

    number - Z-index.

    Try it:

    zIndex(zIndex)

    Setter for the Z-index of the element.

    Params:

    NameTypeDefaultDescription
    zIndexnumber
    0
    		 Value to set.

    Returns:

    anychart.core.Text - Self instance for method chaining.

    Try it:

    AnyChart - HTML5 charts help you to understand any data