class sap.f.cards.NumericSideIndicator

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/f/cards/NumericSideIndicator
Application Component: CA-UI5-CTR

Holds a set of side indicator attributes used in the sap.f.cards.NumericHeader control.


Constructor

Constructor for a new NumericSideIndicator.

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.f.cards.NumericSideIndicator(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
number string

The numeric value

Visibility: public
state sap.m.ValueColor None

The semantic color which represents the state of the side indicator.

Visibility: public
title string

The title of the indicator

Visibility: public
unit string

Defines the unit of measurement (scaling prefix) for the numeric value

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
_number 0..1 sap.m.Text

Used to display the number part of the indicator

_title 0..1 sap.m.Text

Used to display title

_unit 0..1 sap.m.Text

Used to display the unit of measurement for the number


Methods Overview

Method Description
sap.f.cards.NumericSideIndicator.extend

Creates a new subclass of class sap.f.cards.NumericSideIndicator 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.Control.extend.

sap.f.cards.NumericSideIndicator.getMetadata

Returns a metadata object for class sap.f.cards.NumericSideIndicator.

getNumber

Gets current value of property number.

The numeric value

getState

Gets current value of property state.

The semantic color which represents the state of the side indicator.

Default value is "None".

getTitle

Gets current value of property title.

The title of the indicator

getUnit

Gets current value of property unit.

Defines the unit of measurement (scaling prefix) for the numeric value

setNumber

Sets the numeric value.

setState

Sets a new value for property state.

The semantic color which represents the state of the side indicator.

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

Default value is "None".

setTitle

Sets the title.

setUnit

Sets the unit of measurement.

sap.f.cards.NumericSideIndicator.extend

Creates a new subclass of class sap.f.cards.NumericSideIndicator 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.Control.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

sap.f.cards.NumericSideIndicator.getMetadata

Returns a metadata object for class sap.f.cards.NumericSideIndicator.

getNumber

Gets current value of property number.

The numeric value

getState

Gets current value of property state.

The semantic color which represents the state of the side indicator.

Default value is "None".

getTitle

Gets current value of property title.

The title of the indicator

getUnit

Gets current value of property unit.

Defines the unit of measurement (scaling prefix) for the numeric value

setNumber

Sets the numeric value.

Param Type DefaultValue Description
sValue string

The text of the title

setState

Sets a new value for property state.

The semantic color which represents the state of the side indicator.

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

Default value is "None".

Param Type DefaultValue Description
sState sap.m.ValueColor "None"

New value for property state

setTitle

Sets the title.

Param Type DefaultValue Description
sValue string

The text of the title

setUnit

Sets the unit of measurement.

Param Type DefaultValue Description
sValue string

The text of the title