Class sap.suite.ui.commons.MicroAreaChartModule: sap/suite/ui/commons/MicroAreaChart

extends Control

This control displays the history of values as a line mini chart or an area mini chart.

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

Constructor Summary
new sap.suite.ui.commons.MicroAreaChart(sId?, mSettings?)Constructor for a new MicroAreaChart.
Event Summary
press(oControlEvent)The event is fired when the user chooses the micro area chart.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.suite.ui.commons.MicroAreaChart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.MicroAreaChart with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.MicroAreaChart.getMetadata()Returns a metadata object for class sap.suite.ui.commons.MicroAreaChart.
addLine(oLine)Adds some line oLine to the aggregation named lines.
attachPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.MicroAreaChart.
destroyChart()Destroys the chart in the aggregation named chart.
destroyFirstXLabel()Destroys the firstXLabel in the aggregation named firstXLabel.
destroyFirstYLabel()Destroys the firstYLabel in the aggregation named firstYLabel.
destroyInnerMaxThreshold()Destroys the innerMaxThreshold in the aggregation named innerMaxThreshold.
destroyInnerMinThreshold()Destroys the innerMinThreshold in the aggregation named innerMinThreshold.
destroyLastXLabel()Destroys the lastXLabel in the aggregation named lastXLabel.
destroyLastYLabel()Destroys the lastYLabel in the aggregation named lastYLabel.
destroyLines()Destroys all the lines in the aggregation named lines.
destroyMaxLabel()Destroys the maxLabel in the aggregation named maxLabel.
destroyMaxThreshold()Destroys the maxThreshold in the aggregation named maxThreshold.
destroyMinLabel()Destroys the minLabel in the aggregation named minLabel.
destroyMinThreshold()Destroys the minThreshold in the aggregation named minThreshold.
destroyTarget()Destroys the target in the aggregation named target.
detachPress(fnFunction, oListener)Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.MicroAreaChart.
firePress(mArguments?)Fire event press to attached listeners.
getChart()Getter for aggregation chart.
getColorPalette()Getter for property colorPalette.
getFirstXLabel()Getter for aggregation firstXLabel.
getFirstYLabel()Getter for aggregation firstYLabel.
getHeight()Getter for property height.
getInnerMaxThreshold()Getter for aggregation innerMaxThreshold.
getInnerMinThreshold()Getter for aggregation innerMinThreshold.
getLastXLabel()Getter for aggregation lastXLabel.
getLastYLabel()Getter for aggregation lastYLabel.
getLines()Getter for aggregation lines.
getMaxLabel()Getter for aggregation maxLabel.
getMaxThreshold()Getter for aggregation maxThreshold.
getMaxXValue()Getter for property maxXValue.
getMaxYValue()Getter for property maxYValue.
getMinLabel()Getter for aggregation minLabel.
getMinThreshold()Getter for aggregation minThreshold.
getMinXValue()Getter for property minXValue.
getMinYValue()Getter for property minYValue.
getTarget()Getter for aggregation target.
getView()Getter for property view.
getWidth()Getter for property width.
indexOfLine(oLine)Checks for the provided sap.suite.ui.commons.MicroAreaChartItem in the aggregation named lines and returns its index if found or -1 otherwise.
insertLine(oLine, iIndex)Inserts a line into the aggregation named lines.
removeAllLines()Removes all the controls in the aggregation named lines.
removeLine(vLine)Removes an line from the aggregation named lines.
setChart(oChart)Setter for the aggregated chart.
setColorPalette(aColorPalette)Setter for property colorPalette.
setFirstXLabel(oFirstXLabel)Setter for the aggregated firstXLabel.
setFirstYLabel(oFirstYLabel)Setter for the aggregated firstYLabel.
setHeight(sHeight)Setter for property height.
setInnerMaxThreshold(oInnerMaxThreshold)Setter for the aggregated innerMaxThreshold.
setInnerMinThreshold(oInnerMinThreshold)Setter for the aggregated innerMinThreshold.
setLastXLabel(oLastXLabel)Setter for the aggregated lastXLabel.
setLastYLabel(oLastYLabel)Setter for the aggregated lastYLabel.
setMaxLabel(oMaxLabel)Setter for the aggregated maxLabel.
setMaxThreshold(oMaxThreshold)Setter for the aggregated maxThreshold.
setMaxXValue(fMaxXValue)Setter for property maxXValue.
setMaxYValue(fMaxYValue)Setter for property maxYValue.
setMinLabel(oMinLabel)Setter for the aggregated minLabel.
setMinThreshold(oMinThreshold)Setter for the aggregated minThreshold.
setMinXValue(fMinXValue)Setter for property minXValue.
setMinYValue(fMinYValue)Setter for property minYValue.
setTarget(oTarget)Setter for the aggregated target.
setView(oView)Setter for property view.
setWidth(sWidth)Setter for property width.
Constructor Detail
new sap.suite.ui.commons.MicroAreaChart(sId?, mSettings?)
Constructor for a new MicroAreaChart.

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
    • chart : sap.suite.ui.commons.MicroAreaChartItem
    • maxThreshold : sap.suite.ui.commons.MicroAreaChartItem
    • innerMaxThreshold : sap.suite.ui.commons.MicroAreaChartItem
    • innerMinThreshold : sap.suite.ui.commons.MicroAreaChartItem
    • minThreshold : sap.suite.ui.commons.MicroAreaChartItem
    • target : sap.suite.ui.commons.MicroAreaChartItem
    • firstXLabel : sap.suite.ui.commons.MicroAreaChartLabel
    • firstYLabel : sap.suite.ui.commons.MicroAreaChartLabel
    • lastXLabel : sap.suite.ui.commons.MicroAreaChartLabel
    • lastYLabel : sap.suite.ui.commons.MicroAreaChartLabel
    • maxLabel : sap.suite.ui.commons.MicroAreaChartLabel
    • minLabel : sap.suite.ui.commons.MicroAreaChartLabel
    • lines : sap.suite.ui.commons.MicroAreaChartItem[]
  • 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.AreaMicroChart should be used.
    Event Detail
    press(oControlEvent)
    The event is fired when the user chooses the micro area chart.
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    Method Detail
    sap.suite.ui.commons.MicroAreaChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.suite.ui.commons.MicroAreaChart 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.MicroAreaChart.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.suite.ui.commons.MicroAreaChart.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    Adds some line oLine to the aggregation named lines.
    Parameters:
    {sap.suite.ui.commons.MicroAreaChartItem}oLine the line to add; if empty, nothing is inserted
    Since:
    1.29
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    attachPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.MicroAreaChart
    Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.MicroAreaChart.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.MicroAreaChart.
    itself.

    The event is fired when the user chooses the micro area 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.MicroAreaChart.
    itself.
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    Destroys the chart in the aggregation named chart.
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    Destroys the firstXLabel in the aggregation named firstXLabel.
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    Destroys the firstYLabel in the aggregation named firstYLabel.
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    destroyInnerMaxThreshold(): sap.suite.ui.commons.MicroAreaChart
    Destroys the innerMaxThreshold in the aggregation named innerMaxThreshold.
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    destroyInnerMinThreshold(): sap.suite.ui.commons.MicroAreaChart
    Destroys the innerMinThreshold in the aggregation named innerMinThreshold.
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    Destroys the lastXLabel in the aggregation named lastXLabel.
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    Destroys the lastYLabel in the aggregation named lastYLabel.
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    Destroys all the lines in the aggregation named lines.
    Since:
    1.29
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    Destroys the maxLabel in the aggregation named maxLabel.
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    destroyMaxThreshold(): sap.suite.ui.commons.MicroAreaChart
    Destroys the maxThreshold in the aggregation named maxThreshold.
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    Destroys the minLabel in the aggregation named minLabel.
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    destroyMinThreshold(): sap.suite.ui.commons.MicroAreaChart
    Destroys the minThreshold in the aggregation named minThreshold.
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    Destroys the target in the aggregation named target.
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    detachPress(fnFunction, oListener): sap.suite.ui.commons.MicroAreaChart
    Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.MicroAreaChart.

    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.MicroAreaChart}this to allow method chaining
    firePress(mArguments?): sap.suite.ui.commons.MicroAreaChart
    Fire event press to attached listeners.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    Getter for aggregation chart.
    The configuration of the actual values line. The color property defines the color of the line. Points are rendered in the same sequence as in this aggregation.
    Returns:
    {sap.suite.ui.commons.MicroAreaChartItem}
    getColorPalette(): string[]
    Getter for property colorPalette. The color palette for the chart. If this property is set, semantic colors defined in MicroAreaChartItem are ignored. Colors from the palette are assigned to each line consequentially. When all the palette colors are used, assignment of the colors begins from the first palette color.

    Default value is []

    Since:
    1.29
    Returns:
    {string[]} the value of property colorPalette
    Getter for aggregation firstXLabel.
    The label on X axis for the first point of the chart.
    Returns:
    {sap.suite.ui.commons.MicroAreaChartLabel}
    Getter for aggregation firstYLabel.
    The label on Y axis for the first point of the chart.
    Returns:
    {sap.suite.ui.commons.MicroAreaChartLabel}
    getHeight(): sap.ui.core.CSSSize
    Getter for property height. The height of the chart.

    Default value is 190px

    Returns:
    {sap.ui.core.CSSSize} the value of property height
    Getter for aggregation innerMaxThreshold.
    The configuration of the upper line of the inner threshold area. The color property defines the color of the area between inner thresholds. For rendering of the inner threshold area, both innerMaxThreshold and innerMinThreshold aggregations must be defined. Points are rendered in the same sequence as in this aggregation.
    Returns:
    {sap.suite.ui.commons.MicroAreaChartItem}
    Getter for aggregation innerMinThreshold.
    The configuration of the bottom line of the inner threshold area. The color property is ignored. For rendering of the inner threshold area, both innerMaxThreshold and innerMinThreshold aggregations must be defined. Points are rendered in the same sequence as in this aggregation.
    Returns:
    {sap.suite.ui.commons.MicroAreaChartItem}
    Getter for aggregation lastXLabel.
    The label on X axis for the last point of the chart.
    Returns:
    {sap.suite.ui.commons.MicroAreaChartLabel}
    Getter for aggregation lastYLabel.
    The label on Y axis for the last point of the chart.
    Returns:
    {sap.suite.ui.commons.MicroAreaChartLabel}
    Getter for aggregation lines.
    The set of lines.
    Since:
    1.29
    Returns:
    {sap.suite.ui.commons.MicroAreaChartItem[]}
    Getter for aggregation maxLabel.
    The label for the maximum point of the chart.
    Returns:
    {sap.suite.ui.commons.MicroAreaChartLabel}
    Getter for aggregation maxThreshold.
    The configuration of the max threshold area. The color property defines the color of the area above the max threshold line. Points are rendered in the same sequence as in this aggregation.
    Returns:
    {sap.suite.ui.commons.MicroAreaChartItem}
    getMaxXValue(): float
    Getter for property maxXValue. If this property is set it indicates the value X axis ends with.

    Default value is empty/undefined

    Returns:
    {float} the value of property maxXValue
    getMaxYValue(): float
    Getter for property maxYValue. If this property is set it indicates the value Y axis ends with.

    Default value is empty/undefined

    Returns:
    {float} the value of property maxYValue
    Getter for aggregation minLabel.
    The label for the minimum point of the chart.
    Returns:
    {sap.suite.ui.commons.MicroAreaChartLabel}
    Getter for aggregation minThreshold.
    The configuration of the min threshold area. The color property defines the color of the area below the min threshold line. Points are rendered in the same sequence as in this aggregation.
    Returns:
    {sap.suite.ui.commons.MicroAreaChartItem}
    getMinXValue(): float
    Getter for property minXValue. If this property is set it indicates the value X axis starts with.

    Default value is empty/undefined

    Returns:
    {float} the value of property minXValue
    getMinYValue(): float
    Getter for property minYValue. If this property is set it indicates the value Y axis starts with.

    Default value is empty/undefined

    Returns:
    {float} the value of property minYValue
    Getter for aggregation target.
    The configuration of the target values line. The color property defines the color of the line. Points are rendered in the same sequence as in this aggregation.
    Returns:
    {sap.suite.ui.commons.MicroAreaChartItem}
    Getter for property view. The view of the chart.

    Default value is Normal

    Since:
    1.25
    Returns:
    {sap.suite.ui.commons.MicroAreaChartView} the value of property view
    getWidth(): sap.ui.core.CSSSize
    Getter for property width. The width of the chart.

    Default value is 200px

    Returns:
    {sap.ui.core.CSSSize} the value of property width
    indexOfLine(oLine): int
    Checks for the provided sap.suite.ui.commons.MicroAreaChartItem in the aggregation named lines and returns its index if found or -1 otherwise.
    Parameters:
    {sap.suite.ui.commons.MicroAreaChartItem}oLine the line whose index is looked for.
    Since:
    1.29
    Returns:
    {int} the index of the provided control in the aggregation if found, or -1 otherwise
    insertLine(oLine, iIndex): sap.suite.ui.commons.MicroAreaChart
    Inserts a line into the aggregation named lines.
    Parameters:
    {sap.suite.ui.commons.MicroAreaChartItem}oLine the line to insert; if empty, nothing is inserted
    {int}iIndex the 0-based index the line should be inserted at; for a negative value of iIndex, the line is inserted at position 0; for a value greater than the current size of the aggregation, the line is inserted at the last position
    Since:
    1.29
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    Removes all the controls in the aggregation named lines.
    Additionally unregisters them from the hosting UIArea.
    Since:
    1.29
    Returns:
    {sap.suite.ui.commons.MicroAreaChartItem[]} an array of the removed elements (might be empty)
    Removes an line from the aggregation named lines.
    Parameters:
    {int|string|sap.suite.ui.commons.MicroAreaChartItem}vLine the line to remove or its index or id
    Since:
    1.29
    Returns:
    {sap.suite.ui.commons.MicroAreaChartItem} the removed line or null
    Setter for the aggregated chart.
    Parameters:
    {sap.suite.ui.commons.MicroAreaChartItem}oChart
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    setColorPalette(aColorPalette): sap.suite.ui.commons.MicroAreaChart
    Setter for property colorPalette.

    Default value is []

    Parameters:
    {string[]}aColorPalette new value for property colorPalette
    Since:
    1.29
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    setFirstXLabel(oFirstXLabel): sap.suite.ui.commons.MicroAreaChart
    Setter for the aggregated firstXLabel.
    Parameters:
    {sap.suite.ui.commons.MicroAreaChartLabel}oFirstXLabel
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    setFirstYLabel(oFirstYLabel): sap.suite.ui.commons.MicroAreaChart
    Setter for the aggregated firstYLabel.
    Parameters:
    {sap.suite.ui.commons.MicroAreaChartLabel}oFirstYLabel
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    Setter for property height.

    Default value is 190px

    Parameters:
    {sap.ui.core.CSSSize}sHeight new value for property height
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    setInnerMaxThreshold(oInnerMaxThreshold): sap.suite.ui.commons.MicroAreaChart
    Setter for the aggregated innerMaxThreshold.
    Parameters:
    {sap.suite.ui.commons.MicroAreaChartItem}oInnerMaxThreshold
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    setInnerMinThreshold(oInnerMinThreshold): sap.suite.ui.commons.MicroAreaChart
    Setter for the aggregated innerMinThreshold.
    Parameters:
    {sap.suite.ui.commons.MicroAreaChartItem}oInnerMinThreshold
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    setLastXLabel(oLastXLabel): sap.suite.ui.commons.MicroAreaChart
    Setter for the aggregated lastXLabel.
    Parameters:
    {sap.suite.ui.commons.MicroAreaChartLabel}oLastXLabel
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    setLastYLabel(oLastYLabel): sap.suite.ui.commons.MicroAreaChart
    Setter for the aggregated lastYLabel.
    Parameters:
    {sap.suite.ui.commons.MicroAreaChartLabel}oLastYLabel
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    setMaxLabel(oMaxLabel): sap.suite.ui.commons.MicroAreaChart
    Setter for the aggregated maxLabel.
    Parameters:
    {sap.suite.ui.commons.MicroAreaChartLabel}oMaxLabel
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    setMaxThreshold(oMaxThreshold): sap.suite.ui.commons.MicroAreaChart
    Setter for the aggregated maxThreshold.
    Parameters:
    {sap.suite.ui.commons.MicroAreaChartItem}oMaxThreshold
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    setMaxXValue(fMaxXValue): sap.suite.ui.commons.MicroAreaChart
    Setter for property maxXValue.

    Default value is empty/undefined

    Parameters:
    {float}fMaxXValue new value for property maxXValue
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    setMaxYValue(fMaxYValue): sap.suite.ui.commons.MicroAreaChart
    Setter for property maxYValue.

    Default value is empty/undefined

    Parameters:
    {float}fMaxYValue new value for property maxYValue
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    setMinLabel(oMinLabel): sap.suite.ui.commons.MicroAreaChart
    Setter for the aggregated minLabel.
    Parameters:
    {sap.suite.ui.commons.MicroAreaChartLabel}oMinLabel
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    setMinThreshold(oMinThreshold): sap.suite.ui.commons.MicroAreaChart
    Setter for the aggregated minThreshold.
    Parameters:
    {sap.suite.ui.commons.MicroAreaChartItem}oMinThreshold
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    setMinXValue(fMinXValue): sap.suite.ui.commons.MicroAreaChart
    Setter for property minXValue.

    Default value is empty/undefined

    Parameters:
    {float}fMinXValue new value for property minXValue
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    setMinYValue(fMinYValue): sap.suite.ui.commons.MicroAreaChart
    Setter for property minYValue.

    Default value is empty/undefined

    Parameters:
    {float}fMinYValue new value for property minYValue
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    Setter for the aggregated target.
    Parameters:
    {sap.suite.ui.commons.MicroAreaChartItem}oTarget
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    Setter for property view.

    Default value is Normal

    Parameters:
    {sap.suite.ui.commons.MicroAreaChartView}oView new value for property view
    Since:
    1.25
    Returns:
    {sap.suite.ui.commons.MicroAreaChart}this to allow method chaining
    Setter for property width.

    Default value is 200px

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