Table 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. sap.ui.core/Control Width of the Table. Row height in pixel. In the table's header, it defines the minimum height of the row, but it cannot be less than the default height based on the content density configuration. The actual height can increase based on the content. In the table's body, it defines the height of the row content. The actual row height is also influenced by other factors, such as the border width. If the <code>visibleRowCountMode</code> property is set to {@link sap.ui.table.VisibleRowCountMode Fixed} or {@link sap.ui.table.VisibleRowCountMode Interactive}, the value defines the minimum height, and the actual height can increase based on the content. If the mode is {@link sap.ui.table.VisibleRowCountMode Auto}, the value defines the actual height, and any content that doesn't fit is cut off. If no value is set (includes 0), a default height is applied based on the content density configuration. In any <code>visibleRowCountMode</code>, the actual height can increase based on the content. Header row height in pixel. If a value greater than 0 is set, it overrides the height defined in the <code>rowHeight</code> property for the rows in the table's header. The value defines the minimum height, but it cannot be less than the default height based on the content density configuration. The actual height can increase based on the content. Note: In a {@link sap.ui.table.Column#getMultiLabels MultiLabel} scenario, the height is applied to each individual row of the table's header. Flag whether the column header is visible or not. Number of visible rows of the table. First visible row. 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. When the selection mode is changed, the current selection is removed. Note: Since the group header visualization relies on the row selectors, the row selectors are always shown if the grouping functionality (depends on table type) is enabled, even if <code>sap.ui.table.SelectionMode.None</code> is set. Note: If a selection plugin is applied to the table, the selection mode is controlled by the plugin. 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. Note: Since the group header visualization relies on the row selectors, the row selectors are always shown if the grouping functionality (depends on table type) is enabled, even if <code>sap.ui.table.SelectionBehavior.RowOnly</code> is set. 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. Note: If the rows of the table are bound, the value of the property is reset to -1. If a selection plugin is applied to the table, the property is not bindable. replaced by {@link sap.ui.table.Table#getSelectedIndices} and {@link sap.ui.table.Table#setSelectedIndex} Flag whether the controls of the Table are editable or not (currently this only controls the background color in certain themes!) This property has been deprecated and must not be used anymore, since <code>Scrollbar</code> is the only supported option. The <code>threshold</code> defines how many additional (not yet visible records) shall be pre-fetched to enable smooth scrolling. The threshold is always added to the <code>visibleRowCount</code>. If the <code>visibleRowCount</code> is 10 and the <code>threshold</code> is 100, there will be 110 records fetched with the initial load. If the <code>threshold</code> is lower than the <code>visibleRowCount</code>, the <code>visibleRowCount</code> will be used as the <code>threshold</code>. If the value is 0 then the thresholding is disabled. Flag to enable or disable column reordering Enables or disables grouping. If grouping is enabled, the table is grouped by the column which is defined in the <code>groupBy</code> association. The following restrictions apply: <ul> <li>Only client models are supported (e.g. {@link sap.ui.model.json.JSONModel}). Grouping does not work with OData models.</li> <li>The table can only be grouped by one column at a time. Grouping by another column will remove the current grouping.</li> <li>For the grouping to work correctly, {@link sap.ui.table.Column#getSortProperty sortProperty} must be set for the grouped column.</li> <li>If grouping has been done, sorting and filtering is not possible. Any existing sorting and filtering rules do no longer apply. The UI is not updated accordingly (e.g. menu items, sort and filter icons).</li> <li>The column, by which the table is grouped, is not visible. It will become visible again only if the table is grouped by another column or grouping is disabled.</li> </ul> This feature has a limited functionality. 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 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 Defines how the table handles the visible rows in the table. In the <code>"Fixed"</code> mode, the table always has as many rows as defined in the <code>visibleRowCount</code> property. In the <code>"Auto"</code> mode, the <code>visibleRowCount</code> property is changed by the table automatically. It will then adjust its row count to the space it is allowed to cover (limited by the surrounding container), but it cannot have less than defined in the <code>minAutoRowCount</code> property. The <code>visibleRowCount</code> property cannot be set manually. <h3>Limitations</h3> <ul> <li>All rows need to have the same height.</li> <li>The table must be rendered without siblings in its parent DOM element. The only exception is if the parent element is a CSS flex container, and the table is a CSS flex item allowed to grow and shrink.</li> </ul> In the <code>"Interactive"</code> mode, the table has as many rows as defined in the <code>visibleRowCount</code> property after rendering. The user can change the <code>visibleRowCount</code> by dragging a resizer. 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. Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally. Note <ul> <li>Fixed columns need a defined width for the feature to work.</li> <li>The aggregated width of all fixed columns must not exceed the table width. Otherwise the table ignores the value of the property and adapts the behavior in an appropriate way to ensure that the user is still able to scroll horizontally.</li> </ul> Number of rows that are fix on the top. When you use a vertical scrollbar, only the rows which are not fixed, will scroll. Number of rows that are fix on the bottom. When you use a vertical scrollbar, only the rows which are not fixed, will scroll. Flag whether to show or hide the column menu item to freeze or unfreeze a column. Flag whether to enable or disable the context menu on cells to trigger a filtering with the cell value. Setting this property to true will show an overlay on top of the Table content and users cannot click anymore on the Table content. 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. 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. If set to <code>true</code>, the table changes its busy state, resulting in showing or hiding the busy indicator. The table will switch to busy as soon as data is retrieved to be displayed in the currently visible rows. This happens, for example, during scrolling, filtering, or sorting. As soon as the data has been retrieved, the table switches back to not busy. The busy state of the table can still be set manually by calling {@link sap.ui.core.Control#setBusy}. Number of row actions made visible which determines the width of the row action column. The values <code>0</code>, <code>1</code> and <code>2</code> are possible. Enables alternating table row colors. Alternate row coloring is not available for the tree mode. 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) Note: If a selection plugin is applied to the table, this event won't be fired. row index which has been clicked so that the selection has been changed (either selected or deselected) binding context of the row which has been clicked so that selection has been changed array of row indices which selection has been changed (either selected or deselected) indicator if "select all" function is used to select rows 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. fired when a column of the table has been selected reference to the selected column fired when a table column is resized. resized column. new width of the table column as CSS Size definition. fired when a table column is moved. moved column. new position of the column. fired when the table is sorted. sorted column. Sort Order If column was added to sorter this is true. If new sort is started this is set to false fired when the table is filtered. filtered column. filter value. fired when the table is grouped (experimental!). grouped column. fired when the visibility of a table column is changed. affected column. new value of the visible property. fired when the user clicks a cell of the table (experimental!). The control of the cell. DOM reference of the clicked cell. Can be used to position the context menu. Row index of the selected cell. Column index of the selected cell. This is the index of visible columns and might differ from the index maintained in the column aggregation. Column ID of the selected cell. Row binding context of the selected cell. fired when the user clicks a cell of the table. replaced by <code>beforeOpenContextMenu</code>. The control of the cell. DOM reference of the clicked cell. Can be used to position the context menu. Row index of the selected cell. Column index of the selected cell. This is the index of visible columns and might differ from the index maintained in the column aggregation. Column ID of the selected cell. Row binding context of the selected cell. Fired when the user requests the context menu for a table cell. Row index where the context menu opens. Column index where the context menu opens. This is the index of the column in the <code>columns</code> aggregation. Context menu fired when a column of the table should be freezed reference to the column to freeze 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. 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. This event gets fired when the busy state of the table changes. It should only be used by composite controls. This event gets fired when the user pastes content from the clipboard to the table. Pasting can be done via the context menu or the standard paste keyboard shortcut, if the focus is inside the table. 2D array of strings with data from the clipboard. The first dimension represents the rows, and the second dimension represents the cells of the tabular data. Control or text of title section of the Table (if not set it will be hidden) Use the <code>extension</code> aggregation instead. Control or text of footer section of the Table (if not set it will be hidden) Toolbar of the Table If not set, no toolbar area will be rendered. Note: The CSS class sapMTBHeader-CTX is applied on the given toolbar. This aggregation is deprecated, use the <code>extension</code> aggregation instead. Extension section of the Table. If not set, no extension area will be rendered. Note: In case a <code>sap.m.Toolbar</code> is used as header the CSS class sapMTBHeader-CTX should be applied on this toolbar. Columns of the Table This aggregation is managed by the table itself. It can only be used with data binding, is read-only, and does not support templates or factories. Rows are created and rendered only for a subset of the available data and reused for performance reasons. When scrolling, only the binding contexts are updated to show the correct section of the data. This makes it possible to bind the rows to large data sets. But you must not change rows and their children programmatically, as these changes might get lost when the table updates the rows the next time. Also, properties must not be set to static values, as these would not change when scrolling. The cells of rows can be defined with the {@link sap.ui.table.Column#setTemplate template} aggregation of the columns in the {@link sap.ui.table.Table#setColumns columns} aggregation of the table. The actions of rows can be defined with the {@link sap.ui.table.Table#setRowActionTemplate rowActionTemplate} aggregation of the table. Furthermore, row-specific settings can be defined with the {@link sap.ui.table.Table#setRowSettingsTemplate rowSettingsTemplate} aggregation of the table. Row mode This row can be used for user input to create new data. Like in any other row, the cells of this row are also managed by the table and must not be modified. The cell content is defined via the <code>creationTemplate</code> aggregation of the {@link sap.ui.table.Column}. If the creation row is set, the busy indicator will no longer cover the horizontal scrollbar, even if the creation row is invisible. 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. Template for row actions. A template is decoupled from the row or table. Each time the template's properties or aggregations are changed, the template has to be applied again via <code>setRowActionTemplate</code> for the changes to take effect. Template for row settings. A template is decoupled from the row or table. Each time the template's properties or aggregations are changed, the template has to be applied again via <code>setRowSettingsTemplate</code> for the changes to take effect. Defines the context menu for the table. Note: The context menu will also be available for the row selectors as well as in the row actions cell of the table control. The custom context menu will not be shown in the group header rows and the sum row of the <code>AnalyticalTable</code> control. If this aggregation is set, then the <code>enableCellFilter</code> property will have no effect. Plugin section of the table. Multiple plugins are possible, but always only one of a certain type. The following restrictions apply: <ul> <li>If a selection plugin is applied to the table, the table's selection API must not be used. Instead, use the API of the plugin.</li> <li>Only one MultiSelectionPlugin can be applied. No other plugins can be applied.</li> </ul> Defines the message strip to display binding-related messages. The column by which the table is grouped. Grouping will only be performed if <code>enableGrouping</code> is set to <code>true</code>. Setting <code>groupBy</code> in the view does not work and throws an error. It can only be set if the column by which the table is grouped is already part of the <code>columns</code> aggregation of the table. This feature has a limited functionality. Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby). Gets the sorted columns in the order in which sorting was performed through the {@link sap.ui.table.Table#sort} method and menus. Does not reflect sorting at binding level or the columns sort visualization set with {@link sap.ui.table.Column#setSorted} and {@link sap.ui.table.Column#setSortOrder}. Sorts the given column ascending or descending. Column to be sorted or undefined to clear sorting Sort order of the column (if undefined the default will be ascending) Set to true to add the new sort criterion to the existing sort criteria Filter the given column by the given value. Column to be filtered Filter value as string (will be converted) 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. Index of the row to return the context from. Removes complete selection. Adds 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. Zero-based indices of selected items, wrapped in an array. An empty array means "no selection". Adds the given selection interval to the selection. In case of a single selection, only <code>iIndexTo</code> is added to the selection. Index from which the selection starts Index up to which to select Sets the given selection interval as selection. In case of a single selection, only <code>iIndexTo</code> is selected. Index from which the selection starts Index up to which to select Removes the given selection interval from the selection. In case of single selection, only <code>iIndexTo</code> is removed from the selection. Index from which the deselection should start Index up to which to deselect Checks whether an index is selected. Index to check for selection