AnyChart
API Reference
Still have questions?
Contact support
    Top

    class anychart.core.axisMarkers.GanttText Improve this Doc

    Extends: anychart.core.Text

    Gantt text marker.

    Methods Overview

    Specific settings
    scale()Scale settings.
    text()Text settings.
    value()Text marker value settings.
    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.
    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.
    rotation()Rotation settings.
    width()Text marker width.
    zIndex()Z-index of the element.
    Text Settings
    textSettings()Text settings.

    Methods Description

    align

    align()Since version 7.9.0

    Getter for the gantt text marker align.

    Returns:

    anychart.enums.Align | string - The gantt text marker align.
    See listing
    var timeLine = chart.getTimeline();
var customTextMarker = timeLine.textMarker();
customTextMarker.value('2000-02-27 00:00:00');
var align = customTextMarker.align();

    align(align)Since version 7.9.0

    Setter for the gantt text marker align.

    Params:

    NameTypeDefaultDescription
    alignanychart.enums.Align | string
    'center'
    		 Text marker align.

    Returns:

    anychart.core.axisMarkers.GanttText - Self instance for method chaining.

    Try it:

    anchor

    anchor()Since version 7.9.0

    Getter for the text marker anchor settings.

    Returns:

    anychart.enums.Anchor | string - Text marker anchor settings.
    See listing
    var timeLine = chart.getTimeline();
var customTextMarker = timeLine.textMarker();
customTextMarker.value('2000-02-27 00:00:00');
var anchor = customTextMarker.anchor();

    anchor(anchor)Since version 7.9.0

    Setter for the text marker anchor settings.

    Params:

    NameTypeDefaultDescription
    anchoranychart.enums.Anchor | string
    'auto'
    		 Value to set.

    Returns:

    anychart.core.axisMarkers.GanttText - 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.GanttText - 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.GanttText - 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.GanttText - 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.axisMarkers.GanttText - 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.GanttText - 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.GanttText - 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.axisMarkers.GanttText - 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.axisMarkers.GanttText - 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.GanttText - 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.GanttText - 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.GanttText - 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.axisMarkers.GanttText - Self instance for method chaining.

    Try it:

    height

    height()Since version 7.9.0

    Getter for the text marker height.

    Returns:

    number | string | null - The text marker height.
    See listing
    var timeLine = chart.getTimeline();
var customTextMarker = timeLine.textMarker();
customTextMarker.value('2000-02-27 00:00:00');
var height = customTextMarker.height();

    height(height)Since version 7.9.0

    Setter for the text marker height.

    Params:

    NameTypeDefaultDescription
    heightnumber | string
    null
    		 Value to set.

    Returns:

    anychart.core.axisMarkers.GanttText - Self instance for method chaining.

    Try it:

    isHorizontal

    isHorizontal()Since version 7.9.0

    Whether a text marker has horizontal layout.
    Note: Any type of Gantt diagram will return "false", because markers in Gantt charts can be only vertical.
    Layout is defined by anychart.core.axisMarkers.GanttLine#layout method.

    Returns:

    boolean - Returns false, because markers in Gantt charts can be only vertical.

    layout

    layout()Since version 7.9.0

    Getter for the gantt text marker layout.

    Returns:

    anychart.enums.Layout | string - Vertical layout.
    See listing
    var timeLine = chart.getTimeline();
var customTextMarker = timeLine.textMarker();
customTextMarker.value('2000-02-27 00:00:00');
var layoutSettings = customTextMarker.layout();

    layout(layout)Since version 7.9.0

    Setter for the text marker layout.
    Note: The layout method will not work here, only 'vertical' layout are available in Gantt Chart.

    Params:

    NameTypeDefaultDescription
    layoutanychart.enums.Layout | string
    'vertical'
    		 Text marker layout.

    Returns:

    anychart.core.axisMarkers.GanttText - Self instance for method chaining.

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

    Try it:

    offsetX

    offsetX()Since version 7.9.0

    Getter for the text marker offset by x.

    Returns:

    number | string - The text marker offset by x.
    See listing
    var timeLine = chart.getTimeline();
var customTextMarker = timeLine.textMarker();
customTextMarker.value('2000-02-27 00:00:00');
var offsetX = customTextMarker.offsetX();

    offsetX(offset)Since version 7.9.0

    Setter for the text marker offset by x.

    Params:

    NameTypeDefaultDescription
    offsetnumber | string
    0
    		 Value to set.

    Returns:

    anychart.core.axisMarkers.GanttText - Self instance for method chaining.

    Try it:

    offsetY

    offsetY()Since version 7.9.0

    Getter for the text marker offset by y.

    Returns:

    number | string - The text marker offset by y.
    See listing
    var timeLine = chart.getTimeline();
var customTextMarker = timeLine.textMarker();
customTextMarker.value('2000-02-27 00:00:00');
var offsetY = customTextMarker.offsetY();

    offsetY(offset)Since version 7.9.0

    Setter for the text marker offset by y.

    Params:

    NameTypeDefaultDescription
    offsetnumber | string
    0
    		 Value to set.

    Returns:

    anychart.core.axisMarkers.GanttText - 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.GanttText - 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.GanttText - 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:

    rotation

    rotation()Since version 7.9.0

    Getter for the gantt text marker rotation in degrees.

    Returns:

    null | number - The gantt text marker rotation.
    See listing
    var timeLine = chart.getTimeline();
var customTextMarker = timeLine.textMarker();
customTextMarker.value('2000-02-27 00:00:00');
var rotation = customTextMarker.rotation();

    rotation(rotation)Since version 7.9.0

    Setter for the gantt text marker rotation.

    Params:

    NameTypeDefaultDescription
    rotationnumber
    null
    		 Value to set.

    Returns:

    anychart.core.axisMarkers.GanttText - Self instance for method chaining.

    Try it:

    scale

    scale()Since version 7.9.0

    Getter for the gantt text marker scale.

    Returns:

    anychart.scales.GanttDateTime - The gantt text marker scale.
    See listing
    var timeLine = chart.getTimeline();
var customTextMarker = timeLine.textMarker();
customTextMarker.value('2000-02-27 00:00:00');
var scaleSettings = customTextMarker.scale();

    scale(scale)Since version 7.9.0

    Getter for the gantt text marker scale.
    Note: The scale method will not work here, only 'dateTime' scale are available in Gantt Chart. Learn more about scale.

    Params:

    NameTypeDefaultDescription
    scaleanychart.scales.GanttDateTime
    anychart.scales.GanttDateTime
    		 Scale.

    Returns:

    anychart.core.axisMarkers.GanttText - Self instance for method chaining.

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

    Try it:

    text

    text()Since version 7.9.0

    Getter for the gantt text marker text setting.

    Returns:

    string - The gantt text setting.

    Try it:

    text(text)Since version 7.9.0

    Setter for the gantt text marker text setting.

    Params:

    NameTypeDescription
    textstringValue to set.

    Returns:

    anychart.core.axisMarkers.GanttText - 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.GanttText - 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.GanttText - 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.GanttText - 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.GanttText - 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.GanttText - 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.axisMarkers.GanttText - 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.GanttText - Self instance for method chaining.

    Try it:

    value

    value()Since version 7.9.0

    Getter for the gantt text marker value.

    Returns:

    number | anychart.enums.GanttDateTimeMarkers | string - The gantt text marker value.
    See listing
    var timeLine = chart.getTimeline();
var customTextMarker = timeLine.textMarker();
var value = customTextMarker.value();

    value(value)Since version 7.9.0

    Setter for the gantt text marker value.

    Params:

    NameTypeDescription
    valuenumber | anychart.enums.GanttDateTimeMarkers | stringText marker value settings.

    Returns:

    anychart.core.axisMarkers.GanttText - Self instance for method chaining.

    Try it:

    width

    width()Since version 7.9.0

    Getter for the text marker width.

    Returns:

    number | string | null - The text marker width.
    See listing
    var timeLine = chart.getTimeline();
var customTextMarker = timeLine.textMarker();
customTextMarker.value('2000-02-27 00:00:00');
var width = customTextMarker.width();

    width(width)Since version 7.9.0

    Setter for the text marker width.

    Params:

    NameTypeDefaultDescription
    widthnumber | string
    null
    		 Value to set.

    Returns:

    anychart.core.axisMarkers.GanttText - 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.GanttText - 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.GanttText - 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.axisMarkers.GanttText - Self instance for method chaining.

    Try it: