AnyChart
API Reference
Still have questions?
Contact support
    Top

    class anychart.core.axisMarkers.Text Improve this Doc

    Extends: anychart.core.Text

    Text marker.

    Methods Overview

    Specific settings
    text()Text settings.
    value()Text marker value.
    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.
    Axes and Scales
    axis()Axis settings.
    scale()Scale settings.
    scaleRangeMode()Scale range 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.
    Coloring
    background()Background settings.
    Events
    disablePointerEvents()Pointer events settings.
    Interactivity
    enabled()Element state (enabled or disabled).
    selectable()Text selectable option.
    Size and Position
    align()Align settings.
    anchor()Anchor settings.
    height()Text marker height.
    isHorizontal()Whether a text marker has horizontal layout.
    layout()Layout settings.
    offsetX()Text marker offset by x.
    offsetY()Text marker offset by y.
    padding()Padding settings.
    position()Text marker position.
    rotation()Rotation settings.
    width()Text marker width.
    zIndex()Z-index of the series.
    Text Settings
    adjustFontSize()Adjusting settings.
    fontColor()Font color settings.
    maxFontSize()Maximum font size settings.
    minFontSize()Minimum font size settings.
    textSettings()Text settings.
    useHtml()Text useHtml settings.

    Methods Description

    adjustFontSize

    adjustFontSize()

    Getter for the adjust font settings.

    Returns:

    Object - AdjustFontSize settings.
    See listing
    var textMarker = chart.textMarker();
var adjustFontSize = textMarker.adjustFontSize();

    adjustFontSize(bothOrByWidth, byHeight)

    Setter for the adjust font settings.

    Params:

    NameTypeDefaultDescription
    bothOrByWidthObject | Array.<boolean> | boolean
    {width: false, height: false}
    		 If only one param is set, its value goes for another too (see source code).
    byHeightboolean
    		Is font needs to be adjusted by height.
    Returns:
    anychart.core.annotations.Label - Self instance for method chaining.
     Example
    textMarker.adjustFontSize(false);
// the same
textMarker.adjustFontSize(false, false);
// the same
textMarker.adjustFontSize([false, false]);
    Try it:
    align
    align()
    Getter for the text marker align.
    Returns:
    anychart.enums.Align | string - The text marker align.
    Try it:
    align(align)
    Setter for the text marker align.
    Params:
    NameTypeDefaultDescription
    alignanychart.enums.Align | string
    'center'
    		 Text marker align.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    anchor
    anchor()
    Getter for the text marker anchor settings.
    Returns:
    anychart.enums.Anchor | string - Text marker anchor settings.
    Try it:
    anchor(anchor)
    Setter for the text marker anchor settings.
    Params:
    NameTypeDefaultDescription
    anchoranychart.enums.Anchor | string
    'auto'
    		 Text marker anchor to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    axis
    axis()Since version 7.10.0
    Getter for the text marker axis.
    Returns:
    anychart.core.axes.Linear - The text marker axis.
    Try it:
    axis(axis)Since version 7.10.0
    Setter for the text marker axis.
    Params:
    NameTypeDefaultDescription
    axisanychart.core.axes.Linear
    null
    		 Axis instance to set.
    Returns:
    anychart.core.axisMarkers.Line - Self instance for method chaining.
    Try it:
    background
    background()Since version 8.3.0
    Getter for the background.
    Returns:
    anychart.core.ui.Background - The text marker background.
    Try it:
    background(settings)Since version 8.3.0
    Setter for the background.
    Params:
    NameTypeDefaultDescription
    settingsstring | Object | null | boolean
    false
    		 Background settings.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    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.axisMarkers.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.axisMarkers.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.
     See listing
    var textMarker = chart.textMarker();
var fontColor = textMarker.fontColor();
    fontColor(color)
    Setter for the text font color.
    
https://www.w3schools.com/html/html_colors.asp
    Params:
    NameTypeDescription
    colorstringFont color to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    fontColor()
    Getter for the text font color.
    Returns:
    string - Font color.
     See listing
    var textMarker = chart.textMarker();
var fontColor = textMarker.fontColor();
    fontColor(color)
    Setter for the text font color.
    
https://www.w3schools.com/html/html_colors.asp
    Params:
    NameTypeDescription
    colorstringFont color to set.
    Returns:
    anychart.core.axisMarkers.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.axisMarkers.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.axisMarkers.Text - Self instance for method chaining.
    Try it:
    fontOpacity
    fontOpacity()
    Getter for the text font opacity.
    Returns:
    number - Font opacity.
     See listing
    var textMarker = chart.textMarker();
var fontOpacity = textMarker.fontOpacity();
    fontOpacity(opacity)
    Setter for the text font opacity. Double value from 0 to 1.
    Params:
    NameTypeDefaultDescription
    opacitynumber
    1
    		 Font opacity to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    fontSize
    fontSize()
    Getter for the text font size.
    Returns:
    string | number - Font size.
     See listing
    var textMarker = chart.textMarker();
var fontSize = textMarker.fontSize();
    fontSize(size)
    Setter for the text font size.
    Params:
    NameTypeDescription
    sizestring | numberFont size to set.
    Returns:
    anychart.core.axisMarkers.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.axisMarkers.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.axisMarkers.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.axisMarkers.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.
     See listing
    var textMarker = chart.textMarker();
var hAlign = textMarker.hAlign();
    hAlign(align)
    Setter for the text horizontal align.
    Params:
    NameTypeDefaultDescription
    alignanychart.graphics.vector.Text.HAlign | string
    'start'
    		 Value to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    height
    height()
    Getter for the text marker height.
    Returns:
    number | string | null - The text marker height.
     See listing
    var textMarker = chart.textMarker();
var height = textMarker.height();
    height(height)
    Setter for the text marker height.
    Params:
    NameTypeDefaultDescription
    heightnumber | string
    null
    		 Text marker height to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    isHorizontal
    isHorizontal()
    Whether a text marker has horizontal layout.
Layout is define by anychart.core.axisMarkers.Text#layout method.
    Returns:
    boolean - Returns true if the text marker's layout is horizontal.
    Try it:
    layout
    layout()
    Getter for text marker layout.
    Returns:
    anychart.enums.Layout | string - The text marker layout.
    Try it:
    layout(layout)
    Setter for text marker layout.
    Params:
    NameTypeDefaultDescription
    layoutanychart.enums.Layout | string
    'horizontal'
    		 Text marker layout to set.
    Returns:
    anychart.core.axisMarkers.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.axisMarkers.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.axisMarkers.Text - Self instance for method chaining.
    Try it:
    maxFontSize
    maxFontSize()
    Getter for maximum font size settings for adjust text to.
    Returns:
    number - Maximum font size.
     See listing
    var textMarker = chart.textMarker();
var maxFontSize = textMarker.maxFontSize();
    maxFontSize(size)
    Setter for maximum font size settings for adjust text to.
    Params:
    NameTypeDescription
    sizenumber | stringMaximum font size to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    minFontSize
    minFontSize()
    Getter for minimum font size settings for adjust text from.
    Returns:
    number - Minimum font size.
     See listing
    var textMarker = chart.textMarker();
var minFontSize = textMarker.minFontSize();
    minFontSize(size)
    Setter for minimum font size settings for adjust text from.
    Params:
    NameTypeDescription
    sizenumber | stringMinimum font size to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    offsetX
    offsetX()
    Getter for the text marker offset by x.
    Returns:
    number | string - The offset by x.
     See listing
    var textMarkerSettings = chart.textMarker();
var offsetX = textMarkerSettings.offsetX();
    offsetX(offset)
    Setter for the text marker offset by x.
    Params:
    NameTypeDefaultDescription
    offsetnumber | string
    0
    		 Offset by x to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    offsetY
    offsetY()
    Getter for the text marker offset by y.
    Returns:
    number | string - The text marker offset by y.
     See listing
    var textMarkerSettings = chart.textMarker();
var offsetY = textMarkerSettings.offsetY();
    offsetY(offset)
    Setter for the text marker offset by y.
    Params:
    NameTypeDefaultDescription
    offsetnumber | string
    0
    		 Offset by y to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    padding
    padding()Since version 8.3.0
    Getter for the text marker padding.
    Returns:
    anychart.core.utils.Padding - The text marker padding.
    Try it:
    padding(padding)Since version 8.3.0
    Setter for the text marker padding in pixels by one value.
    Params:
    NameTypeDescription
    paddingArray.<(number|string)> | ObjectAn array of field values to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    padding(value1, value2, value3, value4)Since version 8.3.0
    Setter for the text marker padding in pixels using several numbers.
    Params:
    NameTypeDefaultDescription
    value1string | number
    5
    		 Top or top-bottom space.
    value2string | number
    10
    		 Right or right-left space.
    value3string | number
    5
    		 Bottom space.
    value4string | number
    10
    		 Left space.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
     Example
    // 1) top and bottom 10px, left and right 15px
textMarker.padding(10, '15px');
// 2) top 10px, left and right 15px, bottom 5px
textMarker.padding(10, '15px', 5);
// 3) top 10px, right 15px, bottom 5px, left 12px
textMarker.padding(10, '15px', '5px', 12);
    Try it:
    position
    position()
    Getter for the text marker position.
    Returns:
    anychart.enums.Position | string - Text marker position.
    position(position)
    Setter for the text marker position.
    Params:
    NameTypeDefaultDescription
    positionanychart.enums.Position | string
    'center'
    		 Text marker position to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    rotation
    rotation()
    Getter for the text marker rotation in degrees.
    Returns:
    null | number - The text marker rotation.
     See listing
    var textMarkerSettings = chart.textMarker();
var rotation = textMarkerSettings.rotation();
    rotation(rotation)
    Setter for the text marker rotation.
    Params:
    NameTypeDefaultDescription
    rotationnumber
    null
    		 Text marker rotation to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    scale
    scale()
    Getter for the text marker scale.
    Returns:
    anychart.scales.Base - The text marker scale.
    scale(settings)
    Setter for the text marker scale.
    Params:
    NameTypeDefaultDescription
    settingsanychart.scales.Base | Object | anychart.enums.ScaleTypes | string
    anychart.scales.Linear
    		
Scale settings to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    scaleRangeMode
    scaleRangeMode()Since version 8.3.0
    Getter for the scale range mode.
    Returns:
    string - Scale range mode.
     See listing
    var textMarker = chart.textMarker();
var scaleRangeMode = textMarker.scaleRangeMode();
    scaleRangeMode(mode)Since version 8.3.0
    Setter for the scale range mode.
    
Whether to consider the text marker value in the scale calculation or not.
The 'consider' mode consideres the marker value in the scale.
    Params:
    NameTypeDefaultDescription
    modestring | anychart.enums.ScaleRangeMode
    'none'
    		 Scale range mode to set.
    Returns:
    anychart.core.axisMarkers.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.axisMarkers.Text - Self instance for method chaining.
    Try it:
    text
    text()
    Getter for the text marker text settings.
    Returns:
    string - The text marker settings.
     See listing
    var textMarkerSettings = chart.textMarker();
var text = textMarkerSettings.text();
    text(text)
    Setter for the text marker text settings.
    Params:
    NameTypeDefaultDescription
    textstring
    'Text marker'
    		 Text to set.
    Returns:
    anychart.core.axisMarkers.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.axisMarkers.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.axisMarkers.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.axisMarkers.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.axisMarkers.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.axisMarkers.Text - Self instance for method chaining.
    Try it:
    textShadow
    textShadow()
    Getter for the text shadow.
    Returns:
    string - String representation of text shadow.
     See listing
    var textMarker = chart.textMarker();
var textShadow = textMarker.textShadow();
    textShadow(textShadow)
    Setter for the text shadow.
    Params:
    NameTypeDefaultDescription
    textShadowanychart.graphics.vector.TextShadow | string
    'none'
    		 Text shadow to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    useHtml
    useHtml()
    Getter for the useHTML flag.
    Returns:
    boolean - Value of useHTML flag.
     See listing
    var textMarker = chart.textMarker();
var useHtml = textMarker.useHtml();
    useHtml(enabled)
    Setter for flag useHTML.
    Params:
    NameTypeDefaultDescription
    enabledboolean
    false
    		 Enabled state to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    useHtml()
    Getter for the useHTML flag.
    Returns:
    boolean - Value of useHTML flag.
    useHtml(enabled)
    Setter for flag useHTML.
    Params:
    NameTypeDefaultDescription
    enabledboolean
    false
    		 Enabled state to set.
    Returns:
    anychart.core.axisMarkers.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.axisMarkers.Text - Self instance for method chaining.
    Try it:
    value
    value()
    Getter for the text marker value.
    Returns:
    number - The text marker value.
     See listing
    var textMarkerSettings = chart.textMarker();
var value = textMarkerSettings.value();
    value(value)
    Setter for the text marker value.
    Params:
    NameTypeDefaultDescription
    valuenumber
    0
    		 Text marker value to set
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    width
    width()
    Getter for the text marker width.
    Returns:
    number | string | null - The text marker width.
     See listing
    var textMarkerSettings = chart.textMarker();
var width = textMarkerSettings.width();
    width(width)
    Setter for the text marker width.
    Params:
    NameTypeDefaultDescription
    widthnumber | string
    null
    		 Text marker width to set.
    Returns:
    anychart.core.axisMarkers.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.axisMarkers.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.axisMarkers.Text - Self instance for method chaining.
    Try it:
    zIndex
    zIndex()
    Getter for the Z-index of the series.
    Returns:
    number - Chart Z-index.
     See listing
    var zIndex = series.zIndex();
    zIndex(zIndex)
    Setter for the Z-index of the series.
    Params:
    NameTypeDefaultDescription
    zIndexnumber
    30
    		 Z-index to set.
    Returns:
    anychart.core.axisMarkers.Text - Self instance for method chaining.
    Try it:
    AnyChart - Create interactive HTML5 charts easily for your web projects