AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.ui.GanttToolbar Improve this Doc

The GanttToolbar class contains methods for configuring toolbar.
Toolbar is a part of Gantt chart. Toolbar contains menu Print with options print A4 - A0, buttons ZoomIn, ZoomOut, FitAll, ExpandAll/CollapseAll and menu with option Save As (SVG, PNG, JPG, PDF).

Methods Overview

Specific settings
buttonsMode()Toolbar buttons mode.
printPaperSizes()Print paper sizes.
target()Target of the control chart.
Miscellaneous
container()Toolbar container.
draw()Draws Gantt chart toolbar.
updateLocalizedCaptions()Updates localized captions for all menu items and buttons according to current locale settings.

Methods Description

buttonsMode

Toolbar buttons mode getter.
Toolbar buttons mode setter.

Params:

NameTypeDefaultDescription
modeanychart.enums.GanttToolbarButtonsMode
'all'
Buttons mode.

Returns:

anychart.ui.GanttToolbar - Self instance for method chaining.

container

Getter for the Gantt chart toolbar container.

Returns:

Element | undefined - Toolbar container.
Setter for the Gantt chart toolbar container.

Params:

NameTypeDefaultDescription
elementstring | Element
undefined
Element ID or a DOM node.

Returns:

anychart.ui.GanttToolbar - Self instance for method chaining.

draw

Draws Gantt chart toolbar.

Returns:

anychart.ui.GanttToolbar - Self instance for method chaining.

printPaperSizes

Getter for the print paper sizes.

Returns:

Array.<anychart.graphics.vector.PaperSize> - Print paper sizes.
Setter for the print paper sizes. Affects available print sizes in the print menu.

Params:

NameTypeDefaultDescription
paperSizeListArray.<anychart.graphics.vector.PaperSize>
['us-letter', 'a0', 'a0', 'a1', 'a2', 'a3', 'a4', 'a5', 'a6']
An array of supported print paper sizes.

Returns:

anychart.ui.GanttToolbar - Self instance for method chaining.

target

Getter for the toolbar target.

Returns:

anychart.core.Chart | undefined - Toolbar target.
Setter for the toolbar target.

Params:

NameTypeDefaultDescription
targetanychart.core.Chart
undefined
Toolbar target to set.

Returns:

anychart.ui.GanttToolbar - Self instance for method chaining.

updateLocalizedCaptions

Updates localized captions for all menu items and buttons according to current locale settings.

Returns:

anychart.ui.GanttToolbar - Self instance for method chaining.