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
a11y()Accessibility setting.
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.
toA11yTable()Creates and returns the chart represented as an invisible HTML table.
toHtmlTable()Creates and returns a chart as HTML table.
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
exports()Exports settings
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.
shareWithFacebook()Opens Facebook sharing dialog.
shareWithLinkedIn()Opens LinkedIn sharing dialog.
shareWithPinterest()Opens Pinterest sharing dialog.
shareWithTwitter()Opens Twitter sharing dialog.
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()Performs vertical scroll to the end of the chart to the specified row index.
scrollToRow()Performs vertical scroll to a row at the specified index.
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.
fullScreen()Fullscreen mode.
getJpgBase64String()Returns JPG as base64 string.
getPdfBase64String()Returns PDF as base64 string.
getPngBase64String()Returns PNG as base64 string.
getSvgBase64String()Returns SVG as base64 string.
id()Chart id.
isFullScreenAvailable()Whether the fullscreen mode available in the browser or not.
saveAsJpg()Saves the chart as JPEG image.
saveAsPdf()Saves the chart as PDF image.
saveAsPng()Saves the chart as PNG image.
saveAsSvg()Saves the chart as SVG image.
shareAsJpg()Shares a chart as a JPG file and returns a link to the shared image.
shareAsPdf()Shares a chart as a PDF file and returns a link to the shared image.
shareAsPng()Shares a chart as a PNG file and returns a link to the shared image.
shareAsSvg()Shares a chart as a SVG file and returns a link to the shared image.
toSvg()Returns SVG string.

Methods Description

a11y

Getter for the accessibility setting.

Returns:

anychart.core.utils.ChartA11y - Accessibility settings object.
See listing.
var stateOfAccsessibility = chart.a11y();
Setter for the accessibility setting.

Params:

NameTypeDescription
settingsboolean | ObjectWhether to enable accessibility or object with settings.

Returns:

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

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:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

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

background

Getter for the chart background.

Returns:

anychart.core.ui.Background - Chart background.
Setter for the chart background.

Params:

NameTypeDefaultDescription
settingsObject
{enabled: true, fill: "#fff", stroke: 'none', zIndex: 1}
Background object to set.

Returns:

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

bottom

Getter for element bottom bound settings.

Returns:

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

Params:

NameTypeDefaultDescription
bottomnumber | string | null
null
Bottom bound settings for the element.

Returns:

anychart.charts.Gantt - Returns self for method chaining.

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:

NameTypeDescription
boundsanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of element.

Returns:

anychart.charts.Gantt - Self instance for method chaining.
Setter for element bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

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

collapseAll

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

Returns:

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

collapseTask

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

Params:

NameTypeDescription
taskIdstringTask id.

Returns:

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

columnStroke

Getter for the column stroke.

Returns:

string | anychart.graphics.vector.Stroke - The column stroke.
Setter for the column stroke.

Params:

NameTypeDescription
coloranychart.graphics.vector.Stroke | stringColor to set.

Returns:

anychart.charts.Gantt - Self instance for method chaining.
Setter for column stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

container

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

Params:

NameTypeDescription
elementanychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | ElementContainer to set.

Returns:

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

contextMenu

Getter for the context menu.

Returns:

anychart.ui.ContextMenu - Context menu.
Setter for the context menu.

Params:

NameTypeDescription
settingsObject | boolean | nullContext menu settings

Returns:

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

credits

Getter for the credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.
Setter for the chart credits. Learn more about credits settings.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
true
Credits settings

Returns:

anychart.charts.Gantt - An instance of the class for method chaining.

data

Getter for the chart data.

Returns:

anychart.data.Tree | anychart.data.TreeView - Returns data tree.
Setter for the chart data.

Params:

NameTypeDescription
dataanychart.data.Tree | anychart.data.TreeView | Array.<Object>Data tree or raw data.
fillMethodanychart.enums.TreeFillingMethod | stringFill 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.
Setter for the data grid.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled or disabled data grid.

Returns:

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

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:

NameTypeDefaultDescription
heightnumber
20
Value to set.

Returns:

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

draw

Drawing of the Gantt chart.

Params:

NameTypeDescription
asyncbooleanWhether do draw asynchronously. If set to true, the chart will be drawn asynchronously.

Returns:

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

edit

Getter for live edit settings.

Returns:

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

Params:

NameTypeDefaultDescription
settingsObject | 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.

expandTask

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

Params:

NameTypeDescription
taskIdstringTask id.

Returns:

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

exports

Getter for the export charts.

Returns:

anychart.core.utils.Exports - Exports settings.
See listing
var exports = chart.exports();
Setter for the export charts.

Params:

NameTypeDescription
settingsObjectExport settings.

Returns:

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

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.

fitToTask

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

Params:

NameTypeDescription
taskIdstringTask id.

Returns:

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

fullScreen

Getter for the fullscreen mode.

Returns:

boolean - Full screen state (enabled/disabled).
See listing
var fullScreen = chart.fullScreen();
Setter for the fullscreen mode.

Params:

NameTypeDefaultDescription
enabledboolean
false
Enable/Disable fullscreen mode.

Returns:

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

getJpgBase64String

Returns JPG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.

getPdfBase64String

Returns PDF as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
paperSizeOrWidthnumber | stringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidthnumber | booleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.

getPixelBounds

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

Returns:

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

getPngBase64String

Returns PNG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.

getSelectedPoints

Getter for the selected points.

Returns:

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

getStat

Getter for a statistical value by the key.

Params:

NameTypeDescription
keyanychart.enums.Statistics | stringKey.

Returns:

* - Statistics value.

getSvgBase64String

Returns SVG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
paperSizeOrWidthstring | numberPaper Size or width.
landscapeOrHeightboolean | stringLandscape or height.

getTimeline

Getter for the timeline.

Returns:

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

getType

Returns chart type.

Returns:

string - The chart type.

globalToLocal

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

Params:

NameTypeDescription
xCoordnumberGlobal X coordinate.
yCoordnumberGlobal Y coordinate.

Returns:

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

headerHeight

Getter for the header height.

Returns:

number | string - The header height.
Setter for the header height.

Params:

NameTypeDefaultDescription
heightnumber | string
70
Value to set.

Returns:

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

height

Getter for element height settings.

Returns:

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

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Height settings for the element.

Returns:

anychart.charts.Gantt - Returns self for method chaining.

id

Getter for chart id.

Returns:

string - Return chart id.
Setter for chart id.

Params:

NameTypeDescription
idstringChart id.

Returns:

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

interactivity

Getter for interactivity settings for the chart.

Returns:

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

Params:

NameTypeDescription
settingsObject | anychart.enums.HoverMode | stringSettings object or boolean value like enabled state.

Returns:

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

isFullScreenAvailable

Whether the fullscreen mode available in the browser or not.

Returns:

boolean - isFullScreenAvailable state.

label

Getter for the chart label.

Params:

NameTypeDefaultDescription
indexstring | number
0
Index of instance.

Returns:

anychart.core.ui.Label - Label instance.
Setter for the chart label.

Params:

NameTypeDefaultDescription
settingsnull | boolean | Object | string
false
Chart label instance to add by index 0.

Returns:

anychart.charts.Gantt - Self instance for method chaining.
Setter for the chart label.

Params:

NameTypeDefaultDescription
indexstring | number
Label index.
settingsnull | boolean | Object | string
false
Chart label settings.

Returns:

anychart.charts.Gantt - 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:

NameTypeDefaultDescription
leftnumber | string | null
null
Left bound setting for the element.

Returns:

anychart.charts.Gantt - Returns self for method chaining.

legend

Getter for the chart legend.

Returns:

anychart.core.ui.Legend - Legend instance.
Setter for chart legend settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Legend settings.

Returns:

anychart.charts.Gantt - An instance of the class for method chaining.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

localToGlobal

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

Params:

NameTypeDescription
xCoordnumberLocal X coordinate.
yCoordnumberLocal Y coordinate.

Returns:

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

margin

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

Params:

NameTypeDefaultDescription
marginArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Margin to set.

Returns:

anychart.charts.Gantt - 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));
Setter for the chart margin in pixels using several simple values.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | number
0
Left space.

Returns:

anychart.charts.Gantt - 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);

maxHeight

Getter for the maximum height.

Returns:

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

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Maximum height to set.

Returns:

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

maxWidth

Getter for the maximum width.

Returns:

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

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Maximum width to set.

Returns:

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

minHeight

Getter for the minimum height.

Returns:

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

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Minimum height to set.

Returns:

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

minWidth

Getter for the minimum width.

Returns:

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

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Minimum width to set.

Returns:

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

noData

Getter for noData settings.

Returns:

anychart.core.NoDataSettings - NoData settings.
Setter for noData settings.
Learn more about "No data" feature

Params:

NameTypeDescription
settingsObjectNoData settings.

Returns:

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

padding

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

Params:

NameTypeDefaultDescription
paddingArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Padding to set.

Returns:

anychart.charts.Gantt - Self instance for method chaining.
Example.
chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});
Setter for the chart paddings in pixels using several numbers.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | number
0
Left space.

Returns:

anychart.charts.Gantt - 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);

palette

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

Params:

NameTypeDescription
paletteSettingsanychart.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:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.
Getter for element right bound settings.

Returns:

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

Params:

NameTypeDefaultDescription
rightnumber | string | null
null
Right bound setting for the element.

Returns:

anychart.charts.Gantt - Returns self for method chaining.

rowHoverFill

Getter for row hover fill.

Returns:

anychart.graphics.vector.Fill | string - Row hover fill.
Setter for row hover fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an object, an array or a string.

Returns:

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

Params:

NameTypeDefaultDescription
fillFunctionfunction():anychart.graphics.vector.Fill
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.
Fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity (0 to 1).

Returns:

anychart.charts.Gantt - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.charts.Gantt - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

rowSelectedFill

Getter for the row selected fill.

Returns:

anychart.graphics.vector.Fill | string - Row selected fill.
Sets row selected fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
function(){return this.sourceColor}
Color as an object, an array or a string.

Returns:

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

Params:

NameTypeDefaultDescription
fillFunctionfunction():anychart.graphics.vector.Fill
function(){return 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.
Fill color with opacity.
Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity (0 to 1).

Returns:

anychart.charts.Gantt - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.charts.Gantt - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

rowStroke

Getter for the row stroke.

Returns:

string | anychart.graphics.vector.Stroke - The row stroke.
Setter for the row stroke.

Params:

NameTypeDescription
coloranychart.graphics.vector.Stroke | stringColor to set.

Returns:

anychart.charts.Gantt - Self instance for method chaining.
Setter for the row stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

saveAsCsv

Saves chart data as a CSV file.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
csvSettingsObject.<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').
filenamestringFile name to save.

saveAsJpg

Saves the chart as JPEG image.

Params:

NameTypeDescription
widthnumber | ObjectImage width or object with options.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.
filenamestringFile name to save.

saveAsJson

Saves chart config as JSON document.

Params:

NameTypeDescription
filenamestringFile name to save.

saveAsPdf

Saves the chart as PDF image.

Params:

NameTypeDescription
paperSizeOrWidthOrOptionsnumber | string | ObjectAny paper format like 'a0', 'tabloid', 'b4', etc or width, or object with options.
landscapebooleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.
filenamestringFile name to save.

saveAsPng

Saves the chart as PNG image.

Params:

NameTypeDescription
widthnumber | ObjectImage width or object with options.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
filenamestringFile name to save.

saveAsSvg

Saves the chart as SVG image.

Params:

NameTypeDescription
paperSizestring | ObjectPaper Size or object with options.
landscapebooleanLandscape.
filenamestringFile name to save.
Saves the stage as SVG image using width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

saveAsXlsx

Saves chart data as an Excel document.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
filenamestringFile name to save.

saveAsXml

Saves chart config as XML document.

Params:

NameTypeDescription
filenamestringFile name to save.

scrollTo

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

Params:

NameTypeDescription
pxOffsetnumberValue for pixel offset to set.

Returns:

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

scrollToEnd

Performs vertical scroll to the end of the chart to the specified row index.
The scrollToEnd() method should be used after drawing a chart.

Params:

NameTypeDescription
indexnumberEnd index to scroll to set.

Returns:

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

scrollToRow

Performs vertical scroll to a row at the specified index.

Params:

NameTypeDescription
rowIndexnumberRow index.

Returns:

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

shareAsJpg

Shares a chart as a JPG file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.
filenamestringFile name to save.

shareAsPdf

Shares a chart as a PDF file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
paperSizeOrWidthnumber | stringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidthnumber | booleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.
filenamestringFile name to save.

shareAsPng

Shares a chart as a PNG file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
filenamestringFile name to save.

shareAsSvg

Shares a chart as a SVG file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
paperSizeOrWidthstring | numberPaper Size or width.
landscapeOrHeightboolean | stringLandscape or height.
filenamestringFile name to save.

shareWithFacebook

Opens Facebook sharing dialog.

Params:

NameTypeDescription
captionOrOptionsstring | ObjectCaption for the main link or object with options.
linkstringThe URL is attached to the publication.
namestringThe title for the attached link.
descriptionstringDescription for the attached link.

shareWithLinkedIn

Opens LinkedIn sharing dialog.

Params:

NameTypeDescription
captionOrOptionsstring | ObjectCaption for publication or object with options. If not set 'AnyChart' will be used.
descriptionstringDescription.

shareWithPinterest

Opens Pinterest sharing dialog.

Params:

NameTypeDescription
linkOrOptionsstring | ObjectAttached link or object with options. If not set, the image URL will be used.
descriptionstringDescription.

shareWithTwitter

Opens Twitter sharing dialog.

splitterPosition

Getter for the splitter position.

Returns:

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

Params:

NameTypeDefaultDescription
positionstring | number
'30%'
Pixel or percent value.

Returns:

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

title

Getter for the chart title.

Returns:

anychart.core.ui.Title - Chart title.
Setter for the chart title.

Params:

NameTypeDefaultDescription
settingsnull | boolean | Object | string
false
Chart title text or title instance for copy settings from.

Returns:

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

toA11yTable

Creates and returns the chart represented as an invisible HTML table.

Params:

NameTypeDescription
titlestringTitle to set.
asStringbooleanDefines output: HTML string if True, DOM element if False.

Returns:

Element | string | null - HTML table instance with a11y style (invisible), HTML string or null if parsing chart to table fails.

toCsv

Returns CSV string with the chart data.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
csvSettingsObject.<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.

toHtmlTable

Creates and returns a chart as HTML table.

Params:

NameTypeDescription
titlestringTitle to set.
asStringbooleanDefines output: HTML string if True, DOM element if False.

Returns:

Element | string | null - HTML table instance, HTML string or null if parsing chart to table fails.

toJson

Return chart configuration as JSON object or string.

Params:

NameTypeDefaultDescription
stringifyboolean
false
Returns JSON as string.

Returns:

Object | string - Chart configuration.

toSvg

Returns SVG string with paper size and landscape.

Params:

NameTypeDescription
paperSizestring | ObjectPaper Size or object of options.
landscapebooleanLandscape.

Returns:

string - SVG content or empty string.
Returns SVG string with with determined the width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

Returns:

string - SVG content or empty string.

toXml

Return chart configuration as XML string or XMLNode.

Params:

NameTypeDefaultDescription
asXmlNodeboolean
false
Return XML as XMLNode.

Returns:

string | Node - Chart configuration.

top

Getter for element top bound settings.

Returns:

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

Params:

NameTypeDefaultDescription
topnumber | string | null
null
Top bound setting for the element.

Returns:

anychart.charts.Gantt - Returns self for method chaining.

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

width

Getter for element width settings.

Returns:

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

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Width settings for the element.

Returns:

anychart.charts.Gantt - Returns self for method chaining.

xScale

Getter for the timeline X-scale.

Returns:

anychart.scales.GanttDateTime - Default Gantt scale value.
Setter for the timeline X-scale.

Params:

NameTypeDefaultDescription
settingsObject
anychart.scales.GanttDateTime
Scale object.

Returns:

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

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

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

zoomIn

Timeline zoom in.

Params:

NameTypeDescription
zoomFactornumberZoom factor.

Returns:

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

zoomOut

Timeline zoom out.

Params:

NameTypeDescription
zoomFactornumberZoom factor.

Returns:

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

zoomTo

Sets the timeline zoom to range using the date.

Params:

NameTypeDescription
startDatenumberStart date.
endDatenumberEnd date.

Returns:

anychart.charts.Gantt - Self instance for method chaining.
Sets the timeline zoom to range using the interval.

Params:

NameTypeDescription
unitanychart.enums.Interval | stringInterval unit.
countnumberInterval units count (can't be 0).
anchoranychart.enums.GanttRangeAnchor | stringAnchor to zoom from.

Returns:

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