GanttChartContainer

A container that holds one or more GanttChartBase instances.

This class has several built-in several controls to support GanttChartBase instances:

A toolbar above all Gantt Charts. Many built-in controls can be enabled or disabled using configuration property toolbarScheme. Built-in functions include:
- ComboBox for container selection
- Buttons for Add View, Delete View, and Switch Splitter Orientation
- Expand/Collapse groups for expandable charts
- A zooming slider
- A legend button
- A Settings button
If nothing is added to the toolbar, the toolbar is hidden automatically. For more information about the functions and configuration, see the API documentation of sap.gantt.config.ToolbarScheme.
A Splitter containing aggregation ganttCharts

Constructor Summary

new sap.gantt.GanttChartContainer(sId?, mSettings?)Creates and initializes a new Gantt chart container.

Event Summary

customSettingChange(oControlEvent)Event fired when the custom settings are changed.

ganttChartChangeRequested(oControlEvent)Event fired when any change occurs in the toolbar that requests the application to change aggregation ganttCharts.

treeTableToggleEvent(oControlEvent)Event fired when toggle node of the tree table.

Method Summary

sap.gantt.GanttChartContainer.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.GanttChartContainer with name sClassName and enriches it with the information contained in oClassInfo.

sap.gantt.GanttChartContainer.getMetadata()Returns a metadata object for class sap.gantt.GanttChartContainer.

addCustomToolbarItem(oCustomToolbarItem)Adds some customToolbarItem to the aggregation customToolbarItems.

addGanttChart(oGanttChart)Adds some ganttChart to the aggregation ganttCharts.

attachCustomSettingChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the customSettingChange event of this sap.gantt.GanttChartContainer.

attachGanttChartChangeRequested(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the ganttChartChangeRequested event of this sap.gantt.GanttChartContainer.

attachTreeTableToggleEvent(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the treeTableToggleEvent event of this sap.gantt.GanttChartContainer.

bindCustomToolbarItems(oBindingInfo)Binds aggregation customToolbarItems to model data.

bindGanttCharts(oBindingInfo)Binds aggregation ganttCharts to model data.

deselectRelationships(iGanttChartIndex?, aIds?)Deselects relationships and returns a success code.

deselectRows(iGanttChartIndex?, aIds?)Deselects rows and returns a success code.

deselectShapes(iGanttChartIndex?, aIds?)Deselects in-row shapes and returns a success code.

destroyCustomToolbarItems()Destroys all the customToolbarItems in the aggregation customToolbarItems.

destroyGanttCharts()Destroys all the ganttCharts in the aggregation ganttCharts.

destroyLegendContainer()Destroys the legendContainer in the aggregation legendContainer.

detachCustomSettingChange(fnFunction, oListener)Detaches event handler fnFunction from the customSettingChange event of this sap.gantt.GanttChartContainer.

detachGanttChartChangeRequested(fnFunction, oListener)Detaches event handler fnFunction from the ganttChartChangeRequested event of this sap.gantt.GanttChartContainer.

detachTreeTableToggleEvent(fnFunction, oListener)Detaches event handler fnFunction from the treeTableToggleEvent event of this sap.gantt.GanttChartContainer.

fireCustomSettingChange(mArguments?)Fires event customSettingChange to attached listeners.

fireGanttChartChangeRequested(mArguments?)Fires event ganttChartChangeRequested to attached listeners.

fireTreeTableToggleEvent(mArguments?)Fires event treeTableToggleEvent to attached listeners.

getAllSelections(iGanttChartIndex?)Gets all selected rows and shapes, including relationships.

getContainerLayoutKey()Gets current value of property containerLayoutKey.

getContainerLayouts()Gets current value of property containerLayouts.

getCustomToolbarItems()Gets content of aggregation customToolbarItems.

getEnableCursorLine()Gets current value of property enableCursorLine.

getEnableNowLine()Gets current value of property enableNowLine.

getEnableTimeScrollSync()Gets current value of property enableTimeScrollSync.

getEnableVerticalLine()Gets current value of property enableVerticalLine.

getGanttCharts()Gets content of aggregation ganttCharts.

getHeight()Gets current value of property height.

getHierarchies()Gets current value of property hierarchies.

getLegendContainer()Gets content of aggregation legendContainer.

getMaxNumOfGanttCharts()Gets current value of property maxNumOfGanttCharts.

getModes()Gets current value of property modes.

getSelectedRelationships(iGanttChartIndex?)Gets the selected relationships.

getSelectedRows(iGanttChartIndex?)Gets the selected rows.

getSelectedShapes(iGanttChartIndex?)Gets the selected in-row shapes.

getSliderStep()Gets current value of property sliderStep.

getSvgDefs()Gets current value of property svgDefs.

getToolbarSchemeKey()Returns the current effective toolbar scheme key.

getToolbarSchemes()Gets current value of property toolbarSchemes.

getWidth()Gets current value of property width.

indexOfCustomToolbarItem(oCustomToolbarItem)Checks for the provided sap.ui.core.Control in the aggregation customToolbarItems.

indexOfGanttChart(oGanttChart)Checks for the provided sap.gantt.GanttChartBase in the aggregation ganttCharts.

insertCustomToolbarItem(oCustomToolbarItem, iIndex)Inserts a customToolbarItem into the aggregation customToolbarItems.

insertGanttChart(oGanttChart, iIndex)Inserts a ganttChart into the aggregation ganttCharts.

removeAllCustomToolbarItems()Removes all the controls from the aggregation customToolbarItems.

removeAllGanttCharts()Removes all the controls from the aggregation ganttCharts.

removeCustomToolbarItem(vCustomToolbarItem)Removes a customToolbarItem from the aggregation customToolbarItems.

removeGanttChart(vGanttChart)Removes a ganttChart from the aggregation ganttCharts.

selectRelationships(iGanttChartIndex?, aIds?, isExclusive?)Selects relationships and returns a success code.

selectRows(iGanttChartIndex?, aIds?, isExclusive?)Selects rows and returns a success code.

selectRowsAndShapes(iGanttChartIndex?, aIds?, bIsExclusive?)Selects rows and all shapes contained in these rows.

selectShapes(iGanttChart?, aIds?, isExclusive?)Selects in-row shapes and returns a success code.

setContainerLayoutKey(sContainerLayoutKey)Sets a new value for property containerLayoutKey.

setContainerLayouts(sContainerLayouts)Sets a new value for property containerLayouts.

setEnableCursorLine(bEnableCursorLine)Sets a new value for property enableCursorLine.

setEnableNowLine(bEnableNowLine)Sets a new value for property enableNowLine.

setEnableTimeScrollSync(bEnableTimeScrollSync)Sets a new value for property enableTimeScrollSync.

setEnableVerticalLine(bEnableVerticalLine)Sets a new value for property enableVerticalLine.

setHeight(sHeight)Sets a new value for property height.

setHierarchies(sHierarchies)Sets a new value for property hierarchies.

setLegendContainer(oLegendContainer)Sets the aggregated legendContainer.

setMaxNumOfGanttCharts(iMaxNumOfGanttCharts)Sets a new value for property maxNumOfGanttCharts.

setModes(sModes)Sets a new value for property modes.

setSliderStep(iSliderStep)Sets a new value for property sliderStep.

setSvgDefs(sSvgDefs)Sets a new value for property svgDefs.

setToolbarSchemes(sToolbarSchemes)Sets a new value for property toolbarSchemes.

setWidth(sWidth)Sets a new value for property width.

switchOrientation(vOrientation?, bReadConfig?)Switches the splitter orientation.

unbindCustomToolbarItems()Unbinds aggregation customToolbarItems from model data.

unbindGanttCharts()Unbinds aggregation ganttCharts from model data.

Constructor Detail

new sap.gantt.GanttChartContainer(sId?, mSettings?)

Creates and initializes a new Gantt chart container.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

Properties
- width : sap.ui.core.CSSSize (default: 100%)
- height : sap.ui.core.CSSSize (default: 100%)
- enableTimeScrollSync : boolean (default: true)
- enableCursorLine : boolean (default: true)
- enableNowLine : boolean (default: true)
- enableVerticalLine : boolean (default: true)
- svgDefs : sap.gantt.def.SvgDefs
- modes : array (default: sap.gantt.config.DEFAULT_MODES)
- toolbarSchemes : array (default: sap.gantt.config.DEFAULT_CONTAINER_TOOLBAR_SCHEMES)
- hierarchies : array (default: sap.gantt.config.DEFAULT_HIERARCHYS)
- containerLayouts : array (default: sap.gantt.config.DEFAULT_CONTAINER_LAYOUTS)
- containerLayoutKey : string (default: sap.gantt.config.DEFAULT_CONTAINER_SINGLE_LAYOUT_KEY)
- sliderStep : int (default: 10)
- maxNumOfGanttCharts : int (default: 3)
Aggregations
- legendContainer : sap.gantt.legend.LegendContainer
- customToolbarItems : sap.ui.core.Control[]
- ganttCharts : sap.gantt.GanttChartBase[]
Events
- ganttChartChangeRequested : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- customSettingChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- treeTableToggleEvent : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

Parameters:

{string}	sId?	ID for the new control, generated automatically if no ID is given
{object}	mSettings?	Initial settings for the new control

Event Detail

customSettingChange(oControlEvent)

Event fired when the custom settings are changed.

The Custom settings are application-injected settings that can be configured in the Settings dialog box. This event allows the application to handle these settings. Only check boxes are supported.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{string}	oControlEvent.getParameters.id	ID of the custom setting
{boolean}	oControlEvent.getParameters.value	The value of the custom setting

ganttChartChangeRequested(oControlEvent)

Event fired when any change occurs in the toolbar that requests the application to change aggregation ganttCharts.

Possible triggers are:

The source selection group changes in the container toolbar.
The layout group button is clicked in the container toolbar.
The source selection group changes in the Gantt chart toolbar.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{string}	oControlEvent.getParameters.action	Action that caused the change. Possible action values are: `'switchGanttChart'`: The source selection group of one Gantt chart toolbar is changed. `'addGanttChart'`: The Add Gantt chart dropdown menu is selected. `'lessGanttChart'`: The Less Gantt chart dropdown menu is selected. `'switchContainerLayout'`: The source selection group of the Container toolbar is changed.
{int}	oControlEvent.getParameters.ganttChartIndex	Provided for actions `'switchGanttChart'` and `'lessGanttChart'`.
{string}	oControlEvent.getParameters.hierarchyKey	Provided for actions `'switchGanttChart'`, `'addGanttChart'` and `'lessGanttChart'`.
{string}	oControlEvent.getParameters.oldHierarchyKey	Provided for action `'switchGanttChart'`.
{string}	oControlEvent.getParameters.containerLayoutKey	Provided for action `'switchContainerLayout'`.

treeTableToggleEvent(oControlEvent)

Event fired when toggle node of the tree table.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{int}	oControlEvent.getParameters.rowIndex	The index of the expanded/collapsed row.
{object}	oControlEvent.getParameters.rowContext	The binding context of the selected row.
{boolean}	oControlEvent.getParameters.expanded	flag whether the node has been expanded or collapsed.

Method Detail

sap.gantt.GanttChartContainer.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.gantt.GanttChartContainer with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in Object.extend.

Parameters:

{string}	sClassName	Name of the class being created
{object}	oClassInfo?	Object literal with information about the class
{function}	FNMetaImpl?	Constructor function for the metadata object; if not given, it defaults to `sap.ui.core.ElementMetadata`

Returns:

{function}

Created class / constructor function

sap.gantt.GanttChartContainer.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.gantt.GanttChartContainer.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

addCustomToolbarItem(oCustomToolbarItem): sap.gantt.GanttChartContainer

Adds some customToolbarItem to the aggregation customToolbarItems.

Parameters:

{sap.ui.core.Control}

oCustomToolbarItem

the customToolbarItem to add; if empty, nothing is inserted

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

addGanttChart(oGanttChart): sap.gantt.GanttChartContainer

Adds some ganttChart to the aggregation ganttCharts.

Parameters:

{sap.gantt.GanttChartBase}

oGanttChart

the ganttChart to add; if empty, nothing is inserted

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

attachCustomSettingChange(oData?, fnFunction, oListener?): sap.gantt.GanttChartContainer

Attaches event handler fnFunction to the customSettingChange event of this sap.gantt.GanttChartContainer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.gantt.GanttChartContainer itself.

Event fired when the custom settings are changed.

The Custom settings are application-injected settings that can be configured in the Settings dialog box. This event allows the application to handle these settings. Only check boxes are supported.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.gantt.GanttChartContainer` itself

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

attachGanttChartChangeRequested(oData?, fnFunction, oListener?): sap.gantt.GanttChartContainer

Attaches event handler fnFunction to the ganttChartChangeRequested event of this sap.gantt.GanttChartContainer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.gantt.GanttChartContainer itself.

Event fired when any change occurs in the toolbar that requests the application to change aggregation ganttCharts.

Possible triggers are:

The source selection group changes in the container toolbar.
The layout group button is clicked in the container toolbar.
The source selection group changes in the Gantt chart toolbar.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.gantt.GanttChartContainer` itself

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

attachTreeTableToggleEvent(oData?, fnFunction, oListener?): sap.gantt.GanttChartContainer

Attaches event handler fnFunction to the treeTableToggleEvent event of this sap.gantt.GanttChartContainer.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.gantt.GanttChartContainer itself.

Event fired when toggle node of the tree table.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.gantt.GanttChartContainer` itself

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

bindCustomToolbarItems(oBindingInfo): sap.gantt.GanttChartContainer

Binds aggregation customToolbarItems to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Parameters:

{object}

oBindingInfo

The binding information

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

bindGanttCharts(oBindingInfo): sap.gantt.GanttChartContainer

Binds aggregation ganttCharts to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Parameters:

{object}

oBindingInfo

The binding information

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

deselectRelationships(iGanttChartIndex?, aIds?): boolean

Deselects relationships and returns a success code.

Parameters:

{int}	iGanttChartIndex?	Index of the Gantt chart containing the relationships that you want to deselect
{array}	aIds?	List of the relationships that you want to deselect

Returns:

{boolean}

- If any selection change is applied, returns true.

deselectRows(iGanttChartIndex?, aIds?): boolean

Deselects rows and returns a success code.

Parameters:

{int}	iGanttChartIndex?	Index of the Gantt chart containing the rows that you want to deselect
{array}	aIds?	List of the rows that you want to deselect

Returns:

{boolean}

- If any selection change is applied, returns true.

deselectShapes(iGanttChartIndex?, aIds?): boolean

Deselects in-row shapes and returns a success code.

Parameters:

{int}	iGanttChartIndex?	Index of the Gantt chart containing the shapes that you want to deselect
{array}	aIds?	List of the shapes that you want to deselect

Returns:

{boolean}

- If any selection change is applied, returns true.

destroyCustomToolbarItems(): sap.gantt.GanttChartContainer

Destroys all the customToolbarItems in the aggregation customToolbarItems.

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

destroyGanttCharts(): sap.gantt.GanttChartContainer

Destroys all the ganttCharts in the aggregation ganttCharts.

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

destroyLegendContainer(): sap.gantt.GanttChartContainer

Destroys the legendContainer in the aggregation legendContainer.

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

detachCustomSettingChange(fnFunction, oListener): sap.gantt.GanttChartContainer

Detaches event handler fnFunction from the customSettingChange event of this sap.gantt.GanttChartContainer.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

detachGanttChartChangeRequested(fnFunction, oListener): sap.gantt.GanttChartContainer

Detaches event handler fnFunction from the ganttChartChangeRequested event of this sap.gantt.GanttChartContainer.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

detachTreeTableToggleEvent(fnFunction, oListener): sap.gantt.GanttChartContainer

Detaches event handler fnFunction from the treeTableToggleEvent event of this sap.gantt.GanttChartContainer.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

fireCustomSettingChange(mArguments?): sap.gantt.GanttChartContainer

Fires event customSettingChange to attached listeners.

Expects the following event parameters:

id of type stringID of the custom setting
value of type booleanThe value of the custom setting

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

fireGanttChartChangeRequested(mArguments?): sap.gantt.GanttChartContainer

Fires event ganttChartChangeRequested to attached listeners.

Expects the following event parameters:

action of type stringAction that caused the change.
Possible action values are:
- 'switchGanttChart': The source selection group of one Gantt chart toolbar is changed.
- 'addGanttChart': The Add Gantt chart dropdown menu is selected.
- 'lessGanttChart': The Less Gantt chart dropdown menu is selected.
- 'switchContainerLayout': The source selection group of the Container toolbar is changed.
ganttChartIndex of type intProvided for actions 'switchGanttChart' and 'lessGanttChart'.
hierarchyKey of type stringProvided for actions 'switchGanttChart', 'addGanttChart' and 'lessGanttChart'.
oldHierarchyKey of type stringProvided for action 'switchGanttChart'.
containerLayoutKey of type stringProvided for action 'switchContainerLayout'.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

fireTreeTableToggleEvent(mArguments?): sap.gantt.GanttChartContainer

Fires event treeTableToggleEvent to attached listeners.

Expects the following event parameters:

rowIndex of type intThe index of the expanded/collapsed row.
rowContext of type objectThe binding context of the selected row.
expanded of type booleanflag whether the node has been expanded or collapsed.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

getAllSelections(iGanttChartIndex?): object

Gets all selected rows and shapes, including relationships.

Parameters:

{int}

iGanttChartIndex?

Index of the Gantt chart containing that you want to get

Returns:

{object}

The returned object contains "rows" for all selected rows, "shapes" for all selected shapes, and "relationships" for all selected relationships

getContainerLayoutKey(): string

Gets current value of property containerLayoutKey.

Current container layout key.

This is a key configured in configuration property containerLayouts.

Default value is sap.gantt.config.DEFAULT_CONTAINER_SINGLE_LAYOUT_KEY.

Returns:

{string} Value of property containerLayoutKey

getContainerLayouts(): array

Gets current value of property containerLayouts.

Configuration of container layouts.

This configuration affects the data source selection ComboBox in the Container Toolbar. When the selection changes, the ganttChartChangeRequested event that is triggered includes the corresponding layout key.

Default value is sap.gantt.config.DEFAULT_CONTAINER_LAYOUTS.

Returns:

{array} Value of property containerLayouts

getCustomToolbarItems(): sap.ui.core.Control[]

Gets content of aggregation customToolbarItems.

Controls to be placed in the container toolbar.

This aggregation is used only when the custom toolbar item group is configured to be shown in the container toolbar. Different from the built-in buttons that are configured to be shown or hidden, these controls are free controls created by the application, but are only placed in the container toolbar by sap.gantt.GanttChartContainer.

If the source selection group is enabled and you want your application to use a container layout pre-configured for a specific source, you can implement your custom toolbar items in the event handler of event ganttChartChangeRequested.

Returns:

{sap.ui.core.Control[]}

getEnableCursorLine(): boolean

Gets current value of property enableCursorLine.

Switch to enable and disable the cursor line that follows the cursor.

When this value is set, it overrides the corresponding value on instances of aggregation ganttCharts.

Default value is true.

Returns:

{boolean} Value of property enableCursorLine

getEnableNowLine(): boolean

Gets current value of property enableNowLine.

Switch to enable and disable the present time indicator.

When this value is set, it overrides the corresponding value on instances of aggregation ganttCharts.

Default value is true.

Returns:

{boolean} Value of property enableNowLine

getEnableTimeScrollSync(): boolean

Gets current value of property enableTimeScrollSync.

Switch to enable and disable scroll synchronization by time on instances of aggregation ganttCharts.

Default value is true.

Returns:

{boolean} Value of property enableTimeScrollSync

getEnableVerticalLine(): boolean

Gets current value of property enableVerticalLine.

Switch to enable and disable vertical lines representing intervals along the time axis.

When this value is set, it overrides the corresponding value on instances of aggregation ganttCharts.

Default value is true.

Returns:

{boolean} Value of property enableVerticalLine

getGanttCharts(): sap.gantt.GanttChartBase[]

Gets content of aggregation ganttCharts.

Gantt chart instances.

Provide a Gantt chart in compliance with the container layout setting. GanttChartContainer is designed to support Gantt chart layouts that include multiple views.

Returns:

{sap.gantt.GanttChartBase[]}

getHeight(): sap.ui.core.CSSSize

Gets current value of property height.

Height of the control

Default value is 100%.

Returns:

{sap.ui.core.CSSSize} Value of property height

getHierarchies(): array

Gets current value of property hierarchies.

List of available hierarchies. If not provided, a default configuration is provided.

Default value is sap.gantt.config.DEFAULT_HIERARCHYS.

Returns:

{array} Value of property hierarchies

getLegendContainer(): sap.gantt.legend.LegendContainer

Gets content of aggregation legendContainer.

Legend shown when the legend button is clicked.

This aggregation is used only when the Legend button is configured to be shown in the container toolbar.

Returns:

{sap.gantt.legend.LegendContainer}

getMaxNumOfGanttCharts(): int

Gets current value of property maxNumOfGanttCharts.

Define the maximum number of Gantt charts to be displayed on the same screen. When this number is reached, the "Add Gantt Chart" button is grayed out.

Default value is 3.

Returns:

{int} Value of property maxNumOfGanttCharts

getModes(): array

Gets current value of property modes.

List of available modes. To apply modes to the toolbar and shapes, further configuration is needed. (specifically, in property toolbarSchemes, and properties toolbarSchemes and shapes in the GanttChartBase class)If not provided, a default configuration is provided.

Default value is sap.gantt.config.DEFAULT_MODES.

Returns:

{array} Value of property modes

getSelectedRelationships(iGanttChartIndex?): array

Gets the selected relationships.

Parameters:

{int}

iGanttChartIndex?

Index of the Gantt chart containing the selected relationships that you want to get

Returns:

{array}

Returns all selected relationships in the chart

getSelectedRows(iGanttChartIndex?): array

Gets the selected rows.

Parameters:

{int}

iGanttChartIndex?

Index of the Gantt chart containing the selected rows that you want to get

Returns:

{array}

Returns all selected rows

getSelectedShapes(iGanttChartIndex?): array

Gets the selected in-row shapes.

Parameters:

{int}

iGanttChartIndex?

Index of the Gantt chart containing the selected shapes that you want to get

Returns:

{array}

Returns all selected shapes in the chart

getSliderStep(): int

Gets current value of property sliderStep.

Define the amount of units to change the time zoom slider.

See sap.m.Slider#setStep

Default value is 10.

Returns:

{int} Value of property sliderStep

getSvgDefs(): sap.gantt.def.SvgDefs

Gets current value of property svgDefs.

Definitions of paint servers used for advanced shape features around SVG fill, stroke, and filter attributes.

If this property is provided, the paint server definition of the SVG is rendered. Method getDefString() should be implemented by all paint server classes that are passed in in this property. It is easier to assign a common paint server definition in this class instead of in separate instances of sap.gantt.GanttChartBase. Then the definition is rendered only once.

Returns:

{sap.gantt.def.SvgDefs} Value of property svgDefs

getToolbarSchemeKey(): string

Returns the current effective toolbar scheme key.

Returns:

{string}

- Toolbar scheme key.

getToolbarSchemes(): array

Gets current value of property toolbarSchemes.

List of available toolbar schemes. If not provided, a default configuration is provided.

Default value is sap.gantt.config.DEFAULT_CONTAINER_TOOLBAR_SCHEMES.

Returns:

{array} Value of property toolbarSchemes

getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

Width of the control

Default value is 100%.

Returns:

{sap.ui.core.CSSSize} Value of property width

indexOfCustomToolbarItem(oCustomToolbarItem): int

Checks for the provided sap.ui.core.Control in the aggregation customToolbarItems. and returns its index if found or -1 otherwise.

Parameters:

{sap.ui.core.Control}

oCustomToolbarItem

The customToolbarItem whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

indexOfGanttChart(oGanttChart): int

Checks for the provided sap.gantt.GanttChartBase in the aggregation ganttCharts. and returns its index if found or -1 otherwise.

Parameters:

{sap.gantt.GanttChartBase}

oGanttChart

The ganttChart whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

insertCustomToolbarItem(oCustomToolbarItem, iIndex): sap.gantt.GanttChartContainer

Inserts a customToolbarItem into the aggregation customToolbarItems.

Parameters:

{sap.ui.core.Control}	oCustomToolbarItem	the customToolbarItem to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the customToolbarItem should be inserted at; for a negative value of `iIndex`, the customToolbarItem is inserted at position 0; for a value greater than the current size of the aggregation, the customToolbarItem is inserted at the last position

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

insertGanttChart(oGanttChart, iIndex): sap.gantt.GanttChartContainer

Inserts a ganttChart into the aggregation ganttCharts.

Parameters:

{sap.gantt.GanttChartBase}	oGanttChart	the ganttChart to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the ganttChart should be inserted at; for a negative value of `iIndex`, the ganttChart is inserted at position 0; for a value greater than the current size of the aggregation, the ganttChart is inserted at the last position

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

removeAllCustomToolbarItems(): sap.ui.core.Control[]

Removes all the controls from the aggregation customToolbarItems.

Additionally, it unregisters them from the hosting UIArea.

Returns:

{sap.ui.core.Control[]}

An array of the removed elements (might be empty)

removeAllGanttCharts(): sap.gantt.GanttChartBase[]

Removes all the controls from the aggregation ganttCharts.

Additionally, it unregisters them from the hosting UIArea.

Returns:

{sap.gantt.GanttChartBase[]}

An array of the removed elements (might be empty)

removeCustomToolbarItem(vCustomToolbarItem): sap.ui.core.Control

Removes a customToolbarItem from the aggregation customToolbarItems.

Parameters:

{int|string|sap.ui.core.Control}

vCustomToolbarItem

The customToolbarItemto remove or its index or id

Returns:

{sap.ui.core.Control} The removed customToolbarItem or null

removeGanttChart(vGanttChart): sap.gantt.GanttChartBase

Removes a ganttChart from the aggregation ganttCharts.

Parameters:

{int|string|sap.gantt.GanttChartBase}

vGanttChart

The ganttChartto remove or its index or id

Returns:

{sap.gantt.GanttChartBase} The removed ganttChart or null

selectRelationships(iGanttChartIndex?, aIds?, isExclusive?): boolean

Selects relationships and returns a success code.

Parameters:

{int}	iGanttChartIndex?	Index of the Gantt chart containing the relationships that you want to select
{array}	aIds?	List of the relationships that you want to select
{boolean}	isExclusive?	Whether all other selected relationships are to be deselected

Returns:

{boolean}

- If any selection change is applied, returns true.

selectRows(iGanttChartIndex?, aIds?, isExclusive?): boolean

Selects rows and returns a success code.

Parameters:

{int}	iGanttChartIndex?	Index of the Gantt chart containing the rows that you want to select
{array}	aIds?	List of the rows that you want to select
{boolean}	isExclusive?	Whether all other selected rows are to be deselected

Returns:

{boolean}

- If any selection change is applied, returns true.

selectRowsAndShapes(iGanttChartIndex?, aIds?, bIsExclusive?): boolean

Selects rows and all shapes contained in these rows.

Parameters:

{int}	iGanttChartIndex?	Index of the Gantt chart containing the rows and shapes that you want to select
{array}	aIds?	Row UIDs
{boolean}	bIsExclusive?	Whether reset all other selected rows and shapes are to be reset

Returns:

{boolean}

- If any selection change is applied, returns true.

selectShapes(iGanttChart?, aIds?, isExclusive?): boolean

Selects in-row shapes and returns a success code.

Parameters:

{int}	iGanttChart?	Index of the Gantt chart containing the shapes that you want to select
{array}	aIds?	L of the shape IDs that you want to select
{boolean}	isExclusive?	Whether all other selected shapes are to be deselected

Returns:

{boolean}

- If any selection change is applied, returns true.

setContainerLayoutKey(sContainerLayoutKey): sap.gantt.GanttChartContainer

Sets a new value for property containerLayoutKey.

Current container layout key.

This is a key configured in configuration property containerLayouts.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is sap.gantt.config.DEFAULT_CONTAINER_SINGLE_LAYOUT_KEY.

Parameters:

{string} sContainerLayoutKey New value for property containerLayoutKey

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

setContainerLayouts(sContainerLayouts): sap.gantt.GanttChartContainer

Sets a new value for property containerLayouts.

Configuration of container layouts.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is sap.gantt.config.DEFAULT_CONTAINER_LAYOUTS.

Parameters:

{array} sContainerLayouts New value for property containerLayouts

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

setEnableCursorLine(bEnableCursorLine): sap.gantt.GanttChartContainer

Sets a new value for property enableCursorLine.

Switch to enable and disable the cursor line that follows the cursor.

When this value is set, it overrides the corresponding value on instances of aggregation ganttCharts.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:

{boolean} bEnableCursorLine New value for property enableCursorLine

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

setEnableNowLine(bEnableNowLine): sap.gantt.GanttChartContainer

Sets a new value for property enableNowLine.

Switch to enable and disable the present time indicator.

When this value is set, it overrides the corresponding value on instances of aggregation ganttCharts.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:

{boolean} bEnableNowLine New value for property enableNowLine

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

setEnableTimeScrollSync(bEnableTimeScrollSync): sap.gantt.GanttChartContainer

Sets a new value for property enableTimeScrollSync.

Switch to enable and disable scroll synchronization by time on instances of aggregation ganttCharts.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:

{boolean} bEnableTimeScrollSync New value for property enableTimeScrollSync

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

setEnableVerticalLine(bEnableVerticalLine): sap.gantt.GanttChartContainer

Sets a new value for property enableVerticalLine.

Switch to enable and disable vertical lines representing intervals along the time axis.

When this value is set, it overrides the corresponding value on instances of aggregation ganttCharts.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:

{boolean} bEnableVerticalLine New value for property enableVerticalLine

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

setHeight(sHeight): sap.gantt.GanttChartContainer

Sets a new value for property height.

Height of the control

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 100%.

Parameters:

{sap.ui.core.CSSSize} sHeight New value for property height

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

setHierarchies(sHierarchies): sap.gantt.GanttChartContainer

Sets a new value for property hierarchies.

List of available hierarchies. If not provided, a default configuration is provided.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is sap.gantt.config.DEFAULT_HIERARCHYS.

Parameters:

{array} sHierarchies New value for property hierarchies

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

setLegendContainer(oLegendContainer): sap.gantt.GanttChartContainer

Sets the aggregated legendContainer.

Parameters:

{sap.gantt.legend.LegendContainer}

oLegendContainer

The legendContainer to set

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

setMaxNumOfGanttCharts(iMaxNumOfGanttCharts): sap.gantt.GanttChartContainer

Sets a new value for property maxNumOfGanttCharts.

Define the maximum number of Gantt charts to be displayed on the same screen. When this number is reached, the "Add Gantt Chart" button is grayed out.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 3.

Parameters:

{int} iMaxNumOfGanttCharts New value for property maxNumOfGanttCharts

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

setModes(sModes): sap.gantt.GanttChartContainer

Sets a new value for property modes.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is sap.gantt.config.DEFAULT_MODES.

Parameters:

{array} sModes New value for property modes

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

setSliderStep(iSliderStep): sap.gantt.GanttChartContainer

Sets a new value for property sliderStep.

Define the amount of units to change the time zoom slider.

See sap.m.Slider#setStep

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 10.

Parameters:

{int} iSliderStep New value for property sliderStep

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

setSvgDefs(sSvgDefs): sap.gantt.GanttChartContainer

Sets a new value for property svgDefs.

Definitions of paint servers used for advanced shape features around SVG fill, stroke, and filter attributes.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:

{sap.gantt.def.SvgDefs} sSvgDefs New value for property svgDefs

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

setToolbarSchemes(sToolbarSchemes): sap.gantt.GanttChartContainer

Sets a new value for property toolbarSchemes.

List of available toolbar schemes. If not provided, a default configuration is provided.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is sap.gantt.config.DEFAULT_CONTAINER_TOOLBAR_SCHEMES.

Parameters:

{array} sToolbarSchemes New value for property toolbarSchemes

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

setWidth(sWidth): sap.gantt.GanttChartContainer

Sets a new value for property width.

Width of the control

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 100%.

Parameters:

{sap.ui.core.CSSSize} sWidth New value for property width

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

switchOrientation(vOrientation?, bReadConfig?): object

Switches the splitter orientation.

Parameters:

{string}	vOrientation?	Target orientation. If not provided, this method inverts the orientation.
{boolean}	bReadConfig?	If this value is provided, it overrides the target orientation from the current configuration indicated by property `containerLayoutKey`.

Returns:

{object} - this

unbindCustomToolbarItems(): sap.gantt.GanttChartContainer

Unbinds aggregation customToolbarItems from model data.

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining

unbindGanttCharts(): sap.gantt.GanttChartContainer

Unbinds aggregation ganttCharts from model data.

Returns:

{sap.gantt.GanttChartContainer} Reference to this in order to allow method chaining