Table which handles analytical OData backends. The AnalyticalTable only works with an AnalyticalBinding and correctly annotated OData services. Please check on the SAP Annotations for OData Version 2.0 documentation for further details.
Documentation links:
Constructor for a new AnalyticalTable.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.ui.table.AnalyticalTable(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | id for the new control, generated automatically if no id is given |
|
mSettings? | object | initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
autoExpandMode | string | Bundled | The kind of auto expansion algorithm, e.g. optimized filter conditions, per level requests, ... Must be a value of The value of the property is only taken into account if no parameter is given in the binding information. Changes to this property after the table is bound do not have any effect unless an explicit (re-)bind of the Example: oTable.bindRows({ path: "...", parameters: { autoExpandMode: "Bundled" } });Visibility: public |
collapseRecursive | boolean | true | Setting collapseRecursive to true means, that when collapsing a node all subsequent child nodes will also be collapsed. Calling the setter of this property only has an effect when the tables Example: oTable.bindRows({ path: "...", parameters: { collapseRecursive: true } });Visibility: public |
columnVisibilityMenuSorter | any | Functions which is used to sort the column visibility menu entries e.g.: function(ColumnA, ColumnB) { return 0 = equals, <0 lower, >0 greater }; Other values than functions will be ignored. Visibility: public |
|
dirty | boolean | If dirty the content of the Table will be overlayed. Visibility: public |
|
numberOfExpandedLevels | int | 0 | Number of levels, which should be opened initially (on first load of data). The value of the property is only taken into account if no parameter is given in the binding information. Changes to this property after the table is bound do not have any effect unless an explicit (re-)bind of the Example: oTable.bindRows({ path: "...", parameters: { numberOfExpandedLevels: 1 } });Visibility: public |
sumOnTop | boolean | false | Specifies if the total values should be displayed in the group headers or on bottom of the row. Does not affect the total sum. The value of the property is only taken into account if no parameter is given in the binding information. Changes to this property after the table is bound do not have any effect unless an explicit (re-)bind of the Example: oTable.bindRows({ path: "...", parameters: { sumOnTop: true } });Visibility: public |
Name | Type | Default Value | Description |
---|---|---|---|
alternateRowColors | boolean | false | Enables alternating table row colors. Alternate row coloring is not available for the tree mode. |
columnHeaderHeight | int | Header row height in pixel. If a value greater than 0 is set, it overrides the height defined in the Note: In a MultiLabel scenario, the height is applied to each individual row of the table's header. Visibility: public |
|
columnHeaderVisible | boolean | true | Flag whether the column header is visible or not. Caution: Please be aware that when setting this property to |
editable | boolean | true | Flag whether the controls of the Table are editable or not (currently this only controls the background color in certain themes!) Visibility: public |
enableBusyIndicator | boolean | false | If set to |
enableCellFilter | boolean | false | Flag whether to enable or disable the context menu on cells to trigger a filtering with the cell value. |
enableColumnFreeze | boolean | false | Flag whether to show or hide the column menu item to freeze or unfreeze a column. |
enableColumnReordering | boolean | true | Flag to enable or disable column reordering Visibility: public |
enableCustomFilter | boolean | false | 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. |
enableGrouping | boolean | false | Enables or disables grouping. If grouping is enabled, the table is grouped by the column which is defined in the The following restrictions apply:
|
enableSelectAll | boolean | true | 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. |
firstVisibleRow | int | 0 | First visible row. Visibility: public |
fixedBottomRowCount | int | 0 | Number of rows that are fix on the bottom. When you use a vertical scrollbar, only the rows which are not fixed, will scroll. This property is only supported if the |
fixedColumnCount | int | 0 | Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally. Note
|
fixedRowCount | int | 0 | Number of rows that are fix on the top. When you use a vertical scrollbar, only the rows which are not fixed, will scroll. This property is only supported if the |
minAutoRowCount | int | 5 | 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. Visibility: public |
navigationMode | sap.ui.table.NavigationMode | Scrollbar | This property has been deprecated and must not be used anymore, since |
rowActionCount | int | 0 | Number of row actions made visible which determines the width of the row action column. The values |
rowHeight | int | 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 If no value is set (includes 0), a default height is applied based on the content density configuration. In any |
|
selectedIndex | int | -1 | 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. Visibility: public |
selectionBehavior | sap.ui.table.SelectionBehavior | RowSelector | 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 |
selectionMode | sap.ui.table.SelectionMode | MultiToggle | 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 |
showColumnVisibilityMenu | boolean | false | 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 Visibility: public |
showNoData | boolean | true | 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 Visibility: public |
showOverlay | boolean | false | Setting this property to true will show an overlay on top of the Table content and users cannot click anymore on the Table content. |
threshold | int | 100 | The |
visibleRowCount | int | 10 | Number of visible rows of the table. Visibility: public |
visibleRowCountMode | sap.ui.table.VisibleRowCountMode | Fixed | Defines how the table handles the visible rows in the table. In the In the Restrictions
In the |
width | sap.ui.core.CSSSize | auto | Width of the Table. Visibility: public |
Name | Cardinality | Type | Description |
---|---|---|---|
columns | 0..n | sap.ui.table.Column |
Columns of the Table |
contextMenu | 0..1 | sap.ui.core.IContextMenu |
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 group header and summary rows. If this aggregation is set, then the |
extension | 0..n | sap.ui.core.Control |
Extension section of the Table. If not set, no extension area will be rendered. Note: In case a |
footer | 0..1 | sap.ui.core.Control |
Control or text of footer section of the Table (if not set it will be hidden) |
noData | 0..1 | sap.ui.core.Control |
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. |
plugins | 0..n | sap.ui.table.plugins.SelectionPlugin |
Plugin section of the table. Multiple plugins are possible, but always only one of a certain type. The following restrictions apply:
Since: 1.64. |
rowActionTemplate | 0..1 | sap.ui.table.RowAction |
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 |
rowSettingsTemplate | 0..1 | sap.ui.table.RowSettings |
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 |
rows | 0..n | sap.ui.table.Row |
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 template aggregation of the columns in the columns aggregation of the table. The actions of rows can be defined with the rowActionTemplate aggregation of the table. Furthermore, row-specific settings can be defined with the rowSettingsTemplate aggregation of the table. |
title | 0..1 | sap.ui.core.Control |
Control or text of title section of the Table (if not set it will be hidden) |
toolbar | 0..1 | sap.ui.core.Toolbar |
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. |
Method | Description |
---|---|
addSelectionInterval |
Marks a range of tree nodes as selected, starting with iFromIndex going to iToIndex. The nodes are referenced via their absolute row index. Please be aware that the absolute row index only applies to the tree which is visualized by the Please also take notice of the fact, that "addSelectionInterval" does not change any other selection. To override the current selection, please use "setSelctionInterval" or for a single entry use "setSelectedIndex". |
collapse |
Collapses one or more rows. |
collapseAll |
Collapses all nodes (and their child nodes if collapseRecursive is activated). |
expand |
Expands one or more rows. |
expandAll |
Expands all nodes. The current selection is removed, and the table scrolls back to the top. If this method is called, not all groups might be loaded. If the user then scrolls to the bottom of the table, additional groups are loaded, which increases the scroll range, and the scroll thumb moves up. |
sap.ui.table.AnalyticalTable.extend |
Creates a new subclass of class sap.ui.table.AnalyticalTable with name
|
getAnalyticalInfoOfRow |
Returns the current analytical information of the given row or The returned object provides the following information:
|
getAutoExpandMode |
Gets current value of property autoExpandMode. The kind of auto expansion algorithm, e.g. optimized filter conditions, per level requests, ... Must be a value of The value of the property is only taken into account if no parameter is given in the binding information. Changes to this property after the table is bound do not have any effect unless an explicit (re-)bind of the Example: oTable.bindRows({ path: "...", parameters: { autoExpandMode: "Bundled" } }); Default value is
Since 1.44 replaced by the <code>autoExpandMode</code> binding parameter
|
getCollapseRecursive |
Gets current value of property collapseRecursive. Setting collapseRecursive to true means, that when collapsing a node all subsequent child nodes will also be collapsed. Calling the setter of this property only has an effect when the tables Example: oTable.bindRows({ path: "...", parameters: { collapseRecursive: true } }); Default value is
Since 1.76 replaced by the <code>collapseRecursive</code> binding parameter
|
getColumnVisibilityMenuSorter |
Gets current value of property columnVisibilityMenuSorter. Functions which is used to sort the column visibility menu entries e.g.: function(ColumnA, ColumnB) { return 0 = equals, <0 lower, >0 greater }; Other values than functions will be ignored. |
getContextByIndex |
Returns the context of a row by its index. |
getDirty |
Gets current value of property dirty. If dirty the content of the Table will be overlayed.
Since 1.21.2 replaced by {@link sap.ui.table.Table#setShowOverlay}
|
getEnableGrouping |
The property |
getGroupBy |
The |
sap.ui.table.AnalyticalTable.getMetadata |
Returns a metadata object for class sap.ui.table.AnalyticalTable. |
getNumberOfExpandedLevels |
Gets current value of property numberOfExpandedLevels. Number of levels, which should be opened initially (on first load of data). The value of the property is only taken into account if no parameter is given in the binding information. Changes to this property after the table is bound do not have any effect unless an explicit (re-)bind of the Example: oTable.bindRows({ path: "...", parameters: { numberOfExpandedLevels: 1 } }); Default value is
Since 1.44 replaced by the <code>numberOfExpandedLevels</code> binding parameter
|
getSelectedIndex |
Retrieves the lead selection index. The lead selection index is, among other things, used to determine the start/end of a selection range, when using Shift-Click to select multiple entries at once. |
getSelectedIndices |
Returns an array containing the row indices of all selected tree nodes (in ascending order). Please be aware of the following: Due to performance/network traffic reasons, the getSelectedIndices function returns only all indices of actually selected rows/tree nodes. Unknown rows/nodes (as in "not yet loaded" to the client), will not be returned. |
getSumOnTop |
Gets current value of property sumOnTop. Specifies if the total values should be displayed in the group headers or on bottom of the row. Does not affect the total sum. The value of the property is only taken into account if no parameter is given in the binding information. Changes to this property after the table is bound do not have any effect unless an explicit (re-)bind of the Example: oTable.bindRows({ path: "...", parameters: { sumOnTop: true } }); Default value is
Since 1.44 replaced by the <code>sumOnTop</code> binding parameter
|
getTotalSize |
Returns the total size of the data entries. |
isExpanded |
Checks whether the row is expanded or collapsed. |
isIndexSelected |
Checks if the row at the given index is selected. |
removeSelectionInterval |
All rows/tree nodes inside the range (including boundaries) will be deselected. The nodes are referenced with their absolute row index. Please be aware that the absolute row index only applies to the tree which is visualized by the |
resumeUpdateAnalyticalInfo |
This function is used by some composite controls to force updating the AnalyticalInfo |
selectAll |
Selects all available nodes/rows. Explanation of the SelectAll function and what to expect from its behavior: All rows/nodes stored locally on the client are selected. In addition all subsequent rows/tree nodes, which will be paged into view are also immediately selected. However, due to obvious performance/network traffic reasons, the SelectAll function will NOT retrieve any data from the backend. |
setAutoExpandMode |
Sets a new value for property autoExpandMode. The kind of auto expansion algorithm, e.g. optimized filter conditions, per level requests, ... Must be a value of The value of the property is only taken into account if no parameter is given in the binding information. Changes to this property after the table is bound do not have any effect unless an explicit (re-)bind of the Example: oTable.bindRows({ path: "...", parameters: { autoExpandMode: "Bundled" } }); When called with a value of Default value is
Since 1.44 replaced by the <code>autoExpandMode</code> binding parameter
|
setCollapseRecursive |
Sets a new value for property collapseRecursive. Setting collapseRecursive to true means, that when collapsing a node all subsequent child nodes will also be collapsed. Calling the setter of this property only has an effect when the tables Example: oTable.bindRows({ path: "...", parameters: { collapseRecursive: true } }); When called with a value of Default value is
Since 1.76 replaced by the <code>collapseRecursive</code> binding parameter
|
setColumnVisibilityMenuSorter |
Sets a new value for property columnVisibilityMenuSorter. Functions which is used to sort the column visibility menu entries e.g.: function(ColumnA, ColumnB) { return 0 = equals, <0 lower, >0 greater }; Other values than functions will be ignored. When called with a value of |
setDirty |
Sets a new value for property dirty. If dirty the content of the Table will be overlayed. When called with a value of
Since 1.21.2 replaced by {@link sap.ui.table.Table#setShowOverlay}
|
setEnableGrouping |
The property |
setGroupBy |
The |
setNumberOfExpandedLevels |
Sets a new value for property numberOfExpandedLevels. Number of levels, which should be opened initially (on first load of data). The value of the property is only taken into account if no parameter is given in the binding information. Changes to this property after the table is bound do not have any effect unless an explicit (re-)bind of the Example: oTable.bindRows({ path: "...", parameters: { numberOfExpandedLevels: 1 } }); When called with a value of Default value is
Since 1.44 replaced by the <code>numberOfExpandedLevels</code> binding parameter
|
setSelectedIndex |
In an |
setSelectionInterval |
Sets the selection of the Note: The previous selection will be lost/overridden. If this is not the required behavior, please use |
setSumOnTop |
Sets a new value for property sumOnTop. Specifies if the total values should be displayed in the group headers or on bottom of the row. Does not affect the total sum. The value of the property is only taken into account if no parameter is given in the binding information. Changes to this property after the table is bound do not have any effect unless an explicit (re-)bind of the Example: oTable.bindRows({ path: "...", parameters: { sumOnTop: true } }); When called with a value of Default value is
Since 1.44 replaced by the <code>sumOnTop</code> binding parameter
|
suspendUpdateAnalyticalInfo |
This function is used by some composite controls to avoid updating the AnalyticalInfo when several column are added to the table. In order to finally update the AnalyticalInfo and request data, resumeUpdateAnalyticalInfo must be called. |
Marks a range of tree nodes as selected, starting with iFromIndex going to iToIndex. The nodes are referenced via their absolute row index. Please be aware that the absolute row index only applies to the tree which is visualized by the AnalyticalTable
control. Invisible nodes (collapsed child nodes) will not be taken into account.
Please also take notice of the fact, that "addSelectionInterval" does not change any other selection. To override the current selection, please use "setSelctionInterval" or for a single entry use "setSelectedIndex".
Param | Type | DefaultValue | Description |
---|---|---|---|
iFromIndex | int |
The starting index of the range which will be selected. |
|
iToIndex | int |
The starting index of the range which will be selected. |
Collapses one or more rows.
Param | Type | DefaultValue | Description |
---|---|---|---|
vRowIndex | int int[] |
A single index, or an array of indices of the rows to be collapsed |
Expands one or more rows.
Param | Type | DefaultValue | Description |
---|---|---|---|
vRowIndex | int int[] |
A single index or an array of indices of the rows to be expanded |
Expands all nodes. The current selection is removed, and the table scrolls back to the top. If this method is called, not all groups might be loaded. If the user then scrolls to the bottom of the table, additional groups are loaded, which increases the scroll range, and the scroll thumb moves up.
Creates a new subclass of class sap.ui.table.AnalyticalTable with name sClassName
and enriches it with the information contained in oClassInfo
.
oClassInfo
might contain the same kind of information as described in sap.ui.table.Table.extend.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Returns the current analytical information of the given row or null
if no information is available (for example, if the table is not bound or the given row has no binding context).
The returned object provides the following information:
grandTotal
of type boolean
Indicates whether the row is the grand total rowgroup
of type boolean
Indicates whether the row is a group headergroupTotal
of type boolean
Indicates whether the row is a totals row of a grouplevel
of type integer
Level information (-1
if no level information is available)context
of type sap.ui.model.Context
The binding context of the rowgroupedColumns
of type string[]
IDs of the grouped columns (only available for group
and groupTotal
)Param | Type | DefaultValue | Description |
---|---|---|---|
oRow | sap.ui.table.Row |
The row for which the analytical information is returned |
Gets current value of property autoExpandMode.
The kind of auto expansion algorithm, e.g. optimized filter conditions, per level requests, ... Must be a value of sap.ui.table.TreeAutoExpandMode
.
The value of the property is only taken into account if no parameter is given in the binding information. Changes to this property after the table is bound do not have any effect unless an explicit (re-)bind of the rows
aggregation is done.
Example:
oTable.bindRows({ path: "...", parameters: { autoExpandMode: "Bundled" } });
Default value is "Bundled"
.
Gets current value of property collapseRecursive.
Setting collapseRecursive to true means, that when collapsing a node all subsequent child nodes will also be collapsed.
Calling the setter of this property only has an effect when the tables rows
aggregation is already bound and the binding supports this feature.
Example:
oTable.bindRows({ path: "...", parameters: { collapseRecursive: true } });
Default value is true
.
Gets current value of property columnVisibilityMenuSorter.
Functions which is used to sort the column visibility menu entries e.g.: function(ColumnA, ColumnB) { return 0 = equals, <0 lower, >0 greater }; Other values than functions will be ignored.
Returns the context of a row by its index.
Param | Type | DefaultValue | Description |
---|---|---|---|
iIndex | int |
Index of the row to return the context from. |
Gets current value of property dirty.
If dirty the content of the Table will be overlayed.
Returns a metadata object for class sap.ui.table.AnalyticalTable.
Gets current value of property numberOfExpandedLevels.
Number of levels, which should be opened initially (on first load of data).
The value of the property is only taken into account if no parameter is given in the binding information. Changes to this property after the table is bound do not have any effect unless an explicit (re-)bind of the rows
aggregation is done.
Example:
oTable.bindRows({ path: "...", parameters: { numberOfExpandedLevels: 1 } });
Default value is 0
.
Retrieves the lead selection index.
The lead selection index is, among other things, used to determine the start/end of a selection range, when using Shift-Click to select multiple entries at once.
Returns an array containing the row indices of all selected tree nodes (in ascending order).
Please be aware of the following: Due to performance/network traffic reasons, the getSelectedIndices function returns only all indices of actually selected rows/tree nodes. Unknown rows/nodes (as in "not yet loaded" to the client), will not be returned.
Gets current value of property sumOnTop.
Specifies if the total values should be displayed in the group headers or on bottom of the row. Does not affect the total sum.
The value of the property is only taken into account if no parameter is given in the binding information. Changes to this property after the table is bound do not have any effect unless an explicit (re-)bind of the rows
aggregation is done.
Example:
oTable.bindRows({ path: "...", parameters: { sumOnTop: true } });
Default value is false
.
Checks whether the row is expanded or collapsed.
Param | Type | DefaultValue | Description |
---|---|---|---|
iRowIndex | int |
The index of the row to be checked |
Checks if the row at the given index is selected.
Param | Type | DefaultValue | Description |
---|---|---|---|
iRowIndex | int |
The row index for which the selection state should be retrieved |
All rows/tree nodes inside the range (including boundaries) will be deselected. The nodes are referenced with their absolute row index. Please be aware that the absolute row index only applies to the tree which is visualized by the AnalyticalTable
control. Invisible nodes (collapsed child nodes) will not be taken into account.
Param | Type | DefaultValue | Description |
---|---|---|---|
iFromIndex | int |
The starting index of the range which will be deselected. |
|
iToIndex | int |
The starting index of the range which will be deselected. |
This function is used by some composite controls to force updating the AnalyticalInfo
Param | Type | DefaultValue | Description |
---|---|---|---|
bSuppressRefresh | boolean |
binding shall not refresh data |
|
bForceChange | boolean |
forces the binding to fire a change event |
Selects all available nodes/rows.
Explanation of the SelectAll function and what to expect from its behavior: All rows/nodes stored locally on the client are selected. In addition all subsequent rows/tree nodes, which will be paged into view are also immediately selected. However, due to obvious performance/network traffic reasons, the SelectAll function will NOT retrieve any data from the backend.
Sets a new value for property autoExpandMode.
The kind of auto expansion algorithm, e.g. optimized filter conditions, per level requests, ... Must be a value of sap.ui.table.TreeAutoExpandMode
.
The value of the property is only taken into account if no parameter is given in the binding information. Changes to this property after the table is bound do not have any effect unless an explicit (re-)bind of the rows
aggregation is done.
Example:
oTable.bindRows({ path: "...", parameters: { autoExpandMode: "Bundled" } });
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is "Bundled"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sAutoExpandMode | string | "Bundled" |
New value for property |
Sets a new value for property collapseRecursive.
Setting collapseRecursive to true means, that when collapsing a node all subsequent child nodes will also be collapsed.
Calling the setter of this property only has an effect when the tables rows
aggregation is already bound and the binding supports this feature.
Example:
oTable.bindRows({ path: "...", parameters: { collapseRecursive: true } });
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bCollapseRecursive | boolean | true |
New value for property |
Sets a new value for property columnVisibilityMenuSorter.
Functions which is used to sort the column visibility menu entries e.g.: function(ColumnA, ColumnB) { return 0 = equals, <0 lower, >0 greater }; Other values than functions will be ignored.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oColumnVisibilityMenuSorter | any |
New value for property |
Sets a new value for property dirty.
If dirty the content of the Table will be overlayed.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
bDirty | boolean |
New value for property |
The property enableGrouping
is not supported by the AnalyticalTable
control.
Param | Type | DefaultValue | Description |
---|---|---|---|
bValue | boolean |
The groupBy
association is not supported by the AnalyticalTable
control.
Param | Type | DefaultValue | Description |
---|---|---|---|
oGroupBy | sap.ui.core.ID sap.ui.table.Column |
Sets a new value for property numberOfExpandedLevels.
Number of levels, which should be opened initially (on first load of data).
The value of the property is only taken into account if no parameter is given in the binding information. Changes to this property after the table is bound do not have any effect unless an explicit (re-)bind of the rows
aggregation is done.
Example:
oTable.bindRows({ path: "...", parameters: { numberOfExpandedLevels: 1 } });
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 0
.
Param | Type | DefaultValue | Description |
---|---|---|---|
iNumberOfExpandedLevels | int | 0 |
New value for property |
In an AnalyticalTable
control you can only select indices, which correspond to the currently visualized tree. Invisible nodes (e.g. collapsed child nodes) cannot be selected via Index, because they do not correspond to an AnalyticalTable
row.
Param | Type | DefaultValue | Description |
---|---|---|---|
iRowIndex | int |
The row index which will be selected (in case it exists) |
Sets the selection of the AnalyticalTable
control to the given range (including boundaries).
Note: The previous selection will be lost/overridden. If this is not the required behavior, please use addSelectionInterval
and removeSelectionInterval
.
Param | Type | DefaultValue | Description |
---|---|---|---|
iFromIndex | int |
the start index of the selection range |
|
iToIndex | int |
the end index of the selection range |
Sets a new value for property sumOnTop.
Specifies if the total values should be displayed in the group headers or on bottom of the row. Does not affect the total sum.
The value of the property is only taken into account if no parameter is given in the binding information. Changes to this property after the table is bound do not have any effect unless an explicit (re-)bind of the rows
aggregation is done.
Example:
oTable.bindRows({ path: "...", parameters: { sumOnTop: true } });
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bSumOnTop | boolean | false |
New value for property |