AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.charts.Gantt Improve this Doc

Extends: anychart.core.SeparateChart

Gantt chart class.

Methods Overview

Specific settings
getTimeline()Getter for the timeline.
getType()Definition of the chart type.
globalToLocal()Converts the global coordinates to local coordinates.
localToGlobal()Converts the local coordinates to global coordinates.
Axes and Scales
xScale()X-scale settings.
Chart Coloring
background()Background settings.
palette()Palette settings.
Chart Controls
contextMenu()Context menu settings.
credits()Credits settings
dataGrid()Data grid settings.
label()Label settings.
legend()Legend settings.
title()Title settings.
Coloring
columnStroke()Column stroke settings.
rowHoverFill()Row fill settings in hover mode.
rowSelectedFill()Fill settings for selected row.
rowStroke()Row stroke settings.
Data
data()Data settings.
getSelectedPoints()Getter for the selected points.
getStat()Getter for a statistical value by the key.
noData()NoData settings.
Events
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.
saveAsCsv()Saves chart data as a CSV file.
saveAsJson()Saves chart config as JSON document.
saveAsXlsx()Saves chart data as an Excel document.
saveAsXml()Saves chart config as XML document.
toCsv()Returns CSV string with the chart data.
Interactivity
collapseAll()Collapse all expanded tasks.
collapseTask()Collapses task by id.
edit()Live edit settings.
expandAll()Expands all collapsed tasks.
expandTask()Expands task by id.
fitAll()Fits all visible data to width of timeline.
fitToTask()Fits the visible area of the timeline.
interactivity()Interactivity settings.
scrollTo()Performs vertical scrolling by pixel offset.
scrollToEnd()Scrolls vertically to specified index.
scrollToRow()Performs vertical scroll for a row at the specified index.
tooltip()Tooltip settings.
zoomIn()Timeline zoom in.
zoomOut()Timeline zoom out.
zoomTo()Timeline zoom settings.
Size and Position
bottom()Bottom bound settings.
bounds()Bounds settings.
defaultRowHeight()Default row height settings.
getPixelBounds()Returns pixel bounds.
headerHeight()Header height settings.
height()Height settings.
left()Left bound settings.
margin()Margin settings.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
padding()Padding settings.
right()Right bound settings.
splitterPosition()Splitter position settings.
top()Top bound settings.
width()Width settings.
zIndex()Z-index of the element.
XML/JSON
toJson()Return chart configuration as JSON object or string.
toXml()Return chart configuration as XML string or XMLNode.
Miscellaneous
autoRedraw()Redraw chart after changes or not.
container()Getter for the element's container.
draw()Drawing of the Gantt chart.
saveAsJpg()Saves the current chart as JPEG image.
saveAsPdf()Saves the current chart as PDF image.
saveAsPng()Saves the current chart as PNG image.
saveAsSvg()Saves the current chart as SVG image.
toSvg()Returns SVG string.

Methods Description

autoRedraw

Getter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.

Returns:

boolean - AutoRedraw flag.
See listing
var autoRedraw = chart.autoRedraw();
Setter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

background

Getter for the chart background.

Returns:

anychart.core.ui.Background - Chart background.

Try it:

Setter for the chart background.

Params:

Name Type Default Description
value Object
{enabled: true, fill: "#fff", stroke: 'none', zIndex: 1}
Background object to set.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

bottom

Getter for element bottom bound settings.

Returns:

number string undefined - Element's bottom bound setting.
Setter for element bottom bound settings.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

bounds

Getter for element bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.
Setter for bounds of the element using one parameter.

Params:

Name Type Description
value anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds Bounds of element.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

Setter for element bounds settings.

Params:

Name Type Default Description
x number | string
null
X-coordinate.
y number | string
null
Y-coordinate.
width number | string
null
Width.
height number | string
null
Height.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

collapseAll

Collapse all expanded tasks.
The collapseAll() method should be used after drawing a chart.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

collapseTask

Collapses task by id.
The collapseTask() method should be used after drawing a chart.

Params:

Name Type Description
taskId string Task id.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

columnStroke

Getter for the column stroke.

Returns:

string anychart.graphics.vector.Stroke - The column stroke.

Try it:

Setter for the column stroke.

Params:

Name Type Description
value anychart.graphics.vector.Stroke | string Value to set.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

container

Getter for the element's container.
Setter for the element's container.

Params:

Name Type Description
value anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element The value to set.

Returns:

anychart.core.Chart - Self instance for method chaining.
Example
// string
 element.container('containerIdentifier');
// DOM-element
 var domElement = document.getElementById('containerIdentifier');
 element.container(domElement);
// Framework-element
 var fwElement = anychart.standalones.title();
 element.container( fwElement.container() );

Try it:

contextMenu

Getter for the context menu.

Returns:

anychart.ui.ContextMenu - Context menu.

Try it:

Setter for the context menu.

Params:

Name Type Description
value Object | boolean | null Context menu settings

Returns:

anychart.core.Chart - Self instance for method chaining.

credits

Getter for the credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.

Try it:

Setter for the chart credits. Learn more about credits settings.

Params:

Name Type Default Description
value Object | boolean | null
true
Credits settings

Returns:

anychart.core.Chart - An instance of the class for method chaining.

data

Getter for the chart data.

Returns:

anychart.data.Tree anychart.data.TreeView - Returns data tree.

Try it:

Setter for the chart data.

Params:

Name Type Description
value anychart.data.Tree | anychart.data.TreeView | Array.<Object> Data tree or raw data.
fillMethod anychart.enums.TreeFillingMethod | string Fill method.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

dataGrid

Getter for the data grid.

Returns:

anychart.core.ui.DataGrid - Chart's data grid.

Try it:

Setter for the data grid.

Params:

Name Type Default Description
enabled boolean
true
Enabled or disabled data grid.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

defaultRowHeight

Getter for the default row height.

Returns:

number - Default row height.
See listing
var height = chart.defaultRowHeight();
Setter for the default row height.

Params:

Name Type Default Description
value number
20
Value to set.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

draw

Drawing of the Gantt chart.

Params:

Name Type Description
async boolean Whether do draw asynchronously. If set to true, the chart will be drawn asynchronously.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

edit

Getter for live edit settings.

Returns:

anychart.core.gantt.edit.StructureEdit - Live edit settings.

Try it:

Setter for live edit settings.
Note: dataGrid.edit(), timeline.edit() methods have priority over the chart.edit() method.
Learn more about Live editing.

Params:

Name Type Default Description
settings Object | boolean
false
Live edit settings to set.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

expandAll

Expands all collapsed tasks.
The expandAll() method should be used after drawing a chart.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

expandTask

Expands task by id.
The expandTask() method should be used after drawing a chart.

Params:

Name Type Description
taskId string Task id.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

fitAll

Fits all visible data to width of timeline.
The fitAll() method should be used after drawing a chart.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

fitToTask

Fits the visible area of the timeline to the range of specified tasks.

Params:

Name Type Description
taskId string Task id.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

getPixelBounds

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

Returns:

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

getSelectedPoints

Getter for the selected points.

Returns:

Array.<anychart.core.Point> - An array of the selected points.

Try it:

getStat

Getter for a statistical value by the key.

Params:

Name Type Description
key anychart.enums.Statistics | string Key.

Returns:

* - Statistics value.

Try it:

getTimeline

Getter for the timeline.

Returns:

anychart.core.ui.Timeline - The chart's timeline.

Try it:

getType

Returns chart type.

Returns:

string - The chart type.

Try it:

globalToLocal

Converts the global coordinates to local coordinates. Note: Works only after anychart.core.Chart#draw is called.

Params:

Name Type Description
xCoord number Global X coordinate.
yCoord number Global Y coordinate.

Returns:

Object.<string, number> - Object with XY coordinates.

Try it:

headerHeight

Getter for the header height.

Returns:

number string - The header height.

Try it:

Setter for the header height.

Params:

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

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

height

Getter for element height settings.

Returns:

number string undefined - Element's height setting.
Setter for element height setting.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

interactivity

Getter for interactivity settings for the chart.

Returns:

anychart.core.utils.Interactivity - Interactivity settings.
Setter for interactivity settings for the chart.

Params:

Name Type Description
value Object | anychart.enums.HoverMode | string Settings object or boolean value like enabled state.

Returns:

anychart.core.SeparateChart - Self instance for method chaining.

Try it:

label

Getter for the chart label.

Params:

Name Type Default Description
index string | number
0
Index of instance.

Returns:

anychart.core.ui.Label - Label instance.

Try it:

Setter for the chart label.

Params:

Name Type Default Description
value null | boolean | Object | string
false
Chart label instance to add by index 0.

Returns:

anychart.core.Chart - Self instance for method chaining.
Setter for the chart label.

Params:

Name Type Default Description
index string | number
Label index.
value null | boolean | Object | string
false
Chart label settings.

Returns:

anychart.core.Chart - Self instance for method chaining.

left

Getter for element left bound settings.

Returns:

number string undefined - Element's left bound setting.
Setter for element left bound settings.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

legend

Getter for the chart legend.

Returns:

anychart.core.ui.Legend - Legend instance.

Try it:

Setter for chart legend settings.

Params:

Name Type Default Description
value Object | boolean | null
false
Legend settings.

Returns:

anychart.core.Chart - An instance of the class for method chaining.

listen

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(e:Object)
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:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(e:Object)
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:

localToGlobal

Converts the local coordinates to global coordinates. Note: Works only after anychart.core.Chart#draw is called.

Params:

Name Type Description
xCoord number Local X coordinate.
yCoord number Local Y coordinate.

Returns:

Object.<string, number> - Object with XY coordinates.

Try it:

margin

Setter for the chart margin in pixels using a single complex object.

Params:

Name Type Default Description
value Array.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
// all margins 15px
chart.margin(15);
// all margins 15px
chart.margin("15px");
// top and bottom 5px, right and left 15px
chart.margin(anychart.utils.margin(5, 15));

Try it:

Setter for the chart margin in pixels using several simple values.

Params:

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

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
// 1) all 10px
chart.margin(10);
// 2) top and bottom 10px, left and right 15px
chart.margin(10, "15px");
// 3) top 10px, left and right 15px, bottom 5px
chart.margin(10, "15px", 5);
// 4) top 10px, right 15px, bottom 5px, left 12px
chart.margin(10, "15px", "5px", 12);

Try it:

maxHeight

Getter for the maximum height.

Returns:

number string null - Element's maximum height.
Setter for the maximum height.

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

maxWidth

Getter for the maximum width.

Returns:

number string null - Element's maximum width.
Setter for the maximum width.

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

minHeight

Getter for the minimum height.

Returns:

number string null - Element's minimum height.
Setter for the minimum height.

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

minWidth

Getter for the minimum width.

Returns:

number string null - Element's minimum width.
Setter for the minimum width.

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

noData

Getter for noData settings.

Returns:

anychart.core.NoDataSettings - NoData settings.

Try it:

Setter for noData settings.
Learn more about "No data" feature

Params:

Name Type Description
value Object NoData settings.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

padding

Setter for the chart paddings in pixels using a single value.

Params:

Name Type Default Description
value Array.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});

Try it:

Setter for the chart paddings in pixels using several numbers.

Params:

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

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
// 1) all 10px
chart.padding(10);
// 2) top and bottom 10px, left and right 15px
chart.padding(10, "15px");
// 3) top 10px, left and right 15px, bottom 5px
chart.padding(10, "15px", 5);
// 4) top 10px, right 15%, bottom 5px, left 12px
chart.padding(10, "15%", "5px", 12);

Try it:

palette

Getter for the palette.
See listing
var palette = chart.palette();
Setter the for palette.

Params:

Name Type Description
paletteSettings anychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string> Gantt colors palette settings to set.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

print

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:

removeAllListeners

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:

Getter for element right bound settings.

Returns:

number string undefined - Element's right bound setting.
Setter for element right bound setting.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

rowHoverFill

Getter for row hover fill.

Returns:

anychart.graphics.vector.Fill string - Current value hover fill.

Try it:

Sets row hover fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Description
value anychart.graphics.vector.Fill Color as an object or a string.

Returns:

anychart.charts.Gantt - Self instance for method chaining.
Setter for fill settings using function.

Params:

Name Type Default Description
fillFunction function
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.sourceColor - color returned by fill() getter.
   // this.item - item for coloring.
   // this.itemIndex - item index.
   // this.period - the period for Resource chart.
   // this.index - period index.

   return fillValue; // type anychart.graphics.vector.Fill
}

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

Fill color with opacity.
Fill as a string or an object.

Params:

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

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

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

Try it:

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

Try it:

rowSelectedFill

Getter for the row selected fill.

Returns:

anychart.graphics.vector.Fill string - The row select fill.

Try it:

Sets row selected fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Default Description
value anychart.graphics.vector.Fill
"#d2eafa"
Color as an object or a string.

Returns:

anychart.charts.Gantt - Self instance for method chaining.
Setter for fill settings using function.

Params:

Name Type Default Description
fillFunction function
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.sourceColor - color returned by fill() getter.
   // this.item - item for coloring.
   // this.itemIndex - item index.
   // this.period - the period for Resource chart.
   // this.index - period index.

   return fillValue; // type anychart.graphics.vector.Fill
}

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

Fill color with opacity.
Fill as a string or an object.

Params:

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

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

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

Try it:

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

Try it:

rowStroke

Getter for the row stroke.

Returns:

string anychart.graphics.vector.Stroke - The row stroke.

Try it:

Setter for the row stroke.

Params:

Name Type Description
value anychart.graphics.vector.Stroke | string Value to set.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

saveAsCsv

Saves chart data as a CSV file.

Params:

Name Type Description
chartDataExportMode anychart.enums.ChartDataExportMode | string Data export mode.
csvSettings Object.<string, (string|boolean|undefined|function(name:*, value:*))> CSV settings.
CSV settings object:
rowsSeparator - string or undefined (default is '\n')
columnsSeparator - string or undefined (default is ',')
ignoreFirstRow - boolean or undefined (default is 'false')
formats -
1) a function with two arguments such as the field name and value, that returns the formatted value
or
2) the object with the key as the field name, and the value as a format function.
(default is 'undefined').
filename string File name to save.

saveAsJpg

Saves the current chart as JPEG image.

Params:

Name Type Description
width number | Object Image width or object with options.
height number Image height.
quality number Image quality in ratio 0-1.
forceTransparentWhite boolean Force transparent to white or not.
filename string File name to save.

Try it:

saveAsJson

Saves chart config as JSON document.

Params:

Name Type Description
filename string File name to save.

Try it:

saveAsPdf

Saves the current chart as PDF image.

Params:

Name Type Description
paperSizeOrWidthOrOptions number | string | Object Any paper format like 'a0', 'tabloid', 'b4', etc or width, or object with options.
landscape boolean Define, is landscape.
x number Offset X.
y number Offset Y.
filename string File name to save.

Try it:

saveAsPng

Saves the current chart as PNG image.

Params:

Name Type Description
width number | Object Image width or object with options.
height number Image height.
quality number Image quality in ratio 0-1.
filename string File name to save.

Try it:

saveAsSvg

Saves the current chart as SVG image.

Params:

Name Type Description
paperSize string | Object Paper Size or object with options.
landscape boolean Landscape.
filename string File name to save.

Try it:

Saves the stage as SVG image using width and height.

Params:

Name Type Description
width number Image width.
height number Image height.

Try it:

saveAsXlsx

Saves chart data as an Excel document.

Params:

Name Type Description
chartDataExportMode anychart.enums.ChartDataExportMode | string Data export mode.
filename string File name to save.

Try it:

saveAsXml

Saves chart config as XML document.

Params:

Name Type Description
filename string File name to save.

Try it:

scrollTo

Performs vertical scrolling by pixel offset.
The scrollTo() method should be used after drawing a chart.

Params:

Name Type Description
pxOffset number Value for pixel offset to set.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

scrollToEnd

Scrolls vertically to specified index.
The scrollToEnd() method should be used after drawing a chart.

Params:

Name Type Description
index number End index to scroll to set.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

scrollToRow

Performs vertical scroll for a row at the specified index.

Params:

Name Type Description
rowIndex number Row index.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

splitterPosition

Getter for the splitter position.

Returns:

number string - The splitter position.
See listing
var position = chart.splitterPosition();
Setter for the splitter position.

Params:

Name Type Default Description
value string | number
"30%"
Pixel or percent value.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

title

Getter for the chart title.

Returns:

anychart.core.ui.Title - Chart title.

Try it:

Setter for the chart title.

Params:

Name Type Default Description
value null | boolean | Object | string
false
Chart title text or title instance for copy settings from.

Returns:

anychart.core.Chart - Self instance for method chaining.

toCsv

Returns CSV string with the chart data.

Params:

Name Type Description
chartDataExportMode anychart.enums.ChartDataExportMode | string Data export mode.
csvSettings Object.<string, (string|boolean|undefined|function(name:*, value:*)|Object)> CSV settings.
CSV settings object:
rowsSeparator - string or undefined (default is '\n')
columnsSeparator - string or undefined (default is ',')
ignoreFirstRow - boolean or undefined (default is 'false')
formats -
1) a function with two arguments such as the field name and value, that returns the formatted value
or
2) the object with the key as the field name, and the value as a format function.
(default is 'undefined').

Returns:

string - CSV string.

toJson

Return chart configuration as JSON object or string.

Params:

Name Type Default Description
stringify boolean
false
Returns JSON as string.

Returns:

Object string - Chart configuration.

toSvg

Returns SVG string with paper size and landscape.

Params:

Name Type Description
paperSize string | Object Paper Size or object of options.
landscape boolean Landscape.

Returns:

string - SVG content or empty string.

Try it:

Returns SVG string with with determined the width and height.

Params:

Name Type Description
width number Image width.
height number Image height.

Returns:

string - SVG content or empty string.

Try it:

toXml

Return chart configuration as XML string or XMLNode.

Params:

Name Type Default Description
asXmlNode boolean
false
Return XML as XMLNode.

Returns:

string Node - Chart configuration.

tooltip

Getter for the chart tooltip.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Example
var tooltipSettings = chart.tooltip();
Setter for the chart tooltip.

Params:

Name Type Description
tooltipSettings Object | boolean | null Tooltip settings to set.

Returns:

anychart.core.Chart - Self instance for method chaining.

top

Getter for element top bound settings.

Returns:

number string undefined - Element's top bound setting.
Setter for element top bound settings.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

unlisten

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:

unlistenByKey

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:

width

Getter for element width settings.

Returns:

number string undefined - Element's width setting.
Setter for element width setting.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

xScale

Getter for the timeline X-scale.

Returns:

anychart.scales.GanttDateTime - Default Gantt scale value.

Try it:

Setter for the timeline X-scale.

Params:

Name Type Default Description
value Object
anychart.scales.GanttDateTime
Scale object.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

zoomIn

Timeline zoom in.

Params:

Name Type Description
zoomFactor number Zoom factor.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

zoomOut

Timeline zoom out.

Params:

Name Type Description
zoomFactor number Zoom factor.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

zoomTo

Sets the timeline zoom to range using the date.

Params:

Name Type Description
startDate number Start date.
endDate number End date.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it:

Sets the timeline zoom to range using the interval.

Params:

Name Type Description
unit anychart.enums.Interval | string Interval unit.
count number Interval units count (can't be 0).
anchor anychart.enums.GanttRangeAnchor | string Anchor to zoom from.

Returns:

anychart.charts.Gantt - Self instance for method chaining.

Try it: