Class sap.m.P13nDimMeasurePanelModule: sap/m/P13nDimMeasurePanel

extends P13nPanel

The P13nDimMeasurePanel control is used to define chart-specific settings like chart type, the visibility, the order and roles of dimensions and measures for table personalization.


Since: 1.34.0.
Constructor Summary
new sap.m.P13nDimMeasurePanel(sId?, mSettings?)Constructor for a new P13nDimMeasurePanel.
Events borrowed from class sap.m.P13nPanel
beforeNavigationTo
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.m.P13nDimMeasurePanel.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.P13nDimMeasurePanel with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.P13nDimMeasurePanel.getMetadata()Returns a metadata object for class sap.m.P13nDimMeasurePanel.
addAvailableChartType(oAvailableChartType)Adds some availableChartType to the aggregation availableChartTypes.
addDimMeasureItem(oDimMeasureItem)Adds some dimMeasureItem to the aggregation dimMeasureItems.
bindDimMeasureItems(oBindingInfo)Binds aggregation dimMeasureItems to model data.
destroyAvailableChartTypes()Destroys all the availableChartTypes in the aggregation availableChartTypes.
destroyDimMeasureItems()Destroys all the dimMeasureItems in the aggregation dimMeasureItems.
getAvailableChartTypes()Gets content of aggregation availableChartTypes.
getChartTypeKey()Gets current value of property chartTypeKey.
getDimMeasureItems()Gets content of aggregation dimMeasureItems.
indexOfAvailableChartType(oAvailableChartType)Checks for the provided sap.ui.core.Item in the aggregation availableChartTypes.
indexOfDimMeasureItem(oDimMeasureItem)Checks for the provided sap.m.P13nDimMeasureItem in the aggregation dimMeasureItems.
insertAvailableChartType(oAvailableChartType, iIndex)Inserts a availableChartType into the aggregation availableChartTypes.
insertDimMeasureItem(oDimMeasureItem, iIndex)Inserts a dimMeasureItem into the aggregation dimMeasureItems.
removeAllAvailableChartTypes()Removes all the controls from the aggregation availableChartTypes.
removeAllDimMeasureItems()Removes all the controls from the aggregation dimMeasureItems.
removeAvailableChartType(vAvailableChartType)Removes a availableChartType from the aggregation availableChartTypes.
removeDimMeasureItem(vDimMeasureItem)Removes a dimMeasureItem from the aggregation dimMeasureItems.
setChartTypeKey(sChartTypeKey)Sets a new value for property chartTypeKey.
unbindDimMeasureItems()Unbinds aggregation dimMeasureItems from model data.
Methods borrowed from class sap.m.P13nPanel
addItem, attachBeforeNavigationTo, beforeNavigationTo, bindItems, destroyItems, detachBeforeNavigationTo, fireBeforeNavigationTo, getChangeNotifier, getItems, getOkPayload, getResetPayload, getTitle, getTitleLarge, getType, getValidationExecutor, getValidationListener, getVerticalScrolling, indexOfItem, insertItem, onAfterNavigationFrom, onBeforeNavigationFrom, removeAllItems, removeItem, setChangeNotifier, setTitle, setTitleLarge, setType, setValidationExecutor, setValidationListener, setVerticalScrolling, unbindItems
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
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
Constructor Detail
new sap.m.P13nDimMeasurePanel(sId?, mSettings?)
Constructor for a new P13nDimMeasurePanel.

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:

In addition, all settings applicable to the base type sap.m.P13nPanel 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.m.P13nDimMeasurePanel.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.P13nDimMeasurePanel 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.P13nPanel.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.m.P13nDimMeasurePanel.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.P13nDimMeasurePanel.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addAvailableChartType(oAvailableChartType): sap.m.P13nDimMeasurePanel
Adds some availableChartType to the aggregation availableChartTypes.
Parameters:
{sap.ui.core.Item}oAvailableChartType the availableChartType to add; if empty, nothing is inserted
Since:
1.34.0
Returns:
{sap.m.P13nDimMeasurePanel} Reference to this in order to allow method chaining
addDimMeasureItem(oDimMeasureItem): sap.m.P13nDimMeasurePanel
Adds some dimMeasureItem to the aggregation dimMeasureItems.
Parameters:
{sap.m.P13nDimMeasureItem}oDimMeasureItem the dimMeasureItem to add; if empty, nothing is inserted
Since:
1.34.0
Returns:
{sap.m.P13nDimMeasurePanel} Reference to this in order to allow method chaining
bindDimMeasureItems(oBindingInfo): sap.m.P13nDimMeasurePanel
Binds aggregation dimMeasureItems to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Parameters:
{object}oBindingInfo The binding information
Since:
1.34.0
Returns:
{sap.m.P13nDimMeasurePanel} Reference to this in order to allow method chaining
destroyAvailableChartTypes(): sap.m.P13nDimMeasurePanel
Destroys all the availableChartTypes in the aggregation availableChartTypes.
Since:
1.34.0
Returns:
{sap.m.P13nDimMeasurePanel} Reference to this in order to allow method chaining
destroyDimMeasureItems(): sap.m.P13nDimMeasurePanel
Destroys all the dimMeasureItems in the aggregation dimMeasureItems.
Since:
1.34.0
Returns:
{sap.m.P13nDimMeasurePanel} Reference to this in order to allow method chaining
getAvailableChartTypes(): sap.ui.core.Item[]
Gets content of aggregation availableChartTypes.

Specifies available chart types.

Since:
1.34.0
Returns:
{sap.ui.core.Item[]}
getChartTypeKey(): string
Gets current value of property chartTypeKey.

Specifies a chart type key.

Default value is .

Since:
1.34.0
Returns:
{string} Value of property chartTypeKey
getDimMeasureItems(): sap.m.P13nDimMeasureItem[]
Gets content of aggregation dimMeasureItems.

List of columns that has been changed.

Since:
1.34.0
Returns:
{sap.m.P13nDimMeasureItem[]}
indexOfAvailableChartType(oAvailableChartType): int
Checks for the provided sap.ui.core.Item in the aggregation availableChartTypes. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Item}oAvailableChartType The availableChartType whose index is looked for
Since:
1.34.0
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfDimMeasureItem(oDimMeasureItem): int
Checks for the provided sap.m.P13nDimMeasureItem in the aggregation dimMeasureItems. and returns its index if found or -1 otherwise.
Parameters:
{sap.m.P13nDimMeasureItem}oDimMeasureItem The dimMeasureItem whose index is looked for
Since:
1.34.0
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertAvailableChartType(oAvailableChartType, iIndex): sap.m.P13nDimMeasurePanel
Inserts a availableChartType into the aggregation availableChartTypes.
Parameters:
{sap.ui.core.Item}oAvailableChartType the availableChartType to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the availableChartType should be inserted at; for a negative value of iIndex, the availableChartType is inserted at position 0; for a value greater than the current size of the aggregation, the availableChartType is inserted at the last position
Since:
1.34.0
Returns:
{sap.m.P13nDimMeasurePanel} Reference to this in order to allow method chaining
insertDimMeasureItem(oDimMeasureItem, iIndex): sap.m.P13nDimMeasurePanel
Inserts a dimMeasureItem into the aggregation dimMeasureItems.
Parameters:
{sap.m.P13nDimMeasureItem}oDimMeasureItem the dimMeasureItem to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the dimMeasureItem should be inserted at; for a negative value of iIndex, the dimMeasureItem is inserted at position 0; for a value greater than the current size of the aggregation, the dimMeasureItem is inserted at the last position
Since:
1.34.0
Returns:
{sap.m.P13nDimMeasurePanel} Reference to this in order to allow method chaining
removeAllAvailableChartTypes(): sap.ui.core.Item[]
Removes all the controls from the aggregation availableChartTypes.

Additionally, it unregisters them from the hosting UIArea.

Since:
1.34.0
Returns:
{sap.ui.core.Item[]} An array of the removed elements (might be empty)
removeAllDimMeasureItems(): sap.m.P13nDimMeasureItem[]
Removes all the controls from the aggregation dimMeasureItems.

Additionally, it unregisters them from the hosting UIArea.

Since:
1.34.0
Returns:
{sap.m.P13nDimMeasureItem[]} An array of the removed elements (might be empty)
removeAvailableChartType(vAvailableChartType): sap.ui.core.Item
Removes a availableChartType from the aggregation availableChartTypes.
Parameters:
{int|string|sap.ui.core.Item}vAvailableChartType The availableChartTypeto remove or its index or id
Since:
1.34.0
Returns:
{sap.ui.core.Item} The removed availableChartType or null
removeDimMeasureItem(vDimMeasureItem): sap.m.P13nDimMeasureItem
Removes a dimMeasureItem from the aggregation dimMeasureItems.
Parameters:
{int|string|sap.m.P13nDimMeasureItem}vDimMeasureItem The dimMeasureItemto remove or its index or id
Since:
1.34.0
Returns:
{sap.m.P13nDimMeasureItem} The removed dimMeasureItem or null
setChartTypeKey(sChartTypeKey): sap.m.P13nDimMeasurePanel
Sets a new value for property chartTypeKey.

Specifies a chart type key.

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

Default value is .

Parameters:
{string}sChartTypeKey New value for property chartTypeKey
Since:
1.34.0
Returns:
{sap.m.P13nDimMeasurePanel} Reference to this in order to allow method chaining
unbindDimMeasureItems(): sap.m.P13nDimMeasurePanel
Unbinds aggregation dimMeasureItems from model data.
Since:
1.34.0
Returns:
{sap.m.P13nDimMeasurePanel} Reference to this in order to allow method chaining