Class sap.ui.ux3.DataSetSimpleViewModule: sap/ui/ux3/DataSetSimpleView
DataSetSimpleView provides a simple view example for DataSet usage.
Deprecated API:Since version 1.38.
sClassName
and enriches it with the information contained in oClassInfo
. 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
- floating : boolean (default: true)
- name : string (default: Name of this View)
- icon : sap.ui.core.URI
- iconHovered : sap.ui.core.URI
- iconSelected : sap.ui.core.URI
- responsive : boolean (default: false)
- itemMinWidth : int (default: 0)
- initialItemCount : int (default: 0)
- reloadItemCount : int (default: 0)
- scrollArea : any
- height : sap.ui.core.CSSSize
- Aggregations
- template : sap.ui.core.Control
In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.
{string} | sId? | id for the new control, generated automatically if no id is given |
{object} | mSettings? | initial settings for the new control |
- Deprecated:
- Since version 1.38.
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.
{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 |
{function} | Created class / constructor function |
{sap.ui.base.Metadata} | Metadata object describing this class |
template
. {sap.ui.ux3.DataSetSimpleView} | Reference to this in order to allow method chaining |
{sap.ui.ux3.DataSetItem[]} | aItems |
floating
. When true the DatSet items are floating containers. When set to false The Items are rendered in a 1 column Layout.
Default value is true
.
{boolean} | Value of property floating |
height
. If the pagination feature is used without specifying a scroll area, a height for the dataset must be defined.
- Since:
- 1.13.0
{sap.ui.core.CSSSize} | Value of property height |
icon
. Icon source for this view
{sap.ui.core.URI} | Value of property icon |
iconHovered
. icon: hovered state
{sap.ui.core.URI} | Value of property iconHovered |
iconSelected
. icon: selected state
{sap.ui.core.URI} | Value of property iconSelected |
initialItemCount
. If this value is greater zero only this amount of items is loaded in the first place. New items are loaded automatically when the user scrolls down. The number of items which are reloaded can be defined with the property "reloadItemCount"
Default value is 0
.
- Since:
- 1.13.0
{int} | Value of property initialItemCount |
itemMinWidth
. When itemMinWidth>0 and the property floating is true the given minimum width in pixels is set to DatSet items. A minimum width must be given when the property responsive is set.
Default value is 0
.
- Since:
- 1.9.2
{int} | Value of property itemMinWidth |
name
. Name of the View
Default value is Name of this View
.
{string} | Value of property name |
reloadItemCount
. This number defines the item count which is reloaded on scroll if initialItemCount is enabled.
Default value is 0
.
- Since:
- 1.13.0
{int} | Value of property reloadItemCount |
responsive
. When true and the property floating is true the DatSet items are floating containers filling the whole space of a row.
Default value is false
.
- Since:
- 1.9.2
{boolean} | Value of property responsive |
scrollArea
. ID of the DOM Element or jQuery reference to the dom which holds the scrollbar for the dataset
- Since:
- 1.13.0
{any} | Value of property scrollArea |
template
. template
{sap.ui.core.Control} |
{event} | oEvent | SelectionChanged event |
{array} | aItems | Array of DataSetItems added to the parent DataSet |
oItem
is selected {sap.ui.ux3.DataSetItem} | oItem | DataSetItem instance |
floating
. When true the DatSet items are floating containers. When set to false The Items are rendered in a 1 column Layout.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
{boolean} | bFloating | New value for property floating |
{sap.ui.ux3.DataSetSimpleView} | Reference to this in order to allow method chaining |
height
. If the pagination feature is used without specifying a scroll area, a height for the dataset must be defined.
When called with a value of null
or undefined
, the default value of the property will be restored.
{sap.ui.core.CSSSize} | sHeight | New value for property height |
- Since:
- 1.13.0
{sap.ui.ux3.DataSetSimpleView} | Reference to this in order to allow method chaining |
icon
. Icon source for this view
When called with a value of null
or undefined
, the default value of the property will be restored.
{sap.ui.core.URI} | sIcon | New value for property icon |
{sap.ui.ux3.DataSetSimpleView} | Reference to this in order to allow method chaining |
iconHovered
. icon: hovered state
When called with a value of null
or undefined
, the default value of the property will be restored.
{sap.ui.core.URI} | sIconHovered | New value for property iconHovered |
{sap.ui.ux3.DataSetSimpleView} | Reference to this in order to allow method chaining |
iconSelected
. icon: selected state
When called with a value of null
or undefined
, the default value of the property will be restored.
{sap.ui.core.URI} | sIconSelected | New value for property iconSelected |
{sap.ui.ux3.DataSetSimpleView} | Reference to this in order to allow method chaining |
initialItemCount
. If this value is greater zero only this amount of items is loaded in the first place. New items are loaded automatically when the user scrolls down. The number of items which are reloaded can be defined with the property "reloadItemCount"
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 0
.
{int} | iInitialItemCount | New value for property initialItemCount |
- Since:
- 1.13.0
{sap.ui.ux3.DataSetSimpleView} | Reference to this in order to allow method chaining |
itemMinWidth
. When itemMinWidth>0 and the property floating is true the given minimum width in pixels is set to DatSet items. A minimum width must be given when the property responsive is set.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 0
.
{int} | iItemMinWidth | New value for property itemMinWidth |
- Since:
- 1.9.2
{sap.ui.ux3.DataSetSimpleView} | Reference to this in order to allow method chaining |
name
. Name of the View
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Name of this View
.
{string} | sName | New value for property name |
{sap.ui.ux3.DataSetSimpleView} | Reference to this in order to allow method chaining |
reloadItemCount
. This number defines the item count which is reloaded on scroll if initialItemCount is enabled.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 0
.
{int} | iReloadItemCount | New value for property reloadItemCount |
- Since:
- 1.13.0
{sap.ui.ux3.DataSetSimpleView} | Reference to this in order to allow method chaining |
responsive
. When true and the property floating is true the DatSet items are floating containers filling the whole space of a row.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
{boolean} | bResponsive | New value for property responsive |
- Since:
- 1.9.2
{sap.ui.ux3.DataSetSimpleView} | Reference to this in order to allow method chaining |
template
. {sap.ui.core.Control} | oTemplate | The template to set |
{sap.ui.ux3.DataSetSimpleView} | Reference to this in order to allow method chaining |
{sap.ui.ux3.DataSetItem[]} | aDiff | Array of DataSetItems added to the parent DataSet |