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 |
Returns a metadata object for class sap.suite.ui.commons.MicroAreaChart.
Returns:
Adds some line oLine
to the aggregation named lines
.
Parameters:
- Since:
- 1.29
Returns:
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:
Destroys the chart in the aggregation named chart
.
Returns:
Destroys the firstXLabel in the aggregation named firstXLabel
.
Returns:
Destroys the firstYLabel in the aggregation named firstYLabel
.
Returns:
Destroys the innerMaxThreshold in the aggregation named innerMaxThreshold
.
Returns:
Destroys the innerMinThreshold in the aggregation named innerMinThreshold
.
Returns:
Destroys the lastXLabel in the aggregation named lastXLabel
.
Returns:
Destroys the lastYLabel in the aggregation named lastYLabel
.
Returns:
Destroys all the lines in the aggregation named lines
.
- Since:
- 1.29
Returns:
Destroys the maxLabel in the aggregation named maxLabel
.
Returns:
Destroys the maxThreshold in the aggregation named maxThreshold
.
Returns:
Destroys the minLabel in the aggregation named minLabel
.
Returns:
Destroys the minThreshold in the aggregation named minThreshold
.
Returns:
Destroys the target in the aggregation named target
.
Returns:
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:
Fire event press to attached listeners.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
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:
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:
Getter for aggregation firstYLabel
.
The label on Y axis for the first point of the chart.
Returns:
Getter for property
height
. The height of the chart.
Default value is 190px
Returns:
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:
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:
Getter for aggregation lastXLabel
.
The label on X axis for the last point of the chart.
Returns:
Getter for aggregation lastYLabel
.
The label on Y axis for the last point of the chart.
Returns:
Getter for aggregation lines
.
The set of lines.
- Since:
- 1.29
Returns:
Getter for aggregation maxLabel
.
The label for the maximum point of the chart.
Returns:
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:
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:
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:
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:
Getter for property
view
. The view of the chart.
Default value is Normal
- Since:
- 1.25
Returns:
Getter for property
width
. The width of the chart.
Default value is 200px
Returns:
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:
- Since:
- 1.29
Returns:
{int} | the index of the provided control in the aggregation if found, or -1 otherwise |
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:
Removes all the controls in the aggregation named lines
.
Additionally unregisters them from the hosting UIArea.
- Since:
- 1.29
Returns:
Removes an line from the aggregation named lines
.
Parameters:
- Since:
- 1.29
Returns:
Setter for the aggregated chart
.
Parameters:
Returns:
Setter for property
colorPalette
.
Default value is []
Parameters:
{string[]} | aColorPalette | new value for property colorPalette |
- Since:
- 1.29
Returns:
Setter for the aggregated firstXLabel
.
Parameters:
Returns:
Setter for the aggregated firstYLabel
.
Parameters:
Returns:
Setter for property
height
.
Default value is 190px
Parameters:
Returns:
Setter for the aggregated innerMaxThreshold
.
Parameters:
Returns:
Setter for the aggregated innerMinThreshold
.
Parameters:
Returns:
Setter for the aggregated lastXLabel
.
Parameters:
Returns:
Setter for the aggregated lastYLabel
.
Parameters:
Returns:
Setter for the aggregated maxLabel
.
Parameters:
Returns:
Setter for the aggregated maxThreshold
.
Parameters:
Returns:
Setter for property
maxXValue
.
Default value is empty/undefined
Parameters:
{float} | fMaxXValue | new value for property maxXValue |
Returns:
Setter for property
maxYValue
.
Default value is empty/undefined
Parameters:
{float} | fMaxYValue | new value for property maxYValue |
Returns:
Setter for the aggregated minLabel
.
Parameters:
Returns:
Setter for the aggregated minThreshold
.
Parameters:
Returns:
Setter for property
minXValue
.
Default value is empty/undefined
Parameters:
{float} | fMinXValue | new value for property minXValue |
Returns:
Setter for property
minYValue
.
Default value is empty/undefined
Parameters:
{float} | fMinYValue | new value for property minYValue |
Returns:
Setter for the aggregated target
.
Parameters:
Returns:
Setter for property
view
.
Default value is Normal
Parameters:
- Since:
- 1.25
Returns:
Setter for property
width
.
Default value is 200px
Parameters:
Returns: