Class sap.viz.ui5.data.MeasureDefinitionModule: sap/viz/ui5/data/MeasureDefinition

extends Element

Definition of a single Measure


Since: 1.7.2.
Constructor Summary
new sap.viz.ui5.data.MeasureDefinition(sId?, mSettings?)Constructor for a new ui5/data/MeasureDefinition.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.viz.ui5.data.MeasureDefinition.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.data.MeasureDefinition with name sClassName and enriches it with the information contained in oClassInfo.
sap.viz.ui5.data.MeasureDefinition.getMetadata()Returns a metadata object for class sap.viz.ui5.data.MeasureDefinition.
getFormat()Gets current value of property format.
getGroup()Gets current value of property group.
getIdentity()Gets current value of property identity.
getName()Gets current value of property name.
getRange()Gets current value of property range.
getValue()Gets current value of property value.
setFormat(oFormat)Sets a new value for property format.
setGroup(iGroup)Sets a new value for property group.
setIdentity(sIdentity)Sets a new value for property identity.
setName(sName)Sets a new value for property name.
setRange(sRange)Sets a new value for property range.
setValue(oValue)Sets a new value for property value.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, 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, rerender, 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, invalidate, 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.viz.ui5.data.MeasureDefinition(sId?, mSettings?)
Constructor for a new ui5/data/MeasureDefinition.

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.ui.core.Element 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.viz.ui5.data.MeasureDefinition.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.viz.ui5.data.MeasureDefinition 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.

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.viz.ui5.data.MeasureDefinition.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.viz.ui5.data.MeasureDefinition.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getFormat(): any
Gets current value of property format.

Format pattern for values of the measure

Returns:
{any} Value of property format
getGroup(): int
Gets current value of property group.

Measure group this measure belongs to. Order is significant, number should start from 1. Skip this property when use VizFrame.

Default value is 1.

Returns:
{int} Value of property group
getIdentity(): string
Gets current value of property identity.

Id of the measure as displayed in the chart

Returns:
{string} Value of property identity
getName(): string
Gets current value of property name.

Name of the measure as displayed in the chart

Returns:
{string} Value of property name
getRange(): any[]
Gets current value of property range.

Value range

Default value is [].

Returns:
{any[]} Value of property range
getValue(): any
Gets current value of property value.

Value for the measure. Usually bound to some model field.

Returns:
{any} Value of property value
setFormat(oFormat): sap.viz.ui5.data.MeasureDefinition
Sets a new value for property format.

Format pattern for values of the measure

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

Parameters:
{any}oFormat New value for property format
Returns:
{sap.viz.ui5.data.MeasureDefinition} Reference to this in order to allow method chaining
setGroup(iGroup): sap.viz.ui5.data.MeasureDefinition
Sets a new value for property group.

Measure group this measure belongs to. Order is significant, number should start from 1. Skip this property when use VizFrame.

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

Default value is 1.

Parameters:
{int}iGroup New value for property group
Returns:
{sap.viz.ui5.data.MeasureDefinition} Reference to this in order to allow method chaining
setIdentity(sIdentity): sap.viz.ui5.data.MeasureDefinition
Sets a new value for property identity.

Id of the measure as displayed in the chart

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

Parameters:
{string}sIdentity New value for property identity
Returns:
{sap.viz.ui5.data.MeasureDefinition} Reference to this in order to allow method chaining
setName(sName): sap.viz.ui5.data.MeasureDefinition
Sets a new value for property name.

Name of the measure as displayed in the chart

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

Parameters:
{string}sName New value for property name
Returns:
{sap.viz.ui5.data.MeasureDefinition} Reference to this in order to allow method chaining
setRange(sRange): sap.viz.ui5.data.MeasureDefinition
Sets a new value for property range.

Value range

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

Default value is [].

Parameters:
{any[]}sRange New value for property range
Returns:
{sap.viz.ui5.data.MeasureDefinition} Reference to this in order to allow method chaining
setValue(oValue): sap.viz.ui5.data.MeasureDefinition
Sets a new value for property value.

Value for the measure. Usually bound to some model field.

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

Parameters:
{any}oValue New value for property value
Returns:
{sap.viz.ui5.data.MeasureDefinition} Reference to this in order to allow method chaining