Class sap.suite.ui.commons.DeltaMicroChartModule: sap/suite/ui/commons/DeltaMicroChart

extends Control

This control displays a delta of two values as a chart.

Deprecated API:Since version 1.34. Deprecated. sap.suite.ui.microchart.DeltaMicroChart should be used.

Constructor Summary
new sap.suite.ui.commons.DeltaMicroChart(sId?, mSettings?)Constructor for a new DeltaMicroChart.
Event Summary
press(oControlEvent)The event is fired when the user chooses the delta micro chart.
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.commons.DeltaMicroChart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.DeltaMicroChart with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.DeltaMicroChart.getMetadata()Returns a metadata object for class sap.suite.ui.commons.DeltaMicroChart.
attachPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.DeltaMicroChart.
detachPress(fnFunction, oListener)Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.DeltaMicroChart.
firePress(mArguments?)Fire event press to attached listeners.
getColor()Getter for property color.
getDeltaDisplayValue()Getter for property deltaDisplayValue.
getDisplayValue1()Getter for property displayValue1.
getDisplayValue2()Getter for property displayValue2.
getSize()Getter for property size.
getTitle1()Getter for property title1.
getTitle2()Getter for property title2.
getValue1()Getter for property value1.
getValue2()Getter for property value2.
getWidth()Getter for property width.
setColor(oColor)Setter for property color.
setDeltaDisplayValue(sDeltaDisplayValue)Setter for property deltaDisplayValue.
setDisplayValue1(sDisplayValue1)Setter for property displayValue1.
setDisplayValue2(sDisplayValue2)Setter for property displayValue2.
setSize(oSize)Setter for property size.
setTitle1(sTitle1)Setter for property title1.
setTitle2(sTitle2)Setter for property title2.
setValue1(fValue1)Setter for property value1.
setValue2(fValue2)Setter for property value2.
setWidth(sWidth)Setter for property width.
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.commons.DeltaMicroChart(sId?, mSettings?)
Constructor for a new DeltaMicroChart.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).

The supported settings are:

  • Properties
  • Aggregations
    • Associations
      • Events
        • press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
      Parameters:
      {string}sId? id for the new control, generated automatically if no id is given
      {object}mSettings? initial settings for the new control
      Deprecated:
      Since version 1.34. Deprecated. sap.suite.ui.microchart.DeltaMicroChart should be used.
      Event Detail
      press(oControlEvent)
      The event is fired when the user chooses the delta micro chart.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      Method Detail
      sap.suite.ui.commons.DeltaMicroChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.suite.ui.commons.DeltaMicroChart with name sClassName and enriches it with the information contained in oClassInfo.

      oClassInfo might contain the same kind of informations as described in Element.extend.

      Parameters:
      {string}sClassName name of the class to be created
      {object}oClassInfo? object literal with informations about the class
      {function}FNMetaImpl? constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata.
      Returns:
      {function} the created class / constructor function
      sap.suite.ui.commons.DeltaMicroChart.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.suite.ui.commons.DeltaMicroChart.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      attachPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.DeltaMicroChart
      Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.DeltaMicroChart.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.DeltaMicroChart.
      itself.

      The event is fired when the user chooses the delta micro chart.

      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 call, when the event occurs.
      {object}oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.commons.DeltaMicroChart.
      itself.
      Returns:
      {sap.suite.ui.commons.DeltaMicroChart}this to allow method chaining
      detachPress(fnFunction, oListener): sap.suite.ui.commons.DeltaMicroChart
      Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.DeltaMicroChart.

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

      Parameters:
      {function}fnFunction The function to call, when the event occurs.
      {object}oListener Context object on which the given function had to be called.
      Returns:
      {sap.suite.ui.commons.DeltaMicroChart}this to allow method chaining
      firePress(mArguments?): sap.suite.ui.commons.DeltaMicroChart
      Fire event press to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.suite.ui.commons.DeltaMicroChart}this to allow method chaining
      getColor(): sap.suite.ui.commons.InfoTileValueColor
      Getter for property color. The semantic color of the delta value.

      Default value is Neutral

      Returns:
      {sap.suite.ui.commons.InfoTileValueColor} the value of property color
      getDeltaDisplayValue(): string
      Getter for property deltaDisplayValue. If this property is set, it is rendered instead of a calculated delta.

      Default value is empty/undefined

      Returns:
      {string} the value of property deltaDisplayValue
      getDisplayValue1(): string
      Getter for property displayValue1. If this property is set, it is rendered instead of value1.

      Default value is empty/undefined

      Returns:
      {string} the value of property displayValue1
      getDisplayValue2(): string
      Getter for property displayValue2. If this property is set, it is rendered instead of value2.

      Default value is empty/undefined

      Returns:
      {string} the value of property displayValue2
      getSize(): sap.suite.ui.commons.InfoTileSize
      Getter for property size. The size of the chart. If is not set, the default size is applied based on the device type.

      Default value is Auto

      Returns:
      {sap.suite.ui.commons.InfoTileSize} the value of property size
      getTitle1(): string
      Getter for property title1. The first value title.

      Default value is empty/undefined

      Returns:
      {string} the value of property title1
      getTitle2(): string
      Getter for property title2. The second value title.

      Default value is empty/undefined

      Returns:
      {string} the value of property title2
      getValue1(): float
      Getter for property value1. The first value for delta calculation.

      Default value is empty/undefined

      Returns:
      {float} the value of property value1
      getValue2(): float
      Getter for property value2. The second value for delta calculation.

      Default value is empty/undefined

      Returns:
      {float} the value of property value2
      getWidth(): sap.ui.core.CSSSize
      Getter for property width. The width of the chart.

      Default value is empty/undefined

      Returns:
      {sap.ui.core.CSSSize} the value of property width
      setColor(oColor): sap.suite.ui.commons.DeltaMicroChart
      Setter for property color.

      Default value is Neutral

      Parameters:
      {sap.suite.ui.commons.InfoTileValueColor}oColor new value for property color
      Returns:
      {sap.suite.ui.commons.DeltaMicroChart}this to allow method chaining
      setDeltaDisplayValue(sDeltaDisplayValue): sap.suite.ui.commons.DeltaMicroChart
      Setter for property deltaDisplayValue.

      Default value is empty/undefined

      Parameters:
      {string}sDeltaDisplayValue new value for property deltaDisplayValue
      Returns:
      {sap.suite.ui.commons.DeltaMicroChart}this to allow method chaining
      setDisplayValue1(sDisplayValue1): sap.suite.ui.commons.DeltaMicroChart
      Setter for property displayValue1.

      Default value is empty/undefined

      Parameters:
      {string}sDisplayValue1 new value for property displayValue1
      Returns:
      {sap.suite.ui.commons.DeltaMicroChart}this to allow method chaining
      setDisplayValue2(sDisplayValue2): sap.suite.ui.commons.DeltaMicroChart
      Setter for property displayValue2.

      Default value is empty/undefined

      Parameters:
      {string}sDisplayValue2 new value for property displayValue2
      Returns:
      {sap.suite.ui.commons.DeltaMicroChart}this to allow method chaining
      setSize(oSize): sap.suite.ui.commons.DeltaMicroChart
      Setter for property size.

      Default value is Auto

      Parameters:
      {sap.suite.ui.commons.InfoTileSize}oSize new value for property size
      Returns:
      {sap.suite.ui.commons.DeltaMicroChart}this to allow method chaining
      setTitle1(sTitle1): sap.suite.ui.commons.DeltaMicroChart
      Setter for property title1.

      Default value is empty/undefined

      Parameters:
      {string}sTitle1 new value for property title1
      Returns:
      {sap.suite.ui.commons.DeltaMicroChart}this to allow method chaining
      setTitle2(sTitle2): sap.suite.ui.commons.DeltaMicroChart
      Setter for property title2.

      Default value is empty/undefined

      Parameters:
      {string}sTitle2 new value for property title2
      Returns:
      {sap.suite.ui.commons.DeltaMicroChart}this to allow method chaining
      setValue1(fValue1): sap.suite.ui.commons.DeltaMicroChart
      Setter for property value1.

      Default value is empty/undefined

      Parameters:
      {float}fValue1 new value for property value1
      Returns:
      {sap.suite.ui.commons.DeltaMicroChart}this to allow method chaining
      setValue2(fValue2): sap.suite.ui.commons.DeltaMicroChart
      Setter for property value2.

      Default value is empty/undefined

      Parameters:
      {float}fValue2 new value for property value2
      Returns:
      {sap.suite.ui.commons.DeltaMicroChart}this to allow method chaining
      setWidth(sWidth): sap.suite.ui.commons.DeltaMicroChart
      Setter for property width.

      Default value is empty/undefined

      Parameters:
      {sap.ui.core.CSSSize}sWidth new value for property width
      Returns:
      {sap.suite.ui.commons.DeltaMicroChart}this to allow method chaining