class anychart.core.gantt.TimeLineHeader Improve this Doc

Extends: anychart.core.VisualBaseWithBounds

Resource Chart Timeline element.

Methods Overview

Specific Settings
level()	Level option.
Specific settings
drawBottomLine()	Drawing of the bottom line.
drawLeftLine()	Drawing of the left line.
drawRightLine()	Drawing of the right line.
drawTopLine()	Drawing of the top line.
format()	Function to format content text.
holidays()	Padding settings
overlay()	Overlay element.
Advanced Text Settings
maxFontSize()	Maximum font size settings.
minFontSize()	Minimum font size settings.
Coloring
background()	Background settings.
fill()	Fill settings.
stroke()	Stroke settings.
Content Text Settings
useHtml()	Use HTML option.
vAlign()	Text vertical align settings.
Interactivity
enabled()	Element state (enabled or disabled).
Size and Position
bottom()	Bottom bound settings.
getPixelBounds()	Returns pixel bounds.
height()	Height settings.
left()	Left bound settings.
maxHeight()	Maximum height.
maxWidth()	Maximum width.
minHeight()	Minimum height.
minWidth()	Minimum width.
padding()	Padding settings
right()	Right bound settings.
top()	Top bound settings.
width()	Width settings.
zIndex()	Z-index of the element.
Text Settings
adjustFontSize()	Adjusting settings.
disablePointerEvents()	Pointer events settings.
fontColor()	Font color settings.
fontDecoration()	Font decoration setting.
fontFamily()	Font family settings.
fontOpacity()	Font opacity settings.
fontSize()	Font size settings.
fontStyle()	Font style settings.
fontVariant()	Font variant settings.
fontWeight()	Font weight settings.
hAlign()	Text horizontal align settings.
letterSpacing()	Text letter spacing settings.
lineHeight()	Text line height setting.
selectable()	Text selectable option.
textDirection()	Text direction settings.
textIndent()	Text indent settings.
textOverflow()	Text overflow settings.
textShadow()	Text shadow settings.
wordBreak()	Word break mode.
wordWrap()	Word-wrap mode.
Miscellaneous
levelHeight()	Getter for the level height.

Methods Description

adjustFontSize

adjustFontSize()Since version 8.2.0

Getter for the adjusting font size.

Detailed description

Returns an array of two elements [isAdjustByWidth, isAdjustByHeight].

[false, false] - do not adjust (adjust is off )
[true, false] - adjust width
[false, true] - adjust height
[true, true] - adjust the first suitable value.

Returns:

number - An adjusted font size.

See listing

var timeLine = chart.timeLine();
var adjustFontSize = timeLine.adjustFontSize();

adjustFontSize(adjustOrAdjustByWidth, adjustByHeight)Since version 8.2.0

Setter for the adjusting font size.

Detailed description

Minimal and maximal font sizes can be configured using: anychart.core.gantt.TimeLineHeader#minFontSize and anychart.core.gantt.TimeLineHeader#maxFontSize methods.
Note: anychart.core.gantt.TimeLineHeader#fontSize does not work when adjusting is enabled.

Params:

Name	Type	Description
adjustOrAdjustByWidth	boolean \| Array.<boolean> \| Object	Is font needs to be adjusted in case of 1 argument and adjusted by width in case of 2 arguments.
adjustByHeight	boolean	Is font needs to be adjusted by height.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

background

background()Since version 8.2.0

Getter for the background.

Returns:

anychart.core.ui.Background - Background settings.

Try it:

Usage sample

background(settings)Since version 8.2.0

Setter for the background.

Detailed description

Sets background settings depending on parameter type:

null/boolean - disable or enable background.
object - sets background settings.
string - sets background color.

Params:

Name	Type	Description
settings	string \| Object \| null \| boolean	Background settings to set

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

bottom

bottom()

Getter for element bottom bound settings.

Returns:

number | string | undefined - Element's bottom bound setting.

bottom(bottom)

Setter for element bottom bound settings.

Params:

Name	Type	Default	Description
bottom	number \| string \| null	null	Bottom bound settings for the element.

Returns:

anychart.core.gantt.TimeLineHeader - Returns self for method chaining.

Try it:

Usage sample

disablePointerEvents

disablePointerEvents()Since version 8.2.0

Getter for the pointer events settings.

Returns:

boolean - The pointer events settings.

See listing

var timeLine = chart.getTimeline();
var disablePointerEvents = timeLine.disablePointerEvents();

disablePointerEvents(enabled)Since version 8.2.0

Setter for the pointer events setting.

Params:

Name	Type	Default	Description
enabled	boolean	false	Value to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

drawBottomLine

drawBottomLine()Since version 8.2.0

Getter for the bottom line drawing flag.

Returns:

boolean - Drawing flag.

See listing

var timeline = chart.getTimeline();
var flag = timeline.drawBottomLine();

drawBottomLine(enabled)Since version 8.2.0

Setter for the bottom line drawing flag.

Params:

Name	Type	Default	Description
enabled	boolean	false	Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

Try it:

Usage sample

drawLeftLine

drawLeftLine()Since version 8.2.0

Getter for the left line drawing flag.

Returns:

boolean - Drawing flag.

See listing

var timeline = chart.getTimeline();
var flag = timeline.drawLeftLine();

drawLeftLine(enabled)Since version 8.2.0

Setter for the left line drawing flag.

Params:

Name	Type	Default	Description
enabled	boolean	false	Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

Try it:

Usage sample

drawRightLine

drawRightLine()Since version 8.2.0

Getter for the right line drawing flag.

Returns:

boolean - Drawing flag.

See listing

var timeline = chart.timeline();
var flag = timeline.drawRightLine();

drawRightLine(enabled)Since version 8.2.0

Setter for the right line drawing flag.

Params:

Name	Type	Default	Description
enabled	boolean	false	Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

Try it:

Usage sample

drawTopLine

drawTopLine()Since version 8.2.0

Getter for the top line drawing flag.

Returns:

boolean - Drawing flag.

See listing

var timeline = chart.timeline();
var flag = timeline.drawTopLine();

drawTopLine(enabled)Since version 8.2.0

Setter for the top line drawing flag.

Params:

Name	Type	Default	Description
enabled	boolean	false	Value to set.

Returns:

anychart.core.resource.Grid - 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

enabled(enabled)

Setter for the element enabled state.

Params:

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

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

fill

fill()Since version 8.2.0

Getter for the fill color.

Returns:

anychart.graphics.vector.Fill - The fill color.

See listing

var timeLine = chart.timeLine();
var fill = timeLine.fill();

fill(color)Since version 8.2.0

Setter for fill settings using an array or a string. Learn more about coloring.

Params:

Name	Type	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	Color as an object, an array or a string.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

fill(color, opacity)Since version 8.2.0

Fill color with opacity.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

Name	Type	Description
color	string	Color as a string.
opacity	number	Color opacity.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

fill(keys, angle, mode, opacity)Since version 8.2.0

Linear gradient fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Gradient keys.
angle	number	Gradient angle.
mode	boolean \| anychart.graphics.vector.Rect \| Object	Gradient mode.
opacity	number	Gradient opacity.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)Since version 8.2.0

Radial gradient fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Color-stop gradient keys.
cx	number	X ratio of center radial gradient.
cy	number	Y ratio of center radial gradient.
mode	anychart.graphics.math.Rect	If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity	number	Opacity of the gradient.
fx	number	X ratio of focal point.
fy	number	Y ratio of focal point.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

fill(imageSettings)Since version 8.2.0

Image fill. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

fontColor

fontColor()Since version 8.2.0

Getter for font color settings.

Returns:

string - Font color settings.

See listing

var timeLine = chart.getTimeline();
var fontColor = timeLine.fontColor();

fontColor(color)Since version 8.2.0

Setter for font color settings.

Params:

Name	Type	Description
color	string	Font color to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

fontDecoration

fontDecoration()Since version 8.2.0

Getter for font decoration settings.

Returns:

anychart.graphics.vector.Text.Decoration - Font decoration settings.

See listing

var timeLine = chart.getTimeline();
var fontDecoration = timeLine.fontDecoration();

fontDecoration(type)Since version 8.2.0

Setter for font decoration settings.

Params:

Name	Type	Description
type	anychart.graphics.vector.Text.Decoration \| string	Font decoration to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

fontFamily

fontFamily()Since version 8.2.0

Getter for font family settings.

Returns:

string - Font family settings.

See listing

var timeLine = chart.getTimeline();
var fontFamily = timeLine.fontFamily();

fontFamily(fontFamily)Since version 8.2.0

Setter for font family settings.

Params:

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

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

fontOpacity

fontOpacity()Since version 8.2.0

Getter for font opacity settings.

Returns:

number - Font opacity settings.

See listing

var timeLine = chart.getTimeline();
var fontOpacity = timeLine.fontOpacity();

fontOpacity(opacity)Since version 8.2.0

Setter for font opacity settings.

Params:

Name	Type	Description
opacity	number	Font opacity to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

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

fontStyle

fontStyle()Since version 8.2.0

Getter for font style settings.

Returns:

anychart.graphics.vector.Text.FontStyle - Font style settings.

See listing

var timeLine = chart.getTimeline();
var fontStyle = timeLine.fontStyle();

fontStyle(style)Since version 8.2.0

Setter for font style settings.

Params:

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

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

fontVariant

fontVariant()Since version 8.2.0

Getter for font variant settings.

Returns:

anychart.graphics.vector.Text.FontVariant - Font variant settings.

See listing

var timeLine = chart.getTimeline();
var fontVariant = timeLine.fontVariant();

fontVariant(type)Since version 8.2.0

Setter for font variant settings.

Params:

Name	Type	Description
type	string \| anychart.graphics.vector.Text.FontVariant	Font variant to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

fontWeight

fontWeight()Since version 8.2.0

Getter for font weight settings.

Returns:

string | number - Font weight settings.

See listing

var timeLine = chart.getTimeline();
var fontWeight = timeLine.fontWeight();

fontWeight(weight)Since version 8.2.0

Setter for font weight settings.

Params:

Name	Type	Description
weight	string \| number	Font weight to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

format

format()Since version 8.2.0

Getter for the function content text.

Returns:

function | string - Token or function to format text.

See listing

var format = timeLine.format();

format(format)Since version 8.2.0

Setter for the function content text.
Learn more about using the format() method.

Params:

Name	Type	Description
format	function \| string	Function or string token to format content text.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

getPixelBounds

getPixelBounds()

Returns pixel bounds of the element due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the element.

hAlign

hAlign()Since version 8.2.0

Getter for text horizontal align settings.

Returns:

anychart.graphics.vector.Text.HAlign - Horizontal align settings.

See listing

var timeLine = chart.getTimeline();
var hAlign = timeLine.hAlign();

hAlign(align)Since version 8.2.0

Setter for the text horizontal align settings.

Params:

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

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

height

height()

Getter for element height settings.

Returns:

number | string | undefined - Element's height setting.

height(height)

Setter for element height setting.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Height settings for the element.

Returns:

anychart.core.gantt.TimeLineHeader - Returns self for method chaining.

Try it:

Usage sample

holidays

holidays()Since version 8.2.0

Getter for holidays.

Returns:

anychart.core.gantt.TimeLineHeaderLevelHolidaysSettings - Holidays settings.

holidays(settings)Since version 8.2.0

Setter for holidays settings.

Params:

Name	Type	Description
settings	Object	Value to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

left

left()

Getter for element left bound settings.

Returns:

number | string | undefined - Element's left bound setting.

left(left)

Setter for element left bound settings.

Params:

Name	Type	Default	Description
left	number \| string \| null	null	Left bound setting for the element.

Returns:

anychart.core.gantt.TimeLineHeader - Returns self for method chaining.

Try it:

Usage sample

letterSpacing

letterSpacing()Since version 8.2.0

Getter for text letter spacing settings.

Returns:

number - Letter spacing settings.

See listing

var timeLine = chart.getTimeline();
var letterSpacing = timeLine.letterSpacing();

letterSpacing(spacing)Since version 8.2.0

Setter for text letter spacing settings.

Params:

Name	Type	Description
spacing	number \| string	Letter spacing to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

level

level(index)Since version 8.2.0

Getter for level settings.

Params:

Name	Type	Default	Description
index	number	0	Level index.

Returns:

anychart.core.gantt.TimeLineHeader.LevelWrapper - Level settings

Try it:

Usage sample

level(settings)Since version 8.2.0

Setter for level settings.

Detailed description

Sets level settings depending on parameter type:

null/boolean - disable or enable level.
object - sets level settings.

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null	true	Level settings from anychart.core.gantt.TimeLineHeader.LevelWrapper

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

level(index, settings)Since version 8.2.0

Setter for level settings by index.

Detailed description

Sets level settings depending on parameter type:

null/boolean - disable or enable level by index.
object - sets level settings by index.

Params:

Name	Type	Default	Description
index	number	0	Level index.
settings	Object \| boolean \| null	true	Level settings from anychart.core.gantt.TimeLineHeader.LevelWrapper

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

levelHeight

levelHeight()Since version 8.2.0

Getter for the level height.

Returns:

number - The level height.

See listing

var header = timeline.header();
var levelHeight = header.levelHeight();

levelHeight(height)Since version 8.2.0

Setter for the level height.

Params:

Name	Type	Description
height	number	Level height.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

lineHeight

lineHeight()Since version 8.2.0

Getter for text line height settings.

Returns:

number | string - Line height settings.

See listing

var timeLine = chart.getTimeline();
var lineHeight = timeLine.lineHeight();

lineHeight(height)Since version 8.2.0

Setter for text line height settings.

Params:

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

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

maxFontSize

maxFontSize()Since version 8.2.0

Getter for the maximum font size.

Returns:

number - Maximum font size.

See listing

var maxFontSize = timeLine.maxFontSize();

maxFontSize(size)

Setter for the maximum font size.

Detailed description

Note: works only when adjusting is enabled. Look anychart.core.gantt.TimeLineHeader#adjustFontSize.

Params:

Name	Type	Description
size	number \| string	Maximum font size to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

maxHeight

maxHeight()

Getter for the maximum height.

Returns:

number | string | null - Element's maximum height.

maxHeight(height)

Setter for the maximum height.

Params:

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

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

maxWidth

maxWidth()

Getter for the maximum width.

Returns:

number | string | null - Element's maximum width.

maxWidth(width)

Setter for the maximum width.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Maximum width to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

minFontSize

minFontSize()Since version 8.2.0

Getter for the minimum font size.

Returns:

number - Minimum font size.

See listing

var minFontSize = timeLine.minFontSize();

minFontSize(size)

Setter for the minimum font size.

Detailed description

Note: works only when adjusting is enabled. Look anychart.core.gantt.TimeLineHeader#adjustFontSize.

Params:

Name	Type	Description
size	number \| string	Minimum font size to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

minHeight

minHeight()

Getter for the minimum height.

Returns:

number | string | null - Element's minimum height.

minHeight(height)

Setter for the minimum height.

Detailed description

The method sets a minimum height of elements, that will be to remain after a resize of element.

Params:

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

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

minWidth

minWidth()

Getter for the minimum width.

Returns:

number | string | null - Element's minimum width.

minWidth(width)

Setter for the minimum width.

Detailed description

The method sets a minimum width of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Minimum width to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

overlay

overlay()Since version 8.2.0

Getter for the overlay element.

Returns:

anychart.core.gantt.Overlay - Overlay element.

See listing

var element = timeLine.overlay();

overlay(settings)Since version 8.2.0

Setter for the overlay element.

Params:

Name	Type	Description
settings	Object \| null \| boolean	Value to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

padding

padding()Since version 8.2.0

Getter for the padding.

Returns:

anychart.core.utils.Padding - Padding.

Try it:

Usage sample

padding(padding)Since version 8.2.0

Setter for paddings in pixels using a single value.

Params:

Name	Type	Description
padding	null \| Array.<(number\|string)> \| Object	Value to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Examples for paddings

// all paddings 15px
timeLine.padding(15);
// all paddings 15px
timeLine.padding('15px');
// top and bottom 5px ,right and left 15px
timeLine.padding(anychart.utils.padding(5,15));

Try it:

Usage sample

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

Setter for paddings in pixels using several numbers.

Params:

Name	Type	Description
value1	string \| number	Top or top-bottom space.
value2	string \| number	Right or right-left space.
value3	string \| number	Bottom space.
value4	string \| number	Left space.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Examples for paddings

// 1) top and bottom 10px, left and right 15px
timeLine.padding(10, '15px');
// 2) top 10px, left and right 15px, bottom 5px
timeLine.padding(10, '15px', 5);
// 3) top 10px, right 15px, bottom 5px, left 12px
timeLine.padding(10, '15px', '5px', 12);

Try it:

Usage sample

right

right()

Getter for element right bound settings.

Returns:

number | string | undefined - Element's right bound setting.

right(right)

Setter for element right bound setting.

Params:

Name	Type	Default	Description
right	number \| string \| null	null	Right bound setting for the element.

Returns:

anychart.core.gantt.TimeLineHeader - Returns self for method chaining.

Try it:

Usage sample

selectable

selectable()Since version 8.2.0

Getter for the text selectable option.

Returns:

boolean - Text selectable value.

See listing

var timeLine = chart.getTimeline();
var selectable = timeLine.selectable();

selectable(enabled)Since version 8.2.0

Setter for the text selectable option.

Params:

Name	Type	Default	Description
enabled	boolean	false	Value to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

stroke

stroke()Since version 8.2.0

Getter for the stroke.

Returns:

anychart.graphics.vector.Stroke - The stroke.

See listing

var timeLine = chart.timeLine();
var stroke = timeLine.stroke();

stroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 8.2.0

Setter for the stroke. Learn more about stroke settings.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null		Stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	string \| anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	string \| anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

stroke(settings)

Setter for stroke settings using an object.

Params:

Name	Type	Description
settings	Object	Object with stroke settings from anychart.graphics.vector.Stroke

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

textDirection

textDirection()Since version 8.2.0

Getter for the text direction settings.

Returns:

anychart.graphics.vector.Text.Direction - Text direction settings.

See listing

var timeLine = chart.getTimeline();
var textDirection = timeLine.textDirection();

textDirection(type)Since version 8.2.0

Setter for text direction settings.

Params:

Name	Type	Description
type	string \| anychart.graphics.vector.Text.Direction	Value to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

textIndent

textIndent()

Getter for text-indent settings.

Returns:

number - Text indent settings.

See listing

var timeLine = chart.getTimeline();
var textIndent = timeLine.textIndent();

textIndent(indent)Since version 8.2.0

Setter for text-indent settings.

Params:

Name	Type	Description
indent	number	Value to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

textOverflow

textOverflow()Since version 8.2.0

Getter for text overflow settings.

Returns:

anychart.graphics.vector.Text.TextOverflow - Text overflow settings

See listing

var timeLine = chart.getTimeline();
var textOverflow = timeLine.textOverflow();

textOverflow(value)Since version 8.2.0

Setter for text overflow settings.

Params:

Name	Type	Description
value	anychart.graphics.vector.Text.TextOverflow \| string	Value to set

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

textShadow

textShadow()Since version 8.7.2

Getter for text shadow settings.

Returns:

string - String representation of text shadow.

See listing

var timeLine = chart.getTimeline();
var textShadow = timeLine.textShadow();

textShadow(textShadow)Since version 8.7.2

Setter for the text shadow settings.

Params:

Name	Type	Default	Description
textShadow	anychart.graphics.vector.TextShadow \| string	'none'	Text shadow to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

top

top()

Getter for element top bound settings.

Returns:

number | string | undefined - Element's top bound setting.

top(top)

Setter for element top bound settings.

Params:

Name	Type	Default	Description
top	number \| string \| null	null	Top bound setting for the element.

Returns:

anychart.core.gantt.TimeLineHeader - Returns self for method chaining.

Try it:

Usage sample

useHtml

useHtml()Since version 8.2.0

Getter for the useHTML flag.

Returns:

boolean - UseHTML flag.

See listing

var timeLine = chart.getTimeline();
var useHtml = timeLine.useHtml();

useHtml(enabled)Since version 8.2.0

Setter for the useHTML flag.

Params:

Name	Type	Description
enabled	boolean	Value to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

vAlign

vAlign()Since version 8.2.0

Getter for text vertical align settings.

Returns:

anychart.graphics.vector.Text.VAlign - Vertical align.

See listing

var timeLine = chart.getTimeline();
var vAlign = timeLine.vAlign();

vAlign(align)Since version 8.2.0

Setter for text vertical align settings.

Params:

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

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample

width

width()

Getter for element width settings.

Returns:

number | string | undefined - Element's width setting.

width(width)

Setter for element width setting.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Width settings for the element.

Returns:

anychart.core.gantt.TimeLineHeader - Returns self for method chaining.

Try it:

Usage sample

wordBreak

wordBreak()Since version 8.0.0

Getter for the word-break mode.

Returns:

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

See listing

var wordWrap = timeLine.wordBreak();

wordBreak(type)Since version 8.0.0

Setter for the word-break mode.

Params:

Name	Type	Default	Description
type	anychart.enums.WordBreak \| string	'normal'	Value to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

See listing

timeLine.wordBreak('break-all');

wordWrap

wordWrap()Since version 8.0.0

Getter for the word-wrap mode.

Returns:

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

See listing

var wordWrap = timeLine.wordWrap();

wordWrap(type)Since version 8.0.0

Setter for the word-wrap mode.

Params:

Name	Type	Default	Description
type	anychart.enums.WordWrap \| string	'normal'	Value to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

See listing

timeLine.wordWrap('break-word');

zIndex

zIndex()

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Usage sample

zIndex(zIndex)

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
zIndex	number	0	Value to set.

Returns:

anychart.core.gantt.TimeLineHeader - Self instance for method chaining.

Try it:

Usage sample