class sap.m.P13nDimMeasurePanel

Control sample: sap.m.P13nDimMeasurePanel
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Extends: sap.m.P13nPanel
Module: sap/m/P13nDimMeasurePanel
Application Component: CA-UI5-CTR

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

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


Properties

Name Type Default Value Description
chartTypeKey string empty string

Specifies a chart type key.

Visibility: public

Borrowed Properties

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.

Since: 1.30.0.

Visibility: public
type string

Panel type for generic use. Due to extensibility reason the type of type property should be string. So it is feasible to add a custom panel without expanding the type.

Visibility: public
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 P13nDialog when the panel is shown.

Visibility: public

Aggregations

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.

Borrowed Aggregations

Name Cardinality Type Description
items 0..n sap.m.P13nItem

Defines personalization items (e.g. columns in the P13nColumnsPanel).


Events Overview

Event Description
changeChartType

Event raised when a ChartType has been updated.

Since: 1.50.0.

changeDimMeasureItems

Event raised when one or more DimMeasureItems has been updated. Aggregation DimMeasureItems should be updated outside...

Since: 1.50.0.

changeChartType

Event raised when a ChartType has been updated.

Since: 1.50.0.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

changeDimMeasureItems

Event raised when one or more DimMeasureItems has been updated. Aggregation DimMeasureItems should be updated outside...

Since: 1.50.0.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

Methods Overview

Method Description
addAvailableChartType

Adds some availableChartType to the aggregation availableChartTypes.

addDimMeasureItem

Adds some dimMeasureItem to the aggregation dimMeasureItems.

attachChangeChartType

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.

attachChangeDimMeasureItems

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

bindDimMeasureItems

Binds aggregation dimMeasureItems to model data.

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

destroyAvailableChartTypes

Destroys all the availableChartTypes in the aggregation availableChartTypes.

destroyDimMeasureItems

Destroys all the dimMeasureItems in the aggregation dimMeasureItems.

detachChangeChartType

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.

detachChangeDimMeasureItems

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.

sap.m.P13nDimMeasurePanel.extend

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.

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 empty string.

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 sap.ui.core.Item in the aggregation availableChartTypes. and returns its index if found or -1 otherwise.

indexOfDimMeasureItem

Checks for the provided sap.m.P13nDimMeasureItem in the aggregation dimMeasureItems. and returns its index if found or -1 otherwise.

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 null or undefined, the default value of the property will be restored.

Default value is empty string.

unbindDimMeasureItems

Unbinds aggregation dimMeasureItems from model data.

addAvailableChartType

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

addDimMeasureItem

Adds some dimMeasureItem to the aggregation dimMeasureItems.

Param Type DefaultValue Description
oDimMeasureItem sap.m.P13nDimMeasureItem

The dimMeasureItem to add; if empty, nothing is inserted

attachChangeChartType

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 sap.m.P13nDimMeasurePanel itself

attachChangeDimMeasureItems

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 sap.m.P13nDimMeasurePanel itself

bindDimMeasureItems

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

destroyAvailableChartTypes

Destroys all the availableChartTypes in the aggregation availableChartTypes.

destroyDimMeasureItems

Destroys all the dimMeasureItems in the aggregation dimMeasureItems.

detachChangeChartType

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

detachChangeDimMeasureItems

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

sap.m.P13nDimMeasurePanel.extend

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

fireChangeChartType

Fires event changeChartType to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireChangeDimMeasureItems

Fires event changeDimMeasureItems to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

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 empty string.

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

indexOfDimMeasureItem

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

insertAvailableChartType

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

insertDimMeasureItem

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

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.

Param Type DefaultValue Description
vAvailableChartType int string sap.ui.core.Item

The availableChartType to remove or its index or id

removeDimMeasureItem

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

setChartTypeKey

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 chartTypeKey

unbindDimMeasureItems

Unbinds aggregation dimMeasureItems from model data.