Class sap.suite.ui.microchart.ColumnMicroChartDataModule: sap/suite/ui/microchart/ColumnMicroChartData

extends Control

Defines the column chart data.


Since: 1.34.
Constructor Summary
new sap.suite.ui.microchart.ColumnMicroChartData(sId?, mSettings?)Constructor for a new ColumnMicroChartData control.
Event Summary
press(oControlEvent)The event is fired when the user chooses the column data.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.suite.ui.microchart.ColumnMicroChartData.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.microchart.ColumnMicroChartData with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.microchart.ColumnMicroChartData.getMetadata()Returns a metadata object for class sap.suite.ui.microchart.ColumnMicroChartData.
attachPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the press event of this sap.suite.ui.microchart.ColumnMicroChartData.
detachPress(fnFunction, oListener)Detaches event handler fnFunction from the press event of this sap.suite.ui.microchart.ColumnMicroChartData.
firePress(mArguments?)Fires event press to attached listeners.
getColor()Gets current value of property color.
getLabel()Gets current value of property label.
getValue()Gets current value of property value.
setColor(sColor)Sets a new value for property color.
setLabel(sLabel)Sets a new value for property label.
setValue(fValue)Sets a new value for property value.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, 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, 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, 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.suite.ui.microchart.ColumnMicroChartData(sId?, mSettings?)
Constructor for a new ColumnMicroChartData control.

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
    • color : sap.m.ValueColor (default: Neutral)
    • label : string (default: )
    • value : float
  • Events
    • press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Control 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
Event Detail
press(oControlEvent)
The event is fired when the user chooses the column data.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.suite.ui.microchart.ColumnMicroChartData.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.microchart.ColumnMicroChartData 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.

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.suite.ui.microchart.ColumnMicroChartData.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.suite.ui.microchart.ColumnMicroChartData.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachPress(oData?, fnFunction, oListener?): sap.suite.ui.microchart.ColumnMicroChartData
Attaches event handler fnFunction to the press event of this sap.suite.ui.microchart.ColumnMicroChartData.

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.suite.ui.microchart.ColumnMicroChartData itself.

The event is fired when the user chooses the column data.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.microchart.ColumnMicroChartData itself
Returns:
{sap.suite.ui.microchart.ColumnMicroChartData} Reference to this in order to allow method chaining
detachPress(fnFunction, oListener): sap.suite.ui.microchart.ColumnMicroChartData
Detaches event handler fnFunction from the press event of this sap.suite.ui.microchart.ColumnMicroChartData.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.suite.ui.microchart.ColumnMicroChartData} Reference to this in order to allow method chaining
firePress(mArguments?): sap.suite.ui.microchart.ColumnMicroChartData
Fires event press to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.suite.ui.microchart.ColumnMicroChartData} Reference to this in order to allow method chaining
getColor(): sap.m.ValueColor
Gets current value of property color.

The graphic element color.

Default value is Neutral.

Returns:
{sap.m.ValueColor} Value of property color
getLabel(): string
Gets current value of property label.

The line title.

Default value is .

Returns:
{string} Value of property label
getValue(): float
Gets current value of property value.

The actual value.

Returns:
{float} Value of property value
setColor(sColor): sap.suite.ui.microchart.ColumnMicroChartData
Sets a new value for property color.

The graphic element color.

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

Default value is Neutral.

Parameters:
{sap.m.ValueColor}sColor New value for property color
Returns:
{sap.suite.ui.microchart.ColumnMicroChartData} Reference to this in order to allow method chaining
setLabel(sLabel): sap.suite.ui.microchart.ColumnMicroChartData
Sets a new value for property label.

The line title.

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

Default value is .

Parameters:
{string}sLabel New value for property label
Returns:
{sap.suite.ui.microchart.ColumnMicroChartData} Reference to this in order to allow method chaining
setValue(fValue): sap.suite.ui.microchart.ColumnMicroChartData
Sets a new value for property value.

The actual value.

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

Parameters:
{float}fValue New value for property value
Returns:
{sap.suite.ui.microchart.ColumnMicroChartData} Reference to this in order to allow method chaining