SmartTable

extends VBox

The SmartTable control creates a table based on OData metadata and the configuration specified. The entitySet attribute must be specified to use the control. This attribute is used to fetch fields from OData metadata, from which columns will be generated; it can also be used to fetch the actual table data.
Based on the tableType property, this control will render a standard, analytical, or responsive table.
Note:
Most of the attributes/properties are not dynamic and cannot be changed once the control has been initialized.

A detailed description of the OData annotations handled by this control is available here.
Annotation Limitations: Qualifier support for entity types is limited for this control.

Constructor Summary

new sap.ui.comp.smarttable.SmartTable(sId?, mSettings?)Constructor for a new smarttable/SmartTable.

Event Summary

afterVariantApply(oControlEvent)Event fired after a variant has been applied.

afterVariantInitialise(oControlEvent)Event fired after variant management in the SmartTable has been initialized.

afterVariantSave(oControlEvent)Event fired after a variant has been saved.

beforeRebindTable(oControlEvent)Event fired just before the binding is being done.

dataReceived(oControlEvent)Event fired when data is received after binding.

editToggled(oControlEvent)Event fired when display/edit button is clicked.

fieldChange(oControlEvent)Event fired when an editable field, created internally by the SmartTable control, is changed.

initialise(oControlEvent)Event fired once the control has been initialized.

showOverlay(oControlEvent)Event fired just before the overlay is being shown.

Events borrowed from class sap.ui.core.Control

validateFieldGroup

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.ui.comp.smarttable.SmartTable.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.comp.smarttable.SmartTable with name sClassName and enriches it with the information contained in oClassInfo.

sap.ui.comp.smarttable.SmartTable.getMetadata()Returns a metadata object for class sap.ui.comp.smarttable.SmartTable.

applyVariant(oVariantJSON, sContext)Interface function for SmartVariantManagment control, sets the current variant

attachAfterVariantApply(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterVariantApply event of this sap.ui.comp.smarttable.SmartTable.

attachAfterVariantInitialise(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterVariantInitialise event of this sap.ui.comp.smarttable.SmartTable.

attachAfterVariantSave(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterVariantSave event of this sap.ui.comp.smarttable.SmartTable.

attachBeforeRebindTable(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the beforeRebindTable event of this sap.ui.comp.smarttable.SmartTable.

attachDataReceived(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the dataReceived event of this sap.ui.comp.smarttable.SmartTable.

attachEditToggled(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the editToggled event of this sap.ui.comp.smarttable.SmartTable.

attachFieldChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the fieldChange event of this sap.ui.comp.smarttable.SmartTable.

attachInitialise(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the initialise event of this sap.ui.comp.smarttable.SmartTable.

attachShowOverlay(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the showOverlay event of this sap.ui.comp.smarttable.SmartTable.

destroyCustomToolbar()Destroys the customToolbar in the aggregation customToolbar.

destroyNoData()Destroys the noData in the aggregation noData.

destroySemanticKeyAdditionalControl()Destroys the semanticKeyAdditionalControl in the aggregation semanticKeyAdditionalControl.

destroySemanticObjectController()Destroys the semanticObjectController in the aggregation semanticObjectController.

detachAfterVariantApply(fnFunction, oListener)Detaches event handler fnFunction from the afterVariantApply event of this sap.ui.comp.smarttable.SmartTable.

detachAfterVariantInitialise(fnFunction, oListener)Detaches event handler fnFunction from the afterVariantInitialise event of this sap.ui.comp.smarttable.SmartTable.

detachAfterVariantSave(fnFunction, oListener)Detaches event handler fnFunction from the afterVariantSave event of this sap.ui.comp.smarttable.SmartTable.

detachBeforeRebindTable(fnFunction, oListener)Detaches event handler fnFunction from the beforeRebindTable event of this sap.ui.comp.smarttable.SmartTable.

detachDataReceived(fnFunction, oListener)Detaches event handler fnFunction from the dataReceived event of this sap.ui.comp.smarttable.SmartTable.

detachEditToggled(fnFunction, oListener)Detaches event handler fnFunction from the editToggled event of this sap.ui.comp.smarttable.SmartTable.

detachFieldChange(fnFunction, oListener)Detaches event handler fnFunction from the fieldChange event of this sap.ui.comp.smarttable.SmartTable.

detachInitialise(fnFunction, oListener)Detaches event handler fnFunction from the initialise event of this sap.ui.comp.smarttable.SmartTable.

detachShowOverlay(fnFunction, oListener)Detaches event handler fnFunction from the showOverlay event of this sap.ui.comp.smarttable.SmartTable.

exit()Cleans up the control

fetchVariant()Interface function for SmartVariantManagment control, returns the current used variant data

fireAfterVariantApply(mArguments?)Fires event afterVariantApply to attached listeners.

fireAfterVariantInitialise(mArguments?)Fires event afterVariantInitialise to attached listeners.

fireAfterVariantSave(mArguments?)Fires event afterVariantSave to attached listeners.

fireBeforeRebindTable(mArguments?)Fires event beforeRebindTable to attached listeners.

fireDataReceived(mArguments?)Fires event dataReceived to attached listeners.

fireEditToggled(mArguments?)Fires event editToggled to attached listeners.

fireFieldChange(mArguments?)Fires event fieldChange to attached listeners.

fireInitialise(mArguments?)Fires event initialise to attached listeners.

fireShowOverlay(mArguments?)Fires event showOverlay to attached listeners.

getCurrentVariantId()returns the id of the currently selected variant.

getCustomToolbar()Gets content of aggregation customToolbar.

getDemandPopin()Gets current value of property demandPopin.

getEditable()Gets current value of property editable.

getEditTogglable()Gets current value of property editTogglable.

getEnableAutoBinding()Gets current value of property enableAutoBinding.

getEnableCustomFilter()Gets current value of property enableCustomFilter.

getEntitySet()Gets current value of property entitySet.

getHeader()Gets current value of property header.

getIgnoredFields()Gets current value of property ignoredFields.

getIgnoreFromPersonalisation()Gets current value of property ignoreFromPersonalisation.

getInitiallyVisibleFields()Gets current value of property initiallyVisibleFields.

getNoData()Gets content of aggregation noData.

getPersistencyKey()Gets current value of property persistencyKey.

getRequestAtLeastFields()Gets current value of property requestAtLeastFields.

getSemanticKeyAdditionalControl()Gets content of aggregation semanticKeyAdditionalControl.

getSemanticObjectController()Gets content of aggregation semanticObjectController.

getShowFullScreenButton()Gets current value of property showFullScreenButton.

getShowRowCount()Gets current value of property showRowCount.

getShowTablePersonalisation()Gets current value of property showTablePersonalisation.

getShowVariantManagement()Gets current value of property showVariantManagement.

getSmartFilterId()Gets current value of property smartFilterId.

getSmartVariant()ID of the element which is the current target of the association smartVariant, or null.

getTable()returns the internally used table object

getTableBindingPath()Gets current value of property tableBindingPath.

getTableType()Gets current value of property tableType.

getToolbarStyleClass()Gets current value of property toolbarStyleClass.

getUseExportToExcel()Gets current value of property useExportToExcel.

getUseTablePersonalisation()Gets current value of property useTablePersonalisation.

getUseVariantManagement()Gets current value of property useVariantManagement.

rebindTable(bForceRebind)This can be used to trigger binding on the table used in the SmartTable

setCurrentVariantId(sVariantId)Set the current variant according to the sVariantId.

setCustomToolbar(oCustomToolbar)Sets the aggregated customToolbar.

setDemandPopin(bDemandPopin)Sets a new value for property demandPopin.

setEditable(bEditable)Sets a new value for property editable.

setEditTogglable(bEditTogglable)Sets a new value for property editTogglable.

setEnableAutoBinding(bEnableAutoBinding)Sets a new value for property enableAutoBinding.

setEnableCustomFilter(bEnableCustomFilter)Sets a new value for property enableCustomFilter.

setEntitySet(sEntitySetName)The entity set name from OData metadata, with which the table should be bound to

setHeader(sHeader)Sets a new value for property header.

setIgnoredFields(sIgnoredFields)Sets a new value for property ignoredFields.

setIgnoreFromPersonalisation(sIgnoreFromPersonalisation)Sets a new value for property ignoreFromPersonalisation.

setInitiallyVisibleFields(sInitiallyVisibleFields)Sets a new value for property initiallyVisibleFields.

setNoData(vNoData)Sets the aggregated noData.

setPersistencyKey(sPersistencyKey)Sets a new value for property persistencyKey.

setRequestAtLeastFields(sRequestAtLeastFields)Sets a new value for property requestAtLeastFields.

setSemanticKeyAdditionalControl(oSemanticKeyAdditionalControl)Sets the aggregated semanticKeyAdditionalControl.

setSemanticObjectController(oSemanticObjectController)Sets the aggregated semanticObjectController.

setShowFullScreenButton(bShowFullScreenButton)Sets a new value for property showFullScreenButton.

setShowRowCount(bShowRowCount)Sets a new value for property showRowCount.

setShowTablePersonalisation(bShowTablePersonalisation)Sets a new value for property showTablePersonalisation.

setShowVariantManagement(bShowVariantManagement)Sets a new value for property showVariantManagement.

setSmartFilterId(sSmartFilterId)Sets a new value for property smartFilterId.

setSmartVariant(oSmartVariant)Sets the associated smartVariant.

setTableBindingPath(sTableBindingPath)Sets a new value for property tableBindingPath.

setTableType(sTableType)Sets a new value for property tableType.

setToolbarStyleClass(sToolbarStyleClass)Sets a new value for property toolbarStyleClass.

setUseExportToExcel(bUseExportToExcel)Sets a new value for property useExportToExcel.

setUseTablePersonalisation(bUseTablePersonalisation)Sets a new value for property useTablePersonalisation.

setUseVariantManagement(bUseVariantManagement)Sets a new value for property useVariantManagement.

updateTableHeaderState()This can be called once data is received to update table header (count) and toolbar buttons(e.g.

getUseOnlyOneSolidToolbar()Gets current value of property useOnlyOneSolidToolbar.

setUseOnlyOneSolidToolbar(bUseOnlyOneSolidToolbar)Sets a new value for property useOnlyOneSolidToolbar.

Methods borrowed from class sap.m.FlexBox

Methods borrowed from class sap.ui.core.Control

Methods borrowed from class sap.ui.core.Element

Methods borrowed from class sap.ui.base.ManagedObject

addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, hasListeners

OData Annotation Summary

SortRestrictions/NonSortableProperties(Org.OData.Capabilities.V1) on EntitySetDefines whether a column can be sorted.

FilterRestrictions/NonFilterableProperties(Org.OData.Capabilities.V1) on EntitySetDefines whether a column can be filtered.

Label(com.sap.vocabularies.Common.v1) on Property,PropertyPathA short, human-readable text suitable for the column header's text.

LineItem/Label(com.sap.vocabularies.UI.v1) on Property,ParameterA short, human-readable text suitable for the column header's text.

FieldControlType/Hidden(com.sap.vocabularies.Common.v1) on PropertyDefines whether the column is visible.

ISOCurrency(Org.OData.Measures.V1) on PropertyDefines a currency code for an amount according to the ISO 4217 standard.

Unit(Org.OData.Measures.V1) on PropertyThe unit of measure for a measured quantity, for example, cm for centimeters.

IsUpperCase(com.sap.vocabularies.Common.v1) on Property,ParameterDefines whether a string is capitalized.

LineItem(com.sap.vocabularies.UI.v1) on EntityTypeRenders the initial columns for the SmartTable control.

PresentationVariant(com.sap.vocabularies.UI.v1) on EntitySet,EntityTypeRenders the initial columns for the SmartTable control.

Importance(com.sap.vocabularies.UI.v1) on Record,AnnotationShows columns with priority high on phones, with priority medium or high on tablets, and with all priorities on the desktop.

LineItem/DataFieldWithUrl(com.sap.vocabularies.UI.v1) on RecordRenders the value as a URL, if a URL parameter path is present.

CriticalityType(com.sap.vocabularies.UI.v1) on PropertyPathRepresents the criticality state of the data that is present inside the column.

CriticalityRepresentationType/WithoutIcon(com.sap.vocabularies.UI.v1) on PropertyDetermines if criticality is visualized by means of an icon.

SemanticKey(com.sap.vocabularies.Common.v1) on EntityTypeDefines whether a property is a semantic key which is used for key columns (rendering sap.m.ObjectIdentifier).

IsImageUrl(com.sap.vocabularies.Common.v1) on PropertyRenders an image in the cell if the annotation is present.

Constructor Detail

new sap.ui.comp.smarttable.SmartTable(sId?, mSettings?)

Constructor for a new smarttable/SmartTable.

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
- entitySet : string
- smartFilterId : string
- ignoredFields : string
- initiallyVisibleFields : string
- requestAtLeastFields : string
- ignoreFromPersonalisation : string
- tableType : sap.ui.comp.smarttable.TableType
- useVariantManagement : boolean (default: true)
- showVariantManagement : boolean (default: true)
- useExportToExcel : boolean (default: true)
- useTablePersonalisation : boolean (default: true)
- showTablePersonalisation : boolean (default: true)
- showRowCount : boolean (default: true)
- header : string
- toolbarStyleClass : string
- enableCustomFilter : boolean (default: true)
- persistencyKey : string
- useOnlyOneSolidToolbar : boolean (default: false)
- currentVariantId : string
- editable : boolean (default: false)
- enableAutoBinding : boolean (default: false)
- tableBindingPath : string
- editTogglable : boolean (default: false)
- demandPopin : boolean (default: false)
- showFullScreenButton : boolean (default: false)
Aggregations
- customToolbar : sap.m.Toolbar
- semanticObjectController : sap.ui.comp.navpopover.SemanticObjectController
- noData : sap.ui.core.Control|string
- semanticKeyAdditionalControl : sap.ui.core.Control
Events
- initialise : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- beforeRebindTable : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- editToggled : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- dataReceived : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- afterVariantInitialise : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- afterVariantSave : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- afterVariantApply : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- showOverlay : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- fieldChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.m.VBox 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

afterVariantApply(oControlEvent)

Event fired after a variant has been applied.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

Since:: 1.28.0

afterVariantInitialise(oControlEvent)

Event fired after variant management in the SmartTable has been initialized.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

Since:: 1.28.0

afterVariantSave(oControlEvent)

Event fired after a variant has been saved. This event can be used to retrieve the ID of the saved variant.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

Since:: 1.28.0

beforeRebindTable(oControlEvent)

Event fired just before the binding is being done.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

Since:: 1.26.0

dataReceived(oControlEvent)

Event fired when data is received after binding. The event is fired if the binding for the table is done by the SmartTable itself.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

Since:: 1.28.0

editToggled(oControlEvent)

Event fired when display/edit button is clicked.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

Since:: 1.28.0

fieldChange(oControlEvent)

Event fired when an editable field, created internally by the SmartTable control, is changed.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

Since:: 1.34.0

initialise(oControlEvent)

Event fired once the control has been initialized.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

Since:: 1.26.0

showOverlay(oControlEvent)

Event fired just before the overlay is being shown.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

Since:: 1.32.0

Method Detail

sap.ui.comp.smarttable.SmartTable.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.comp.smarttable.SmartTable with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.VBox.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.comp.smarttable.SmartTable.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.ui.comp.smarttable.SmartTable.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

applyVariant(oVariantJSON, sContext)

Interface function for SmartVariantManagment control, sets the current variant

Parameters:

{Object}	oVariantJSON	the variants json
{string}	sContext	describes the context in which the apply was executed

attachAfterVariantApply(oData?, fnFunction, oListener?): sap.ui.comp.smarttable.SmartTable

Attaches event handler fnFunction to the afterVariantApply event of this sap.ui.comp.smarttable.SmartTable.

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.comp.smarttable.SmartTable itself.

Event fired after a variant has been applied.

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.comp.smarttable.SmartTable` itself

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

attachAfterVariantInitialise(oData?, fnFunction, oListener?): sap.ui.comp.smarttable.SmartTable

Attaches event handler fnFunction to the afterVariantInitialise event of this sap.ui.comp.smarttable.SmartTable.

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.comp.smarttable.SmartTable itself.

Event fired after variant management in the SmartTable has been initialized.

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.comp.smarttable.SmartTable` itself

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

attachAfterVariantSave(oData?, fnFunction, oListener?): sap.ui.comp.smarttable.SmartTable

Attaches event handler fnFunction to the afterVariantSave event of this sap.ui.comp.smarttable.SmartTable.

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.comp.smarttable.SmartTable itself.

Event fired after a variant has been saved. This event can be used to retrieve the ID of the saved variant.

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.comp.smarttable.SmartTable` itself

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

attachBeforeRebindTable(oData?, fnFunction, oListener?): sap.ui.comp.smarttable.SmartTable

Attaches event handler fnFunction to the beforeRebindTable event of this sap.ui.comp.smarttable.SmartTable.

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.comp.smarttable.SmartTable itself.

Event fired just before the binding is being done.

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.comp.smarttable.SmartTable` itself

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

attachDataReceived(oData?, fnFunction, oListener?): sap.ui.comp.smarttable.SmartTable

Attaches event handler fnFunction to the dataReceived event of this sap.ui.comp.smarttable.SmartTable.

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.comp.smarttable.SmartTable itself.

Event fired when data is received after binding. The event is fired if the binding for the table is done by the SmartTable itself.

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.comp.smarttable.SmartTable` itself

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

attachEditToggled(oData?, fnFunction, oListener?): sap.ui.comp.smarttable.SmartTable

Attaches event handler fnFunction to the editToggled event of this sap.ui.comp.smarttable.SmartTable.

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.comp.smarttable.SmartTable itself.

Event fired when display/edit button is clicked.

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.comp.smarttable.SmartTable` itself

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

attachFieldChange(oData?, fnFunction, oListener?): sap.ui.comp.smarttable.SmartTable

Attaches event handler fnFunction to the fieldChange event of this sap.ui.comp.smarttable.SmartTable.

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.comp.smarttable.SmartTable itself.

Event fired when an editable field, created internally by the SmartTable control, 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.comp.smarttable.SmartTable` itself

Since:: 1.34.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

attachInitialise(oData?, fnFunction, oListener?): sap.ui.comp.smarttable.SmartTable

Attaches event handler fnFunction to the initialise event of this sap.ui.comp.smarttable.SmartTable.

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.comp.smarttable.SmartTable itself.

Event fired once the control has been initialized.

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.comp.smarttable.SmartTable` itself

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

attachShowOverlay(oData?, fnFunction, oListener?): sap.ui.comp.smarttable.SmartTable

Attaches event handler fnFunction to the showOverlay event of this sap.ui.comp.smarttable.SmartTable.

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.comp.smarttable.SmartTable itself.

Event fired just before the overlay is being shown.

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.comp.smarttable.SmartTable` itself

Since:: 1.32.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

destroyCustomToolbar(): sap.ui.comp.smarttable.SmartTable

Destroys the customToolbar in the aggregation customToolbar.

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

destroyNoData(): sap.ui.comp.smarttable.SmartTable

Destroys the noData in the aggregation noData.

Since:: 1.32.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

destroySemanticKeyAdditionalControl(): sap.ui.comp.smarttable.SmartTable

Destroys the semanticKeyAdditionalControl in the aggregation semanticKeyAdditionalControl.

Since:: 1.38.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

destroySemanticObjectController(): sap.ui.comp.smarttable.SmartTable

Destroys the semanticObjectController in the aggregation semanticObjectController.

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

detachAfterVariantApply(fnFunction, oListener): sap.ui.comp.smarttable.SmartTable

Detaches event handler fnFunction from the afterVariantApply event of this sap.ui.comp.smarttable.SmartTable.

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.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

detachAfterVariantInitialise(fnFunction, oListener): sap.ui.comp.smarttable.SmartTable

Detaches event handler fnFunction from the afterVariantInitialise event of this sap.ui.comp.smarttable.SmartTable.

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.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

detachAfterVariantSave(fnFunction, oListener): sap.ui.comp.smarttable.SmartTable

Detaches event handler fnFunction from the afterVariantSave event of this sap.ui.comp.smarttable.SmartTable.

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.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

detachBeforeRebindTable(fnFunction, oListener): sap.ui.comp.smarttable.SmartTable

Detaches event handler fnFunction from the beforeRebindTable event of this sap.ui.comp.smarttable.SmartTable.

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.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

detachDataReceived(fnFunction, oListener): sap.ui.comp.smarttable.SmartTable

Detaches event handler fnFunction from the dataReceived event of this sap.ui.comp.smarttable.SmartTable.

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.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

detachEditToggled(fnFunction, oListener): sap.ui.comp.smarttable.SmartTable

Detaches event handler fnFunction from the editToggled event of this sap.ui.comp.smarttable.SmartTable.

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.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

detachFieldChange(fnFunction, oListener): sap.ui.comp.smarttable.SmartTable

Detaches event handler fnFunction from the fieldChange event of this sap.ui.comp.smarttable.SmartTable.

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.34.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

detachInitialise(fnFunction, oListener): sap.ui.comp.smarttable.SmartTable

Detaches event handler fnFunction from the initialise event of this sap.ui.comp.smarttable.SmartTable.

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.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

detachShowOverlay(fnFunction, oListener): sap.ui.comp.smarttable.SmartTable

Detaches event handler fnFunction from the showOverlay event of this sap.ui.comp.smarttable.SmartTable.

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.32.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

exit()

Cleans up the control

fetchVariant(): json

Interface function for SmartVariantManagment control, returns the current used variant data

Returns:

{json}

The currently set variant

fireAfterVariantApply(mArguments?): sap.ui.comp.smarttable.SmartTable

Fires event afterVariantApply to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

fireAfterVariantInitialise(mArguments?): sap.ui.comp.smarttable.SmartTable

Fires event afterVariantInitialise to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

fireAfterVariantSave(mArguments?): sap.ui.comp.smarttable.SmartTable

Fires event afterVariantSave to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

fireBeforeRebindTable(mArguments?): sap.ui.comp.smarttable.SmartTable

Fires event beforeRebindTable to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

fireDataReceived(mArguments?): sap.ui.comp.smarttable.SmartTable

Fires event dataReceived to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

fireEditToggled(mArguments?): sap.ui.comp.smarttable.SmartTable

Fires event editToggled to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

fireFieldChange(mArguments?): sap.ui.comp.smarttable.SmartTable

Fires event fieldChange to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Since:: 1.34.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

fireInitialise(mArguments?): sap.ui.comp.smarttable.SmartTable

Fires event initialise to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

fireShowOverlay(mArguments?): sap.ui.comp.smarttable.SmartTable

Fires event showOverlay to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Since:: 1.32.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

getCurrentVariantId(): string

returns the id of the currently selected variant.

Returns:

{string}

id of the currently selected variant

getCustomToolbar(): sap.m.Toolbar

Gets content of aggregation customToolbar.

A toolbar that can be added by the user to define their own custom buttons, icons, etc. If this is specified, the SmartTable control does not create an additional toolbar, but makes use of this one.

Since:: 1.26.0

Returns:

{sap.m.Toolbar}

getDemandPopin(): boolean

Gets current value of property demandPopin.

The demandPopin attribute can be set to true or false depending on whether you want to display columns as popins on the responsive table

Default value is false.

Since:: 1.30.0

Returns:

{boolean} Value of property demandPopin

getEditable(): boolean

Gets current value of property editable.

This attribute can be used to specify if the controls created by the SmartTable control are editable.

Default value is false.

Since:: 1.28.0

Returns:

{boolean} Value of property editable

getEditTogglable(): boolean

Gets current value of property editTogglable.

Specifies whether the editable property can be toggled via a button on the toolbar. (The automatic toggle of controls works only for the SmartField scenario)

Default value is false.

Since:: 1.28.0

Returns:

{boolean} Value of property editTogglable

getEnableAutoBinding(): boolean

Gets current value of property enableAutoBinding.

When set to true, this enables automatic binding of the table using the tableBindingPath (if it exists) or entitySet property. This happens just after the initialise event has been fired.

Default value is false.

Since:: 1.28.0

Returns:

{boolean} Value of property enableAutoBinding

getEnableCustomFilter(): boolean

Gets current value of property enableCustomFilter.

Can be used to override the filter behavior. If set to true (default), instead of the filter input box a button is rendered. When pressing this button, the SmartTable control opens the filter panel directly in the table personalization dialog.

Default value is true.

Since:: 1.26.0

Returns:

{boolean} Value of property enableCustomFilter

getEntitySet(): string

Gets current value of property entitySet.

The entity set name from which to fetch data and generate the columns. Note that this is not a dynamic UI5 property

Since:: 1.26.0

Returns:

{string} Value of property entitySet

getHeader(): string

Gets current value of property header.

Specifies header text that is shown in table

Since:: 1.26.0

Returns:

{string} Value of property header

getIgnoredFields(): string

Gets current value of property ignoredFields.

CSV of fields that must be ignored in the OData metadata by the SmartTable control.
Note:
No validation is done. Please ensure that you do not add spaces or special characters.

Since:: 1.26.0

Returns:

{string} Value of property ignoredFields

getIgnoreFromPersonalisation(): string

Gets current value of property ignoreFromPersonalisation.

CSV of fields that is not shown in the personalization dialog.
Note:
No validation is done. Please ensure that you do not add spaces or special characters.

Since:: 1.32.0

Returns:

{string} Value of property ignoreFromPersonalisation

getInitiallyVisibleFields(): string

Gets current value of property initiallyVisibleFields.

CSV of fields that must be shown initially in the SmartTable as visible columns and in the order specified.
This property is mainly meant to be used when no LineItem annotation exists.
If you have fields in the XMLView they are always shown first; then, the columns are added based on the LineItem annotation and finally based on this property.
Note:
If both this property and the LineItem annotation exist, the order of fields cannot be guaranteed to be as mentioned here.
No validation is done. Please ensure that you do not add spaces or special characters.

Since:: 1.32.0

Returns:

{string} Value of property initiallyVisibleFields

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.
Currently the Responsive Table only supports string values.

Since:: 1.32.0

Returns:

{sap.ui.core.Control|string}

getPersistencyKey(): string

Gets current value of property persistencyKey.

Key used to access personalization data.

Since:: 1.26.0

Returns:

{string} Value of property persistencyKey

getRequestAtLeastFields(): string

Gets current value of property requestAtLeastFields.

CSV of fields that must be always requested from the backend
This property is mainly meant to be used when there is no PresentationVariant annotation.
If both this property and the PresentationVariant annotation exist, the select request sent to the backend would be a combination of both.
Note:
This property has no effect when AnalyticalTable is used.
No validation is done. Please ensure that you do not add spaces or special characters.

Since:: 1.32.0

Returns:

{string} Value of property requestAtLeastFields

getSemanticKeyAdditionalControl(): sap.ui.core.Control

Gets content of aggregation semanticKeyAdditionalControl.

Allows users to specify an additional control that will be added to a VBox for the first semantic key field.
Note:
This property is not meant for public use.

Since:: 1.38.0

Returns:

{sap.ui.core.Control}

getSemanticObjectController(): sap.ui.comp.navpopover.SemanticObjectController

Gets content of aggregation semanticObjectController.

The Semantic Object Controller allows the user to specify and overwrite functionality for semantic object navigation.

Since:: 1.28.0

Returns:

{sap.ui.comp.navpopover.SemanticObjectController}

getShowFullScreenButton(): boolean

Gets current value of property showFullScreenButton.

Controls the visibility of the FullScreen button.

Default value is false.

Since:: 1.38

Returns:

{boolean} Value of property showFullScreenButton

getShowRowCount(): boolean

Gets current value of property showRowCount.

If the showRowCount attribute is set to true number of rows is shown along with the header text.

Default value is true.

Since:: 1.26.0

Returns:

{boolean} Value of property showRowCount

getShowTablePersonalisation(): boolean

Gets current value of property showTablePersonalisation.

The showTablePersonalisation attribute can be set to true or false for controlling the visibility of the TablePersonalisation button.

Default value is true.

Since:: 1.38.0

Returns:

{boolean} Value of property showTablePersonalisation

getShowVariantManagement(): boolean

Gets current value of property showVariantManagement.

The showVariantManagement attribute can be set to true or false for controlling the visibility of VariantManagement button.

Default value is true.

Since:: 1.38.0

Returns:

{boolean} Value of property showVariantManagement

getSmartFilterId(): string

Gets current value of property smartFilterId.

ID of the corresponding SmartFilter control; When specified, the SmartTable searches for the SmartFilter (also in the closest parent View) and attaches to the relevant events of the SmartFilter; to fetch data, show overlay etc.

Since:: 1.26.0

Returns:

{string} Value of property smartFilterId

getSmartVariant(): sap.ui.core.Control

ID of the element which is the current target of the association smartVariant, or null.

Since:: 1.38

Returns:

{sap.ui.core.Control}

getTable(): object

returns the internally used table object

Returns:

{object}

the table

getTableBindingPath(): string

Gets current value of property tableBindingPath.

This attribute can be used to specify the path that is used during the binding of the table. If not specified, the entitySet attribute is used instead. (used only if binding is established internally/automatically - See enableAutoBinding)

Since:: 1.28.0

Returns:

{string} Value of property tableBindingPath

getTableType(): sap.ui.comp.smarttable.TableType

Gets current value of property tableType.

Specifies the type of table to be created in the SmartTable control.
Note:
If you add a table to the content of the SmartTable in the view, this property has no effect.

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.TableType} Value of property tableType

getToolbarStyleClass(): string

Gets current value of property toolbarStyleClass.

A style class which is defined for the toolbar of the table.

Since:: 1.26.0

Returns:

{string} Value of property toolbarStyleClass

getUseExportToExcel(): boolean

Gets current value of property useExportToExcel.

Can be set to true or false depending on whether you want to export data to MS Excel®.

Default value is true.

Since:: 1.26.0

Returns:

{boolean} Value of property useExportToExcel

getUseTablePersonalisation(): boolean

Gets current value of property useTablePersonalisation.

The useTablePersonalisation attribute can be set to true or false depending on whether you want to define personalized table settings. If you want to persist the table personalization, you need to specify the persistencyKey property.

Default value is true.

Since:: 1.26.0

Returns:

{boolean} Value of property useTablePersonalisation

getUseVariantManagement(): boolean

Gets current value of property useVariantManagement.

The useVariantManagement attribute can be set to true or false depending on whether you want to use variants. As a prerequisite you need to specify the persistencyKey property.

Default value is true.

Since:: 1.26.0

Returns:

{boolean} Value of property useVariantManagement

rebindTable(bForceRebind)

This can be used to trigger binding on the table used in the SmartTable

Parameters:

{boolean}

bForceRebind

force bind call to be triggered on the inner table

setCurrentVariantId(sVariantId)

Set the current variant according to the sVariantId. In case an empty string or null or undefined was passed the STANDARD will be set. STANDARD will also be set, in case the passed sVariantId could not be found. In case neither a flexibility variant, nor the content for the standard variant could not be obtained, nor the personalisable control obtained nothing will be executed/changed

Parameters:

{string}

sVariantId

id of the currently selected variant

setCustomToolbar(oCustomToolbar): sap.ui.comp.smarttable.SmartTable

Sets the aggregated customToolbar.

Parameters:

{sap.m.Toolbar}

oCustomToolbar

The customToolbar to set

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setDemandPopin(bDemandPopin): sap.ui.comp.smarttable.SmartTable

Sets a new value for property demandPopin.

The demandPopin attribute can be set to true or false depending on whether you want to display columns as popins on the responsive table

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

Default value is false.

Parameters:

{boolean} bDemandPopin New value for property demandPopin

Since:: 1.30.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setEditable(bEditable): sap.ui.comp.smarttable.SmartTable

Sets a new value for property editable.

This attribute can be used to specify if the controls created by the SmartTable control are editable.

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

Default value is false.

Parameters:

{boolean} bEditable New value for property editable

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setEditTogglable(bEditTogglable): sap.ui.comp.smarttable.SmartTable

Sets a new value for property editTogglable.

Specifies whether the editable property can be toggled via a button on the toolbar. (The automatic toggle of controls works only for the SmartField scenario)

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

Default value is false.

Parameters:

{boolean} bEditTogglable New value for property editTogglable

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setEnableAutoBinding(bEnableAutoBinding): sap.ui.comp.smarttable.SmartTable

Sets a new value for property enableAutoBinding.

When set to true, this enables automatic binding of the table using the tableBindingPath (if it exists) or entitySet property. This happens just after the initialise event has been fired.

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

Default value is false.

Parameters:

{boolean} bEnableAutoBinding New value for property enableAutoBinding

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setEnableCustomFilter(bEnableCustomFilter): sap.ui.comp.smarttable.SmartTable

Sets a new value for property enableCustomFilter.

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

Default value is true.

Parameters:

{boolean} bEnableCustomFilter New value for property enableCustomFilter

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setEntitySet(sEntitySetName)

The entity set name from OData metadata, with which the table should be bound to

Parameters:

{string}

sEntitySetName

The entity set

setHeader(sHeader): sap.ui.comp.smarttable.SmartTable

Sets a new value for property header.

Specifies header text that is shown in table

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

Parameters:

{string} sHeader New value for property header

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setIgnoredFields(sIgnoredFields): sap.ui.comp.smarttable.SmartTable

Sets a new value for property ignoredFields.

CSV of fields that must be ignored in the OData metadata by the SmartTable control.
Note:
No validation is done. Please ensure that you do not add spaces or special characters.

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

Parameters:

{string} sIgnoredFields New value for property ignoredFields

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setIgnoreFromPersonalisation(sIgnoreFromPersonalisation): sap.ui.comp.smarttable.SmartTable

Sets a new value for property ignoreFromPersonalisation.

CSV of fields that is not shown in the personalization dialog.
Note:
No validation is done. Please ensure that you do not add spaces or special characters.

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

Parameters:

{string} sIgnoreFromPersonalisation New value for property ignoreFromPersonalisation

Since:: 1.32.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setInitiallyVisibleFields(sInitiallyVisibleFields): sap.ui.comp.smarttable.SmartTable

Sets a new value for property initiallyVisibleFields.

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

Parameters:

{string} sInitiallyVisibleFields New value for property initiallyVisibleFields

Since:: 1.32.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setNoData(vNoData): sap.ui.comp.smarttable.SmartTable

Sets the aggregated noData.

Parameters:

{sap.ui.core.Control|string}

vNoData

The noData to set

Since:: 1.32.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setPersistencyKey(sPersistencyKey): sap.ui.comp.smarttable.SmartTable

Sets a new value for property persistencyKey.

Key used to access personalization data.

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

Parameters:

{string} sPersistencyKey New value for property persistencyKey

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setRequestAtLeastFields(sRequestAtLeastFields): sap.ui.comp.smarttable.SmartTable

Sets a new value for property requestAtLeastFields.

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

Parameters:

{string} sRequestAtLeastFields New value for property requestAtLeastFields

Since:: 1.32.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setSemanticKeyAdditionalControl(oSemanticKeyAdditionalControl): sap.ui.comp.smarttable.SmartTable

Sets the aggregated semanticKeyAdditionalControl.

Parameters:

{sap.ui.core.Control}

oSemanticKeyAdditionalControl

The semanticKeyAdditionalControl to set

Since:: 1.38.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setSemanticObjectController(oSemanticObjectController): sap.ui.comp.smarttable.SmartTable

Sets the aggregated semanticObjectController.

Parameters:

{sap.ui.comp.navpopover.SemanticObjectController}

oSemanticObjectController

The semanticObjectController to set

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setShowFullScreenButton(bShowFullScreenButton): sap.ui.comp.smarttable.SmartTable

Sets a new value for property showFullScreenButton.

Controls the visibility of the FullScreen button.

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

Default value is false.

Parameters:

{boolean} bShowFullScreenButton New value for property showFullScreenButton

Since:: 1.38

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setShowRowCount(bShowRowCount): sap.ui.comp.smarttable.SmartTable

Sets a new value for property showRowCount.

If the showRowCount attribute is set to true number of rows is shown along with the header text.

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

Default value is true.

Parameters:

{boolean} bShowRowCount New value for property showRowCount

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setShowTablePersonalisation(bShowTablePersonalisation): sap.ui.comp.smarttable.SmartTable

Sets a new value for property showTablePersonalisation.

The showTablePersonalisation attribute can be set to true or false for controlling the visibility of the TablePersonalisation button.

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

Default value is true.

Parameters:

{boolean} bShowTablePersonalisation New value for property showTablePersonalisation

Since:: 1.38.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setShowVariantManagement(bShowVariantManagement): sap.ui.comp.smarttable.SmartTable

Sets a new value for property showVariantManagement.

The showVariantManagement attribute can be set to true or false for controlling the visibility of VariantManagement button.

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

Default value is true.

Parameters:

{boolean} bShowVariantManagement New value for property showVariantManagement

Since:: 1.38.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setSmartFilterId(sSmartFilterId): sap.ui.comp.smarttable.SmartTable

Sets a new value for property smartFilterId.

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

Parameters:

{string} sSmartFilterId New value for property smartFilterId

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setSmartVariant(oSmartVariant): sap.ui.comp.smarttable.SmartTable

Sets the associated smartVariant.

Parameters:

{sap.ui.core.Control}

oSmartVariant

Id of an element which becomes the new target of this smartVariant association; alternatively, an element instance may be given

Since:: 1.38

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setTableBindingPath(sTableBindingPath): sap.ui.comp.smarttable.SmartTable

Sets a new value for property tableBindingPath.

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

Parameters:

{string} sTableBindingPath New value for property tableBindingPath

Since:: 1.28.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setTableType(sTableType): sap.ui.comp.smarttable.SmartTable

Sets a new value for property tableType.

Specifies the type of table to be created in the SmartTable control.
Note:
If you add a table to the content of the SmartTable in the view, this property has no effect.

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

Parameters:

{sap.ui.comp.smarttable.TableType} sTableType New value for property tableType

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setToolbarStyleClass(sToolbarStyleClass): sap.ui.comp.smarttable.SmartTable

Sets a new value for property toolbarStyleClass.

A style class which is defined for the toolbar of the table.

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

Parameters:

{string} sToolbarStyleClass New value for property toolbarStyleClass

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setUseExportToExcel(bUseExportToExcel): sap.ui.comp.smarttable.SmartTable

Sets a new value for property useExportToExcel.

Can be set to true or false depending on whether you want to export data to MS Excel®.

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

Default value is true.

Parameters:

{boolean} bUseExportToExcel New value for property useExportToExcel

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setUseTablePersonalisation(bUseTablePersonalisation): sap.ui.comp.smarttable.SmartTable

Sets a new value for property useTablePersonalisation.

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

Default value is true.

Parameters:

{boolean} bUseTablePersonalisation New value for property useTablePersonalisation

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

setUseVariantManagement(bUseVariantManagement): sap.ui.comp.smarttable.SmartTable

Sets a new value for property useVariantManagement.

The useVariantManagement attribute can be set to true or false depending on whether you want to use variants. As a prerequisite you need to specify the persistencyKey property.

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

Default value is true.

Parameters:

{boolean} bUseVariantManagement New value for property useVariantManagement

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

updateTableHeaderState()

This can be called once data is received to update table header (count) and toolbar buttons(e.g. Excel Export) enabled state

getUseOnlyOneSolidToolbar(): boolean

Gets current value of property useOnlyOneSolidToolbar.

If set to true, the standard toolbar and custom toolbar will be merged into one toolbar. The combined toolbar will have a solid style.

Default value is false.

Deprecated:
Since 1.29. This property has no effect

Since:: 1.26.0

Returns:

{boolean} Value of property useOnlyOneSolidToolbar

setUseOnlyOneSolidToolbar(bUseOnlyOneSolidToolbar): sap.ui.comp.smarttable.SmartTable

Sets a new value for property useOnlyOneSolidToolbar.

If set to true, the standard toolbar and custom toolbar will be merged into one toolbar. The combined toolbar will have a solid style.

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

Default value is false.

Parameters:

{boolean} bUseOnlyOneSolidToolbar New value for property useOnlyOneSolidToolbar

Deprecated:
Since 1.29. This property has no effect

Since:: 1.26.0

Returns:

{sap.ui.comp.smarttable.SmartTable} Reference to this in order to allow method chaining

OData Annotation Detail

SortRestrictions/NonSortableProperties(Org.OData.Capabilities.V1)

Defines whether a column can be sorted. Columns are sortable by default. If sorting on columns has to be restricted, then such columns must be listed under NonSortableProperties (exclude from sorting).

The annotation is calculated from the currently bound EntitySet and contains a Property collection of the corresponding EntityType definition. Only PropertyPath for columns to be excluded from sorting can be applied.

For columns added to the content of the SmartTable control, the annotation is not used, and the hosting component needs to take care of correct settings.

XML Example of OData V4 with Customer and CompanyCode Properties Excluded from Sorting

   <Annotation Term="Org.OData.Capabilities.V1.SortRestrictions">
     <PropertyValue Property="NonSortableProperties">
       <Collection>
          <PropertyPath>Customer</PropertyPath>
          <PropertyPath>CompanyCode</PropertyPath>
       </Collection>
     </PropertyValue>
   </Annotation>

For OData v2 the sap:sortable annotation on the Property can be used to exclude from sorting.

   <Property Name="Customer" ... sap:sortable="false"/>
   <Property Name="CompanyCode" ... sap:sortable="false"/>

Refer OData v4 annotations for details about annotations.

Target Type:

EntitySet

Interpretation:

Provide the annotation for paths to be excluded. Paths will be included by default.

Applies to Aggregation/Property:

columns/#

Since:: 1.28.1

FilterRestrictions/NonFilterableProperties(Org.OData.Capabilities.V1)

Defines whether a column can be filtered. Columns are filterable by default and need to be excluded.

The annotation is calculated from the currently bound EntitySet and contains a PropertyPath collection of the corresponding EntityType definition. Only PropertyPaths for columns to be excluded from filtering can be applied.

For columns added to the content's table of the SmartTable, the annotation is not used and the hosting component needs to take care of correct settings.

Note: Currently only OData V2 annotation is supported.

XML Example of OData V4 with Excluded Customer and CompanyCode Properties from Filtering

   <Annotation Term="Org.OData.Capabilities.V1.FilterRestrictions">
     <PropertyValue Property="NonFilterableProperties">
       <Collection>
          <PropertyPath>Customer</PropertyPath>
          <PropertyPath>CompanyCode</PropertyPath>
       </Collection>
     </PropertyValue>
   </Annotation>

For OData v2 the sap:filterable annotation on the Property can be used to exclude from filtering.

   <Property Name="Customer" ... sap:filterable="false"/>
   <Property Name="CompanyCode" ... sap:filterable="false"/>

Refer OData v4 annotations for details about annotations.

Target Type:

EntitySet

Interpretation:

Provide the annotation for paths to be excluded. Paths will be included by default.

Applies to Aggregation/Property:

columns/#

Since:: 1.28.1

Label(com.sap.vocabularies.Common.v1)

A short, human-readable text suitable for the column header's text.

Either com.sap.vocabularies.Common.v1.Label annotation on the Property or Label annotation of com.sap.vocabularies.UI.v1.DataFieldAbstract within com.sap.vocabularies.UI.v1.LineItem annotation can be used. If com.sap.vocabularies.Common.v1.Label annotation is given, it has precedence. If none of the annotations is given the label will be the Property name of the column.

For columns added to the content's table of the SmartTable, the annotation is not used and the hosting component needs to take care of correct settings and translation.

XML Example of OData V4 with CustomerName as Label for Customer Property

   <Property Name="Customer">
      <Annotation Term="UI.Label" Path="CustomerName" />
   </Property>
   <Property Name="CustomerName" type="Edm.String" />

For OData v2 the sap:label annotation on the Property can be used to define the label of the column.

   <Property Name="Customer" ... sap:label="My Customer"/>

Refer OData v4 annotations for details about annotations.

Target Type:

Property

PropertyPath

Applies to Aggregation/Property:

columns/#/label

Since:: 1.28.1

LineItem/Label(com.sap.vocabularies.UI.v1)

A short, human-readable text suitable for the column header's text.

For columns added to the content's table of the SmartTable, the annotation is not used and the hosting component needs to take care of correct settings and translation.

XML Example of OData V4 with CustomerName as Label for Customer Property

   <Property Name="Customer">
      <Annotation Term="UI.Label" Path="CustomerName" />
   </Property>
   <Property Name="CustomerName" type="Edm.String" />

For OData v2 the sap:label annotation on the Property can be used define the label of the column.

   <Property Name="Customer" ... sap:label="My Customer"/>

Refer OData v4 annotations for details about annotations.

Target Type:

Property

Parameter

Applies to Aggregation/Property:

columns/#/label

Since:: 1.28.1

FieldControlType/Hidden(com.sap.vocabularies.Common.v1)

Defines whether the column is visible. The SmartTable control interprets the EnumMemberFieldControlType/Hidden of the FieldControl annotation for setting the visibility. If a Property is set to hidden in OData annotation, then the SmartTable control ignores processing this Property.

Note: Currently only FieldControlType/Hidden is supported for statically hiding the columns.

XML Example of OData V4 with Hidden Customer and CompanyCode Properties

   <Property Name="Customer">
     <Annotation Term="UI.FieldControlType/Hidden"/>
   </Property>
   <Property Name="CompanyCode">
     <Annotation Term="UI.FieldControlTpye/Hidden"/>
   </Property>

For OData v2 the sap:visible annotation on the Property can be used to assign visibility.

   <Property Name="Customer" ... sap:visible="false"/>
   <Property Name="CompanyCode" ... sap:visible="false"/>

Refer OData v4 annotations for details about annotations.

Target Type:

Property

Applies to Aggregation/Property:

columns/#/visible

Since:: 1.28.1

ISOCurrency(Org.OData.Measures.V1)

Defines a currency code for an amount according to the ISO 4217 standard. ISOCurrency annotation can point to a Property, which can also be null.

XML Example of OData V4 with CurrencyCode Associated to Price Property

   <Property Name="Price">
      <Annotation Term="Measures.ISOCurrency" Path="CurrencyCode" />
   </Property>
   <Property Name="CurrencyCode" type="Edm.String" />

For OData v2 the sap:semantics="currency-code" along with sap:unit annotations on the Property can be used to assign a currency code to the field.

   <Property Name="Price" ... sap:ubit="CurrencyCode"/>
   <Property Name="CurrencyCode" ... sap:semantics="currency-code"/>

Refer OData v4 annotations for details about annotations.

Target Type:

Property

Applies to Aggregation/Property:

columns/#/cellContent

Since:: 1.28.1

Unit(Org.OData.Measures.V1)

The unit of measure for a measured quantity, for example, cm for centimeters. Renders the value associated with the unit annotation of a Property, which can be null.

XML Example of OData V4 with OrderedUnit Associated to OrderedQuantity Property

  <Property Name="OrderedQuantity">
    <Annotation Term="Measures.Unit" Path="OrderedUnit" />
  </Property>
  <Property Name="OrderedUnit" type="Edm.String" />

For OData v2 the sap:semantics="unit-of-measure" along with sap:unit annotations on the Property can be used to assign unit of measure to the field.

   <Property Name="OrderedQuantity" ... sap:unit="OrderedUnit"/>
   <Property Name="OrderedUnit" ... sap:semantics="unit-of-measure"/>

Refer OData v4 annotations for details about annotations.

Target Type:

Property

Applies to Aggregation/Property:

columns/#/cellContent

Since:: 1.28.1

IsUpperCase(com.sap.vocabularies.Common.v1)

Defines whether a string is capitalized.

XML Example of OData V4 with Capitalized Customer and CompanyCode Properties

   <Annotation Term="com.sap.vocabularies.Common.v1.IsUpperCase">
       <Collection>
          <PropertyPath>Customer</PropertyPath>
          <PropertyPath>CompanyCode</PropertyPath>
       </Collection>
   </Annotation>

For OData v2 the sap:display-format="UpperCase" annotation on the Property can be used to render the text in upper case format.

   <Property Name="Customer" ... sap:display-format="UpperCase"/>
   <Property Name="CompanyCode" ... sap:display-format="UpperCase"/>

Refer OData v4 annotations for details about annotations.

Target Type:

Property

Parameter

Applies to Aggregation/Property:

columns/#

columns/#/cellContent

Since:: 1.28.1

LineItem(com.sap.vocabularies.UI.v1)

Renders the initial columns for the SmartTable control.

XML Example of OData V4 Customer and CompanyCode Properties as LineItem

   <Annotation Term="com.sap.vocabularies.UI.v1.LineItem">
       <Collection>
         <Record>
            <PropertyValue Property="Value" Path="Customer" />
            <PropertyValue Property="Value" Path="CompanyCode" />
          </Record>
       </Collection>
   </Annotation>

Refer OData v4 annotations for details about annotations.

Target Type:

EntityType

Applies to Aggregation/Property:

columns

Since:: 1.28.1

PresentationVariant(com.sap.vocabularies.UI.v1)

Renders the initial columns for the SmartTable control. A PropertyPath and an AnnotationPath can be used for constructing PresentationVariant annotation.

XML Example of OData V4 with Customer and CompanyCode Properties as PresentationVariant

   <Annotation Term="com.sap.vocabularies.UI.v1.PresentationVariant">
     <Record>
       <PropertyValue Property="Visualizations">
         <Collection>
           <AnnotationPath>@UI.LineItem</AnnotationPath>
         </Collection>
       </PropertyValue>
       <PropertyValue Property="RequestAtLeast">
         <Collection>
           <PropertyPath>Customer</PropertyPath>
           <PropertyPath>CompanyCode</PropertyPath>
         </Collection>
       </PropertyValue>
         <PropertyValue Property="SortOrder">
           <Collection>
             <Record>
               <PropertyValue Property="Property" PropertyPath="CompanyCode"/>
               <PropertyValue Property="Descending" Bool="true"/>
             </Record>
             <Record>
               <PropertyValue Property="Property" PropertyPath="Customer"/>
             </Record>
           </Collection>
         </PropertyValue>
       </Record>
     </Annotation>

Refer OData v4 annotations for details about annotations.

Target Type:

EntitySet

EntityType

Applies to Aggregation/Property:

columns

Since:: 1.28.1

Importance(com.sap.vocabularies.UI.v1)

Shows columns with priority high on phones, with priority medium or high on tablets, and with all priorities on the desktop.

Note: Currently the Importance annotation is only evaluated in the LineItem DataField annotation.

XML Example of OData V4 with the Importance Annotation

   <Property Name="Customer">
     <Annotation Term="UI.Importance" EnumMember="UI.ImportanceType/High" />
   </Property>
   <Property Name="CompanyCode">
     <Annotation Term="UI.Importance" EnumMember="UI.ImportanceType/Medium" />
   </Property>

Refer OData v4 annotations for details about annotations.

Target Type:

Record

Annotation

Applies to Aggregation/Property:

columns/#/visible

Since:: 1.28.1

LineItem/DataFieldWithUrl(com.sap.vocabularies.UI.v1)

Renders the value as a URL, if a URL parameter path is present. This annotation must be specified along with the LineItem annotation.

Note: Currently only odata.fillUriTemplate with LabeledElement for filling the URL parameter is support in the Apply Function.

XML Example for OData V4 with DataFieldWithUrl Annotation

   <Record Type="com.sap.vocabularies.UI.v1.DataFieldWithUrl">
     <PropertyValue Property="Label" String="Link to"/>
     <PropertyValue Property="Value" String="Google Maps"/>
     <PropertyValue Property="Url">
       <Apply Function="odata.fillUriTemplate">
         <String>https://www.google.de/maps/{city1}/{street},{city2}</String>
           <LabeledElement Name="street">
             <Path>Address/Street</Path>
           </LabeledElement>
           <LabeledElement Name="city1">
             <Path>Address/City</Path>
           </LabeledElement>
           <LabeledElement Name="city2">
             <Path>Address/City</Path>
           </LabeledElement>
       </Apply>
     </PropertyValue>
   </Record>

Refer OData v4 annotations for details about annotations.

Target Type:

Record

Applies to Aggregation/Property:

columns/cellContent

Since:: 1.38.1

CriticalityType(com.sap.vocabularies.UI.v1)

Represents the criticality state of the data that is present inside the column. This annotation must be specified along with the LineItem annotation. Color coding is also applied to the criticality state based on the provided EnumMember.

XML Example for OData V4 with CriticalityType Annotation

   <Record Type="UI.DataField">
     <PropertyValue Property="Criticality"
       Path="to_StockAvailability/StockAvailability" />
     <PropertyValue Property="CriticalityRepresentation"
       EnumMember="com.sap.vocabularies.UI.v1.CriticalityRepresentationType/WithoutIcon" />
     <PropertyValue Property="Value" Path="to_StockAvailability/StockAvailability" />
   </Record>

Refer OData v4 annotations for details about annotations.

Target Type:

PropertyPath

Applies to Aggregation/Property:

columns/criticality

Since:: 1.38.1

CriticalityRepresentationType/WithoutIcon(com.sap.vocabularies.UI.v1)

Determines if criticality is visualized by means of an icon. The CriticalityRepresentation contains EnumMember that can be used to control the visibility of the icon. An icon is added along with the criticality state by default. If PropertyPath is to be excluded from having an icon, then PropertyPath must be annotated with the CriticalityRepresentationType/WithoutIcon annotation.

XML Example for OData V4 with CriticalityRepresentationType/WithoutIcon Annotation

   <Record Type="UI.DataField">
     <PropertyValue Property="Criticality"
       Path="to_StockAvailability/StockAvailability" />
     <PropertyValue Property="CriticalityRepresentation"
       EnumMember="com.sap.vocabularies.UI.v1.CriticalityRepresentationType/WithoutIcon" />
     <PropertyValue Property="Value" Path="to_StockAvailability/StockAvailability" />
   </Record>

Refer OData v4 annotations for details about annotations.

Target Type:

Property

Applies to Aggregation/Property:

columns/criticalityIcon

Since:: 1.38.1

SemanticKey(com.sap.vocabularies.Common.v1)

Defines whether a property is a semantic key which is used for key columns (rendering sap.m.ObjectIdentifier).

XML Example of OData V4 with SemanticKey Annotation

   <Annotations Target="SalesOrderType" xmlns="http://docs.oasis-open.org/odata/ns/edm">
     <Annotation Term="com.sap.vocabularies.Common.v1.SemanticKey">
       <Collection>
         <PropertyPath>SalesOrderID</PropertyPath>
         <PropertyPath>SalesOrderItemID</PropertyPath>
       </Collection>
     </Annotation>
   </Annotations>

Refer OData v4 annotations for details about annotations.

Target Type:

EntityType

Applies to Aggregation/Property:

columns/cellContent

Since:: 1.38.1

IsImageUrl(com.sap.vocabularies.Common.v1)

Renders an image in the cell if the annotation is present.

XML Example of OData V4 with the IsImageUrl Annotation

   <Property Name="Product">
     <Annotation Term="com.sap.vocabularies.Common.v1.IsImageUrl" Bool="true" />
   </Property>

Refer OData v4 annotations for details about annotations.

Target Type:

Property

Applies to Aggregation/Property:

columns/image

Since:: 1.38.1