Class sap.suite.ui.microchart.AreaMicroChartItemModule: sap/suite/ui/microchart/AreaMicroChartItem

extends Control

Graphical representation of the area micro chart regarding the value lines, the thresholds, and the target values.


Since: 1.34.
Constructor Summary
new sap.suite.ui.microchart.AreaMicroChartItem(sId?, mSettings?)The configuration of the graphic element on the 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.microchart.AreaMicroChartItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.microchart.AreaMicroChartItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.microchart.AreaMicroChartItem.getMetadata()Returns a metadata object for class sap.suite.ui.microchart.AreaMicroChartItem.
addPoint(oPoint)Adds some point to the aggregation points.
bindPoints(oBindingInfo)Binds aggregation points to model data.
destroyPoints()Destroys all the points in the aggregation points.
getColor()Gets current value of property color.
getPoints()Gets content of aggregation points.
getTitle()Gets current value of property title.
indexOfPoint(oPoint)Checks for the provided sap.suite.ui.microchart.AreaMicroChartPoint in the aggregation points.
insertPoint(oPoint, iIndex)Inserts a point into the aggregation points.
removeAllPoints()Removes all the controls from the aggregation points.
removePoint(vPoint)Removes a point from the aggregation points.
setColor(sColor)Sets a new value for property color.
setTitle(sTitle)Sets a new value for property title.
unbindPoints()Unbinds aggregation points from model data.
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.AreaMicroChartItem(sId?, mSettings?)
The configuration of the graphic element on the chart.

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)
    • title : string
  • Aggregations
    • points : sap.suite.ui.microchart.AreaMicroChartPoint[] (default)

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
Method Detail
sap.suite.ui.microchart.AreaMicroChartItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.microchart.AreaMicroChartItem 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.AreaMicroChartItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.suite.ui.microchart.AreaMicroChartItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addPoint(oPoint): sap.suite.ui.microchart.AreaMicroChartItem
Adds some point to the aggregation points.
Parameters:
{sap.suite.ui.microchart.AreaMicroChartPoint}oPoint the point to add; if empty, nothing is inserted
Returns:
{sap.suite.ui.microchart.AreaMicroChartItem} Reference to this in order to allow method chaining
bindPoints(oBindingInfo): sap.suite.ui.microchart.AreaMicroChartItem
Binds aggregation points to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Parameters:
{object}oBindingInfo The binding information
Returns:
{sap.suite.ui.microchart.AreaMicroChartItem} Reference to this in order to allow method chaining
destroyPoints(): sap.suite.ui.microchart.AreaMicroChartItem
Destroys all the points in the aggregation points.
Returns:
{sap.suite.ui.microchart.AreaMicroChartItem} 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
getPoints(): sap.suite.ui.microchart.AreaMicroChartPoint[]
Gets content of aggregation points.

The set of points for this graphic element.

Returns:
{sap.suite.ui.microchart.AreaMicroChartPoint[]}
getTitle(): string
Gets current value of property title.

The line title.

Returns:
{string} Value of property title
indexOfPoint(oPoint): int
Checks for the provided sap.suite.ui.microchart.AreaMicroChartPoint in the aggregation points. and returns its index if found or -1 otherwise.
Parameters:
{sap.suite.ui.microchart.AreaMicroChartPoint}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.microchart.AreaMicroChartItem
Inserts a point into the aggregation points.
Parameters:
{sap.suite.ui.microchart.AreaMicroChartPoint}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.microchart.AreaMicroChartItem} Reference to this in order to allow method chaining
removeAllPoints(): sap.suite.ui.microchart.AreaMicroChartPoint[]
Removes all the controls from the aggregation points.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.suite.ui.microchart.AreaMicroChartPoint[]} An array of the removed elements (might be empty)
removePoint(vPoint): sap.suite.ui.microchart.AreaMicroChartPoint
Removes a point from the aggregation points.
Parameters:
{int|string|sap.suite.ui.microchart.AreaMicroChartPoint}vPoint The pointto remove or its index or id
Returns:
{sap.suite.ui.microchart.AreaMicroChartPoint} The removed point or null
setColor(sColor): sap.suite.ui.microchart.AreaMicroChartItem
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.AreaMicroChartItem} Reference to this in order to allow method chaining
setTitle(sTitle): sap.suite.ui.microchart.AreaMicroChartItem
Sets a new value for property title.

The line title.

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

Parameters:
{string}sTitle New value for property title
Returns:
{sap.suite.ui.microchart.AreaMicroChartItem} Reference to this in order to allow method chaining
unbindPoints(): sap.suite.ui.microchart.AreaMicroChartItem
Unbinds aggregation points from model data.
Returns:
{sap.suite.ui.microchart.AreaMicroChartItem} Reference to this in order to allow method chaining