sap.suite.ui.microchart.AreaMicroChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.microchart.AreaMicroChart 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 |
Returns a metadata object for class sap.suite.ui.microchart.AreaMicroChart.
Returns:
Adds some line to the aggregation lines
.
Parameters:
Returns:
Attaches event handler
fnFunction
to the
press
event of this
sap.suite.ui.microchart.AreaMicroChart
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.suite.ui.microchart.AreaMicroChart
itself.
The event is triggered when the chart is pressed.
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 be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.suite.ui.microchart.AreaMicroChart itself |
Returns:
Parameters:
{object} | oBindingInfo | The binding information |
Returns:
Parameters:
{object} | oBindingInfo | The binding information |
Returns:
Parameters:
{object} | oBindingInfo | The binding information |
Returns:
Destroys the chart in the aggregation chart
.
Returns:
Destroys the firstXLabel in the aggregation firstXLabel
.
Returns:
Destroys the firstYLabel in the aggregation firstYLabel
.
Returns:
Destroys the innerMaxThreshold in the aggregation innerMaxThreshold
.
Returns:
Destroys the innerMinThreshold in the aggregation innerMinThreshold
.
Returns:
Destroys the lastXLabel in the aggregation lastXLabel
.
Returns:
Destroys the lastYLabel in the aggregation lastYLabel
.
Returns:
Destroys all the lines in the aggregation lines
.
Returns:
Destroys the maxLabel in the aggregation maxLabel
.
Returns:
Destroys the maxThreshold in the aggregation maxThreshold
.
Returns:
Destroys the minLabel in the aggregation minLabel
.
Returns:
Destroys the minThreshold in the aggregation minThreshold
.
Returns:
Destroys the target in the aggregation target
.
Returns:
Detaches event handler
fnFunction
from the
press
event of this
sap.suite.ui.microchart.AreaMicroChart
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
Fires event press
to attached listeners.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Gets content of 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[]
Gets current value of property
colorPalette
.
The color palette for the chart. If this property is set, semantic colors defined in AreaMicroChartItem 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 []
.
Returns:
{string[]} | Value of property colorPalette |
Gets content of aggregation
firstXLabel
.
The label on X axis for the first point of the chart.
Returns:
Gets content of aggregation
firstYLabel
.
The label on Y axis for the first point of the chart.
Returns:
Gets current value of property
height
.
The height of the chart.
Returns:
Gets content of 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:
Gets content of 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:
getIsResponsive(): boolean
Gets current value of property
isResponsive
.
If this set to true, width and height of the control are determined by the width and height of the container in which the control is placed. Width and height properties are ignored in such case.
Default value is false
.
- Since:
- 1.38.0
Returns:
{boolean} | Value of property isResponsive |
Gets content of aggregation
lastXLabel
.
The label on X axis for the last point of the chart.
Returns:
Gets content of aggregation
lastYLabel
.
The label on Y axis for the last point of the chart.
Returns:
Gets content of aggregation
lines
.
The set of lines.
Returns:
Gets content of aggregation
maxLabel
.
The label for the maximum point of the chart.
Returns:
Gets content of 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
Gets current value of property
maxXValue
.
If this property is set it indicates the value X axis ends with.
Returns:
{float} | Value of property maxXValue |
getMaxYValue(): float
Gets current value of property
maxYValue
.
If this property is set it indicates the value X axis ends with.
Returns:
{float} | Value of property maxYValue |
Gets content of aggregation
minLabel
.
The label for the minimum point of the chart.
Returns:
Gets content of 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
Gets current value of property
minXValue
.
If this property is set it indicates the value X axis ends with.
Returns:
{float} | Value of property minXValue |
getMinYValue(): float
Gets current value of property
minYValue
.
If this property is set it indicates the value X axis ends with.
Returns:
{float} | Value of property minYValue |
getShowLabel(): boolean
Gets current value of property
showLabel
.
Determines if the labels are displayed or not.
Default value is true
.
Returns:
{boolean} | Value of property showLabel |
Gets content of 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:
Gets current value of property
view
.
The view of the chart.
Default value is Normal
.
Returns:
Gets current value of property
width
.
The width of the chart.
Returns:
indexOfLine(oLine): int
Checks for the provided sap.suite.ui.microchart.AreaMicroChartItem
in the aggregation lines
. and returns its index if found or -1 otherwise.
Parameters:
Returns:
{int} | The index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a line into the aggregation lines
.
Parameters:
{sap.suite.ui.microchart.AreaMicroChartItem} | 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 |
Returns:
Removes all the controls from the aggregation
lines
.
Additionally, it unregisters them from the hosting UIArea.
Returns:
Removes a line from the aggregation lines
.
Parameters:
Returns:
Sets the aggregated chart
.
Parameters:
Returns:
Sets a new value for property
colorPalette
.
The color palette for the chart. If this property is set, semantic colors defined in AreaMicroChartItem 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.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is []
.
Parameters:
{string[]} | sColorPalette | New value for property colorPalette |
Returns:
Sets the aggregated firstXLabel
.
Parameters:
Returns:
Sets the aggregated firstYLabel
.
Parameters:
Returns:
Sets a new value for property
height
.
The height of the chart.
When called with a value of null
or undefined
, the default value of the property will be restored.
Parameters:
Returns:
Sets the aggregated innerMaxThreshold
.
Parameters:
Returns:
Sets the aggregated innerMinThreshold
.
Parameters:
Returns:
Sets a new value for property
isResponsive
.
If this set to true, width and height of the control are determined by the width and height of the container in which the control is placed. Width and height properties are ignored in such case.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Parameters:
{boolean} | bIsResponsive | New value for property isResponsive |
- Since:
- 1.38.0
Returns:
Sets the aggregated lastXLabel
.
Parameters:
Returns:
Sets the aggregated lastYLabel
.
Parameters:
Returns:
Sets the aggregated maxLabel
.
Parameters:
Returns:
Sets the aggregated maxThreshold
.
Parameters:
Returns:
setMaxXValue(value, bSuppressInvalidate): void
Property setter for the Max X value
Parameters:
{int} | value | new value Max X |
{boolean} | bSuppressInvalidate | Suppress in validate |
setMaxYValue(value, bSuppressInvalidate): void
Property setter for the Max Y value
Parameters:
{string} | value | new value Max Y |
{boolean} | bSuppressInvalidate | Suppress in validate |
Sets the aggregated minLabel
.
Parameters:
Returns:
Sets the aggregated minThreshold
.
Parameters:
Returns:
setMinXValue(value, bSuppressInvalidate): void
Property setter for the Min X value
Parameters:
{int} | value | new value Min X |
{boolean} | bSuppressInvalidate | Suppress in validate |
setMinYValue(value, bSuppressInvalidate): void
Property setter for the Min Y value
Parameters:
{value} | value | new value Min Y |
{boolean} | bSuppressInvalidate | Suppress in validate |
Sets a new value for property
showLabel
.
Determines if the labels are displayed or not.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Parameters:
{boolean} | bShowLabel | New value for property showLabel |
Returns:
Sets the aggregated target
.
Parameters:
Returns:
Sets a new value for property
view
.
The view of the chart.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Normal
.
Parameters:
Returns:
Sets a new value for property
width
.
The width of the chart.
When called with a value of null
or undefined
, the default value of the property will be restored.
Parameters:
Returns:
Unbinds aggregation chart
from model data.
Returns:
Unbinds aggregation lines
from model data.
Returns:
Unbinds aggregation target
from model data.
Returns: