class anychart.core.axisMarkers.GanttText Improve this Doc

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:

Name	Type	Default	Description
align	anychart.enums.Align \| string	'center'	Text marker align.

Returns:

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

Try it:

Usage sample

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:

Name	Type	Default	Description
anchor	anychart.enums.Anchor \| string	'auto'	Value to set.

Returns:

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

Try it:

Usage sample

background

background()Since version 8.3.0

Getter for the background.

Returns:

anychart.core.ui.Background - The text marker background.

Try it:

Usage sample

background(settings)Since version 8.3.0

Setter for the background.

Detailed description

Sets text marker background settings depending on parameter type:

null/boolean - disable or enable text marker background.
object - sets text marker background settings.
string - sets fill for the text marker background.

Params:

Name	Type	Default	Description
settings	string \| 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:

Usage sample

disablePointerEvents(enabled)

Setter for the pointer events.

Params:

Name	Type	Default	Description
enabled	boolean	false	Enabled state to set.

Returns:

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

Try it:

Usage sample

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

fontColor

fontColor()

Getter for the text font color.

Returns:

string - Font color.

Try it:

Usage sample

fontColor(color)

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

Params:

Name	Type	Default	Description
color	string	'#7c868e'	Value to set.

Returns:

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

Try it:

Usage sample

fontDecoration

fontDecoration()

Getter for the text font decoration.

Returns:

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

Try it:

Usage sample

fontDecoration(value)

Setter for the text font decoration.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.Decoration \| string	'none'	Font decoration to set.

Returns:

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

Try it:

Usage sample

fontFamily

fontFamily()

Getter for the font family.

Returns:

string - Font family.

Try it:

Usage sample

fontFamily(family)

Setter for the font family.

Params:

Name	Type	Default	Description
family	string	'Verdana', Helvetica, Arial, sans-serif	Font family to set.

Returns:

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

Try it:

Usage sample

fontOpacity

fontOpacity()

Getter for the text font opacity.

Returns:

number - Font opacity.

Try it:

Usage sample

fontOpacity(opacity)

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

Params:

Name	Type	Default	Description
opacity	number	1	Value to set.

Returns:

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

Try it:

Usage sample

Name	Type	Default	Description
size	string \| number	16	Font size to set.

fontStyle

fontStyle()

Getter for the text font style.

Returns:

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

Try it:

Usage sample

fontStyle(style)

Setter for the text font style.

Params:

Name	Type	Default	Description
style	anychart.graphics.vector.Text.FontStyle \| string	'normal'	Font style to set.

Returns:

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

Try it:

Usage sample

fontVariant

fontVariant()

Getter for the text font variant.

Returns:

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

Try it:

Usage sample

fontVariant(value)

Setter for the text font variant.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.FontVariant \| string	'normal'	Font variant to set.

Returns:

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

Try it:

Usage sample

fontWeight

fontWeight()

Getter for the text font weight.

Returns:

string | number - Font weight.

Try it:

Usage sample

fontWeight(weight)

Setter for the text font weight.
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.axisMarkers.GanttText - Self instance for method chaining.

Try it:

Usage sample

hAlign

hAlign()

Getter for the text horizontal align.

Returns:

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

Try it:

Usage sample

hAlign(align)

Setter for the text horizontal align.

Params:

Name	Type	Default	Description
align	anychart.graphics.vector.Text.HAlign \| string	'start'	Value to set.

Returns:

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

Try it:

Usage sample

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:

Name	Type	Default	Description
height	number \| string	null	Value to set.

Returns:

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

Try it:

Usage sample

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:

Name	Type	Default	Description
layout	anychart.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:

Usage sample

letterSpacing(spacing)

Setter for the text letter spacing.
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.axisMarkers.GanttText - Self instance for method chaining.

Try it:

Usage sample

lineHeight

lineHeight()

Getter for the text line height.

Returns:

string | number - Text line height.

Try it:

Usage sample

lineHeight(height)

Setter for the text line height.
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.axisMarkers.GanttText - Self instance for method chaining.

Try it:

Usage sample

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:

Name	Type	Default	Description
offset	number \| string	0	Value to set.

Returns:

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

Try it:

Usage sample

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:

Name	Type	Default	Description
offset	number \| string	0	Value to set.

Returns:

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

Try it:

Usage sample

padding

padding()Since version 8.3.0

Getter for the text marker padding.

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 text marker padding.

Try it:

Usage sample

padding(padding)Since version 8.3.0

Setter for the text marker padding in pixels by one value.

Params:

Name	Type	Description
padding	Array.<(number\|string)> \| Object	An array of field values to set.

Returns:

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

Try it:

Usage sample

padding(value1, value2, value3, value4)Since version 8.3.0

Setter for the text marker padding in pixels using several numbers.

Params:

Name	Type	Default	Description
value1	string \| number	5	Top or top-bottom space.
value2	string \| number	10	Right or right-left space.
value3	string \| number	5	Bottom space.
value4	string \| 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:

Usage sample

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.

Detailed description

If null is provided then rotation angle depends on layout: vertical = -90 degrees; horizontal = 0 degrees.

Params:

Name	Type	Default	Description
rotation	number	null	Value to set.

Returns:

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

Try it:

Usage sample

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:

Name	Type	Default	Description
scale	anychart.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:

Usage sample

selectable(enabled)

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
enabled	boolean	false	Enabled state to set.

Returns:

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

Try it:

Usage sample

text

text()Since version 7.9.0

Getter for the gantt text marker text setting.

Returns:

string - The gantt text setting.

Try it:

Usage sample

text(text)Since version 7.9.0

Setter for the gantt text marker text setting.

Params:

Name	Type	Description
text	string	Value to set.

Returns:

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

Try it:

Usage sample

textDirection

textDirection()

Getter for the text direction.

Returns:

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

Try it:

Usage sample

textDirection(direction)

Setter for the text direction.

Params:

Name	Type	Default	Description
direction	anychart.graphics.vector.Text.Direction \| string	'ltr'	Text direction to set.

Returns:

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

Try it:

Usage sample

textIndent

textIndent()

Getter for the text indent.

Returns:

number - Text indent.

Try it:

Usage sample

textIndent(indent)

Setter for the text indent.

Params:

Name	Type	Default	Description
indent	number	0	Text indent to set.

Returns:

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

Try it:

Usage sample

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:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.TextOverflow \| string	""	Text overflow settings to set.

Returns:

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

Try it:

Usage sample

textSettings

textSettings()

Getter for the full text appearance settings.

Returns:

Object - A copy of settings object.

Try it:

Usage sample

textSettings(name)

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 settings.

Try it:

Usage sample

textSettings(objectWithSettings)

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, 'wordWrap': smth, 'wordBreak': smth, 'textOverflow': smth, 'selectable': smth, 'useHtml': smth 'textShadow':smth }

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

Try it:

Usage sample

textSettings(name, settings)

Setter for the text appearance settings.

Detailed description

Overrides text setting Value by its Name.

Params:

Name	Type	Description
name	string	Setting name.
settings	string \| number \| boolean \| function	Text settings.

Returns:

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

Try it:

Usage sample

useHtml

useHtml()

Getter for the useHTML flag.

Returns:

boolean - Value of useHTML flag.

Try it:

Usage sample

useHtml(enabled)

Setter for flag useHTML.

Detailed description

This property defines whether HTML text should be parsed.

Params:

Name	Type	Default	Description
enabled	boolean	false	Enabled state to set.

Returns:

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

Try it:

Usage sample

vAlign

vAlign()

Getter for the text vertical align.

Returns:

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

Try it:

Usage sample

vAlign(align)

Setter for the text vertical align.

Params:

Name	Type	Default	Description
align	anychart.graphics.vector.Text.VAlign \| string	'top'	Value to set.

Returns:

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

Try it:

Usage sample

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:

Name	Type	Description
value	number \| anychart.enums.GanttDateTimeMarkers \| string	Text 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();