Class sap.suite.ui.commons.MicroAreaChartItemModule: sap/suite/ui/commons/MicroAreaChartItem

extends Element

The configuration of the graphic element on the chart.

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

Constructor Summary
new sap.suite.ui.commons.MicroAreaChartItem(sId?, mSettings?)Constructor for a new MicroAreaChartItem.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.suite.ui.commons.MicroAreaChartItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.MicroAreaChartItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.MicroAreaChartItem.getMetadata()Returns a metadata object for class sap.suite.ui.commons.MicroAreaChartItem.
addPoint(oPoint)Adds some point oPoint to the aggregation named points.
bindPoints(sPath, oTemplate, oSorter, aFilters)Binder for aggregation points.
destroyPoints()Destroys all the points in the aggregation named points.
getColor()Getter for property color.
getPoints()Getter for aggregation points.
getTitle()Getter for property title.
indexOfPoint(oPoint)Checks for the provided sap.suite.ui.commons.MicroAreaChartPoint in the aggregation named points and returns its index if found or -1 otherwise.
insertPoint(oPoint, iIndex)Inserts a point into the aggregation named points.
removeAllPoints()Removes all the controls in the aggregation named points.
removePoint(vPoint)Removes an point from the aggregation named points.
setColor(oColor)Setter for property color.
setTitle(sTitle)Setter for property title.
unbindPoints()Unbinder for aggregation points.
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.suite.ui.commons.MicroAreaChartItem(sId?, mSettings?)
Constructor for a new MicroAreaChartItem.

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
    • color : sap.suite.ui.commons.InfoTileValueColor (default: sap.suite.ui.commons.InfoTileValueColor.Neutral)
    • title : string
  • Aggregations
    • points : sap.suite.ui.commons.MicroAreaChartPoint[]
  • Associations
    • Events

      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
      Deprecated:
      Since version 1.34. Deprecated. sap.suite.ui.microchart.AreaMicroChartItem should be used.
      Method Detail
      sap.suite.ui.commons.MicroAreaChartItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.suite.ui.commons.MicroAreaChartItem 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.MicroAreaChartItem.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.suite.ui.commons.MicroAreaChartItem.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      addPoint(oPoint): sap.suite.ui.commons.MicroAreaChartItem
      Adds some point oPoint to the aggregation named points.
      Parameters:
      {sap.suite.ui.commons.MicroAreaChartPoint}oPoint the point to add; if empty, nothing is inserted
      Returns:
      {sap.suite.ui.commons.MicroAreaChartItem}this to allow method chaining
      bindPoints(sPath, oTemplate, oSorter, aFilters): sap.suite.ui.commons.MicroAreaChartItem
      Binder for aggregation points.
      Parameters:
      {string}sPath path to a list in the model
      {sap.ui.core.Element}oTemplate the control template for this aggregation
      {sap.ui.model.Sorter}oSorter the initial sort order (optional)
      {array}aFilters the predefined filters for this aggregation (optional)
      Returns:
      {sap.suite.ui.commons.MicroAreaChartItem}this to allow method chaining
      destroyPoints(): sap.suite.ui.commons.MicroAreaChartItem
      Destroys all the points in the aggregation named points.
      Returns:
      {sap.suite.ui.commons.MicroAreaChartItem}this to allow method chaining
      getColor(): sap.suite.ui.commons.InfoTileValueColor
      Getter for property color. The graphic element color.

      Default value is Neutral

      Returns:
      {sap.suite.ui.commons.InfoTileValueColor} the value of property color
      getPoints(): sap.suite.ui.commons.MicroAreaChartPoint[]
      Getter for aggregation points.
      The set of points for this graphic element.
      Returns:
      {sap.suite.ui.commons.MicroAreaChartPoint[]}
      getTitle(): string
      Getter for property title. The line title.

      Default value is empty/undefined

      Since:
      1.29
      Returns:
      {string} the value of property title
      indexOfPoint(oPoint): int
      Checks for the provided sap.suite.ui.commons.MicroAreaChartPoint in the aggregation named points and returns its index if found or -1 otherwise.
      Parameters:
      {sap.suite.ui.commons.MicroAreaChartPoint}oPoint the point whose index is looked for.
      Returns:
      {int} the index of the provided control in the aggregation if found, or -1 otherwise
      insertPoint(oPoint, iIndex): sap.suite.ui.commons.MicroAreaChartItem
      Inserts a point into the aggregation named points.
      Parameters:
      {sap.suite.ui.commons.MicroAreaChartPoint}oPoint the point to insert; if empty, nothing is inserted
      {int}iIndex the 0-based index the point should be inserted at; for a negative value of iIndex, the point is inserted at position 0; for a value greater than the current size of the aggregation, the point is inserted at the last position
      Returns:
      {sap.suite.ui.commons.MicroAreaChartItem}this to allow method chaining
      removeAllPoints(): sap.suite.ui.commons.MicroAreaChartPoint[]
      Removes all the controls in the aggregation named points.
      Additionally unregisters them from the hosting UIArea.
      Returns:
      {sap.suite.ui.commons.MicroAreaChartPoint[]} an array of the removed elements (might be empty)
      removePoint(vPoint): sap.suite.ui.commons.MicroAreaChartPoint
      Removes an point from the aggregation named points.
      Parameters:
      {int|string|sap.suite.ui.commons.MicroAreaChartPoint}vPoint the point to remove or its index or id
      Returns:
      {sap.suite.ui.commons.MicroAreaChartPoint} the removed point or null
      setColor(oColor): sap.suite.ui.commons.MicroAreaChartItem
      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.MicroAreaChartItem}this to allow method chaining
      setTitle(sTitle): sap.suite.ui.commons.MicroAreaChartItem
      Setter for property title.

      Default value is empty/undefined

      Parameters:
      {string}sTitle new value for property title
      Since:
      1.29
      Returns:
      {sap.suite.ui.commons.MicroAreaChartItem}this to allow method chaining
      unbindPoints(): sap.suite.ui.commons.MicroAreaChartItem
      Unbinder for aggregation points.
      Returns:
      {sap.suite.ui.commons.MicroAreaChartItem}this to allow method chaining