Class sap.ui.table.AnalyticalTableModule: sap/ui/table/AnalyticalTable

extends Table

Table which handles analytical OData backends. The AnalyticalTable only works with an AnalyticalBinding and correctly annotated OData services. Please check on the SAP Annotations for OData Version 2.0 documentation for further details.

Constructor Summary
new sap.ui.table.AnalyticalTable(sId?, mSettings?)Constructor for a new AnalyticalTable.
Events borrowed from class sap.ui.table.Table
busyStateChanged, cellClick, cellContextmenu, columnFreeze, columnMove, columnResize, columnSelect, columnVisibility, customFilter, filter, firstVisibleRowChanged, group, rowSelectionChange, sort
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.ui.table.AnalyticalTable.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.table.AnalyticalTable with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.table.AnalyticalTable.getMetadata()Returns a metadata object for class sap.ui.table.AnalyticalTable.
addSelectionInterval(iFromIndex, iToIndex)Marks a range of tree nodes as selected, starting with iFromIndex going to iToIndex.
clearSelection()Clears the complete selection (all tree table rows/nodes will lose their selection)
collapseAll()Collapses all nodes (and lower if collapseRecursive is activated)
getAutoExpandMode()Gets current value of property autoExpandMode.
getCollapseRecursive()Gets current value of property collapseRecursive.
getColumnVisibilityMenuSorter()Gets current value of property columnVisibilityMenuSorter.
getContextByIndex(iIndex)Returns the context of a row by its index.
getNumberOfExpandedLevels()Gets current value of property numberOfExpandedLevels.
getSelectedIndex()Retrieves the lead selection index.
getSelectedIndices()Returns an array containing the row indices of all selected tree nodes (ordered ascending).
getSumOnTop()Gets current value of property sumOnTop.
getTotalSize()Returns the total size of the data entries.
isIndexSelected(iRowIndex)Checks if the row at the given index is selected.
removeSelectionInterval(iFromIndex, iToIndex)All rows/tree nodes inside the range (including boundaries) will be deselected.
resumeUpdateAnalyticalInfo(bSuppressRefresh, bForceChange)This function is used by some composite controls to force updating the AnalyticalInfo
selectAll()Selects all available nodes/rows.
setAutoExpandMode(sAutoExpandMode)Sets a new value for property autoExpandMode.
setColumnVisibilityMenuSorter(oColumnVisibilityMenuSorter)Sets a new value for property columnVisibilityMenuSorter.
setNumberOfExpandedLevels(iNumberOfExpandedLevels)Sets a new value for property numberOfExpandedLevels.
setSelectedIndex(iRowIndex)Overriden from Table.js base class.
setSelectionBehavior(sBehavior)Sets the selection behavior.
setSelectionInterval(iFromIndex, iToIndex)Sets the selection of the TreeTable to the given range (including boundaries).
setSelectionMode(sSelectionMode)Sets the selection mode, the current selection is lost.
setSumOnTop(bSumOnTop)Sets a new value for property sumOnTop.
suspendUpdateAnalyticalInfo()This function is used by some composite controls to avoid updating the AnalyticalInfo when several column are added to the table.
getDirty()Gets current value of property dirty.
setDirty(bDirty)Sets a new value for property dirty.
Methods borrowed from class sap.ui.table.Table
addAriaLabelledBy, addColumn, addExtension, addRow, attachBusyStateChanged, attachCellClick, attachCellContextmenu, attachColumnFreeze, attachColumnMove, attachColumnResize, attachColumnSelect, attachColumnVisibility, attachCustomFilter, attachFilter, attachFirstVisibleRowChanged, attachGroup, attachRowSelectionChange, attachSort, autoResizeColumn, bindColumns, bindRows, destroyColumns, destroyExtension, destroyFooter, destroyNoData, destroyRows, destroyTitle, destroyToolbar, detachBusyStateChanged, detachCellClick, detachCellContextmenu, detachColumnFreeze, detachColumnMove, detachColumnResize, detachColumnSelect, detachColumnVisibility, detachCustomFilter, detachFilter, detachFirstVisibleRowChanged, detachGroup, detachRowSelectionChange, detachSort, exportData, filter, fireBusyStateChanged, fireCellClick, fireCellContextmenu, fireColumnFreeze, fireColumnMove, fireColumnResize, fireColumnSelect, fireColumnVisibility, fireCustomFilter, fireFilter, fireFirstVisibleRowChanged, fireGroup, fireRowSelectionChange, fireSort, getAriaLabelledBy, getColumnHeaderHeight, getColumnHeaderVisible, getColumns, getEditable, getEnableBusyIndicator, getEnableCellFilter, getEnableColumnFreeze, getEnableColumnReordering, getEnableCustomFilter, getEnableGrouping, getEnableSelectAll, getExtension, getFirstVisibleRow, getFixedBottomRowCount, getFixedColumnCount, getFixedRowCount, getFooter, getGroupBy, getMinAutoRowCount, getNavigationMode, getNoData, getRowHeight, getRows, getSelectionBehavior, getSelectionMode, getShowColumnVisibilityMenu, getShowNoData, getShowOverlay, getSortedColumns, getThreshold, getTitle, getToolbar, getVisibleRowCount, getVisibleRowCountMode, getWidth, indexOfColumn, indexOfExtension, indexOfRow, insertColumn, insertExtension, insertRow, removeAllAriaLabelledBy, removeAllColumns, removeAllExtension, removeAllRows, removeAriaLabelledBy, removeColumn, removeExtension, removeRow, setColumnHeaderHeight, setColumnHeaderVisible, setEditable, setEnableBusyIndicator, setEnableCellFilter, setEnableColumnFreeze, setEnableColumnReordering, setEnableCustomFilter, setEnableSelectAll, setFirstVisibleRow, setFixedBottomRowCount, setFixedColumnCount, setFixedRowCount, setFooter, setGroupBy, setMinAutoRowCount, setNavigationMode, setNoData, setRowHeight, setShowColumnVisibilityMenu, setShowNoData, setShowOverlay, setThreshold, setTitle, setToolbar, setVisibleRowCount, setVisibleRowCountMode, setWidth, sort, unbindColumns, 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, 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, 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.ui.table.AnalyticalTable(sId?, mSettings?)
Constructor for a new AnalyticalTable.

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:

In addition, all settings applicable to the base type sap.ui.table.Table 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
See:
http://scn.sap.com/docs/DOC-44986
Method Detail
sap.ui.table.AnalyticalTable.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.table.AnalyticalTable 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.table.Table.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.ui.table.AnalyticalTable.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.table.AnalyticalTable.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addSelectionInterval(iFromIndex, iToIndex): sap.ui.table.TreeTable
Marks a range of tree nodes as selected, starting with iFromIndex going to iToIndex. The TreeNodes are referenced via their absolute row index. Please be aware, that the absolute row index only applies to the the tree which is visualized by the TreeTable. Invisible nodes (collapsed child nodes) will not be regarded.

Please also take notice of the fact, that "addSelectionInterval" does not change any other selection. To override the current selection, please use "setSelctionInterval" or for a single entry use "setSelectedIndex".

Parameters:
{int}iFromIndex The starting index of the range which will be selected.
{int}iToIndex The starting index of the range which will be selected.
Returns:
{sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
clearSelection(): sap.ui.table.TreeTable
Clears the complete selection (all tree table rows/nodes will lose their selection)
Returns:
{sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
collapseAll(): sap.ui.table.TreeTable
Collapses all nodes (and lower if collapseRecursive is activated)
Returns:
{sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
getAutoExpandMode(): string
Gets current value of property autoExpandMode.

The kind of auto expansion algorithm, e.g. optimised filter conditions, per level requests, ... sap.ui.table.TreeAutoExpandMode

Default value is Bundled.

Returns:
{string} Value of property autoExpandMode
getCollapseRecursive(): boolean
Gets current value of property collapseRecursive.

Setting collapseRecursive to true means, that when collapsing a node all subsequent child nodes will also be collapsed.

Default value is true.

Returns:
{boolean} Value of property collapseRecursive
getColumnVisibilityMenuSorter(): any
Gets current value of property columnVisibilityMenuSorter.

Functions which is used to sort the column visibility menu entries e.g.: function(ColumnA, ColumnB) { return 0 = equals, <0 lower, >0 greater }; Other values than functions will be ignored.

Returns:
{any} Value of property columnVisibilityMenuSorter
getContextByIndex(iIndex): object
Returns the context of a row by its index.
Parameters:
{int}iIndex Index of the row to return the context from.
Returns:
{object}
getNumberOfExpandedLevels(): int
Gets current value of property numberOfExpandedLevels.

Number of levels, which should be opened initially (on first load of data).

Default value is 0.

Returns:
{int} Value of property numberOfExpandedLevels
getSelectedIndex(): int[]
Retrieves the lead selection index. The lead selection index is, among other things, used to determine the start/end of a selection range, when using Shift-Click to select multiple entries at once.
Returns:
{int[]} an array containing all selected indices (ascending ordered integers)
getSelectedIndices(): int[]
Returns an array containing the row indices of all selected tree nodes (ordered ascending).

Please be aware of the following: Due to performance/network traffic reasons, the getSelectedIndices function returns only all indices of actually selected rows/tree nodes. Unknown rows/nodes (as in "not yet loaded" to the client), will not be returned.

Returns:
{int[]} an array containing all selected indices
getSumOnTop(): boolean
Gets current value of property sumOnTop.

Specifies if the total values should be displayed in the group headers or on bottom of the row. Does not affact the total sum.

Default value is false.

Returns:
{boolean} Value of property sumOnTop
getTotalSize(): int
Returns the total size of the data entries.
Returns:
{int}
isIndexSelected(iRowIndex): boolean
Checks if the row at the given index is selected.
Parameters:
{int}iRowIndex The row index for which the selection state should be retrieved
Returns:
{boolean} true if the index is selected, false otherwise
removeSelectionInterval(iFromIndex, iToIndex): sap.ui.table.TreeTable
All rows/tree nodes inside the range (including boundaries) will be deselected. Tree nodes are referenced with theit absolute row index inside the tree- Please be aware, that the absolute row index only applies to the the tree which is visualized by the TreeTable. Invisible nodes (collapsed child nodes) will not be regarded.
Parameters:
{int}iFromIndex The starting index of the range which will be deselected.
{int}iToIndex The starting index of the range which will be deselected.
Returns:
{sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
resumeUpdateAnalyticalInfo(bSuppressRefresh, bForceChange)
This function is used by some composite controls to force updating the AnalyticalInfo
Parameters:
{boolean}bSuppressRefresh binding shall not refresh data
{boolean}bForceChange forces the binding to fire a change event
selectAll(): sap.ui.table.TreeTable
Selects all available nodes/rows.

Explanation of the SelectAll function and what to expect from its behavior: All rows/tree nodes locally stored on the client are selected. In addition all subsequent rows/tree nodes, which will be paged into view are also immediatly selected. However, due to obvious performance/network traffic reasons, the SelectAll function will NOT retrieve any data from the backend.

Returns:
{sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
setAutoExpandMode(sAutoExpandMode): sap.ui.table.AnalyticalTable
Sets a new value for property autoExpandMode.

The kind of auto expansion algorithm, e.g. optimised filter conditions, per level requests, ... sap.ui.table.TreeAutoExpandMode

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

Default value is Bundled.

Parameters:
{string}sAutoExpandMode New value for property autoExpandMode
Returns:
{sap.ui.table.AnalyticalTable} Reference to this in order to allow method chaining
setColumnVisibilityMenuSorter(oColumnVisibilityMenuSorter): sap.ui.table.AnalyticalTable
Sets a new value for property columnVisibilityMenuSorter.

Functions which is used to sort the column visibility menu entries e.g.: function(ColumnA, ColumnB) { return 0 = equals, <0 lower, >0 greater }; Other values than functions will be ignored.

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

Parameters:
{any}oColumnVisibilityMenuSorter New value for property columnVisibilityMenuSorter
Returns:
{sap.ui.table.AnalyticalTable} Reference to this in order to allow method chaining
setNumberOfExpandedLevels(iNumberOfExpandedLevels): sap.ui.table.AnalyticalTable
Sets a new value for property numberOfExpandedLevels.

Number of levels, which should be opened initially (on first load of data).

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

Default value is 0.

Parameters:
{int}iNumberOfExpandedLevels New value for property numberOfExpandedLevels
Returns:
{sap.ui.table.AnalyticalTable} Reference to this in order to allow method chaining
setSelectedIndex(iRowIndex): sap.ui.table.TreeTable
Overriden from Table.js base class. In a TreeTable you can only select indices, which correspond to the currently visualized tree. Invisible tree nodes (e.g. collapsed child nodes) can not be selected via Index, because they do not correspond to a TreeTable row.
Parameters:
{int}iRowIndex The row index which will be selected (if existing)
Returns:
{sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
setSelectionBehavior(sBehavior): sap.ui.table.Table
Sets the selection behavior. Since the AnalyticalTable relies on the RowSelector for rendering the group headers the SelectionBehavior "RowOnly" is not supported and must not be used.
Parameters:
{string}sBehavior the selection behavior, see sap.ui.table.SelectionBehavior
Returns:
{sap.ui.table.Table} this for chaining
setSelectionInterval(iFromIndex, iToIndex): sap.ui.table.TreeTable
Sets the selection of the TreeTable to the given range (including boundaries). Beware: The previous selection will be lost/overriden. If this is not wanted, please use "addSelectionInterval" and "removeSelectionIntervall".
Parameters:
{int}iFromIndex the start index of the selection range
{int}iToIndex the end index of the selection range
Returns:
{sap.ui.table.TreeTable} a reference on the TreeTable control, can be used for chaining
setSelectionMode(sSelectionMode): sap.ui.table.Table
Sets the selection mode, the current selection is lost. Since the AnalyticalTable relies on the RowSelector for rendering the group headers the SelectionMode "None" is not supported and must not be used.
Parameters:
{string}sSelectionMode the selection mode, see sap.ui.table.SelectionMode
Returns:
{sap.ui.table.Table} a reference on the table for chaining
setSumOnTop(bSumOnTop): sap.ui.table.AnalyticalTable
Sets a new value for property sumOnTop.

Specifies if the total values should be displayed in the group headers or on bottom of the row. Does not affact the total sum.

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

Default value is false.

Parameters:
{boolean}bSumOnTop New value for property sumOnTop
Returns:
{sap.ui.table.AnalyticalTable} Reference to this in order to allow method chaining
suspendUpdateAnalyticalInfo()
This function is used by some composite controls to avoid updating the AnalyticalInfo when several column are added to the table. In order to finally update the AnalyticalInfo and request data, resumeUpdateAnalyticalInfo must be called.
getDirty(): boolean
Gets current value of property dirty.

If dirty the content of the Table will be overlayed.

Deprecated:
Since version 1.21.2. Please use setShowOverlay instead.
Returns:
{boolean} Value of property dirty
setDirty(bDirty): sap.ui.table.AnalyticalTable
Sets a new value for property dirty.

If dirty the content of the Table will be overlayed.

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

Parameters:
{boolean}bDirty New value for property dirty
Deprecated:
Since version 1.21.2. Please use setShowOverlay instead.
Returns:
{sap.ui.table.AnalyticalTable} Reference to this in order to allow method chaining