Class sap.ui.table.TableModule: sap/ui/table/Table

extends Control
known direct subclasses: AnalyticalTable, TreeTable

Provides a comprehensive set of features for displaying and dealing with vast amounts of data. The Table control supports desktop PCs and tablet devices. On tablets, special consideration should be given to the number of visible columns and rows due to the limited performance of some devices.

In order to keep the document DOM as lean as possible, the Table control reuses its DOM elements of the rows. When the user scrolls, only the row contexts are changed but the rendered controls remain the same. This allows the Table control to handle huge amounts of data. Nevertheless, restrictions apply regarding the number of displayed columns. Keep the number as low as possible to improve performance. Due to the nature of tables, the used control for column templates also has a big influence on the performance.

The Table control relies completely on data binding, and its supported feature set is tightly coupled to the data model and binding being used.

Constructor Summary
new sap.ui.table.Table(sId?, mSettings?)Constructor for a new Table.
Event Summary
busyStateChanged(oControlEvent)This event gets fired when the busy state of the table changes.
cellClick(oControlEvent)fired when the user clicks a cell of the table (experimental!).
cellContextmenu(oControlEvent)fired when the user clicks a cell of the table.
columnFreeze(oControlEvent)fired when a column of the table should be freezed
columnMove(oControlEvent)fired when a table column is moved.
columnResize(oControlEvent)fired when a table column is resized.
columnSelect(oControlEvent)fired when a column of the table has been selected
columnVisibility(oControlEvent)fired when the visibility of a table column is changed.
customFilter(oControlEvent)This event is triggered when the custom filter item of the column menu is pressed.
filter(oControlEvent)fired when the table is filtered.
firstVisibleRowChanged(oControlEvent)This event gets fired when the first visible row is changed.
group(oControlEvent)fired when the table is grouped (experimental!).
rowSelectionChange(oControlEvent)fired when the row selection of the table has been changed (the event parameters can be used to determine selection changes - to find out the selected rows you should better use the table selection API)
sort(oControlEvent)fired when the table is sorted.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.table.Table.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.table.Table with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.table.Table.getMetadata()Returns a metadata object for class sap.ui.table.Table.
addAriaLabelledBy(vAriaLabelledBy)Adds some ariaLabelledBy into the association ariaLabelledBy.
addColumn(oColumn)Adds some column to the aggregation columns.
addExtension(oExtension)Adds some extension to the aggregation extension.
addRow(oRow)Adds some row to the aggregation rows.
addSelectionInterval(iIndexFrom, iIndexTo)Adds the given selection interval to the selection.
attachBusyStateChanged(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the busyStateChanged event of this sap.ui.table.Table.
attachCellClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the cellClick event of this sap.ui.table.Table.
attachCellContextmenu(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the cellContextmenu event of this sap.ui.table.Table.
attachColumnFreeze(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the columnFreeze event of this sap.ui.table.Table.
attachColumnMove(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the columnMove event of this sap.ui.table.Table.
attachColumnResize(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the columnResize event of this sap.ui.table.Table.
attachColumnSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the columnSelect event of this sap.ui.table.Table.
attachColumnVisibility(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the columnVisibility event of this sap.ui.table.Table.
attachCustomFilter(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the customFilter event of this sap.ui.table.Table.
attachFilter(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the filter event of this sap.ui.table.Table.
attachFirstVisibleRowChanged(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the firstVisibleRowChanged event of this sap.ui.table.Table.
attachGroup(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the group event of this sap.ui.table.Table.
attachRowSelectionChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the rowSelectionChange event of this sap.ui.table.Table.
attachSort(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the sort event of this sap.ui.table.Table.
autoResizeColumn(iColIndex)Triggers automatic resizing of a column to the widest content.
bindColumns(oBindingInfo)Binds aggregation columns to model data.
bindRows(oBindingInfo)Binds aggregation rows to model data.
clearSelection()Removes complete selection.
destroyColumns()Destroys all the columns in the aggregation columns.
destroyExtension()Destroys all the extension in the aggregation extension.
destroyFooter()Destroys the footer in the aggregation footer.
destroyNoData()Destroys the noData in the aggregation noData.
destroyRows()Destroys all the rows in the aggregation rows.
destroyTitle()Destroys the title in the aggregation title.
destroyToolbar()Destroys the toolbar in the aggregation toolbar.
detachBusyStateChanged(fnFunction, oListener)Detaches event handler fnFunction from the busyStateChanged event of this sap.ui.table.Table.
detachCellClick(fnFunction, oListener)Detaches event handler fnFunction from the cellClick event of this sap.ui.table.Table.
detachCellContextmenu(fnFunction, oListener)Detaches event handler fnFunction from the cellContextmenu event of this sap.ui.table.Table.
detachColumnFreeze(fnFunction, oListener)Detaches event handler fnFunction from the columnFreeze event of this sap.ui.table.Table.
detachColumnMove(fnFunction, oListener)Detaches event handler fnFunction from the columnMove event of this sap.ui.table.Table.
detachColumnResize(fnFunction, oListener)Detaches event handler fnFunction from the columnResize event of this sap.ui.table.Table.
detachColumnSelect(fnFunction, oListener)Detaches event handler fnFunction from the columnSelect event of this sap.ui.table.Table.
detachColumnVisibility(fnFunction, oListener)Detaches event handler fnFunction from the columnVisibility event of this sap.ui.table.Table.
detachCustomFilter(fnFunction, oListener)Detaches event handler fnFunction from the customFilter event of this sap.ui.table.Table.
detachFilter(fnFunction, oListener)Detaches event handler fnFunction from the filter event of this sap.ui.table.Table.
detachFirstVisibleRowChanged(fnFunction, oListener)Detaches event handler fnFunction from the firstVisibleRowChanged event of this sap.ui.table.Table.
detachGroup(fnFunction, oListener)Detaches event handler fnFunction from the group event of this sap.ui.table.Table.
detachRowSelectionChange(fnFunction, oListener)Detaches event handler fnFunction from the rowSelectionChange event of this sap.ui.table.Table.
detachSort(fnFunction, oListener)Detaches event handler fnFunction from the sort event of this sap.ui.table.Table.
exportData(mSettings?)Creates a new sap.ui.core.util.Export object and fills row/column information from the table if not provided.
filter(oColumn, sValue)filter the given column by the given value
fireBusyStateChanged(mArguments?)Fires event busyStateChanged to attached listeners.
fireCellClick(mArguments?)Fires event cellClick to attached listeners.
fireCellContextmenu(mArguments?)Fires event cellContextmenu to attached listeners.
fireColumnFreeze(mArguments?)Fires event columnFreeze to attached listeners.
fireColumnMove(mArguments?)Fires event columnMove to attached listeners.
fireColumnResize(mArguments?)Fires event columnResize to attached listeners.
fireColumnSelect(mArguments?)Fires event columnSelect to attached listeners.
fireColumnVisibility(mArguments?)Fires event columnVisibility to attached listeners.
fireCustomFilter(mArguments?)Fires event customFilter to attached listeners.
fireFilter(mArguments?)Fires event filter to attached listeners.
fireFirstVisibleRowChanged(mArguments?)Fires event firstVisibleRowChanged to attached listeners.
fireGroup(mArguments?)Fires event group to attached listeners.
fireRowSelectionChange(mArguments?)Fires event rowSelectionChange to attached listeners.
fireSort(mArguments?)Fires event sort to attached listeners.
getAriaLabelledBy()Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
getColumnHeaderHeight()Gets current value of property columnHeaderHeight.
getColumnHeaderVisible()Gets current value of property columnHeaderVisible.
getColumns()Gets content of aggregation columns.
getContextByIndex(iIndex)Returns the context of a row by its index.
getEditable()Gets current value of property editable.
getEnableBusyIndicator()Gets current value of property enableBusyIndicator.
getEnableCellFilter()Gets current value of property enableCellFilter.
getEnableColumnFreeze()Gets current value of property enableColumnFreeze.
getEnableColumnReordering()Gets current value of property enableColumnReordering.
getEnableCustomFilter()Gets current value of property enableCustomFilter.
getEnableGrouping()Gets current value of property enableGrouping.
getEnableSelectAll()Gets current value of property enableSelectAll.
getExtension()Gets content of aggregation extension.
getFirstVisibleRow()Gets current value of property firstVisibleRow.
getFixedBottomRowCount()Gets current value of property fixedBottomRowCount.
getFixedColumnCount()Gets current value of property fixedColumnCount.
getFixedRowCount()Gets current value of property fixedRowCount.
getFooter()Gets content of aggregation footer.
getGroupBy()ID of the element which is the current target of the association groupBy, or null.
getMinAutoRowCount()Gets current value of property minAutoRowCount.
getNoData()Gets content of aggregation noData.
getRowHeight()Gets current value of property rowHeight.
getRows()Gets content of aggregation rows.
getSelectedIndex()Gets current value of property selectedIndex.
getSelectedIndices()Zero-based indices of selected items, wrapped in an array.
getSelectionBehavior()Gets current value of property selectionBehavior.
getSelectionMode()Gets current value of property selectionMode.
getShowColumnVisibilityMenu()Gets current value of property showColumnVisibilityMenu.
getShowNoData()Gets current value of property showNoData.
getShowOverlay()Gets current value of property showOverlay.
getSortedColumns()gets sorted columns
getThreshold()Gets current value of property threshold.
getTitle()Gets content of aggregation title.
getToolbar()Gets content of aggregation toolbar.
getVisibleRowCount()Gets current value of property visibleRowCount.
getVisibleRowCountMode()Gets current value of property visibleRowCountMode.
getWidth()Gets current value of property width.
indexOfColumn(oColumn)Checks for the provided sap.ui.table.Column in the aggregation columns.
indexOfExtension(oExtension)Checks for the provided sap.ui.core.Control in the aggregation extension.
indexOfRow(oRow)Checks for the provided sap.ui.table.Row in the aggregation rows.
insertColumn(oColumn, iIndex)Inserts a column into the aggregation columns.
insertExtension(oExtension, iIndex)Inserts a extension into the aggregation extension.
insertRow(oRow, iIndex)Inserts a row into the aggregation rows.
isIndexSelected(iIndex)Returns whether the given index is selected.
removeAllAriaLabelledBy()Removes all the controls in the association named ariaLabelledBy.
removeAllColumns()Removes all the controls from the aggregation columns.
removeAllExtension()Removes all the controls from the aggregation extension.
removeAllRows()Removes all the controls from the aggregation rows.
removeAriaLabelledBy(vAriaLabelledBy)Removes an ariaLabelledBy from the association named ariaLabelledBy.
removeColumn(vColumn)Removes a column from the aggregation columns.
removeExtension(vExtension)Removes a extension from the aggregation extension.
removeRow(vRow)Removes a row from the aggregation rows.
removeSelectionInterval(iIndexFrom, iIndexTo)Removes the given selection interval from the selection.
selectAll()Add all rows to the selection.
setColumnHeaderHeight(iColumnHeaderHeight)Sets a new value for property columnHeaderHeight.
setColumnHeaderVisible(bColumnHeaderVisible)Sets a new value for property columnHeaderVisible.
setEditable(bEditable)Sets a new value for property editable.
setEnableBusyIndicator(bEnableBusyIndicator)Sets a new value for property enableBusyIndicator.
setEnableCellFilter(bEnableCellFilter)Sets a new value for property enableCellFilter.
setEnableColumnFreeze(bEnableColumnFreeze)Sets a new value for property enableColumnFreeze.
setEnableColumnReordering(bEnableColumnReordering)Sets a new value for property enableColumnReordering.
setEnableCustomFilter(bEnableCustomFilter)Sets a new value for property enableCustomFilter.
setEnableSelectAll(bEnableSelectAll)Sets a new value for property enableSelectAll.
setFirstVisibleRow(iFirstVisibleRow)Sets a new value for property firstVisibleRow.
setFixedBottomRowCount(iFixedBottomRowCount)Sets a new value for property fixedBottomRowCount.
setFixedColumnCount(iFixedColumnCount)Sets a new value for property fixedColumnCount.
setFixedRowCount(iFixedRowCount)Sets a new value for property fixedRowCount.
setFooter(vFooter)Sets the aggregated footer.
setGroupBy(oGroupBy)Sets the associated groupBy.
setMinAutoRowCount(iMinAutoRowCount)Sets a new value for property minAutoRowCount.
setNoData(vNoData)Sets the aggregated noData.
setRowHeight(iRowHeight)Sets a new value for property rowHeight.
setSelectedIndex(iSelectedIndex)Sets a new value for property selectedIndex.
setSelectionBehavior(sSelectionBehavior)Sets a new value for property selectionBehavior.
setSelectionInterval(iIndexFrom, iIndexTo)Sets the given selection interval as selection.
setSelectionMode(sSelectionMode)Sets the selection mode.
setShowColumnVisibilityMenu(bShowColumnVisibilityMenu)Sets a new value for property showColumnVisibilityMenu.
setShowNoData(bShowNoData)Sets a new value for property showNoData.
setShowOverlay(bShowOverlay)Sets a new value for property showOverlay.
setThreshold()Sets the threshold value, which will be added to all data requests in case the Table is bound against an OData service.
setTitle(vTitle)Sets the aggregated title.
setToolbar(oToolbar)Sets the aggregated toolbar.
setVisibleRowCount(iVisibleRowCount)Sets a new value for property visibleRowCount.
setVisibleRowCountMode(sVisibleRowCountMode)Sets a new value for property visibleRowCountMode.
setWidth(sWidth)Sets a new value for property width.
sort(oColumn, oSortOrder, bAdd)sorts the given column ascending or descending
unbindColumns()Unbinds aggregation columns from model data.
unbindRows()Unbinds aggregation rows from model data.
getNavigationMode()Gets current value of property navigationMode.
setNavigationMode(sNavigationMode)Sets a new value for property navigationMode.
Constructor Detail
new sap.ui.table.Table(sId?, mSettings?)
Constructor for a new Table.

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
    • title : sap.ui.core.Control|string
    • footer : sap.ui.core.Control|string
    • toolbar : sap.ui.core.Toolbar
    • extension : sap.ui.core.Control[]
    • columns : sap.ui.table.Column[] (default)
    • rows : sap.ui.table.Row[]
    • noData : sap.ui.core.Control|string
  • Events
    • rowSelectionChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • columnSelect : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • columnResize : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • columnMove : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • sort : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • filter : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • group : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • columnVisibility : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • cellClick : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • cellContextmenu : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • columnFreeze : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • customFilter : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • firstVisibleRowChanged : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • busyStateChanged : 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
busyStateChanged(oControlEvent)
This event gets fired when the busy state of the table changes. It should only be used by composite controls.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Since:
1.37.0
cellClick(oControlEvent)
fired when the user clicks a cell of the table (experimental!).
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.core.Control}oControlEvent.getParameters.cellControl The control of the cell.
{Object}oControlEvent.getParameters.cellDomRef DOM reference of the clicked cell. Can be used to position the context menu.
{int}oControlEvent.getParameters.rowIndex Row index of the selected cell.
{int}oControlEvent.getParameters.columnIndex Column index of the selected cell. This is the index of visible columns and might differ from the index maintained in the column aggregation.
{string}oControlEvent.getParameters.columnId Column ID of the selected cell.
{sap.ui.model.Context}oControlEvent.getParameters.rowBindingContext Row binding context of the selected cell.
Since:
1.21.0
cellContextmenu(oControlEvent)
fired when the user clicks a cell of the table.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.core.Control}oControlEvent.getParameters.cellControl The control of the cell.
{Object}oControlEvent.getParameters.cellDomRef DOM reference of the clicked cell. Can be used to position the context menu.
{int}oControlEvent.getParameters.rowIndex Row index of the selected cell.
{int}oControlEvent.getParameters.columnIndex Column index of the selected cell. This is the index of visible columns and might differ from the index maintained in the column aggregation.
{string}oControlEvent.getParameters.columnId Column ID of the selected cell.
{sap.ui.model.Context}oControlEvent.getParameters.rowBindingContext Row binding context of the selected cell.
Since:
1.21.0
columnFreeze(oControlEvent)
fired when a column of the table should be freezed
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.table.Column}oControlEvent.getParameters.column reference to the column to freeze
Since:
1.21.0
columnMove(oControlEvent)
fired when a table column is moved.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.table.Column}oControlEvent.getParameters.column moved column.
{int}oControlEvent.getParameters.newPos new position of the column.
columnResize(oControlEvent)
fired when a table column is resized.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.table.Column}oControlEvent.getParameters.column resized column.
{sap.ui.core.CSSSize}oControlEvent.getParameters.width new width of the table column as CSS Size definition.
columnSelect(oControlEvent)
fired when a column of the table has been selected
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.table.Column}oControlEvent.getParameters.column reference to the selected column
columnVisibility(oControlEvent)
fired when the visibility of a table column is changed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.table.Column}oControlEvent.getParameters.column affected column.
{boolean}oControlEvent.getParameters.visible new value of the visible property.
customFilter(oControlEvent)
This event is triggered when the custom filter item of the column menu is pressed. The column on which the event was triggered is passed as parameter.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Since:
1.23.0
filter(oControlEvent)
fired when the table is filtered.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.table.Column}oControlEvent.getParameters.column filtered column.
{string}oControlEvent.getParameters.value filter value.
firstVisibleRowChanged(oControlEvent)
This event gets fired when the first visible row is changed. It should only be used by composite controls. The event even is fired when setFirstVisibleRow is called programmatically.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Since:
1.37.0
group(oControlEvent)
fired when the table is grouped (experimental!).
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.table.Column}oControlEvent.getParameters.column grouped column.
rowSelectionChange(oControlEvent)
fired when the row selection of the table has been changed (the event parameters can be used to determine selection changes - to find out the selected rows you should better use the table selection API)
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{int}oControlEvent.getParameters.rowIndex row index which has been clicked so that the selection has been changed (either selected or deselected)
{object}oControlEvent.getParameters.rowContext binding context of the row which has been clicked so that selection has been changed
{int[]}oControlEvent.getParameters.rowIndices array of row indices which selection has been changed (either selected or deselected)
{boolean}oControlEvent.getParameters.selectAll indicator if "select all" function is used to select rows
{boolean}oControlEvent.getParameters.userInteraction indicates that the event was fired due to an explicit user interaction like clicking the row header or using the keyboard (SPACE or ENTER) to select a row or a range of rows.
sort(oControlEvent)
fired when the table is sorted.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.table.Column}oControlEvent.getParameters.column sorted column.
{sap.ui.table.SortOrder}oControlEvent.getParameters.sortOrder Sort Order
{boolean}oControlEvent.getParameters.columnAdded If column was added to sorter this is true. If new sort is started this is set to false
Method Detail
sap.ui.table.Table.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.table.Table 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.ui.table.Table.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.table.Table.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addAriaLabelledBy(vAriaLabelledBy): sap.ui.table.Table
Adds some ariaLabelledBy into the association ariaLabelledBy.
Parameters:
{string|sap.ui.core.Control}vAriaLabelledBy the ariaLabelledBy to add; if empty, nothing is inserted
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
addColumn(oColumn): sap.ui.table.Table
Adds some column to the aggregation columns.
Parameters:
{sap.ui.table.Column}oColumn the column to add; if empty, nothing is inserted
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
addExtension(oExtension): sap.ui.table.Table
Adds some extension to the aggregation extension.
Parameters:
{sap.ui.core.Control}oExtension the extension to add; if empty, nothing is inserted
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
addRow(oRow): sap.ui.table.Table
Adds some row to the aggregation rows.
Parameters:
{sap.ui.table.Row}oRow the row to add; if empty, nothing is inserted
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
addSelectionInterval(iIndexFrom, iIndexTo): sap.ui.table.Table
Adds the given selection interval to the selection. In case of single selection the "indexTo" value will be used for as selected index.
Parameters:
{int}iIndexFrom Index from which .
{int}iIndexTo Indices of the items that shall additionally be selected.
Returns:
{sap.ui.table.Table}
attachBusyStateChanged(oData?, fnFunction, oListener?): sap.ui.table.Table
Attaches event handler fnFunction to the busyStateChanged event of this sap.ui.table.Table.

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.ui.table.Table itself.

This event gets fired when the busy state of the table changes. It should only be used by composite controls.

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.ui.table.Table itself
Since:
1.37.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
attachCellClick(oData?, fnFunction, oListener?): sap.ui.table.Table
Attaches event handler fnFunction to the cellClick event of this sap.ui.table.Table.

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.ui.table.Table itself.

fired when the user clicks a cell of the table (experimental!).

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.ui.table.Table itself
Since:
1.21.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
attachCellContextmenu(oData?, fnFunction, oListener?): sap.ui.table.Table
Attaches event handler fnFunction to the cellContextmenu event of this sap.ui.table.Table.

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.ui.table.Table itself.

fired when the user clicks a cell of the 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.ui.table.Table itself
Since:
1.21.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
attachColumnFreeze(oData?, fnFunction, oListener?): sap.ui.table.Table
Attaches event handler fnFunction to the columnFreeze event of this sap.ui.table.Table.

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.ui.table.Table itself.

fired when a column of the table should be freezed

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.ui.table.Table itself
Since:
1.21.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
attachColumnMove(oData?, fnFunction, oListener?): sap.ui.table.Table
Attaches event handler fnFunction to the columnMove event of this sap.ui.table.Table.

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.ui.table.Table itself.

fired when a table column is moved.

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.ui.table.Table itself
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
attachColumnResize(oData?, fnFunction, oListener?): sap.ui.table.Table
Attaches event handler fnFunction to the columnResize event of this sap.ui.table.Table.

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.ui.table.Table itself.

fired when a table column is resized.

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.ui.table.Table itself
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
attachColumnSelect(oData?, fnFunction, oListener?): sap.ui.table.Table
Attaches event handler fnFunction to the columnSelect event of this sap.ui.table.Table.

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.ui.table.Table itself.

fired when a column of the table has been selected

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.ui.table.Table itself
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
attachColumnVisibility(oData?, fnFunction, oListener?): sap.ui.table.Table
Attaches event handler fnFunction to the columnVisibility event of this sap.ui.table.Table.

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.ui.table.Table itself.

fired when the visibility of a table column is changed.

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.ui.table.Table itself
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
attachCustomFilter(oData?, fnFunction, oListener?): sap.ui.table.Table
Attaches event handler fnFunction to the customFilter event of this sap.ui.table.Table.

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.ui.table.Table itself.

This event is triggered when the custom filter item of the column menu is pressed. The column on which the event was triggered is passed as parameter.

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.ui.table.Table itself
Since:
1.23.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
attachFilter(oData?, fnFunction, oListener?): sap.ui.table.Table
Attaches event handler fnFunction to the filter event of this sap.ui.table.Table.

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.ui.table.Table itself.

fired when the table is filtered.

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.ui.table.Table itself
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
attachFirstVisibleRowChanged(oData?, fnFunction, oListener?): sap.ui.table.Table
Attaches event handler fnFunction to the firstVisibleRowChanged event of this sap.ui.table.Table.

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.ui.table.Table itself.

This event gets fired when the first visible row is changed. It should only be used by composite controls. The event even is fired when setFirstVisibleRow is called programmatically.

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.ui.table.Table itself
Since:
1.37.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
attachGroup(oData?, fnFunction, oListener?): sap.ui.table.Table
Attaches event handler fnFunction to the group event of this sap.ui.table.Table.

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.ui.table.Table itself.

fired when the table is grouped (experimental!).

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

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.ui.table.Table itself.

fired when the row selection of the table has been changed (the event parameters can be used to determine selection changes - to find out the selected rows you should better use the table selection API)

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.ui.table.Table itself
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
attachSort(oData?, fnFunction, oListener?): sap.ui.table.Table
Attaches event handler fnFunction to the sort event of this sap.ui.table.Table.

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.ui.table.Table itself.

fired when the table is sorted.

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.ui.table.Table itself
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
autoResizeColumn(iColIndex)
Triggers automatic resizing of a column to the widest content.

Experimental API:Experimental! Presently implemented to only work with a very limited set of controls (e.g. sap.m.Text).

Parameters:
{int}iColIndex The index of the column in the list of visible columns.
Experimental:
Experimental! Presently implemented to only work with a very limited set of controls (e.g. sap.m.Text).
bindColumns(oBindingInfo): sap.ui.table.Table
Binds aggregation columns to model data.

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

Parameters:
{object}oBindingInfo The binding information
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
bindRows(oBindingInfo): sap.ui.table.Table
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.ui.table.Table} Reference to this in order to allow method chaining
clearSelection(): sap.ui.table.Table
Removes complete selection.
Returns:
{sap.ui.table.Table}
destroyColumns(): sap.ui.table.Table
Destroys all the columns in the aggregation columns.
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
destroyExtension(): sap.ui.table.Table
Destroys all the extension in the aggregation extension.
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
destroyFooter(): sap.ui.table.Table
Destroys the footer in the aggregation footer.
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
destroyNoData(): sap.ui.table.Table
Destroys the noData in the aggregation noData.
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
destroyRows(): sap.ui.table.Table
Destroys all the rows in the aggregation rows.
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
destroyTitle(): sap.ui.table.Table
Destroys the title in the aggregation title.
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
destroyToolbar(): sap.ui.table.Table
Destroys the toolbar in the aggregation toolbar.
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
detachBusyStateChanged(fnFunction, oListener): sap.ui.table.Table
Detaches event handler fnFunction from the busyStateChanged event of this sap.ui.table.Table.

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
Since:
1.37.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
detachCellClick(fnFunction, oListener): sap.ui.table.Table
Detaches event handler fnFunction from the cellClick event of this sap.ui.table.Table.

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
Since:
1.21.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
detachCellContextmenu(fnFunction, oListener): sap.ui.table.Table
Detaches event handler fnFunction from the cellContextmenu event of this sap.ui.table.Table.

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
Since:
1.21.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
detachColumnFreeze(fnFunction, oListener): sap.ui.table.Table
Detaches event handler fnFunction from the columnFreeze event of this sap.ui.table.Table.

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
Since:
1.21.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
detachColumnMove(fnFunction, oListener): sap.ui.table.Table
Detaches event handler fnFunction from the columnMove event of this sap.ui.table.Table.

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.ui.table.Table} Reference to this in order to allow method chaining
detachColumnResize(fnFunction, oListener): sap.ui.table.Table
Detaches event handler fnFunction from the columnResize event of this sap.ui.table.Table.

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.ui.table.Table} Reference to this in order to allow method chaining
detachColumnSelect(fnFunction, oListener): sap.ui.table.Table
Detaches event handler fnFunction from the columnSelect event of this sap.ui.table.Table.

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.ui.table.Table} Reference to this in order to allow method chaining
detachColumnVisibility(fnFunction, oListener): sap.ui.table.Table
Detaches event handler fnFunction from the columnVisibility event of this sap.ui.table.Table.

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.ui.table.Table} Reference to this in order to allow method chaining
detachCustomFilter(fnFunction, oListener): sap.ui.table.Table
Detaches event handler fnFunction from the customFilter event of this sap.ui.table.Table.

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
Since:
1.23.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
detachFilter(fnFunction, oListener): sap.ui.table.Table
Detaches event handler fnFunction from the filter event of this sap.ui.table.Table.

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.ui.table.Table} Reference to this in order to allow method chaining
detachFirstVisibleRowChanged(fnFunction, oListener): sap.ui.table.Table
Detaches event handler fnFunction from the firstVisibleRowChanged event of this sap.ui.table.Table.

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
Since:
1.37.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
detachGroup(fnFunction, oListener): sap.ui.table.Table
Detaches event handler fnFunction from the group event of this sap.ui.table.Table.

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

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.ui.table.Table} Reference to this in order to allow method chaining
detachSort(fnFunction, oListener): sap.ui.table.Table
Detaches event handler fnFunction from the sort event of this sap.ui.table.Table.

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.ui.table.Table} Reference to this in order to allow method chaining
exportData(mSettings?): Promise
Creates a new sap.ui.core.util.Export object and fills row/column information from the table if not provided. For the cell content, the column's "sortProperty" will be used (experimental!)

Please note: The return value was changed from jQuery Promises to standard ES6 Promises. jQuery specific Promise methods ('done', 'fail', 'always', 'pipe' and 'state') are still available but should not be used. Please use only the standard methods 'then' and 'catch'!

Experimental API:Experimental because the property for the column/cell definitions (sortProperty) could change in future.

Parameters:
{object}mSettings? settings for the new Export, see sap.ui.core.util.Exportconstructor
Experimental:
Experimental because the property for the column/cell definitions (sortProperty) could change in future.
Returns:
{Promise} Promise object
filter(oColumn, sValue): sap.ui.table.Table
filter the given column by the given value
Parameters:
{sap.ui.table.Column}oColumn column to be filtered
{string}sValue filter value as string (will be converted)
Returns:
{sap.ui.table.Table}
fireBusyStateChanged(mArguments?): sap.ui.table.Table
Fires event busyStateChanged to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.37.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
fireCellClick(mArguments?): boolean
Fires event cellClick to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Expects the following event parameters:

  • cellControl of type sap.ui.core.ControlThe control of the cell.
  • cellDomRef of type ObjectDOM reference of the clicked cell. Can be used to position the context menu.
  • rowIndex of type intRow index of the selected cell.
  • columnIndex of type intColumn index of the selected cell. This is the index of visible columns and might differ from the index maintained in the column aggregation.
  • columnId of type stringColumn ID of the selected cell.
  • rowBindingContext of type sap.ui.model.ContextRow binding context of the selected cell.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.21.0
Returns:
{boolean} Whether or not to prevent the default action
fireCellContextmenu(mArguments?): boolean
Fires event cellContextmenu to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Expects the following event parameters:

  • cellControl of type sap.ui.core.ControlThe control of the cell.
  • cellDomRef of type ObjectDOM reference of the clicked cell. Can be used to position the context menu.
  • rowIndex of type intRow index of the selected cell.
  • columnIndex of type intColumn index of the selected cell. This is the index of visible columns and might differ from the index maintained in the column aggregation.
  • columnId of type stringColumn ID of the selected cell.
  • rowBindingContext of type sap.ui.model.ContextRow binding context of the selected cell.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.21.0
Returns:
{boolean} Whether or not to prevent the default action
fireColumnFreeze(mArguments?): boolean
Fires event columnFreeze to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Expects the following event parameters:

  • column of type sap.ui.table.Columnreference to the column to freeze
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.21.0
Returns:
{boolean} Whether or not to prevent the default action
fireColumnMove(mArguments?): boolean
Fires event columnMove to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Expects the following event parameters:

  • column of type sap.ui.table.Columnmoved column.
  • newPos of type intnew position of the column.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{boolean} Whether or not to prevent the default action
fireColumnResize(mArguments?): boolean
Fires event columnResize to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Expects the following event parameters:

  • column of type sap.ui.table.Columnresized column.
  • width of type sap.ui.core.CSSSizenew width of the table column as CSS Size definition.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{boolean} Whether or not to prevent the default action
fireColumnSelect(mArguments?): boolean
Fires event columnSelect to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Expects the following event parameters:

  • column of type sap.ui.table.Columnreference to the selected column
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{boolean} Whether or not to prevent the default action
fireColumnVisibility(mArguments?): boolean
Fires event columnVisibility to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Expects the following event parameters:

  • column of type sap.ui.table.Columnaffected column.
  • visible of type booleannew value of the visible property.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{boolean} Whether or not to prevent the default action
fireCustomFilter(mArguments?): sap.ui.table.Table
Fires event customFilter to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.23.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
fireFilter(mArguments?): boolean
Fires event filter to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Expects the following event parameters:

  • column of type sap.ui.table.Columnfiltered column.
  • value of type stringfilter value.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{boolean} Whether or not to prevent the default action
fireFirstVisibleRowChanged(mArguments?): sap.ui.table.Table
Fires event firstVisibleRowChanged to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.37.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
fireGroup(mArguments?): boolean
Fires event group to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Expects the following event parameters:

  • column of type sap.ui.table.Columngrouped column.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{boolean} Whether or not to prevent the default action
fireRowSelectionChange(mArguments?): sap.ui.table.Table
Fires event rowSelectionChange to attached listeners.

Expects the following event parameters:

  • rowIndex of type introw index which has been clicked so that the selection has been changed (either selected or deselected)
  • rowContext of type objectbinding context of the row which has been clicked so that selection has been changed
  • rowIndices of type int[]array of row indices which selection has been changed (either selected or deselected)
  • selectAll of type booleanindicator if "select all" function is used to select rows
  • userInteraction of type booleanindicates that the event was fired due to an explicit user interaction like clicking the row header or using the keyboard (SPACE or ENTER) to select a row or a range of rows.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
fireSort(mArguments?): boolean
Fires event sort to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Expects the following event parameters:

  • column of type sap.ui.table.Columnsorted column.
  • sortOrder of type sap.ui.table.SortOrderSort Order
  • columnAdded of type booleanIf column was added to sorter this is true. If new sort is started this is set to false
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{boolean} Whether or not to prevent the default action
getAriaLabelledBy(): sap.ui.core.Control[]
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Returns:
{sap.ui.core.Control[]}
getColumnHeaderHeight(): int
Gets current value of property columnHeaderHeight.

Height of the column header of the Table in pixel.

Returns:
{int} Value of property columnHeaderHeight
getColumnHeaderVisible(): boolean
Gets current value of property columnHeaderVisible.

Flag whether the column header is visible or not.

Default value is true.

Returns:
{boolean} Value of property columnHeaderVisible
getColumns(): sap.ui.table.Column[]
Gets content of aggregation columns.

Columns of the Table

Returns:
{sap.ui.table.Column[]}
getContextByIndex(iIndex): object
Returns the context of a row by its index. Please note that for server-based models like OData, the supplied index might not have been loaded yet. If the context is not available at the client, the binding will trigger a backend request and request this single context. Although this API looks synchronous it may not return a context but load it and fire a change event on the binding.

For server-based models you should consider to only make this API call when the index is within the currently visible scroll area.

Parameters:
{int}iIndex Index of the row to return the context from.
Returns:
{object}
getEditable(): boolean
Gets current value of property editable.

Flag whether the controls of the Table are editable or not (currently this only controls the background color in certain themes!)

Default value is true.

Returns:
{boolean} Value of property editable
getEnableBusyIndicator(): boolean
Gets current value of property enableBusyIndicator.

Set this parameter to true to make the table handle the busy indicator by its own. The table will switch to busy as soon as it scrolls into an unpaged area. This feature can only be used when the navigation mode is set to scrolling.

Default value is false.

Since:
1.27.0
Returns:
{boolean} Value of property enableBusyIndicator
getEnableCellFilter(): boolean
Gets current value of property enableCellFilter.

Flag whether to enable or disable the context menu on cells to trigger a filtering with the cell value.

Default value is false.

Since:
1.21.0
Returns:
{boolean} Value of property enableCellFilter
getEnableColumnFreeze(): boolean
Gets current value of property enableColumnFreeze.

Flag whether to show or hide the column menu item to freeze or unfreeze a column.

Default value is false.

Since:
1.21.0
Returns:
{boolean} Value of property enableColumnFreeze
getEnableColumnReordering(): boolean
Gets current value of property enableColumnReordering.

Flag to enable or disable column reordering

Default value is true.

Returns:
{boolean} Value of property enableColumnReordering
getEnableCustomFilter(): boolean
Gets current value of property enableCustomFilter.

Set this parameter to true to implement your own filter behaviour. Instead of the filter input box a button will be rendered for which' press event (customFilter) you can register an event handler.

Default value is false.

Since:
1.23.0
Returns:
{boolean} Value of property enableCustomFilter
getEnableGrouping(): boolean
Gets current value of property enableGrouping.

Flag to enable or disable column grouping. (experimental!)

Default value is false.

Returns:
{boolean} Value of property enableGrouping
getEnableSelectAll(): boolean
Gets current value of property enableSelectAll.

Specifies if a select all button should be displayed in the top left corner. This button is only displayed if the row selector is visible and the selection mode is set to any kind of multi selection.

Default value is true.

Since:
1.23.0
Returns:
{boolean} Value of property enableSelectAll
getExtension(): sap.ui.core.Control[]
Gets content of aggregation extension.

Extension section of the Table (if not set it will be hidden)

Returns:
{sap.ui.core.Control[]}
getFirstVisibleRow(): int
Gets current value of property firstVisibleRow.

First visible row.

Default value is 0.

Returns:
{int} Value of property firstVisibleRow
getFixedBottomRowCount(): int
Gets current value of property fixedBottomRowCount.

Number of rows that are fix on the bottom. When you use a vertical scroll bar, only the rows which are not fixed, will scroll.

Default value is 0.

Since:
1.18.7
Returns:
{int} Value of property fixedBottomRowCount
getFixedColumnCount(): int
Gets current value of property fixedColumnCount.

Number of columns that are fix on the left. When you use a horizontal scroll bar, only the columns which are not fixed, will scroll. Fixed columns need a defined width for the feature to work. Please note that the aggregated width of all fixed columns must not exceed the table width since there will be no scrollbar for fixed columns.

Default value is 0.

Returns:
{int} Value of property fixedColumnCount
getFixedRowCount(): int
Gets current value of property fixedRowCount.

Number of rows that are fix on the top. When you use a vertical scroll bar, only the rows which are not fixed, will scroll.

Default value is 0.

Returns:
{int} Value of property fixedRowCount
getFooter(): sap.ui.core.Control|string
Gets content of aggregation footer.

Control or text of footer section of the Table (if not set it will be hidden)

Returns:
{sap.ui.core.Control|string}
getGroupBy(): sap.ui.table.Column
ID of the element which is the current target of the association groupBy, or null.
Returns:
{sap.ui.table.Column}
getMinAutoRowCount(): int
Gets current value of property minAutoRowCount.

This property is used to set the minimum count of visible rows when the property visibleRowCountMode is set to Auto or Interactive. For any other visibleRowCountMode, it is ignored.

Default value is 5.

Returns:
{int} Value of property minAutoRowCount
getNoData(): sap.ui.core.Control|string
Gets content of aggregation noData.

The value for the noData aggregation can be either a string value or a control instance. The control is shown, in case there is no data for the Table available. In case of a string value this will simply replace the no data text.

Returns:
{sap.ui.core.Control|string}
getRowHeight(): int
Gets current value of property rowHeight.

Height of a row of the Table in pixel.

Returns:
{int} Value of property rowHeight
getRows(): sap.ui.table.Row[]
Gets content of aggregation rows.

Rows of the Table

Returns:
{sap.ui.table.Row[]}
getSelectedIndex(): int
Gets current value of property selectedIndex.

Zero-based index of selected item. Index value for no selection is -1. When multi-selection is enabled and multiple items are selected, the method returns the lead selected item. Sets the zero-based index of the currently selected item. This method removes any previous selections. When the given index is invalid, the call is ignored.

Default value is -1.

Returns:
{int} Value of property selectedIndex
getSelectedIndices()
Zero-based indices of selected items, wrapped in an array. An empty array means "no selection".
getSelectionBehavior(): sap.ui.table.SelectionBehavior
Gets current value of property selectionBehavior.

Selection behavior of the Table. This property defines whether the row selector is displayed and whether the row, the row selector or both can be clicked to select a row.

Default value is RowSelector.

Returns:
{sap.ui.table.SelectionBehavior} Value of property selectionBehavior
getSelectionMode(): sap.ui.table.SelectionMode
Gets current value of property selectionMode.

Selection mode of the Table. This property controls whether single or multiple rows can be selected and how the selection can be extended. It may also influence the visual appearance.

Default value is MultiToggle.

Returns:
{sap.ui.table.SelectionMode} Value of property selectionMode
getShowColumnVisibilityMenu(): boolean
Gets current value of property showColumnVisibilityMenu.

Flag to show or hide the column visibility menu. This menu will get displayed in each generated column header menu. It allows to show or hide columns

Default value is false.

Returns:
{boolean} Value of property showColumnVisibilityMenu
getShowNoData(): boolean
Gets current value of property showNoData.

Flag whether to show the no data overlay or not once the table is empty. If set to false the table will just show a grid of empty cells

Default value is true.

Returns:
{boolean} Value of property showNoData
getShowOverlay(): boolean
Gets current value of property showOverlay.

Setting this property to true will show an overlay on top of the Table content and users cannot click anymore on the Table content.

Default value is false.

Since:
1.21.2
Returns:
{boolean} Value of property showOverlay
getSortedColumns()
gets sorted columns
getThreshold(): int
Gets current value of property threshold.

The threshold defines how many additional (not yet visible records) shall be pre-fetched to enable smooth scrolling. The threshold is always added to the visibleRowCount. If the visibleRowCount is 10 and the threshold is 100, there will be 110 records fetched with the initial load. If the threshold is lower than the visibleRowCount, the visibleRowCount will be used as the threshold. If the value is 0 then the thresholding is disabled.

Default value is 100.

Returns:
{int} Value of property threshold
getTitle(): sap.ui.core.Control|string
Gets content of aggregation title.

Control or text of title section of the Table (if not set it will be hidden)

Returns:
{sap.ui.core.Control|string}
getToolbar(): sap.ui.core.Toolbar
Gets content of aggregation toolbar.

Toolbar of the Table (if not set it will be hidden)

Returns:
{sap.ui.core.Toolbar}
getVisibleRowCount(): int
Gets current value of property visibleRowCount.

Number of visible rows of the table.

Default value is 10.

Returns:
{int} Value of property visibleRowCount
getVisibleRowCountMode(): sap.ui.table.VisibleRowCountMode
Gets current value of property visibleRowCountMode.

This defines how the table handles the visible rows in the table. The default behavior is, that a fixed row count is defined. If you change it to auto the visibleRowCount property is changed by the table automatically. It will then adjust its maximum row count to the space it is allowed to cover (limited by the surrounding container) and its minimum row count to the value of the property minAutoRowCount (default value : 5) In manual mode the user can change the visibleRowCount interactively.

Default value is Fixed.

Since:
1.9.2
Returns:
{sap.ui.table.VisibleRowCountMode} Value of property visibleRowCountMode
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

Width of the Table.

Default value is auto.

Returns:
{sap.ui.core.CSSSize} Value of property width
indexOfColumn(oColumn): int
Checks for the provided sap.ui.table.Column in the aggregation columns. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.table.Column}oColumn The column whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfExtension(oExtension): int
Checks for the provided sap.ui.core.Control in the aggregation extension. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oExtension The extension 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.table.Row in the aggregation rows. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.table.Row}oRow The row whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertColumn(oColumn, iIndex): sap.ui.table.Table
Inserts a column into the aggregation columns.
Parameters:
{sap.ui.table.Column}oColumn the column to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the column should be inserted at; for a negative value of iIndex, the column is inserted at position 0; for a value greater than the current size of the aggregation, the column is inserted at the last position
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
insertExtension(oExtension, iIndex): sap.ui.table.Table
Inserts a extension into the aggregation extension.
Parameters:
{sap.ui.core.Control}oExtension the extension to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the extension should be inserted at; for a negative value of iIndex, the extension is inserted at position 0; for a value greater than the current size of the aggregation, the extension is inserted at the last position
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
insertRow(oRow, iIndex): sap.ui.table.Table
Inserts a row into the aggregation rows.
Parameters:
{sap.ui.table.Row}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.ui.table.Table} Reference to this in order to allow method chaining
isIndexSelected(iIndex): boolean
Returns whether the given index is selected.
Parameters:
{int}iIndex Index which is checked for selection state.
Returns:
{boolean}
removeAllAriaLabelledBy(): sap.ui.core.Control[]
Removes all the controls in the association named ariaLabelledBy.
Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAllColumns(): sap.ui.table.Column[]
Removes all the controls from the aggregation columns.

Additionally, it unregisters them from the hosting UIArea.

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

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.table.Row[]
Removes all the controls from the aggregation rows.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.table.Row[]} An array of the removed elements (might be empty)
removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.Control
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Parameters:
{int|string|sap.ui.core.Control}vAriaLabelledBy The ariaLabelledByto be removed or its index or ID
Returns:
{sap.ui.core.Control} the removed ariaLabelledBy or null
removeColumn(vColumn): sap.ui.table.Column
Removes a column from the aggregation columns.
Parameters:
{int|string|sap.ui.table.Column}vColumn The columnto remove or its index or id
Returns:
{sap.ui.table.Column} The removed column or null
removeExtension(vExtension): sap.ui.core.Control
Removes a extension from the aggregation extension.
Parameters:
{int|string|sap.ui.core.Control}vExtension The extensionto remove or its index or id
Returns:
{sap.ui.core.Control} The removed extension or null
removeRow(vRow): sap.ui.table.Row
Removes a row from the aggregation rows.
Parameters:
{int|string|sap.ui.table.Row}vRow The rowto remove or its index or id
Returns:
{sap.ui.table.Row} The removed row or null
removeSelectionInterval(iIndexFrom, iIndexTo): sap.ui.table.Table
Removes the given selection interval from the selection. In case of single selection this call removeSelectedIndex with the "indexTo" value.
Parameters:
{int}iIndexFrom Index from which .
{int}iIndexTo Indices of the items that shall additionally be selected.
Returns:
{sap.ui.table.Table}
selectAll()
Add all rows to the selection. Please note that for server based models like OData the indices which are considered to be selected might not be available at the client yet. Calling getContextByIndex might not return a result but trigger a roundtrip to request this single entity.
setColumnHeaderHeight(iColumnHeaderHeight): sap.ui.table.Table
Sets a new value for property columnHeaderHeight.

Height of the column header of the Table in pixel.

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

Parameters:
{int}iColumnHeaderHeight New value for property columnHeaderHeight
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setColumnHeaderVisible(bColumnHeaderVisible): sap.ui.table.Table
Sets a new value for property columnHeaderVisible.

Flag whether the column header is visible or not.

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

Default value is true.

Parameters:
{boolean}bColumnHeaderVisible New value for property columnHeaderVisible
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setEditable(bEditable): sap.ui.table.Table
Sets a new value for property editable.

Flag whether the controls of the Table are editable or not (currently this only controls the background color in certain themes!)

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

Default value is true.

Parameters:
{boolean}bEditable New value for property editable
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setEnableBusyIndicator(bEnableBusyIndicator): sap.ui.table.Table
Sets a new value for property enableBusyIndicator.

Set this parameter to true to make the table handle the busy indicator by its own. The table will switch to busy as soon as it scrolls into an unpaged area. This feature can only be used when the navigation mode is set to scrolling.

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

Default value is false.

Parameters:
{boolean}bEnableBusyIndicator New value for property enableBusyIndicator
Since:
1.27.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setEnableCellFilter(bEnableCellFilter): sap.ui.table.Table
Sets a new value for property enableCellFilter.

Flag whether to enable or disable the context menu on cells to trigger a filtering with the cell value.

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

Default value is false.

Parameters:
{boolean}bEnableCellFilter New value for property enableCellFilter
Since:
1.21.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setEnableColumnFreeze(bEnableColumnFreeze): sap.ui.table.Table
Sets a new value for property enableColumnFreeze.

Flag whether to show or hide the column menu item to freeze or unfreeze a column.

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

Default value is false.

Parameters:
{boolean}bEnableColumnFreeze New value for property enableColumnFreeze
Since:
1.21.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setEnableColumnReordering(bEnableColumnReordering): sap.ui.table.Table
Sets a new value for property enableColumnReordering.

Flag to enable or disable column reordering

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

Default value is true.

Parameters:
{boolean}bEnableColumnReordering New value for property enableColumnReordering
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setEnableCustomFilter(bEnableCustomFilter): sap.ui.table.Table
Sets a new value for property enableCustomFilter.

Set this parameter to true to implement your own filter behaviour. Instead of the filter input box a button will be rendered for which' press event (customFilter) you can register an event handler.

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

Default value is false.

Parameters:
{boolean}bEnableCustomFilter New value for property enableCustomFilter
Since:
1.23.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setEnableSelectAll(bEnableSelectAll): sap.ui.table.Table
Sets a new value for property enableSelectAll.

Specifies if a select all button should be displayed in the top left corner. This button is only displayed if the row selector is visible and the selection mode is set to any kind of multi selection.

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

Default value is true.

Parameters:
{boolean}bEnableSelectAll New value for property enableSelectAll
Since:
1.23.0
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setFirstVisibleRow(iFirstVisibleRow): sap.ui.table.Table
Sets a new value for property firstVisibleRow.

First visible row.

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

Default value is 0.

Parameters:
{int}iFirstVisibleRow New value for property firstVisibleRow
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setFixedBottomRowCount(iFixedBottomRowCount): sap.ui.table.Table
Sets a new value for property fixedBottomRowCount.

Number of rows that are fix on the bottom. When you use a vertical scroll bar, only the rows which are not fixed, will scroll.

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

Default value is 0.

Parameters:
{int}iFixedBottomRowCount New value for property fixedBottomRowCount
Since:
1.18.7
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setFixedColumnCount(iFixedColumnCount): sap.ui.table.Table
Sets a new value for property fixedColumnCount.

Number of columns that are fix on the left. When you use a horizontal scroll bar, only the columns which are not fixed, will scroll. Fixed columns need a defined width for the feature to work. Please note that the aggregated width of all fixed columns must not exceed the table width since there will be no scrollbar for fixed columns.

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

Default value is 0.

Parameters:
{int}iFixedColumnCount New value for property fixedColumnCount
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setFixedRowCount(iFixedRowCount): sap.ui.table.Table
Sets a new value for property fixedRowCount.

Number of rows that are fix on the top. When you use a vertical scroll bar, only the rows which are not fixed, will scroll.

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

Default value is 0.

Parameters:
{int}iFixedRowCount New value for property fixedRowCount
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setFooter(vFooter): sap.ui.table.Table
Sets the aggregated footer.
Parameters:
{sap.ui.core.Control|string}vFooter The footer to set
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setGroupBy(oGroupBy): sap.ui.table.Table
Sets the associated groupBy.
Parameters:
{sap.ui.table.Column}oGroupBy Id of an element which becomes the new target of this groupBy association; alternatively, an element instance may be given
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setMinAutoRowCount(iMinAutoRowCount): sap.ui.table.Table
Sets a new value for property minAutoRowCount.

This property is used to set the minimum count of visible rows when the property visibleRowCountMode is set to Auto or Interactive. For any other visibleRowCountMode, it is ignored.

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

Default value is 5.

Parameters:
{int}iMinAutoRowCount New value for property minAutoRowCount
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setNoData(vNoData): sap.ui.table.Table
Sets the aggregated noData.
Parameters:
{sap.ui.core.Control|string}vNoData The noData to set
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setRowHeight(iRowHeight): sap.ui.table.Table
Sets a new value for property rowHeight.

Height of a row of the Table in pixel.

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

Parameters:
{int}iRowHeight New value for property rowHeight
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setSelectedIndex(iSelectedIndex): sap.ui.table.Table
Sets a new value for property selectedIndex.

Zero-based index of selected item. Index value for no selection is -1. When multi-selection is enabled and multiple items are selected, the method returns the lead selected item. Sets the zero-based index of the currently selected item. This method removes any previous selections. When the given index is invalid, the call is ignored.

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

Default value is -1.

Parameters:
{int}iSelectedIndex New value for property selectedIndex
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setSelectionBehavior(sSelectionBehavior): sap.ui.table.Table
Sets a new value for property selectionBehavior.

Selection behavior of the Table. This property defines whether the row selector is displayed and whether the row, the row selector or both can be clicked to select a row.

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

Default value is RowSelector.

Parameters:
{sap.ui.table.SelectionBehavior}sSelectionBehavior New value for property selectionBehavior
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setSelectionInterval(iIndexFrom, iIndexTo): sap.ui.table.Table
Sets the given selection interval as selection. In case of single selection the "indexTo" value will be used for as selected index.
Parameters:
{int}iIndexFrom Index from which .
{int}iIndexTo Indices of the items that shall additionally be selected.
Returns:
{sap.ui.table.Table}
setSelectionMode(sSelectionMode)
Sets the selection mode. The current selection is lost.
Parameters:
{string}sSelectionMode the selection mode, see sap.ui.table.SelectionMode
setShowColumnVisibilityMenu(bShowColumnVisibilityMenu): sap.ui.table.Table
Sets a new value for property showColumnVisibilityMenu.

Flag to show or hide the column visibility menu. This menu will get displayed in each generated column header menu. It allows to show or hide columns

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

Default value is false.

Parameters:
{boolean}bShowColumnVisibilityMenu New value for property showColumnVisibilityMenu
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setShowNoData(bShowNoData): sap.ui.table.Table
Sets a new value for property showNoData.

Flag whether to show the no data overlay or not once the table is empty. If set to false the table will just show a grid of empty cells

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

Default value is true.

Parameters:
{boolean}bShowNoData New value for property showNoData
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setShowOverlay(bShowOverlay): sap.ui.table.Table
Sets a new value for property showOverlay.

Setting this property to true will show an overlay on top of the Table content and users cannot click anymore on the Table content.

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

Default value is false.

Parameters:
{boolean}bShowOverlay New value for property showOverlay
Since:
1.21.2
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setThreshold()
Sets the threshold value, which will be added to all data requests in case the Table is bound against an OData service.
setTitle(vTitle): sap.ui.table.Table
Sets the aggregated title.
Parameters:
{sap.ui.core.Control|string}vTitle The title to set
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setToolbar(oToolbar): sap.ui.table.Table
Sets the aggregated toolbar.
Parameters:
{sap.ui.core.Toolbar}oToolbar The toolbar to set
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setVisibleRowCount(iVisibleRowCount): sap.ui.table.Table
Sets a new value for property visibleRowCount.

Number of visible rows of the table.

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

Default value is 10.

Parameters:
{int}iVisibleRowCount New value for property visibleRowCount
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setVisibleRowCountMode(sVisibleRowCountMode): sap.ui.table.Table
Sets a new value for property visibleRowCountMode.

This defines how the table handles the visible rows in the table. The default behavior is, that a fixed row count is defined. If you change it to auto the visibleRowCount property is changed by the table automatically. It will then adjust its maximum row count to the space it is allowed to cover (limited by the surrounding container) and its minimum row count to the value of the property minAutoRowCount (default value : 5) In manual mode the user can change the visibleRowCount interactively.

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

Default value is Fixed.

Parameters:
{sap.ui.table.VisibleRowCountMode}sVisibleRowCountMode New value for property visibleRowCountMode
Since:
1.9.2
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
setWidth(sWidth): sap.ui.table.Table
Sets a new value for property width.

Width of the Table.

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

Default value is auto.

Parameters:
{sap.ui.core.CSSSize}sWidth New value for property width
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
sort(oColumn, oSortOrder, bAdd): sap.ui.table.Table
sorts the given column ascending or descending
Parameters:
{sap.ui.table.Column}oColumn column to be sorted
{sap.ui.table.SortOrder}oSortOrder sort order of the column (if undefined the default will be ascending)
{Boolean}bAdd Set to true to add the new sort criterion to the existing sort criteria
Returns:
{sap.ui.table.Table}
unbindColumns(): sap.ui.table.Table
Unbinds aggregation columns from model data.
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
unbindRows(): sap.ui.table.Table
Unbinds aggregation rows from model data.
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining
getNavigationMode(): sap.ui.table.NavigationMode
Gets current value of property navigationMode.

Determines whether a scrollbar or a paginator is used for navigation inside the table. If the paginator mode is used, it requires the sap.ui.commons library.

This renders a scrollbar as a navigation element. Data fetched from an OData service is still loaded page-wise no matter which visual representation is used for navigation inside the table.

Default value is Scrollbar.

Deprecated:
As of version 1.38, there is no replacement, since Scrollbar is the only supported option
Returns:
{sap.ui.table.NavigationMode} Value of property navigationMode
setNavigationMode(sNavigationMode): sap.ui.table.Table
Sets a new value for property navigationMode.

Determines whether a scrollbar or a paginator is used for navigation inside the table. If the paginator mode is used, it requires the sap.ui.commons library.

This renders a scrollbar as a navigation element. Data fetched from an OData service is still loaded page-wise no matter which visual representation is used for navigation inside the table.

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

Default value is Scrollbar.

Parameters:
{sap.ui.table.NavigationMode}sNavigationMode New value for property navigationMode
Deprecated:
As of version 1.38, there is no replacement, since Scrollbar is the only supported option
Returns:
{sap.ui.table.Table} Reference to this in order to allow method chaining