Class sap.gantt.GanttChartModule: sap/gantt/GanttChart

extends GanttChartBase

Gantt Chart control.

The Gantt chart has a horizontal axis at the top that represents time and a vertical axis that represents rows.

Constructor Summary
new sap.gantt.GanttChart(sId?, mSettings?)Creates and initializes a new Gantt Chart.
Events borrowed from class sap.gantt.GanttChartBase
chartClick, chartDoubleClick, chartDragEnter, chartDragLeave, chartMouseOver, chartRightClick, ganttChartSwitchRequested, horizontalScroll, relationshipSelectionChange, rowSelectionChange, shapeDragEnd, shapeSelectionChange, splitterResize, treeTableToggleEvent, verticalScroll
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.GanttChart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.GanttChart with name sClassName and enriches it with the information contained in oClassInfo.
sap.gantt.GanttChart.getMetadata()Returns a metadata object for class sap.gantt.GanttChart.
deselectRelationships(aIds?)Deselects relationships
deselectRows(aIds?)Deselects rows
deselectShapes(aIds?)deselect shapes
expandToLevel(iLevel)Expands the GanttChart to the given level
getAllRowData()Gets all row data
getRowByShapeUid(sShapeUid?)Get row object by shape uid
getSelectedRelationships()Get all the current selected relationships
getSelectedRows()Gets the selected rows
getSelectedShapes()Gets the selected shapes
selectRelationships(aIds?, bIsExclusive?)Selects relationships, and deselects all other selected relationships if aIds is a null list and bIsExclusive is true
selectRows(aIds?, bIsExclusive?)Selects rows
selectRowsAndShapes(aIds?, bIsExclusive?)Select rows and all shapes contained in those rows
selectShapes(aIds?, bIsExclusive?)Selects shapes, and deselects all shapes when aIds is a null list and bIsExclusive is true
setFirstVisibleRow(iRowIndex)Sets the first visible row in the Gantt Chart Control.
Methods borrowed from class sap.gantt.GanttChartBase
addRelationship, addRow, attachChartClick, attachChartDoubleClick, attachChartDragEnter, attachChartDragLeave, attachChartMouseOver, attachChartRightClick, attachGanttChartSwitchRequested, attachHorizontalScroll, attachRelationshipSelectionChange, attachRowSelectionChange, attachShapeDragEnd, attachShapeSelectionChange, attachSplitterResize, attachTreeTableToggleEvent, attachVerticalScroll, bindCalendarDef, bindRelationships, bindRows, destroyCalendarDef, destroyRelationships, destroyRows, detachChartClick, detachChartDoubleClick, detachChartDragEnter, detachChartDragLeave, detachChartMouseOver, detachChartRightClick, detachGanttChartSwitchRequested, detachHorizontalScroll, detachRelationshipSelectionChange, detachRowSelectionChange, detachShapeDragEnd, detachShapeSelectionChange, detachSplitterResize, detachTreeTableToggleEvent, detachVerticalScroll, fireChartClick, fireChartDoubleClick, fireChartDragEnter, fireChartDragLeave, fireChartMouseOver, fireChartRightClick, fireGanttChartSwitchRequested, fireHorizontalScroll, fireRelationshipSelectionChange, fireRowSelectionChange, fireShapeDragEnd, fireShapeSelectionChange, fireSplitterResize, fireTreeTableToggleEvent, fireVerticalScroll, getAxisOrdinal, getAxisTime, getBaseRowHeight, getCalendarDef, getChartSchemes, getEnableCursorLine, getEnableNowLine, getEnableVerticalLine, getHeight, getHierarchies, getHierarchyKey, getLocale, getMode, getModes, getObjectTypes, getRelationships, getRows, getSelectionMode, getSelectionPanelSize, getShapeDataNames, getShapes, getSvgDefs, getTimeAxis, getTimeZoomRate, getToolbarSchemes, getWidth, handleExpandChartChange, indexOfRelationship, indexOfRow, init, insertRelationship, insertRow, jumpToPosition, notifySourceChange, removeAllRelationships, removeAllRows, removeRelationship, removeRow, setBaseRowHeight, setCalendarDef, setChartSchemes, setEnableCursorLine, setEnableNowLine, setEnableVerticalLine, setHeight, setHierarchies, setHierarchyKey, setLocale, setMode, setModes, setObjectTypes, setSelectionMode, setSelectionPanelSize, setShapeDataNames, setShapes, setSvgDefs, setTimeAxis, setTimeZoomRate, setToolbarSchemes, setWidth, unbindCalendarDef, unbindRelationships, unbindRows
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.GanttChart(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:

  • Aggregations

    In addition, all settings applicable to the base type sap.gantt.GanttChartBase 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
    Method Detail
    sap.gantt.GanttChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.gantt.GanttChart with name sClassName and enriches it with the information contained in oClassInfo.

    oClassInfo might contain the same kind of information as described in sap.gantt.GanttChartBase.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.GanttChart.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.gantt.GanttChart.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    deselectRelationships(aIds?): boolean
    Deselects relationships
    Parameters:
    {array}aIds? List of the relationships that you want to deselect
    Returns:
    {boolean} True if the selection change is applied
    deselectRows(aIds?): boolean
    Deselects rows
    Parameters:
    {array}aIds? List of the rows that you want to deselect
    Returns:
    {boolean} True if the selection change is applied
    deselectShapes(aIds?): boolean
    deselect shapes
    Parameters:
    {array}aIds? List of the shapes that you want to deselect
    Returns:
    {boolean} True if the selection change is applied
    expandToLevel(iLevel): sap.gantt.GanttChart
    Expands the GanttChart to the given level
    Parameters:
    {int}iLevel Level to be expanded to
    Returns:
    {sap.gantt.GanttChart} A reference to the GanttChart control, which can be used for chaining
    See:
    sap.ui.table.TreeTable.expandToLevel
    getAllRowData(): array
    Gets all row data
    Returns:
    {array} All row data
    getRowByShapeUid(sShapeUid?): object
    Get row object by shape uid
    Parameters:
    {string}sShapeUid? shape uid
    Returns:
    {object} row object
    getSelectedRelationships(): array
    Get all the current selected relationships
    Returns:
    {array} selected relationships
    getSelectedRows(): array
    Gets the selected rows
    Returns:
    {array} Selected rows
    getSelectedShapes(): array
    Gets the selected shapes
    Returns:
    {array} selected shapes
    selectRelationships(aIds?, bIsExclusive?): boolean
    Selects relationships, and deselects all other selected relationships if aIds is a null list and bIsExclusive is true
    Parameters:
    {array}aIds? List of the shapes that you want to select
    {boolean}bIsExclusive? Whether all other selected shapes are deselected
    Returns:
    {boolean} True if the selection change is applied
    selectRows(aIds?, bIsExclusive?): boolean
    Selects rows
    Parameters:
    {array}aIds? List of the rows that you want to select
    {boolean}bIsExclusive? Whether all other selected rows are deselected
    Returns:
    {boolean} True if the selection change is applied
    selectRowsAndShapes(aIds?, bIsExclusive?): boolean
    Select rows and all shapes contained in those rows
    Parameters:
    {array}aIds? Row uids
    {boolean}bIsExclusive? Wether all other selected rows and shapes are deselected
    Returns:
    {boolean} True if the selection change is applied
    selectShapes(aIds?, bIsExclusive?): boolean
    Selects shapes, and deselects all shapes when aIds is a null list and bIsExclusive is true
    Parameters:
    {array}aIds? List of the shapes that you want to select
    {boolean}bIsExclusive? Whether all other selected shapes are deselected
    Returns:
    {boolean} True if the selection change is applied
    setFirstVisibleRow(iRowIndex): sap.gantt.GanttChart
    Sets the first visible row in the Gantt Chart Control.
    Parameters:
    {int}iRowIndex The row index to be set as the first visible row
    Returns:
    {sap.gantt.GanttChart} A reference to the GanttChart control, which can be used for chaining
    See:
    sap.ui.table.Table.setFirstVisibleRow