Class sap.suite.ui.commons.ColumnMicroChartModule: sap/suite/ui/commons/ColumnMicroChart
This control shows a column chart.
Deprecated API:Since version 1.34. Deprecated. sap.suite.ui.microchart.ColumnMicroChart should be used.
sClassName
and enriches it with the information contained in oClassInfo
.fnFunction
to the 'press' event of this sap.suite.ui.commons.ColumnMicroChart
.fnFunction
from the 'press' event of this sap.suite.ui.commons.ColumnMicroChart
.sap.suite.ui.commons.ColumnData
in the aggregation named columns
and returns its index if found or -1 otherwise. 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
- columns : sap.suite.ui.commons.ColumnData[]
- leftTopLabel : sap.suite.ui.commons.ColumnMicroChartLabel
- rightTopLabel : sap.suite.ui.commons.ColumnMicroChartLabel
- leftBottomLabel : sap.suite.ui.commons.ColumnMicroChartLabel
- rightBottomLabel : sap.suite.ui.commons.ColumnMicroChartLabel
- Associations
- Events
- press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
{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.ColumnMicroChart should be used.
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters |
sClassName
and enriches it with the information contained in oClassInfo
. oClassInfo
might contain the same kind of informations as described in Element.extend.
{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. |
{function} | the created class / constructor function |
{sap.ui.base.Metadata} | Metadata object describing this class |
oColumn
to the aggregation named columns
. {sap.suite.ui.commons.ColumnData} | oColumn | the column to add; if empty, nothing is inserted |
{sap.suite.ui.commons.ColumnMicroChart} | this to allow method chaining |
fnFunction
to the 'press' event of this sap.suite.ui.commons.ColumnMicroChart
.. When called, the context of the event handler (its
this
) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.ColumnMicroChart
.
itself. The event is fired when the user chooses the column 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.ColumnMicroChart .itself. |
Returns:
{sap.suite.ui.commons.ColumnMicroChart} | this to allow method chaining |
destroyColumns(): sap.suite.ui.commons.ColumnMicroChart Destroys all the columns in the aggregation named columns
. Returns:{sap.suite.ui.commons.ColumnMicroChart} this
to allow method chaining
destroyLeftBottomLabel(): sap.suite.ui.commons.ColumnMicroChart Destroys the leftBottomLabel in the aggregation named leftBottomLabel
. - Since:
- 1.28
Returns:{sap.suite.ui.commons.ColumnMicroChart} this
to allow method chaining
destroyLeftTopLabel(): sap.suite.ui.commons.ColumnMicroChart Destroys the leftTopLabel in the aggregation named leftTopLabel
. - Since:
- 1.28
Returns:{sap.suite.ui.commons.ColumnMicroChart} this
to allow method chaining
destroyRightBottomLabel(): sap.suite.ui.commons.ColumnMicroChart Destroys the rightBottomLabel in the aggregation named rightBottomLabel
. - Since:
- 1.28
Returns:{sap.suite.ui.commons.ColumnMicroChart} this
to allow method chaining
destroyRightTopLabel(): sap.suite.ui.commons.ColumnMicroChart Destroys the rightTopLabel in the aggregation named rightTopLabel
. - Since:
- 1.28
Returns:{sap.suite.ui.commons.ColumnMicroChart} this
to allow method chaining
detachPress(fnFunction, oListener): sap.suite.ui.commons.ColumnMicroChart Detach event handler fnFunction
from the 'press' event of this sap.suite.ui.commons.ColumnMicroChart
.
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.ColumnMicroChart} this
to allow method chaining
firePress(mArguments?): sap.suite.ui.commons.ColumnMicroChart Fire event press to attached listeners. Parameters:{Map} mArguments? the arguments to pass along with the event.
Returns:{sap.suite.ui.commons.ColumnMicroChart} this
to allow method chaining
getColumns(): sap.suite.ui.commons.ColumnData[] Getter for aggregation columns
.
The column chart data. Returns:{sap.suite.ui.commons.ColumnData[]}
getHeight(): sap.ui.core.CSSSize Getter for property height
. The height of the chart. If it is not set, the height of the control is defined by the size property. Default value is empty/undefined
Returns:{sap.ui.core.CSSSize} the value of property height
getLeftBottomLabel(): sap.suite.ui.commons.ColumnMicroChartLabel Getter for aggregation leftBottomLabel
.
The label on the left bottom corner of the chart. - Since:
- 1.28
Returns:{sap.suite.ui.commons.ColumnMicroChartLabel}
getLeftTopLabel(): sap.suite.ui.commons.ColumnMicroChartLabel Getter for aggregation leftTopLabel
.
The label on the left top corner of the chart. - Since:
- 1.28
Returns:{sap.suite.ui.commons.ColumnMicroChartLabel}
getRightBottomLabel(): sap.suite.ui.commons.ColumnMicroChartLabel Getter for aggregation rightBottomLabel
.
The label on the right bottom corner of the chart. - Since:
- 1.28
Returns:{sap.suite.ui.commons.ColumnMicroChartLabel}
getRightTopLabel(): sap.suite.ui.commons.ColumnMicroChartLabel Getter for aggregation rightTopLabel
.
The label on the right top corner of the chart. - Since:
- 1.28
Returns:{sap.suite.ui.commons.ColumnMicroChartLabel}
getSize(): sap.suite.ui.commons.InfoTileSize Getter for property size
. Updates the size of the chart. If not set then the default size is applied based on the device tile. Default value is Auto
Returns:{sap.suite.ui.commons.InfoTileSize} the value of property size
getWidth(): sap.ui.core.CSSSize Getter for property width
. The width of the chart. If it is not set, the width of the control is defined by the size property. Default value is empty/undefined
Returns:{sap.ui.core.CSSSize} the value of property width
indexOfColumn(oColumn): int Checks for the provided sap.suite.ui.commons.ColumnData
in the aggregation named columns
and returns its index if found or -1 otherwise. Parameters:{sap.suite.ui.commons.ColumnData} oColumn the column whose index is looked for.
Returns:{int} the index of the provided control in the aggregation if found, or -1 otherwise
insertColumn(oColumn, iIndex): sap.suite.ui.commons.ColumnMicroChart Inserts a column into the aggregation named columns
. Parameters:{sap.suite.ui.commons.ColumnData} oColumn the column to insert; if empty, nothing is inserted {int} iIndex the 0
-based index the column should be inserted at; for a negative value of iIndex
, the column is inserted at position 0; for a value greater than the current size of the aggregation, the column is inserted at the last position
Returns:{sap.suite.ui.commons.ColumnMicroChart} this
to allow method chaining
removeAllColumns(): sap.suite.ui.commons.ColumnData[] Removes all the controls in the aggregation named columns
.
Additionally unregisters them from the hosting UIArea. Returns:{sap.suite.ui.commons.ColumnData[]} an array of the removed elements (might be empty)
removeColumn(vColumn): sap.suite.ui.commons.ColumnData Removes an column from the aggregation named columns
. Parameters:{int|string|sap.suite.ui.commons.ColumnData} vColumn the column to remove or its index or id
Returns:{sap.suite.ui.commons.ColumnData} the removed column or null
setHeight(sHeight): sap.suite.ui.commons.ColumnMicroChart Setter for property height
. Default value is empty/undefined
Parameters:{sap.ui.core.CSSSize} sHeight new value for property height
Returns:{sap.suite.ui.commons.ColumnMicroChart} this
to allow method chaining
setLeftBottomLabel(oLeftBottomLabel): sap.suite.ui.commons.ColumnMicroChart Setter for the aggregated leftBottomLabel
. Parameters:{sap.suite.ui.commons.ColumnMicroChartLabel} oLeftBottomLabel
- Since:
- 1.28
Returns:{sap.suite.ui.commons.ColumnMicroChart} this
to allow method chaining
setLeftTopLabel(oLeftTopLabel): sap.suite.ui.commons.ColumnMicroChart Setter for the aggregated leftTopLabel
. Parameters:{sap.suite.ui.commons.ColumnMicroChartLabel} oLeftTopLabel
- Since:
- 1.28
Returns:{sap.suite.ui.commons.ColumnMicroChart} this
to allow method chaining
setRightBottomLabel(oRightBottomLabel): sap.suite.ui.commons.ColumnMicroChart Setter for the aggregated rightBottomLabel
. Parameters:{sap.suite.ui.commons.ColumnMicroChartLabel} oRightBottomLabel
- Since:
- 1.28
Returns:{sap.suite.ui.commons.ColumnMicroChart} this
to allow method chaining
setRightTopLabel(oRightTopLabel): sap.suite.ui.commons.ColumnMicroChart Setter for the aggregated rightTopLabel
. Parameters:{sap.suite.ui.commons.ColumnMicroChartLabel} oRightTopLabel
- Since:
- 1.28
Returns:{sap.suite.ui.commons.ColumnMicroChart} this
to allow method chaining
setSize(oSize): sap.suite.ui.commons.ColumnMicroChart Setter for property size
. Default value is Auto
Parameters:{sap.suite.ui.commons.InfoTileSize} oSize new value for property size
Returns:{sap.suite.ui.commons.ColumnMicroChart} this
to allow method chaining
setWidth(sWidth): sap.suite.ui.commons.ColumnMicroChart Setter for property width
. Default value is empty/undefined
Parameters:{sap.ui.core.CSSSize} sWidth new value for property width
Returns:{sap.suite.ui.commons.ColumnMicroChart} this
to allow method chaining