AnalyticalColumn

This column adds additional properties to the table column which are needed for the analytical binding and table

Experimental API:Since version 1.21. The AnalyticalColumn will be productized soon. Some attributes will be added to Column.

Constructor Summary

new sap.ui.table.AnalyticalColumn(sId?, mSettings?)Constructor for a new AnalyticalColumn.

Events borrowed from class sap.ui.table.Column

columnMenuOpen

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

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

sap.ui.table.AnalyticalColumn.getMetadata()Returns a metadata object for class sap.ui.table.AnalyticalColumn.

getGroupHeaderFormatter()Gets current value of property groupHeaderFormatter.

getInResult()Gets current value of property inResult.

getLeadingProperty()Gets current value of property leadingProperty.

getShowIfGrouped()Gets current value of property showIfGrouped.

getSummed()Gets current value of property summed.

setGroupHeaderFormatter(oGroupHeaderFormatter)Sets a new value for property groupHeaderFormatter.

setInResult(bInResult)Sets a new value for property inResult.

setLeadingProperty(sLeadingProperty)Sets a new value for property leadingProperty.

setShowIfGrouped(bShowIfGrouped)Sets a new value for property showIfGrouped.

setSummed(bSummed)Sets a new value for property summed.

Methods borrowed from class sap.ui.table.Column

addMultiLabel, attachColumnMenuOpen, destroyLabel, destroyMenu, destroyMultiLabels, destroyTemplate, detachColumnMenuOpen, fireColumnMenuOpen, getAutoResizable, getDefaultFilterOperator, getFiltered, getFilterOperator, getFilterProperty, getFilterType, getFilterValue, getFlexible, getGrouped, getHAlign, getHeaderSpan, getLabel, getMenu, getMultiLabels, getName, getResizable, getShowFilterMenuEntry, getShowSortMenuEntry, getSorted, getSortOrder, getSortProperty, getTemplate, getVisible, getWidth, indexOfMultiLabel, insertMultiLabel, removeAllMultiLabels, removeMultiLabel, setAutoResizable, setDefaultFilterOperator, setFiltered, setFilterOperator, setFilterProperty, setFilterType, setFilterValue, setFlexible, setGrouped, setHAlign, setHeaderSpan, setLabel, setMenu, setName, setResizable, setShowFilterMenuEntry, setShowSortMenuEntry, setSorted, setSortOrder, setSortProperty, setTemplate, setVisible, setWidth, shouldRender, sort, toggleSort

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, invalidate, 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

Constructor Detail

new sap.ui.table.AnalyticalColumn(sId?, mSettings?)

Constructor for a new AnalyticalColumn.

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
- leadingProperty : string
- summed : boolean (default: false)
- inResult : boolean (default: false)
- showIfGrouped : boolean (default: false)
- groupHeaderFormatter : any

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

Method Detail

sap.ui.table.AnalyticalColumn.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.table.AnalyticalColumn 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.Column.extend.

Parameters:

{string}	sClassName	Name of the class being created
{object}	oClassInfo?	Object literal with information about the class
{function}	FNMetaImpl?	Constructor function for the metadata object; if not given, it defaults to `sap.ui.core.ElementMetadata`

Returns:

{function}

Created class / constructor function

sap.ui.table.AnalyticalColumn.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.ui.table.AnalyticalColumn.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getGroupHeaderFormatter(): any

Gets current value of property groupHeaderFormatter.

If the column is grouped, this formatter is used to format the value in the group header

Returns:

{any} Value of property groupHeaderFormatter

getInResult(): boolean

Gets current value of property inResult.

Specifies that the dimension referred to by the column shall be included in the granularity of the data result. It allows a finer distinction between a visible/grouped/(included)inResult column.

Default value is false.

Returns:

{boolean} Value of property inResult

getLeadingProperty(): string

Gets current value of property leadingProperty.

Defines the primary model property which is used inside the Column. In case of the analytical extension this means the property which is grouped by for dimensions or the property which is summed for measures.

Returns:

{string} Value of property leadingProperty

getShowIfGrouped(): boolean

Gets current value of property showIfGrouped.

Specifies whether the column is displayed within the table even if it is grouped or not. A grouped column has the same value for every rows within the group.

Default value is false.

Returns:

{boolean} Value of property showIfGrouped

getSummed(): boolean

Gets current value of property summed.

If defined a sum for this column is calculated

Default value is false.

Returns:

{boolean} Value of property summed

setGroupHeaderFormatter(oGroupHeaderFormatter): sap.ui.table.AnalyticalColumn

Sets a new value for property groupHeaderFormatter.

If the column is grouped, this formatter is used to format the value in the group header

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

Parameters:

{any} oGroupHeaderFormatter New value for property groupHeaderFormatter

Returns:

{sap.ui.table.AnalyticalColumn} Reference to this in order to allow method chaining

setInResult(bInResult): sap.ui.table.AnalyticalColumn

Sets a new value for property inResult.

Specifies that the dimension referred to by the column shall be included in the granularity of the data result. It allows a finer distinction between a visible/grouped/(included)inResult column.

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

Default value is false.

Parameters:

{boolean} bInResult New value for property inResult

Returns:

{sap.ui.table.AnalyticalColumn} Reference to this in order to allow method chaining

setLeadingProperty(sLeadingProperty): sap.ui.table.AnalyticalColumn

Sets a new value for property leadingProperty.

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

Parameters:

{string} sLeadingProperty New value for property leadingProperty

Returns:

{sap.ui.table.AnalyticalColumn} Reference to this in order to allow method chaining

setShowIfGrouped(bShowIfGrouped): sap.ui.table.AnalyticalColumn

Sets a new value for property showIfGrouped.

Specifies whether the column is displayed within the table even if it is grouped or not. A grouped column has the same value for every rows within the group.

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

Default value is false.

Parameters:

{boolean} bShowIfGrouped New value for property showIfGrouped

Returns:

{sap.ui.table.AnalyticalColumn} Reference to this in order to allow method chaining

setSummed(bSummed): sap.ui.table.AnalyticalColumn

Sets a new value for property summed.

If defined a sum for this column is calculated

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

Default value is false.

Parameters:

{boolean} bSummed New value for property summed

Returns:

{sap.ui.table.AnalyticalColumn} Reference to this in order to allow method chaining