Base type for items
aggregation in P13nPanel
control.
Constructor for a new P13nItem.
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.P13nItem(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 |
---|---|---|---|
aggregationRole | string | Defines aggregation role |
|
columnKey | string | Can be used as input for subsequent actions. Visibility: public |
|
description | string | Defines additional information of the link. |
|
formatSettings | object | A JSON object containing the formatSettings which will be used to pass additional type/format settings for the entered value. if type==time or date or datetime the object will be used for the DateFormatter, TimeFormatter or DateTimeFormatter Below you can find a brief example Visibility: public |
|
href | string | Defines href of a link. |
|
isDefault | boolean | false | the column with isDefault==true will be used as the selected column item on the conditionPanel Visibility: public |
maxLength | string | specifies the number of characters which can be entered in the value fields of the condition panel Visibility: public |
|
nullable | boolean | false | Defines if the item is nullable Visibility: public |
precision | string | if type==numeric the precision will be used to format the entered value (maxIntegerDigits of the used Formatter) Visibility: public |
|
press | object | Defines press handler of a link. |
|
role | string | Defines role. The role is reflected in the manner how the dimension will influence the chart layout. |
|
scale | string | if type==numeric the scale will be used to format the entered value (maxFractionDigits of the used Formatter) Visibility: public |
|
target | string | Defines target of a link. Visibility: public |
|
text | string | empty string | The text to be displayed for the item. Visibility: public |
type | string | text | data type of the column (text, numeric or date is supported) Visibility: public |
typeInstance | object | data type instance of the column. Can be used instead of the type, precision, scale and formatSettings properties Visibility: public |
|
values | string[] | the array of values for type bool. e.g. ["", "Off", "On"]. The first entry can be empty (used to blank the value field). Next value represent the false value, last entry the true value. |
|
visible | boolean | Defines visibility of column Visibility: public |
|
width | string | Defines column width Visibility: public |
Method | Description |
---|---|
sap.m.P13nItem.extend |
Creates a new subclass of class sap.m.P13nItem with name
|
getAggregationRole |
Gets current value of property aggregationRole. Defines aggregation role |
getColumnKey |
Gets current value of property columnKey. Can be used as input for subsequent actions. |
getDescription |
Gets current value of property description. Defines additional information of the link. |
getFormatSettings |
Gets current value of property formatSettings. A JSON object containing the formatSettings which will be used to pass additional type/format settings for the entered value. if type==time or date or datetime the object will be used for the DateFormatter, TimeFormatter or DateTimeFormatter Below you can find a brief example
|
getHref |
Gets current value of property href. Defines href of a link. |
getIsDefault |
Gets current value of property isDefault. the column with isDefault==true will be used as the selected column item on the conditionPanel Default value is |
getMaxLength |
Gets current value of property maxLength. specifies the number of characters which can be entered in the value fields of the condition panel |
sap.m.P13nItem.getMetadata |
Returns a metadata object for class sap.m.P13nItem. |
getNullable |
Gets current value of property nullable. Defines if the item is nullable Default value is |
getPrecision |
Gets current value of property precision. if type==numeric the precision will be used to format the entered value (maxIntegerDigits of the used Formatter) |
getPress |
Gets current value of property press. Defines press handler of a link. |
getRole |
Gets current value of property role. Defines role. The role is reflected in the manner how the dimension will influence the chart layout. |
getScale |
Gets current value of property scale. if type==numeric the scale will be used to format the entered value (maxFractionDigits of the used Formatter) |
getTarget |
Gets current value of property target. Defines target of a link. |
getText |
Gets current value of property text. The text to be displayed for the item. Default value is |
getType |
Gets current value of property type. data type of the column (text, numeric or date is supported) Default value is |
getTypeInstance |
Gets current value of property typeInstance. data type instance of the column. Can be used instead of the type, precision, scale and formatSettings properties |
getValues |
Gets current value of property values. the array of values for type bool. e.g. ["", "Off", "On"]. The first entry can be empty (used to blank the value field). Next value represent the false value, last entry the true value. |
getVisible |
Gets current value of property visible. Defines visibility of column |
getWidth |
Gets current value of property width. Defines column width |
setAggregationRole |
Sets a new value for property aggregationRole. Defines aggregation role When called with a value of |
setColumnKey |
Sets a new value for property columnKey. Can be used as input for subsequent actions. When called with a value of |
setDescription |
Sets a new value for property description. Defines additional information of the link. When called with a value of |
setFormatSettings |
Sets a new value for property formatSettings. A JSON object containing the formatSettings which will be used to pass additional type/format settings for the entered value. if type==time or date or datetime the object will be used for the DateFormatter, TimeFormatter or DateTimeFormatter Below you can find a brief example
When called with a value of |
setHref |
Sets a new value for property href. Defines href of a link. When called with a value of |
setIsDefault |
Sets a new value for property isDefault. the column with isDefault==true will be used as the selected column item on the conditionPanel When called with a value of Default value is |
setMaxLength |
Sets a new value for property maxLength. specifies the number of characters which can be entered in the value fields of the condition panel When called with a value of |
setNullable |
Sets a new value for property nullable. Defines if the item is nullable When called with a value of Default value is |
setPrecision |
Sets a new value for property precision. if type==numeric the precision will be used to format the entered value (maxIntegerDigits of the used Formatter) When called with a value of |
setPress |
Sets a new value for property press. Defines press handler of a link. When called with a value of |
setRole |
Sets a new value for property role. Defines role. The role is reflected in the manner how the dimension will influence the chart layout. When called with a value of |
setScale |
Sets a new value for property scale. if type==numeric the scale will be used to format the entered value (maxFractionDigits of the used Formatter) When called with a value of |
setTarget |
Sets a new value for property target. Defines target of a link. When called with a value of |
setText |
Sets a new value for property text. The text to be displayed for the item. When called with a value of Default value is |
setType |
Sets a new value for property type. data type of the column (text, numeric or date is supported) When called with a value of Default value is |
setTypeInstance |
Sets a new value for property typeInstance. data type instance of the column. Can be used instead of the type, precision, scale and formatSettings properties When called with a value of |
setValues |
Sets a new value for property values. the array of values for type bool. e.g. ["", "Off", "On"]. The first entry can be empty (used to blank the value field). Next value represent the false value, last entry the true value. When called with a value of |
setVisible |
Sets a new value for property visible. Defines visibility of column When called with a value of |
setWidth |
Sets a new value for property width. Defines column width When called with a value of |
Creates a new subclass of class sap.m.P13nItem 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.core.Element.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 |
Gets current value of property description.
Defines additional information of the link.
Gets current value of property formatSettings.
A JSON object containing the formatSettings which will be used to pass additional type/format settings for the entered value. if type==time or date or datetime the object will be used for the DateFormatter, TimeFormatter or DateTimeFormatter
Below you can find a brief example
{
UTC: false,
style: "medium" //"short" or "long"
}
Gets current value of property isDefault.
the column with isDefault==true will be used as the selected column item on the conditionPanel
Default value is false
.
Gets current value of property maxLength.
specifies the number of characters which can be entered in the value fields of the condition panel
Gets current value of property nullable.
Defines if the item is nullable
Default value is false
.
Gets current value of property precision.
if type==numeric the precision will be used to format the entered value (maxIntegerDigits of the used Formatter)
Gets current value of property role.
Defines role. The role is reflected in the manner how the dimension will influence the chart layout.
Gets current value of property scale.
if type==numeric the scale will be used to format the entered value (maxFractionDigits of the used Formatter)
Gets current value of property text.
The text to be displayed for the item.
Default value is empty string
.
Gets current value of property type.
data type of the column (text, numeric or date is supported)
Default value is "text"
.
Gets current value of property typeInstance.
data type instance of the column. Can be used instead of the type, precision, scale and formatSettings properties
Gets current value of property values.
the array of values for type bool. e.g. ["", "Off", "On"]. The first entry can be empty (used to blank the value field). Next value represent the false value, last entry the true value.
Sets a new value for property aggregationRole.
Defines aggregation role
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sAggregationRole | string |
New value for property |
Sets a new value for property columnKey.
Can be used as input for subsequent actions.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sColumnKey | string |
New value for property |
Sets a new value for property description.
Defines additional information of the link.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sDescription | string |
New value for property |
Sets a new value for property formatSettings.
A JSON object containing the formatSettings which will be used to pass additional type/format settings for the entered value. if type==time or date or datetime the object will be used for the DateFormatter, TimeFormatter or DateTimeFormatter
Below you can find a brief example
{
UTC: false,
style: "medium" //"short" or "long"
}
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFormatSettings | object |
New value for property |
Sets a new value for property href.
Defines href of a link.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sHref | string |
New value for property |
Sets a new value for property isDefault.
the column with isDefault==true will be used as the selected column item on the conditionPanel
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bIsDefault | boolean | false |
New value for property |
Sets a new value for property maxLength.
specifies the number of characters which can be entered in the value fields of the condition panel
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sMaxLength | string |
New value for property |
Sets a new value for property nullable.
Defines if the item is nullable
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bNullable | boolean | false |
New value for property |
Sets a new value for property precision.
if type==numeric the precision will be used to format the entered value (maxIntegerDigits of the used Formatter)
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sPrecision | string |
New value for property |
Sets a new value for property press.
Defines press handler of a link.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPress | object |
New value for property |
Sets a new value for property role.
Defines role. The role is reflected in the manner how the dimension will influence the chart layout.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sRole | string |
New value for property |
Sets a new value for property scale.
if type==numeric the scale will be used to format the entered value (maxFractionDigits of the used Formatter)
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sScale | string |
New value for property |
Sets a new value for property target.
Defines target of a link.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTarget | string |
New value for property |
Sets a new value for property text.
The text to be displayed for the item.
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 |
---|---|---|---|
sText | string | "" |
New value for property |
Sets a new value for property type.
data type of the column (text, numeric or date is supported)
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is "text"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sType | string | "text" |
New value for property |
Sets a new value for property typeInstance.
data type instance of the column. Can be used instead of the type, precision, scale and formatSettings properties
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oTypeInstance | object |
New value for property |
Sets a new value for property values.
the array of values for type bool. e.g. ["", "Off", "On"]. The first entry can be empty (used to blank the value field). Next value represent the false value, last entry the true value.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sValues | string[] |
New value for property |
Sets a new value for property visible.
Defines visibility of column
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
bVisible | boolean |
New value for property |
Sets a new value for property width.
Defines column width
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sWidth | string |
New value for property |