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.
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.
vAlign()	Text vertical align 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
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.
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(value)Since version 7.9.0

Setter for the gantt text marker align.

Params:

Name	Type	Default	Description
value	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(value)Since version 7.9.0

Setter for the text marker anchor settings.

Params:

Name	Type	Default	Description
value	anychart.enums.Anchor \| string	"center"	Value to set.

Returns:

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

Try it:

Usage sample

disablePointerEvents

disablePointerEvents()

Getter for the current pointer events.

Returns:

boolean - Flag of the current state.

Try it:

Usage sample

disablePointerEvents(value)

Setter for the pointer events.

Params:

Name	Type	Default	Description
value	boolean	false	Value to set.

Returns:

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

Try it:

Usage sample

enabled

enabled()

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.

Try it:

Usage sample

Name	Type	Default	Description
value	boolean	true	Value to set.

fontColor

fontColor()

Getter for the text font color.

Returns:

string - The current font color.

Try it:

Usage sample

fontColor(value)

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

Params:

Name	Type	Default	Description
value	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 - The current 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"	Value to set.

Returns:

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

Try it:

Usage sample

fontFamily

fontFamily()

Getter for the current font family.

Returns:

string - The current font family.

Try it:

Usage sample

fontFamily(value)

Setter for font family.

Params:

Name	Type	Default	Description
value	string	"Verdana", Helvetica, Arial, sans-serif	Value 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 - The current font opacity.

Try it:

Usage sample

fontOpacity(value)

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

Try it:

Usage sample

Name	Type	Default	Description
value	string \| number	16	Value to set.

fontStyle

fontStyle()

Getter for the text font style.

Returns:

anychart.graphics.vector.Text.FontStyle | string - The current font style.

Try it:

Usage sample

fontStyle(value)

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.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 - The current 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"	Value 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 - The current font weight.

Try it:

Usage sample

fontWeight(value)

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

Params:

Name	Type	Default	Description
value	string \| number	"normal"	Value 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 - The current text horizontal align.

Try it:

Usage sample

hAlign(value)

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.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(value)Since version 7.9.0

Setter for the text marker height.

Params:

Name	Type	Default	Description
value	number \| string \| null	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(value)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
value	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 - The current letter spacing.

Try it:

Usage sample

letterSpacing(value)

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

Try it:

Usage sample

lineHeight

lineHeight()

Getter for the text line height.

Returns:

string | number - The current text line height.

Try it:

Usage sample

lineHeight(value)

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

Try it:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

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.

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:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

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

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:

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(value)Since version 7.9.0

Setter for the text marker offset by x.

Params:

Name	Type	Default	Description
value	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(value)Since version 7.9.0

Setter for the text marker offset by y.

Params:

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

Returns:

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

Try it:

Usage sample

print

print(paperSizeOrOptions, landscape)

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:

Usage sample

removeAllListeners

removeAllListeners(type)

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:

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(value)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
value	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(value)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	Description
value	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 current text selectable option.

Try it:

Usage sample

selectable(value)

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.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(value)Since version 7.9.0

Setter for the gantt text marker text setting.

Params:

Name	Type	Description
value	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 - Current text direction.

Try it:

Usage sample

textDirection(value)

Setter for the text direction.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.Direction \| string	"ltr"	Value 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 - The current text indent.

Try it:

Usage sample

textIndent(value)

Setter for the text indent.

Params:

Name	Type	Default	Description
value	number	0	Value 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 - The current text overflow settings.

Try it:

Usage sample

textOverflow(value)

Setter for the text overflow settings.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.TextOverflow \| string	""	Value 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 the setting.

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, "textWrap": smth, "textOverflow": smth, "selectable": smth, "useHtml": smth }`.

Returns:

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

Try it:

Usage sample

textSettings(name, value)

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

Try it:

Usage sample

textWrap

textWrap()

Getter for the text wrap settings.

Returns:

anychart.graphics.vector.Text.TextWrap | string - The current text wrap settings.

Try it:

Usage sample

textWrap(value)

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

Try it:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

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:

Usage sample

unlistenByKey

unlistenByKey(key)

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:

Usage sample

useHtml

useHtml()

Getter for the useHTML flag.

Returns:

boolean - The current value of useHTML flag.

Try it:

Usage sample

useHtml(value)

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.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 - The current text vertical align.

Try it:

Usage sample

vAlign(value)

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.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();

width(value)Since version 7.9.0

Setter for the text marker width.

Params:

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

Returns:

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

Try it:

Usage sample

zIndex

zIndex()

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Usage sample

zIndex(value)

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

Try it:

Usage sample

class anychart.core.axisMarkers.GanttText Improve this Doc

Methods Overview

Methods Description

align

anchor

disablePointerEvents

enabled

fontColor

fontDecoration

fontFamily

fontOpacity

fontSize

fontStyle

fontVariant

fontWeight

hAlign

height

isHorizontal

layout

letterSpacing

lineHeight

listen

listenOnce

offsetX

offsetY

print

removeAllListeners

rotation

scale

selectable

text

textDirection

textIndent

textOverflow

textSettings

textWrap

unlisten

unlistenByKey

useHtml

vAlign

value

width

zIndex