Abstract Class sap.gantt.GanttChartBaseModule: sap/gantt/GanttChartBase

extends Control
known direct subclasses: GanttChart, GanttChartWithTable

Base class for all Gantt charts.

This base class defines:

  • Basic properties and aggregations.
  • Metadata required integrate with GanttChartContainer.
sap.gantt provides two basic implementations of GanttChartBase:
  • sap.gantt.GanttChart - A chart area that contains rows along the vertical axis and a time scale along the horizontal axis.
  • sap.gantt.GanttChartWithTable - A tree table and a chart area separated by a splitter with rows synchronized.

Constructor Summary
new sap.gantt.GanttChartBase(sId?, mSettings?)Creates and initializes a new Gantt chart.
Event Summary
chartClick(oControlEvent)Event fired when the chart is clicked
chartDoubleClick(oControlEvent)Event fired when the chart is double-clicked
chartDragEnter(oControlEvent)
chartDragLeave(oControlEvent)
chartMouseOver(oControlEvent)Event is fired when a mouse-hover occurs in the graphic part.
chartRightClick(oControlEvent)Event fired when the chart is right-clicked
ganttChartSwitchRequested(oControlEvent)Event fired when the hierarchy key has changed in the Gantt chart toolbar.
horizontalScroll(oControlEvent)Horizontal (time axis) scroll.
relationshipSelectionChange(oControlEvent)Event fired when the selection status of relationships changes.
rowSelectionChange(oControlEvent)Event fired when the selection status of rows changes.
shapeDragEnd(oControlEvent)Event fired when a drag-and-drop occurs on one or more selected shapes.
shapeSelectionChange(oControlEvent)Event fired when the selection status of shapes changes.
splitterResize(oControlEvent)Splitter (if exists) resized.
treeTableToggleEvent(oControlEvent)Event fired when toggle node of the tree table.
verticalScroll(oControlEvent)Vertical (row axis) scroll.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.gantt.GanttChartBase.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.GanttChartBase with name sClassName and enriches it with the information contained in oClassInfo.
sap.gantt.GanttChartBase.getMetadata()Returns a metadata object for class sap.gantt.GanttChartBase.
addRelationship(oRelationship)Adds some relationship to the aggregation relationships.
addRow(oRow)Adds some row to the aggregation rows.
attachChartClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the chartClick event of this sap.gantt.GanttChartBase.
attachChartDoubleClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the chartDoubleClick event of this sap.gantt.GanttChartBase.
attachChartDragEnter(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the chartDragEnter event of this sap.gantt.GanttChartBase.
attachChartDragLeave(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the chartDragLeave event of this sap.gantt.GanttChartBase.
attachChartMouseOver(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the chartMouseOver event of this sap.gantt.GanttChartBase.
attachChartRightClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the chartRightClick event of this sap.gantt.GanttChartBase.
attachGanttChartSwitchRequested(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the ganttChartSwitchRequested event of this sap.gantt.GanttChartBase.
attachHorizontalScroll(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the horizontalScroll event of this sap.gantt.GanttChartBase.
attachRelationshipSelectionChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the relationshipSelectionChange event of this sap.gantt.GanttChartBase.
attachRowSelectionChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the rowSelectionChange event of this sap.gantt.GanttChartBase.
attachShapeDragEnd(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the shapeDragEnd event of this sap.gantt.GanttChartBase.
attachShapeSelectionChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the shapeSelectionChange event of this sap.gantt.GanttChartBase.
attachSplitterResize(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the splitterResize event of this sap.gantt.GanttChartBase.
attachTreeTableToggleEvent(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the treeTableToggleEvent event of this sap.gantt.GanttChartBase.
attachVerticalScroll(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the verticalScroll event of this sap.gantt.GanttChartBase.
bindCalendarDef(oBindingInfo)Binds aggregation calendarDef to model data.
bindRelationships(oBindingInfo)Binds aggregation relationships to model data.
bindRows(oBindingInfo)Binds aggregation rows to model data.
destroyCalendarDef()Destroys the calendarDef in the aggregation calendarDef.
destroyRelationships()Destroys all the relationships in the aggregation relationships.
destroyRows()Destroys all the rows in the aggregation rows.
detachChartClick(fnFunction, oListener)Detaches event handler fnFunction from the chartClick event of this sap.gantt.GanttChartBase.
detachChartDoubleClick(fnFunction, oListener)Detaches event handler fnFunction from the chartDoubleClick event of this sap.gantt.GanttChartBase.
detachChartDragEnter(fnFunction, oListener)Detaches event handler fnFunction from the chartDragEnter event of this sap.gantt.GanttChartBase.
detachChartDragLeave(fnFunction, oListener)Detaches event handler fnFunction from the chartDragLeave event of this sap.gantt.GanttChartBase.
detachChartMouseOver(fnFunction, oListener)Detaches event handler fnFunction from the chartMouseOver event of this sap.gantt.GanttChartBase.
detachChartRightClick(fnFunction, oListener)Detaches event handler fnFunction from the chartRightClick event of this sap.gantt.GanttChartBase.
detachGanttChartSwitchRequested(fnFunction, oListener)Detaches event handler fnFunction from the ganttChartSwitchRequested event of this sap.gantt.GanttChartBase.
detachHorizontalScroll(fnFunction, oListener)Detaches event handler fnFunction from the horizontalScroll event of this sap.gantt.GanttChartBase.
detachRelationshipSelectionChange(fnFunction, oListener)Detaches event handler fnFunction from the relationshipSelectionChange event of this sap.gantt.GanttChartBase.
detachRowSelectionChange(fnFunction, oListener)Detaches event handler fnFunction from the rowSelectionChange event of this sap.gantt.GanttChartBase.
detachShapeDragEnd(fnFunction, oListener)Detaches event handler fnFunction from the shapeDragEnd event of this sap.gantt.GanttChartBase.
detachShapeSelectionChange(fnFunction, oListener)Detaches event handler fnFunction from the shapeSelectionChange event of this sap.gantt.GanttChartBase.
detachSplitterResize(fnFunction, oListener)Detaches event handler fnFunction from the splitterResize event of this sap.gantt.GanttChartBase.
detachTreeTableToggleEvent(fnFunction, oListener)Detaches event handler fnFunction from the treeTableToggleEvent event of this sap.gantt.GanttChartBase.
detachVerticalScroll(fnFunction, oListener)Detaches event handler fnFunction from the verticalScroll event of this sap.gantt.GanttChartBase.
fireChartClick(mArguments?)Fires event chartClick to attached listeners.
fireChartDoubleClick(mArguments?)Fires event chartDoubleClick to attached listeners.
fireChartDragEnter(mArguments?)Fires event chartDragEnter to attached listeners.
fireChartDragLeave(mArguments?)Fires event chartDragLeave to attached listeners.
fireChartMouseOver(mArguments?)Fires event chartMouseOver to attached listeners.
fireChartRightClick(mArguments?)Fires event chartRightClick to attached listeners.
fireGanttChartSwitchRequested(mArguments?)Fires event ganttChartSwitchRequested to attached listeners.
fireHorizontalScroll(mArguments?)Fires event horizontalScroll to attached listeners.
fireRelationshipSelectionChange(mArguments?)Fires event relationshipSelectionChange to attached listeners.
fireRowSelectionChange(mArguments?)Fires event rowSelectionChange to attached listeners.
fireShapeDragEnd(mArguments?)Fires event shapeDragEnd to attached listeners.
fireShapeSelectionChange(mArguments?)Fires event shapeSelectionChange to attached listeners.
fireSplitterResize(mArguments?)Fires event splitterResize to attached listeners.
fireTreeTableToggleEvent(mArguments?)Fires event treeTableToggleEvent to attached listeners.
fireVerticalScroll(mArguments?)Fires event verticalScroll to attached listeners.
getAxisOrdinal()Provides the Ordinal Axis that is used to draw the SVG graphic.
getAxisTime()Provides the Time Axis that is used to draw the SVG graphic.
getBaseRowHeight()Gets current value of property baseRowHeight.
getCalendarDef()Gets content of aggregation calendarDef.
getChartSchemes()Gets current value of property chartSchemes.
getEnableCursorLine()Gets current value of property enableCursorLine.
getEnableNowLine()Gets current value of property enableNowLine.
getEnableVerticalLine()Gets current value of property enableVerticalLine.
getHeight()Gets current value of property height.
getHierarchies()Gets current value of property hierarchies.
getHierarchyKey()Gets current value of property hierarchyKey.
getLocale()Gets current value of property locale.
getMode()Gets current value of property mode.
getModes()Gets current value of property modes.
getObjectTypes()Gets current value of property objectTypes.
getRelationships()Gets content of aggregation relationships.
getRows()Gets content of aggregation rows.
getSelectionMode()Gets current value of property selectionMode.
getSelectionPanelSize()Gets current value of property selectionPanelSize.
getShapeDataNames()Gets current value of property shapeDataNames.
getShapes()Gets current value of property shapes.
getSvgDefs()Gets current value of property svgDefs.
getTimeAxis()Gets current value of property timeAxis.
getTimeZoomRate()Gets current value of property timeZoomRate.
getToolbarSchemes()Gets current value of property toolbarSchemes.
getWidth()Gets current value of property width.
handleExpandChartChange(bExpanded, aChartSchemes, aSelectedIndices)Default event handler for internal event expandChartChange from global TOOLBAR.
indexOfRelationship(oRelationship)Checks for the provided sap.ui.core.Control in the aggregation relationships.
indexOfRow(oRow)Checks for the provided sap.ui.core.Control in the aggregation rows.
init()Initializes the GanttChart instance after creation.
insertRelationship(oRelationship, iIndex)Inserts a relationship into the aggregation relationships.
insertRow(oRow, iIndex)Inserts a row into the aggregation rows.
jumpToPosition(vDate)Jumps to a given time.
notifySourceChange()Notify that the data source had changed.
removeAllRelationships()Removes all the controls from the aggregation relationships.
removeAllRows()Removes all the controls from the aggregation rows.
removeRelationship(vRelationship)Removes a relationship from the aggregation relationships.
removeRow(vRow)Removes a row from the aggregation rows.
setBaseRowHeight(iBaseRowHeight)Sets a new value for property baseRowHeight.
setCalendarDef(oCalendarDef)Sets the aggregated calendarDef.
setChartSchemes(sChartSchemes)Sets a new value for property chartSchemes.
setEnableCursorLine(bEnableCursorLine)Sets a new value for property enableCursorLine.
setEnableNowLine(bEnableNowLine)Sets a new value for property enableNowLine.
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.
setHierarchyKey(sHierarchyKey)Sets a new value for property hierarchyKey.
setLocale(sLocale)Sets a new value for property locale.
setMode(sMode)Sets a new value for property mode.
setModes(sModes)Sets a new value for property modes.
setObjectTypes(sObjectTypes)Sets a new value for property objectTypes.
setSelectionMode(sSelectionMode)Sets a new value for property selectionMode.
setSelectionPanelSize(sSelectionPanelSize)Sets a new value for property selectionPanelSize.
setShapeDataNames(sShapeDataNames)Sets a new value for property shapeDataNames.
setShapes(sShapes)Sets a new value for property shapes.
setSvgDefs(sSvgDefs)Sets a new value for property svgDefs.
setTimeAxis(sTimeAxis)Sets a new value for property timeAxis.
setTimeZoomRate(fTimeZoomRate)Sets a new value for property timeZoomRate.
setToolbarSchemes(sToolbarSchemes)Sets a new value for property toolbarSchemes.
setWidth(sWidth)Sets a new value for property width.
unbindCalendarDef()Unbinds aggregation calendarDef from model data.
unbindRelationships()Unbinds aggregation relationships from model data.
unbindRows()Unbinds aggregation rows from model data.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.gantt.GanttChartBase(sId?, mSettings?)
Creates and initializes a new Gantt chart.

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
  • Aggregations
  • Events
    • ganttChartSwitchRequested : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • splitterResize : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • horizontalScroll : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • verticalScroll : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • chartMouseOver : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • chartClick : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • chartDoubleClick : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • chartRightClick : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • chartDragEnter : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • chartDragLeave : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • rowSelectionChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • relationshipSelectionChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • shapeSelectionChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • shapeDragEnd : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • treeTableToggleEvent : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

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
chartClick(oControlEvent)
Event fired when the chart is clicked
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.objectInfo Row object information of the current mouse point.
{object}oControlEvent.getParameters.leadingRowInfo Leading row object information. null when it is the main row at current mouse point; main row information if it is one of multiple expanded rows.
{string}oControlEvent.getParameters.timestamp Timestamp of the current mouse point.
{string}oControlEvent.getParameters.svgId ID of SVG.
{int[]}oControlEvent.getParameters.svgCoordinate [x, y] Coordinate of the current mouse point in the SVG coordinate system.
{string}oControlEvent.getParameters.effectingMode Effective mode. It can be the current Gantt Chart mode or the mode derived from the chart scheme mode.
{object}oControlEvent.getParameters.originEvent Original JQuery event object.
chartDoubleClick(oControlEvent)
Event fired when the chart is double-clicked
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.objectInfo Row object information of the current mouse point.
{object}oControlEvent.getParameters.leadingRowInfo Leading row object information. null when it is the main row at current mouse point; main row information if it is one of multiple expanded rows.
{string}oControlEvent.getParameters.timestamp Timestamp of the current mouse point.
{string}oControlEvent.getParameters.svgId ID of SVG.
{int[]}oControlEvent.getParameters.svgCoordinate [x, y] Coordinate of the current mouse point in the SVG coordinate system.
{string}oControlEvent.getParameters.effectingMode Effective mode. It can be the current Gantt Chart mode or the mode derived from the chart scheme mode.
{object}oControlEvent.getParameters.originEvent Original JQuery event object.
chartDragEnter(oControlEvent)
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.originEvent
chartDragLeave(oControlEvent)
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.originEvent
{object}oControlEvent.getParameters.draggingSource
chartMouseOver(oControlEvent)
Event is fired when a mouse-hover occurs in the graphic part.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.objectInfo Row object information of the current mouse point.
{object}oControlEvent.getParameters.leadingRowInfo Leading row object information. null when it is the main row at current mouse point; main row information if it is one of multiple expanded rows.
{string}oControlEvent.getParameters.timestamp Timestamp of the current mouse point.
{string}oControlEvent.getParameters.svgId ID of SVG.
{int[]}oControlEvent.getParameters.svgCoordinate [x, y] Coordinate of the current mouse point in the SVG coordinate system.
{string}oControlEvent.getParameters.effectingMode Effective mode. It can be the current Gantt Chart mode or the mode derived from the chart scheme mode.
{object}oControlEvent.getParameters.originEvent Original JQuery event object.
chartRightClick(oControlEvent)
Event fired when the chart is right-clicked
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.objectInfo Row object information of the current mouse point.
{object}oControlEvent.getParameters.leadingRowInfo Leading row object information. null when it is the main row at current mouse point; main row information if it is one of multiple expanded rows.
{string}oControlEvent.getParameters.timestamp Timestamp of the current mouse point.
{string}oControlEvent.getParameters.svgId ID of SVG.
{int[]}oControlEvent.getParameters.svgCoordinate [x, y] Coordinate of the current mouse point in the SVG coordinate system.
{string}oControlEvent.getParameters.effectingMode Effective mode. It can be the current Gantt Chart mode or a mode derived from the chart scheme mode.
{object}oControlEvent.getParameters.originEvent Original JQuery event object.
ganttChartSwitchRequested(oControlEvent)
Event fired when the hierarchy key has changed in the Gantt chart toolbar.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.hierarchyKey Target hierarchy key.
horizontalScroll(oControlEvent)
Horizontal (time axis) scroll.

If the horizontal scroll bar exists and synchronization is needed with other Gantt charts in the container, use this event.

Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{int}oControlEvent.getParameters.scrollSteps Scroll steps.
relationshipSelectionChange(oControlEvent)
Event fired when the selection status of relationships changes.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.originEvent Original JQuery event object.
rowSelectionChange(oControlEvent)
Event fired when the selection status of rows changes.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.originEvent Original JQuery event object.
shapeDragEnd(oControlEvent)
Event fired when a drag-and-drop occurs on one or more selected shapes.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.originEvent Original JQuery event object.
{object[]}oControlEvent.getParameters.sourceShapeData List of source shape data.
{string}oControlEvent.getParameters.sourceSvgId Source SVG ID.
{object[]}oControlEvent.getParameters.targetData List of target shape data. Sorted by shape level.
{string}oControlEvent.getParameters.targetSvgId Target SVG ID.
shapeSelectionChange(oControlEvent)
Event fired when the selection status of shapes changes.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.originEvent Original JQuery event object.
splitterResize(oControlEvent)
Splitter (if exists) resized.

If a splitter exists and synchronization is needed with other Gantt charts in the container, use this event. You can listen for this event and obtain zoomInfo.

Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.id ID of the source control.
{int[]}oControlEvent.getParameters.oldSizes Old size in the form of [height, width].
{int[]}oControlEvent.getParameters.newSizes New size in the form of [height, width].
{object}oControlEvent.getParameters.zoomInfo Zoom information.

This object contains all related information for the listener to get the current zoom level of the time axis. Usually zoomInfo contains the following information:

  • "base" - Base for zooming calculation.
    • "sGranularity": "4day", - Zoom level that is used to calculate the zoom base; it is taken from timeAxis.granularity.
    • "fScale": 3840000 - Base scale determined by zoomStrategy level and now().
  • "determinedByConfig" - Zoom level calculated by configuration timeAxis.
    • "fRate": 1, - Zoom rate determined by configuration timeAxis.granularity.
    • "fMaxRate": 384, - Maximum zoom rate determined by configuration timeAxis.finestGranularity.
    • "fMinRate": 0.02197802197802198 - Minimum zoom rate determined by configuration timeAxis.coarsestGranularity.
  • "determinedByChartWidth" - Zoom level calculated by the SVG width.
    • "fMinRate": 0.0279009617614573, - Minimum zoom rate determined by the chart width and configuration timeAxis.planHorizon.
    • "fSuitableRate": 0.5078804440909039 - Suitable zoom rate determined by the chart width and configuration timeAxis.initHorizon.
  • iChartWidth: 417 - Chart width in pixel.
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.
verticalScroll(oControlEvent)
Vertical (row axis) scroll.

If the vertical scroll bar exists and synchronization is needed with other Gantt charts in the container, use this event.

Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{int}oControlEvent.getParameters.scrollSteps Scroll steps.
Method Detail
sap.gantt.GanttChartBase.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.gantt.GanttChartBase with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.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.GanttChartBase.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.gantt.GanttChartBase.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addRelationship(oRelationship): sap.gantt.GanttChartBase
Adds some relationship to the aggregation relationships.
Parameters:
{sap.ui.core.Control}oRelationship the relationship to add; if empty, nothing is inserted
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
addRow(oRow): sap.gantt.GanttChartBase
Adds some row to the aggregation rows.
Parameters:
{sap.ui.core.Control}oRow the row to add; if empty, nothing is inserted
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
attachChartClick(oData?, fnFunction, oListener?): sap.gantt.GanttChartBase
Attaches event handler fnFunction to the chartClick event of this sap.gantt.GanttChartBase.

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.GanttChartBase itself.

Event fired when the chart is clicked

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.GanttChartBase itself
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
attachChartDoubleClick(oData?, fnFunction, oListener?): sap.gantt.GanttChartBase
Attaches event handler fnFunction to the chartDoubleClick event of this sap.gantt.GanttChartBase.

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.GanttChartBase itself.

Event fired when the chart is double-clicked

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.GanttChartBase itself
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
attachChartDragEnter(oData?, fnFunction, oListener?): sap.gantt.GanttChartBase
Attaches event handler fnFunction to the chartDragEnter event of this sap.gantt.GanttChartBase.

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.GanttChartBase itself.

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.GanttChartBase itself
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
attachChartDragLeave(oData?, fnFunction, oListener?): sap.gantt.GanttChartBase
Attaches event handler fnFunction to the chartDragLeave event of this sap.gantt.GanttChartBase.

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.GanttChartBase itself.

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.GanttChartBase itself
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
attachChartMouseOver(oData?, fnFunction, oListener?): sap.gantt.GanttChartBase
Attaches event handler fnFunction to the chartMouseOver event of this sap.gantt.GanttChartBase.

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.GanttChartBase itself.

Event is fired when a mouse-hover occurs in the graphic part.

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.GanttChartBase itself
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
attachChartRightClick(oData?, fnFunction, oListener?): sap.gantt.GanttChartBase
Attaches event handler fnFunction to the chartRightClick event of this sap.gantt.GanttChartBase.

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.GanttChartBase itself.

Event fired when the chart is right-clicked

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.GanttChartBase itself
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
attachGanttChartSwitchRequested(oData?, fnFunction, oListener?): sap.gantt.GanttChartBase
Attaches event handler fnFunction to the ganttChartSwitchRequested event of this sap.gantt.GanttChartBase.

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.GanttChartBase itself.

Event fired when the hierarchy key has changed 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.GanttChartBase itself
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
attachHorizontalScroll(oData?, fnFunction, oListener?): sap.gantt.GanttChartBase
Attaches event handler fnFunction to the horizontalScroll event of this sap.gantt.GanttChartBase.

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.GanttChartBase itself.

Horizontal (time axis) scroll.

If the horizontal scroll bar exists and synchronization is needed with other Gantt charts in the container, use this event.

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.GanttChartBase itself
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
attachRelationshipSelectionChange(oData?, fnFunction, oListener?): sap.gantt.GanttChartBase
Attaches event handler fnFunction to the relationshipSelectionChange event of this sap.gantt.GanttChartBase.

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.GanttChartBase itself.

Event fired when the selection status of relationships changes.

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.GanttChartBase itself
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
attachRowSelectionChange(oData?, fnFunction, oListener?): sap.gantt.GanttChartBase
Attaches event handler fnFunction to the rowSelectionChange event of this sap.gantt.GanttChartBase.

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.GanttChartBase itself.

Event fired when the selection status of rows changes.

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.GanttChartBase itself
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
attachShapeDragEnd(oData?, fnFunction, oListener?): sap.gantt.GanttChartBase
Attaches event handler fnFunction to the shapeDragEnd event of this sap.gantt.GanttChartBase.

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.GanttChartBase itself.

Event fired when a drag-and-drop occurs on one or more selected shapes.

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.GanttChartBase itself
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
attachShapeSelectionChange(oData?, fnFunction, oListener?): sap.gantt.GanttChartBase
Attaches event handler fnFunction to the shapeSelectionChange event of this sap.gantt.GanttChartBase.

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.GanttChartBase itself.

Event fired when the selection status of shapes changes.

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.GanttChartBase itself
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
attachSplitterResize(oData?, fnFunction, oListener?): sap.gantt.GanttChartBase
Attaches event handler fnFunction to the splitterResize event of this sap.gantt.GanttChartBase.

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.GanttChartBase itself.

Splitter (if exists) resized.

If a splitter exists and synchronization is needed with other Gantt charts in the container, use this event. You can listen for this event and obtain zoomInfo.

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.GanttChartBase itself
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
attachTreeTableToggleEvent(oData?, fnFunction, oListener?): sap.gantt.GanttChartBase
Attaches event handler fnFunction to the treeTableToggleEvent event of this sap.gantt.GanttChartBase.

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.GanttChartBase 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.GanttChartBase itself
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
attachVerticalScroll(oData?, fnFunction, oListener?): sap.gantt.GanttChartBase
Attaches event handler fnFunction to the verticalScroll event of this sap.gantt.GanttChartBase.

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.GanttChartBase itself.

Vertical (row axis) scroll.

If the vertical scroll bar exists and synchronization is needed with other Gantt charts in the container, use this event.

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.GanttChartBase itself
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
bindCalendarDef(oBindingInfo): sap.gantt.GanttChartBase
Binds aggregation calendarDef 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.GanttChartBase} Reference to this in order to allow method chaining
bindRelationships(oBindingInfo): sap.gantt.GanttChartBase
Binds aggregation relationships 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.GanttChartBase} Reference to this in order to allow method chaining
bindRows(oBindingInfo): sap.gantt.GanttChartBase
Binds aggregation rows 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.GanttChartBase} Reference to this in order to allow method chaining
destroyCalendarDef(): sap.gantt.GanttChartBase
Destroys the calendarDef in the aggregation calendarDef.
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
destroyRelationships(): sap.gantt.GanttChartBase
Destroys all the relationships in the aggregation relationships.
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
destroyRows(): sap.gantt.GanttChartBase
Destroys all the rows in the aggregation rows.
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
detachChartClick(fnFunction, oListener): sap.gantt.GanttChartBase
Detaches event handler fnFunction from the chartClick event of this sap.gantt.GanttChartBase.

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.GanttChartBase} Reference to this in order to allow method chaining
detachChartDoubleClick(fnFunction, oListener): sap.gantt.GanttChartBase
Detaches event handler fnFunction from the chartDoubleClick event of this sap.gantt.GanttChartBase.

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.GanttChartBase} Reference to this in order to allow method chaining
detachChartDragEnter(fnFunction, oListener): sap.gantt.GanttChartBase
Detaches event handler fnFunction from the chartDragEnter event of this sap.gantt.GanttChartBase.

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.GanttChartBase} Reference to this in order to allow method chaining
detachChartDragLeave(fnFunction, oListener): sap.gantt.GanttChartBase
Detaches event handler fnFunction from the chartDragLeave event of this sap.gantt.GanttChartBase.

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.GanttChartBase} Reference to this in order to allow method chaining
detachChartMouseOver(fnFunction, oListener): sap.gantt.GanttChartBase
Detaches event handler fnFunction from the chartMouseOver event of this sap.gantt.GanttChartBase.

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.GanttChartBase} Reference to this in order to allow method chaining
detachChartRightClick(fnFunction, oListener): sap.gantt.GanttChartBase
Detaches event handler fnFunction from the chartRightClick event of this sap.gantt.GanttChartBase.

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.GanttChartBase} Reference to this in order to allow method chaining
detachGanttChartSwitchRequested(fnFunction, oListener): sap.gantt.GanttChartBase
Detaches event handler fnFunction from the ganttChartSwitchRequested event of this sap.gantt.GanttChartBase.

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.GanttChartBase} Reference to this in order to allow method chaining
detachHorizontalScroll(fnFunction, oListener): sap.gantt.GanttChartBase
Detaches event handler fnFunction from the horizontalScroll event of this sap.gantt.GanttChartBase.

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.GanttChartBase} Reference to this in order to allow method chaining
detachRelationshipSelectionChange(fnFunction, oListener): sap.gantt.GanttChartBase
Detaches event handler fnFunction from the relationshipSelectionChange event of this sap.gantt.GanttChartBase.

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.GanttChartBase} Reference to this in order to allow method chaining
detachRowSelectionChange(fnFunction, oListener): sap.gantt.GanttChartBase
Detaches event handler fnFunction from the rowSelectionChange event of this sap.gantt.GanttChartBase.

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.GanttChartBase} Reference to this in order to allow method chaining
detachShapeDragEnd(fnFunction, oListener): sap.gantt.GanttChartBase
Detaches event handler fnFunction from the shapeDragEnd event of this sap.gantt.GanttChartBase.

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.GanttChartBase} Reference to this in order to allow method chaining
detachShapeSelectionChange(fnFunction, oListener): sap.gantt.GanttChartBase
Detaches event handler fnFunction from the shapeSelectionChange event of this sap.gantt.GanttChartBase.

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.GanttChartBase} Reference to this in order to allow method chaining
detachSplitterResize(fnFunction, oListener): sap.gantt.GanttChartBase
Detaches event handler fnFunction from the splitterResize event of this sap.gantt.GanttChartBase.

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.GanttChartBase} Reference to this in order to allow method chaining
detachTreeTableToggleEvent(fnFunction, oListener): sap.gantt.GanttChartBase
Detaches event handler fnFunction from the treeTableToggleEvent event of this sap.gantt.GanttChartBase.

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.GanttChartBase} Reference to this in order to allow method chaining
detachVerticalScroll(fnFunction, oListener): sap.gantt.GanttChartBase
Detaches event handler fnFunction from the verticalScroll event of this sap.gantt.GanttChartBase.

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.GanttChartBase} Reference to this in order to allow method chaining
fireChartClick(mArguments?): sap.gantt.GanttChartBase
Fires event chartClick to attached listeners.

Expects the following event parameters:

  • objectInfo of type objectRow object information of the current mouse point.
  • leadingRowInfo of type objectLeading row object information. null when it is the main row at current mouse point; main row information if it is one of multiple expanded rows.
  • timestamp of type stringTimestamp of the current mouse point.
  • svgId of type stringID of SVG.
  • svgCoordinate of type int[][x, y] Coordinate of the current mouse point in the SVG coordinate system.
  • effectingMode of type stringEffective mode. It can be the current Gantt Chart mode or the mode derived from the chart scheme mode.
  • originEvent of type objectOriginal JQuery event object.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
fireChartDoubleClick(mArguments?): sap.gantt.GanttChartBase
Fires event chartDoubleClick to attached listeners.

Expects the following event parameters:

  • objectInfo of type objectRow object information of the current mouse point.
  • leadingRowInfo of type objectLeading row object information. null when it is the main row at current mouse point; main row information if it is one of multiple expanded rows.
  • timestamp of type stringTimestamp of the current mouse point.
  • svgId of type stringID of SVG.
  • svgCoordinate of type int[][x, y] Coordinate of the current mouse point in the SVG coordinate system.
  • effectingMode of type stringEffective mode. It can be the current Gantt Chart mode or the mode derived from the chart scheme mode.
  • originEvent of type objectOriginal JQuery event object.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
fireChartDragEnter(mArguments?): sap.gantt.GanttChartBase
Fires event chartDragEnter to attached listeners.

Expects the following event parameters:

  • originEvent of type object
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
fireChartDragLeave(mArguments?): sap.gantt.GanttChartBase
Fires event chartDragLeave to attached listeners.

Expects the following event parameters:

  • originEvent of type object
  • draggingSource of type object
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
fireChartMouseOver(mArguments?): sap.gantt.GanttChartBase
Fires event chartMouseOver to attached listeners.

Expects the following event parameters:

  • objectInfo of type objectRow object information of the current mouse point.
  • leadingRowInfo of type objectLeading row object information. null when it is the main row at current mouse point; main row information if it is one of multiple expanded rows.
  • timestamp of type stringTimestamp of the current mouse point.
  • svgId of type stringID of SVG.
  • svgCoordinate of type int[][x, y] Coordinate of the current mouse point in the SVG coordinate system.
  • effectingMode of type stringEffective mode. It can be the current Gantt Chart mode or the mode derived from the chart scheme mode.
  • originEvent of type objectOriginal JQuery event object.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
fireChartRightClick(mArguments?): sap.gantt.GanttChartBase
Fires event chartRightClick to attached listeners.

Expects the following event parameters:

  • objectInfo of type objectRow object information of the current mouse point.
  • leadingRowInfo of type objectLeading row object information. null when it is the main row at current mouse point; main row information if it is one of multiple expanded rows.
  • timestamp of type stringTimestamp of the current mouse point.
  • svgId of type stringID of SVG.
  • svgCoordinate of type int[][x, y] Coordinate of the current mouse point in the SVG coordinate system.
  • effectingMode of type stringEffective mode. It can be the current Gantt Chart mode or a mode derived from the chart scheme mode.
  • originEvent of type objectOriginal JQuery event object.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
fireGanttChartSwitchRequested(mArguments?): sap.gantt.GanttChartBase
Fires event ganttChartSwitchRequested to attached listeners.

Expects the following event parameters:

  • hierarchyKey of type stringTarget hierarchy key.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
fireHorizontalScroll(mArguments?): sap.gantt.GanttChartBase
Fires event horizontalScroll to attached listeners.

Expects the following event parameters:

  • scrollSteps of type intScroll steps.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
fireRelationshipSelectionChange(mArguments?): sap.gantt.GanttChartBase
Fires event relationshipSelectionChange to attached listeners.

Expects the following event parameters:

  • originEvent of type objectOriginal JQuery event object.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
fireRowSelectionChange(mArguments?): sap.gantt.GanttChartBase
Fires event rowSelectionChange to attached listeners.

Expects the following event parameters:

  • originEvent of type objectOriginal JQuery event object.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
fireShapeDragEnd(mArguments?): sap.gantt.GanttChartBase
Fires event shapeDragEnd to attached listeners.

Expects the following event parameters:

  • originEvent of type objectOriginal JQuery event object.
  • sourceShapeData of type object[]List of source shape data.
  • sourceSvgId of type stringSource SVG ID.
  • targetData of type object[]List of target shape data. Sorted by shape level.
  • targetSvgId of type stringTarget SVG ID.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
fireShapeSelectionChange(mArguments?): sap.gantt.GanttChartBase
Fires event shapeSelectionChange to attached listeners.

Expects the following event parameters:

  • originEvent of type objectOriginal JQuery event object.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
fireSplitterResize(mArguments?): sap.gantt.GanttChartBase
Fires event splitterResize to attached listeners.

Expects the following event parameters:

  • id of type stringID of the source control.
  • oldSizes of type int[]Old size in the form of [height, width].
  • newSizes of type int[]New size in the form of [height, width].
  • zoomInfo of type objectZoom information.

    This object contains all related information for the listener to get the current zoom level of the time axis. Usually zoomInfo contains the following information:

    • "base" - Base for zooming calculation.
      • "sGranularity": "4day", - Zoom level that is used to calculate the zoom base; it is taken from timeAxis.granularity.
      • "fScale": 3840000 - Base scale determined by zoomStrategy level and now().
    • "determinedByConfig" - Zoom level calculated by configuration timeAxis.
      • "fRate": 1, - Zoom rate determined by configuration timeAxis.granularity.
      • "fMaxRate": 384, - Maximum zoom rate determined by configuration timeAxis.finestGranularity.
      • "fMinRate": 0.02197802197802198 - Minimum zoom rate determined by configuration timeAxis.coarsestGranularity.
    • "determinedByChartWidth" - Zoom level calculated by the SVG width.
      • "fMinRate": 0.0279009617614573, - Minimum zoom rate determined by the chart width and configuration timeAxis.planHorizon.
      • "fSuitableRate": 0.5078804440909039 - Suitable zoom rate determined by the chart width and configuration timeAxis.initHorizon.
    • iChartWidth: 417 - Chart width in pixel.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
fireTreeTableToggleEvent(mArguments?): sap.gantt.GanttChartBase
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.GanttChartBase} Reference to this in order to allow method chaining
fireVerticalScroll(mArguments?): sap.gantt.GanttChartBase
Fires event verticalScroll to attached listeners.

Expects the following event parameters:

  • scrollSteps of type intScroll steps.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
getAxisOrdinal(): sap.gantt.misc.AxisOrdinal
Provides the Ordinal Axis that is used to draw the SVG graphic.

This method is intended to allow access to the ordinal axis. Do not change the ordinal axis. All subclasses must provide implementations.

Returns:
{sap.gantt.misc.AxisOrdinal} Returns the axis ordinal instance.
getAxisTime(): sap.gantt.misc.AxisTime
Provides the Time Axis that is used to draw the SVG graphic.

This method is intended to allow access to the time axis. Do not change the time axis. All subclasses must provide implementations.

Returns:
{sap.gantt.misc.AxisTime} Returns the axis time instance.
getBaseRowHeight(): int
Gets current value of property baseRowHeight.
Returns:
{int} Value of property baseRowHeight
getCalendarDef(): sap.gantt.def.cal.CalendarDefs
Gets content of aggregation calendarDef.

Paint servers consumed by special shape sap.gantt.shape.cal.Calendar.

This aggregation is designed to improve performance of calendar shapes. Rows usually share a similar definition with calendar shapes. It is possible to define a Calendar paint server to draw only one rectangle for each row. Notes for classes extended from sap.gantt.def.cal.CalendarDef: Different from property paintServerDefs, paint servers defined here must implement method getDefNode() instead of method getDefString().

Returns:
{sap.gantt.def.cal.CalendarDefs}
getChartSchemes(): array
Gets current value of property chartSchemes.

Configuration of chart schemes.

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

Default value is sap.gantt.config.DEFAULT_CHART_SCHEMES.

Returns:
{array} Value of property chartSchemes
getEnableCursorLine(): boolean
Gets current value of property enableCursorLine.

Switch to show and hide the cursor line that follows the cursor.

Default value is true.

Returns:
{boolean} Value of property enableCursorLine
getEnableNowLine(): boolean
Gets current value of property enableNowLine.

Switch to show and hide the present time indicator

Default value is true.

Returns:
{boolean} Value of property enableNowLine
getEnableVerticalLine(): boolean
Gets current value of property enableVerticalLine.

Switch to show and hide vertical lines representing intervals along the time axis

Default value is true.

Returns:
{boolean} Value of property enableVerticalLine
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.

Configuration of 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
getHierarchyKey(): string
Gets current value of property hierarchyKey.

Current hierarchy key referencing from configuration property hierarchies.

If source select group is enabled in the Gantt chart toolbar, the current hierarchy name referenced from hierarchies by this property is shown. For applications that do not require this function, this property can be ignored and a default value is used.

Default value is sap.gantt.config.DEFAULT_HIERARCHY_KEY.

Returns:
{string} Value of property hierarchyKey
getLocale(): sap.gantt.config.Locale
Gets current value of property locale.

Configuration of locale settings.

Most locale settings can be configured in sap.ui.configuration objects. Only the time zone and day-light-saving time option are provided by locale settings.

Default value is sap.gantt.config.DEFAULT_LOCALE_CET.

Returns:
{sap.gantt.config.Locale} Value of property locale
getMode(): string
Gets current value of property mode.

Current mode of the Gantt chart.

If no value is provided, GanttChart uses a default mode key.

Default value is sap.gantt.config.DEFAULT_MODE_KEY.

Returns:
{string} Value of property mode
getModes(): array
Gets current value of property modes.

Configuration of available modes.

List of available modes. To apply modes to toolbar and shapes, further configuration is needed. If not provided, a default configuration is provided.

Default value is sap.gantt.config.DEFAULT_MODES.

Returns:
{array} Value of property modes
getObjectTypes(): array
Gets current value of property objectTypes.

Configuration of object types.

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

Default value is sap.gantt.config.DEFAULT_OBJECT_TYPES.

Returns:
{array} Value of property objectTypes
getRelationships(): sap.ui.core.Control[]
Gets content of aggregation relationships.

Relationships of shapes carried by rows.

Similar to rows, this aggregation does not request templates either. Relationships are a special shape with a category of "crossRowShape". How relationships are drawn is also specified in configuration property shapes.

Returns:
{sap.ui.core.Control[]}
getRows(): sap.ui.core.Control[]
Gets content of aggregation rows.

Rows of sap.gantt.GanttChartBase

This aggregation is delegated to sap.gantt.table.TreeTable. Rows are provide a base for shapes with a category of "InRowShape". The configuration in property shapes determines how the shapes are drawn.

Returns:
{sap.ui.core.Control[]}
getSelectionMode(): sap.gantt.SelectionMode
Gets current value of property selectionMode.

Selection mode for GanttChart

This property controls whether multiToggle or multi-selection mode is enabled for the tree table and for shapes. It may also affect the visual appearance, such as whether check boxes are available for selection.

Default value is MultiWithKeyboard.

Returns:
{sap.gantt.SelectionMode} Value of property selectionMode
getSelectionPanelSize(): sap.ui.core.CSSSize
Gets current value of property selectionPanelSize.

If the implementation contains a selection panel, this is the initial width.

In the current library, sap.gantt.GanttChart does not have a selection panel. sap.gantt.GanttChart has a selection panel implemented by sap.ui.table.TreeTable.

Default value is 30%.

Returns:
{sap.ui.core.CSSSize} Value of property selectionPanelSize
getShapeDataNames(): array
Gets current value of property shapeDataNames.

Configuration of shape data names.

List of available shape data names. This configuration must be provided if SVG graphics are needed.

Default value is [].

Returns:
{array} Value of property shapeDataNames
getShapes(): array
Gets current value of property shapes.

Configuration of shape data against shape classes.

List of available shapes. The shapes configured in this list are initialized inside sap.gantt.GanttChartBase. Note that for JSON data binding, this configuration supports deep structured data structures. For ODATA binding, only one level is supported.

Default value is [].

Returns:
{array} Value of property shapes
getSvgDefs(): sap.gantt.def.SvgDefs
Gets current value of property svgDefs.

SVG reusable element definitions.

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.

Returns:
{sap.gantt.def.SvgDefs} Value of property svgDefs
getTimeAxis(): sap.gantt.config.TimeAxis
Gets current value of property timeAxis.

Configuration of the time axis.

Planning horizon, initial horizon, and zoom level can be configured with this property. If not provided, a default configuration is provided.

Default value is sap.gantt.config.DEFAULT_TIME_AXIS.

Returns:
{sap.gantt.config.TimeAxis} Value of property timeAxis
getTimeZoomRate(): float
Gets current value of property timeZoomRate.

Zoom level in float.

This property allows application developers to control the zoom level. When GanttChart is embedded in sap.gantt.GanttChartContainer, you do not have to manage this property.

Default value is 1.

Returns:
{float} Value of property timeZoomRate
getToolbarSchemes(): array
Gets current value of property toolbarSchemes.

Configuration of toolbar schemes.

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

Default value is sap.gantt.config.DEFAULT_GANTTCHART_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
handleExpandChartChange(bExpanded, aChartSchemes, aSelectedIndices)
Default event handler for internal event expandChartChange from global TOOLBAR.
Parameters:
{boolean}bExpanded expand or collapse the selected row
{array}aChartSchemes binded chart scheme
{array}aSelectedIndices user selected row indices
indexOfRelationship(oRelationship): int
Checks for the provided sap.ui.core.Control in the aggregation relationships. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oRelationship The relationship whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfRow(oRow): int
Checks for the provided sap.ui.core.Control in the aggregation rows. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oRow The row whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
init()
Initializes the GanttChart instance after creation.
insertRelationship(oRelationship, iIndex): sap.gantt.GanttChartBase
Inserts a relationship into the aggregation relationships.
Parameters:
{sap.ui.core.Control}oRelationship the relationship to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the relationship should be inserted at; for a negative value of iIndex, the relationship is inserted at position 0; for a value greater than the current size of the aggregation, the relationship is inserted at the last position
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
insertRow(oRow, iIndex): sap.gantt.GanttChartBase
Inserts a row into the aggregation rows.
Parameters:
{sap.ui.core.Control}oRow the row to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the row should be inserted at; for a negative value of iIndex, the row is inserted at position 0; for a value greater than the current size of the aggregation, the row is inserted at the last position
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
jumpToPosition(vDate)
Jumps to a given time.

This method sets the position of the visible area to a certain timestamp. It can be used to implement the function of Jump To First, Jump To Last, and Jump To Current.

A Redraw of SVG is triggered.

Parameters:
{timestamp}vDate Accepted value is a 14-digit timestamp or a Date object.
notifySourceChange()
Notify that the data source had changed.
removeAllRelationships(): sap.ui.core.Control[]
Removes all the controls from the aggregation relationships.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAllRows(): sap.ui.core.Control[]
Removes all the controls from the aggregation rows.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeRelationship(vRelationship): sap.ui.core.Control
Removes a relationship from the aggregation relationships.
Parameters:
{int|string|sap.ui.core.Control}vRelationship The relationshipto remove or its index or id
Returns:
{sap.ui.core.Control} The removed relationship or null
removeRow(vRow): sap.ui.core.Control
Removes a row from the aggregation rows.
Parameters:
{int|string|sap.ui.core.Control}vRow The rowto remove or its index or id
Returns:
{sap.ui.core.Control} The removed row or null
setBaseRowHeight(iBaseRowHeight): sap.gantt.GanttChartBase
Sets a new value for property baseRowHeight.

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

Parameters:
{int}iBaseRowHeight New value for property baseRowHeight
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
setCalendarDef(oCalendarDef): sap.gantt.GanttChartBase
Sets the aggregated calendarDef.
Parameters:
{sap.gantt.def.cal.CalendarDefs}oCalendarDef The calendarDef to set
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
setChartSchemes(sChartSchemes): sap.gantt.GanttChartBase
Sets a new value for property chartSchemes.

Configuration of chart schemes.

List of available chart 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_CHART_SCHEMES.

Parameters:
{array}sChartSchemes New value for property chartSchemes
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
setEnableCursorLine(bEnableCursorLine): sap.gantt.GanttChartBase
Sets a new value for property enableCursorLine.

Switch to show and hide the cursor line that follows the cursor.

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.GanttChartBase} Reference to this in order to allow method chaining
setEnableNowLine(bEnableNowLine): sap.gantt.GanttChartBase
Sets a new value for property enableNowLine.

Switch to show and hide the present time indicator

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.GanttChartBase} Reference to this in order to allow method chaining
setEnableVerticalLine(bEnableVerticalLine): sap.gantt.GanttChartBase
Sets a new value for property enableVerticalLine.

Switch to show and hide vertical lines representing intervals along the time axis

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.GanttChartBase} Reference to this in order to allow method chaining
setHeight(sHeight): sap.gantt.GanttChartBase
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.GanttChartBase} Reference to this in order to allow method chaining
setHierarchies(sHierarchies): sap.gantt.GanttChartBase
Sets a new value for property hierarchies.

Configuration of 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.GanttChartBase} Reference to this in order to allow method chaining
setHierarchyKey(sHierarchyKey): sap.gantt.GanttChartBase
Sets a new value for property hierarchyKey.

Current hierarchy key referencing from configuration property hierarchies.

If source select group is enabled in the Gantt chart toolbar, the current hierarchy name referenced from hierarchies by this property is shown. For applications that do not require this function, this property can be ignored and a default value is used.

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_HIERARCHY_KEY.

Parameters:
{string}sHierarchyKey New value for property hierarchyKey
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
setLocale(sLocale): sap.gantt.GanttChartBase
Sets a new value for property locale.

Configuration of locale settings.

Most locale settings can be configured in sap.ui.configuration objects. Only the time zone and day-light-saving time option are provided by locale settings.

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_LOCALE_CET.

Parameters:
{sap.gantt.config.Locale}sLocale New value for property locale
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
setMode(sMode): sap.gantt.GanttChartBase
Sets a new value for property mode.

Current mode of the Gantt chart.

If no value is provided, GanttChart uses a default mode key.

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_MODE_KEY.

Parameters:
{string}sMode New value for property mode
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
setModes(sModes): sap.gantt.GanttChartBase
Sets a new value for property modes.

Configuration of available modes.

List of available modes. To apply modes to toolbar and shapes, further configuration is needed. 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_MODES.

Parameters:
{array}sModes New value for property modes
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
setObjectTypes(sObjectTypes): sap.gantt.GanttChartBase
Sets a new value for property objectTypes.

Configuration of object types.

List of available object types. 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_OBJECT_TYPES.

Parameters:
{array}sObjectTypes New value for property objectTypes
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
setSelectionMode(sSelectionMode): sap.gantt.GanttChartBase
Sets a new value for property selectionMode.

Selection mode for GanttChart

This property controls whether multiToggle or multi-selection mode is enabled for the tree table and for shapes. It may also affect the visual appearance, such as whether check boxes are available for selection.

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

Default value is MultiWithKeyboard.

Parameters:
{sap.gantt.SelectionMode}sSelectionMode New value for property selectionMode
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
setSelectionPanelSize(sSelectionPanelSize): sap.gantt.GanttChartBase
Sets a new value for property selectionPanelSize.

If the implementation contains a selection panel, this is the initial width.

In the current library, sap.gantt.GanttChart does not have a selection panel. sap.gantt.GanttChart has a selection panel implemented by sap.ui.table.TreeTable.

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

Default value is 30%.

Parameters:
{sap.ui.core.CSSSize}sSelectionPanelSize New value for property selectionPanelSize
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
setShapeDataNames(sShapeDataNames): sap.gantt.GanttChartBase
Sets a new value for property shapeDataNames.

Configuration of shape data names.

List of available shape data names. This configuration must be provided if SVG graphics are needed.

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

Default value is [].

Parameters:
{array}sShapeDataNames New value for property shapeDataNames
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
setShapes(sShapes): sap.gantt.GanttChartBase
Sets a new value for property shapes.

Configuration of shape data against shape classes.

List of available shapes. The shapes configured in this list are initialized inside sap.gantt.GanttChartBase. Note that for JSON data binding, this configuration supports deep structured data structures. For ODATA binding, only one level is supported.

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

Default value is [].

Parameters:
{array}sShapes New value for property shapes
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
setSvgDefs(sSvgDefs): sap.gantt.GanttChartBase
Sets a new value for property svgDefs.

SVG reusable element definitions.

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.

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.GanttChartBase} Reference to this in order to allow method chaining
setTimeAxis(sTimeAxis): sap.gantt.GanttChartBase
Sets a new value for property timeAxis.

Configuration of the time axis.

Planning horizon, initial horizon, and zoom level can be configured with this property. 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_TIME_AXIS.

Parameters:
{sap.gantt.config.TimeAxis}sTimeAxis New value for property timeAxis
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
setTimeZoomRate(fTimeZoomRate): sap.gantt.GanttChartBase
Sets a new value for property timeZoomRate.

Zoom level in float.

This property allows application developers to control the zoom level. When GanttChart is embedded in sap.gantt.GanttChartContainer, you do not have to manage this property.

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

Default value is 1.

Parameters:
{float}fTimeZoomRate New value for property timeZoomRate
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
setToolbarSchemes(sToolbarSchemes): sap.gantt.GanttChartBase
Sets a new value for property toolbarSchemes.

Configuration of toolbar schemes.

List of available toolbar shcemes. 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_GANTTCHART_TOOLBAR_SCHEMES.

Parameters:
{array}sToolbarSchemes New value for property toolbarSchemes
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
setWidth(sWidth): sap.gantt.GanttChartBase
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.GanttChartBase} Reference to this in order to allow method chaining
unbindCalendarDef(): sap.gantt.GanttChartBase
Unbinds aggregation calendarDef from model data.
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
unbindRelationships(): sap.gantt.GanttChartBase
Unbinds aggregation relationships from model data.
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining
unbindRows(): sap.gantt.GanttChartBase
Unbinds aggregation rows from model data.
Returns:
{sap.gantt.GanttChartBase} Reference to this in order to allow method chaining