DimensionDefinition

Definition of a single dimension in a dataset

Since: 1.7.2.

Constructor Summary

new sap.viz.ui5.data.DimensionDefinition(sId?, mSettings?)Constructor for a new ui5/data/DimensionDefinition.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.viz.ui5.data.DimensionDefinition.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.data.DimensionDefinition with name sClassName and enriches it with the information contained in oClassInfo.

sap.viz.ui5.data.DimensionDefinition.getMetadata()Returns a metadata object for class sap.viz.ui5.data.DimensionDefinition.

getAxis()Gets current value of property axis.

getDataType()Gets current value of property dataType.

getDisplayValue()Gets current value of property displayValue.

getIdentity()Gets current value of property identity.

getName()Gets current value of property name.

getValue()Gets current value of property value.

setAxis(iAxis)Sets a new value for property axis.

setDataType(sDataType)Sets a new value for property dataType.

setDisplayValue(oDisplayValue)Sets a new value for property displayValue.

setIdentity(sIdentity)Sets a new value for property identity.

setName(sName)Sets a new value for property name.

setValue(oValue)Sets a new value for property value.

Methods borrowed from class sap.ui.core.Element

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.DimensionDefinition(sId?, mSettings?)

Constructor for a new ui5/data/DimensionDefinition.

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:

Properties
- axis : int
- value : any
- name : string
- identity : string
- displayValue : any
- dataType : string

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.DimensionDefinition.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.viz.ui5.data.DimensionDefinition 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.DimensionDefinition.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.viz.ui5.data.DimensionDefinition.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getAxis(): int

Gets current value of property axis.

Number of axis this dimension belongs to. Currently must be 1 or 2. Skip this property when use VizFrame.

Returns:

{int} Value of property axis

getDataType(): string

Gets current value of property dataType.

Data type of the dimension as displayed in the chart. Enumeration: string, number, date. Currently only in time series chart, it is required to set data type to 'date' if this column is going to be fed on 'timeAxis'.

Returns:

{string} Value of property dataType

getDisplayValue(): any

Gets current value of property displayValue.

Display value for the dimension. Usually bound to some model field.

Returns:

{any} Value of property displayValue

getIdentity(): string

Gets current value of property identity.

Id of the dimension as displayed in the chart

Returns:

{string} Value of property identity

getName(): string

Gets current value of property name.

Name of the dimension as displayed in the chart

Returns:

{string} Value of property name

getValue(): any

Gets current value of property value.

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

Returns:

{any} Value of property value

setAxis(iAxis): sap.viz.ui5.data.DimensionDefinition

Sets a new value for property axis.

Number of axis this dimension belongs to. Currently must be 1 or 2. Skip this property when use VizFrame.

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

Parameters:

{int} iAxis New value for property axis

Returns:

{sap.viz.ui5.data.DimensionDefinition} Reference to this in order to allow method chaining

setDataType(sDataType): sap.viz.ui5.data.DimensionDefinition

Sets a new value for property dataType.

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

Parameters:

{string} sDataType New value for property dataType

Returns:

{sap.viz.ui5.data.DimensionDefinition} Reference to this in order to allow method chaining

setDisplayValue(oDisplayValue): sap.viz.ui5.data.DimensionDefinition

Sets a new value for property displayValue.

Display value for the dimension. 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} oDisplayValue New value for property displayValue

Returns:

{sap.viz.ui5.data.DimensionDefinition} Reference to this in order to allow method chaining

setIdentity(sIdentity): sap.viz.ui5.data.DimensionDefinition

Sets a new value for property identity.

Id of the dimension 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.DimensionDefinition} Reference to this in order to allow method chaining

setName(sName): sap.viz.ui5.data.DimensionDefinition

Sets a new value for property name.

Name of the dimension 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.DimensionDefinition} Reference to this in order to allow method chaining

setValue(oValue): sap.viz.ui5.data.DimensionDefinition

Sets a new value for property value.

Value for the dimension. 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.DimensionDefinition} Reference to this in order to allow method chaining