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.
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#constructor for a general description of the syntax of the settings object.
new sap.m.P13nDimMeasurePanel(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | id for the new control, generated automatically if no id is given |
|
mSettings? | object | initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
changeNotifier | object | Callback which notifies a change on this panel. Visibility: public |
|
title | string | Title text appears in the panel. Visibility: public |
|
titleLarge | string | Large title text appears e.g. in dialog header in case that only one panel is shown. |
|
type | string | Panel type for generic use. Due to extensibility reason the type of |
|
validationExecutor | object | Callback method which is called in order to validate end user entry. Visibility: public |
|
validationListener | object | Callback method which is called in order to register for validation result. Visibility: public |
|
verticalScrolling | boolean | true | Enables the vertical Scrolling on the |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
availableChartTypes | 0..n | sap.ui.core.Item |
Specifies available chart types. |
content | 0..n | sap.ui.core.Control |
Internal aggregation for the toolbar content. |
dimMeasureItems | 0..n | sap.m.P13nDimMeasureItem |
List of columns that has been changed. |
Name | Cardinality | Type | Description |
---|---|---|---|
items | 0..n | sap.m.P13nItem |
Defines personalization items (e.g. columns in the |
Event | Description |
---|---|
changeChartType |
Event raised when a |
changeDimMeasureItems |
Event raised when one or more |
Method | Description |
---|---|
addAvailableChartType |
Adds some availableChartType to the aggregation availableChartTypes. |
addDimMeasureItem |
Adds some dimMeasureItem to the aggregation dimMeasureItems. |
attachChangeChartType |
Attaches event handler When called, the context of the event handler (its Event raised when a |
attachChangeDimMeasureItems |
Attaches event handler When called, the context of the event handler (its Event raised when one or more |
bindDimMeasureItems |
Binds aggregation dimMeasureItems to model data. See ManagedObject.bindAggregation for a detailed description of the possible properties of |
destroyAvailableChartTypes |
Destroys all the availableChartTypes in the aggregation availableChartTypes. |
destroyDimMeasureItems |
Destroys all the dimMeasureItems in the aggregation dimMeasureItems. |
detachChangeChartType |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachChangeDimMeasureItems |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.m.P13nDimMeasurePanel.extend |
Creates a new subclass of class sap.m.P13nDimMeasurePanel with name
|
fireChangeChartType |
Fires event changeChartType to attached listeners. |
fireChangeDimMeasureItems |
Fires event changeDimMeasureItems to attached listeners. |
getAvailableChartTypes |
Gets content of aggregation availableChartTypes. Specifies available chart types. |
getChartTypeKey |
Gets current value of property chartTypeKey. Specifies a chart type key. Default value is |
getDimMeasureItems |
Gets content of aggregation dimMeasureItems. List of columns that has been changed. |
sap.m.P13nDimMeasurePanel.getMetadata |
Returns a metadata object for class sap.m.P13nDimMeasurePanel. |
indexOfAvailableChartType |
Checks for the provided |
indexOfDimMeasureItem |
Checks for the provided |
insertAvailableChartType |
Inserts a availableChartType into the aggregation availableChartTypes. |
insertDimMeasureItem |
Inserts a dimMeasureItem into the aggregation dimMeasureItems. |
removeAllAvailableChartTypes |
Removes all the controls from the aggregation availableChartTypes. Additionally, it unregisters them from the hosting UIArea. |
removeAllDimMeasureItems |
Removes all the controls from the aggregation dimMeasureItems. Additionally, it unregisters them from the hosting UIArea. |
removeAvailableChartType |
Removes a availableChartType from the aggregation availableChartTypes. |
removeDimMeasureItem |
Removes a dimMeasureItem from the aggregation dimMeasureItems. |
setChartTypeKey |
Sets a new value for property chartTypeKey. Specifies a chart type key. When called with a value of Default value is |
unbindDimMeasureItems |
Unbinds aggregation dimMeasureItems from model data. |
Adds some availableChartType to the aggregation availableChartTypes.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAvailableChartType | sap.ui.core.Item |
The availableChartType to add; if empty, nothing is inserted |
Adds some dimMeasureItem to the aggregation dimMeasureItems.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDimMeasureItem | sap.m.P13nDimMeasureItem |
The dimMeasureItem to add; if empty, nothing is inserted |
Attaches event handler fnFunction
to the changeChartType event of this sap.m.P13nDimMeasurePanel
.
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.m.P13nDimMeasurePanel
itself.
Event raised when a ChartType
has been updated.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the changeDimMeasureItems event of this sap.m.P13nDimMeasurePanel
.
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.m.P13nDimMeasurePanel
itself.
Event raised when one or more DimMeasureItems
has been updated. Aggregation DimMeasureItems
should be updated outside...
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Binds aggregation dimMeasureItems to model data.
See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo
.
Param | Type | DefaultValue | Description |
---|---|---|---|
oBindingInfo | sap.ui.base.ManagedObject.AggregationBindingInfo |
The binding information |
Destroys all the availableChartTypes in the aggregation availableChartTypes.
Detaches event handler fnFunction
from the changeChartType event of this sap.m.P13nDimMeasurePanel
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the changeDimMeasureItems event of this sap.m.P13nDimMeasurePanel
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Fires event changeChartType to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event changeDimMeasureItems to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Gets content of aggregation availableChartTypes.
Specifies available chart types.
Gets current value of property chartTypeKey.
Specifies a chart type key.
Default value is empty string
.
Gets content of aggregation dimMeasureItems.
List of columns that has been changed.
Returns a metadata object for class sap.m.P13nDimMeasurePanel.
Checks for the provided sap.ui.core.Item
in the aggregation availableChartTypes. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAvailableChartType | sap.ui.core.Item |
The availableChartType whose index is looked for |
Checks for the provided sap.m.P13nDimMeasureItem
in the aggregation dimMeasureItems. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDimMeasureItem | sap.m.P13nDimMeasureItem |
The dimMeasureItem whose index is looked for |
Inserts a availableChartType into the aggregation availableChartTypes.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAvailableChartType | sap.ui.core.Item |
The availableChartType to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a dimMeasureItem into the aggregation dimMeasureItems.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDimMeasureItem | sap.m.P13nDimMeasureItem |
The dimMeasureItem to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation availableChartTypes.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation dimMeasureItems.
Additionally, it unregisters them from the hosting UIArea.
Removes a availableChartType from the aggregation availableChartTypes.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAvailableChartType | int string sap.ui.core.Item |
The availableChartType to remove or its index or id |
Removes a dimMeasureItem from the aggregation dimMeasureItems.
Param | Type | DefaultValue | Description |
---|---|---|---|
vDimMeasureItem | int string sap.m.P13nDimMeasureItem |
The dimMeasureItem to remove or its index or id |
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 empty string
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sChartTypeKey | string | "" |
New value for property |