Class sap.suite.ui.microchart.ColumnMicroChartModule: sap/suite/ui/microchart/ColumnMicroChart

extends Control

Compares different values which are represented as vertical bars. This control replaces the deprecated sap.suite.ui.commons.ColumnMicroChart.


Since: 1.34.
Constructor Summary
new sap.suite.ui.microchart.ColumnMicroChart(sId?, mSettings?)Constructor for a new ColumnMicroChart control.
Event Summary
press(oControlEvent)The event is fired when the user chooses the column 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.ColumnMicroChart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.microchart.ColumnMicroChart with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.microchart.ColumnMicroChart.getMetadata()Returns a metadata object for class sap.suite.ui.microchart.ColumnMicroChart.
addColumn(oColumn)Adds some column to the aggregation columns.
attachPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the press event of this sap.suite.ui.microchart.ColumnMicroChart.
bindColumns(oBindingInfo)Binds aggregation columns to model data.
destroyColumns()Destroys all the columns in the aggregation columns.
destroyLeftBottomLabel()Destroys the leftBottomLabel in the aggregation leftBottomLabel.
destroyLeftTopLabel()Destroys the leftTopLabel in the aggregation leftTopLabel.
destroyRightBottomLabel()Destroys the rightBottomLabel in the aggregation rightBottomLabel.
destroyRightTopLabel()Destroys the rightTopLabel in the aggregation rightTopLabel.
detachPress(fnFunction, oListener)Detaches event handler fnFunction from the press event of this sap.suite.ui.microchart.ColumnMicroChart.
firePress(mArguments?)Fires event press to attached listeners.
getColumns()Gets content of aggregation columns.
getHeight()Gets current value of property height.
getIsResponsive()Gets current value of property isResponsive.
getLeftBottomLabel()Gets content of aggregation leftBottomLabel.
getLeftTopLabel()Gets content of aggregation leftTopLabel.
getRightBottomLabel()Gets content of aggregation rightBottomLabel.
getRightTopLabel()Gets content of aggregation rightTopLabel.
getSize()Gets current value of property size.
getWidth()Gets current value of property width.
indexOfColumn(oColumn)Checks for the provided sap.suite.ui.microchart.ColumnMicroChartData in the aggregation columns.
insertColumn(oColumn, iIndex)Inserts a column into the aggregation columns.
removeAllColumns()Removes all the controls from the aggregation columns.
removeColumn(vColumn)Removes a column from the aggregation columns.
setHeight(sHeight)Sets a new value for property height.
setIsResponsive(bIsResponsive)Sets a new value for property isResponsive.
setLeftBottomLabel(oLeftBottomLabel)Sets the aggregated leftBottomLabel.
setLeftTopLabel(oLeftTopLabel)Sets the aggregated leftTopLabel.
setRightBottomLabel(oRightBottomLabel)Sets the aggregated rightBottomLabel.
setRightTopLabel(oRightTopLabel)Sets the aggregated rightTopLabel.
setSize(sSize)Sets a new value for property size.
setWidth(sWidth)Sets a new value for property width.
unbindColumns()Unbinds aggregation columns 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.ColumnMicroChart(sId?, mSettings?)
Constructor for a new ColumnMicroChart control.

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
  • Aggregations
  • Events
    • press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

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
Event Detail
press(oControlEvent)
The event is fired when the user chooses the column chart.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.suite.ui.microchart.ColumnMicroChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.microchart.ColumnMicroChart 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.ColumnMicroChart.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.suite.ui.microchart.ColumnMicroChart.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addColumn(oColumn): sap.suite.ui.microchart.ColumnMicroChart
Adds some column to the aggregation columns.
Parameters:
{sap.suite.ui.microchart.ColumnMicroChartData}oColumn the column to add; if empty, nothing is inserted
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
attachPress(oData?, fnFunction, oListener?): sap.suite.ui.microchart.ColumnMicroChart
Attaches event handler fnFunction to the press event of this sap.suite.ui.microchart.ColumnMicroChart.

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.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 be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.microchart.ColumnMicroChart itself
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
bindColumns(oBindingInfo): sap.suite.ui.microchart.ColumnMicroChart
Binds aggregation columns 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.ColumnMicroChart} Reference to this in order to allow method chaining
destroyColumns(): sap.suite.ui.microchart.ColumnMicroChart
Destroys all the columns in the aggregation columns.
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
destroyLeftBottomLabel(): sap.suite.ui.microchart.ColumnMicroChart
Destroys the leftBottomLabel in the aggregation leftBottomLabel.
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
destroyLeftTopLabel(): sap.suite.ui.microchart.ColumnMicroChart
Destroys the leftTopLabel in the aggregation leftTopLabel.
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
destroyRightBottomLabel(): sap.suite.ui.microchart.ColumnMicroChart
Destroys the rightBottomLabel in the aggregation rightBottomLabel.
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
destroyRightTopLabel(): sap.suite.ui.microchart.ColumnMicroChart
Destroys the rightTopLabel in the aggregation rightTopLabel.
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
detachPress(fnFunction, oListener): sap.suite.ui.microchart.ColumnMicroChart
Detaches event handler fnFunction from the press event of this sap.suite.ui.microchart.ColumnMicroChart.

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:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
firePress(mArguments?): sap.suite.ui.microchart.ColumnMicroChart
Fires event press to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
getColumns(): sap.suite.ui.microchart.ColumnMicroChartData[]
Gets content of aggregation columns.

The column chart data.

Returns:
{sap.suite.ui.microchart.ColumnMicroChartData[]}
getHeight(): sap.ui.core.CSSSize
Gets current value of property height.

The height of the chart. If it is not set, the height of the control is defined by the size property.

Returns:
{sap.ui.core.CSSSize} Value of property height
getIsResponsive(): boolean
Gets current value of property isResponsive.

If 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. Size, width and height properties are ignored in this case.

Default value is false.

Since:
1.38.0
Returns:
{boolean} Value of property isResponsive
getLeftBottomLabel(): sap.suite.ui.microchart.ColumnMicroChartLabel
Gets content of aggregation leftBottomLabel.

The label on the left bottom corner of the chart.

Returns:
{sap.suite.ui.microchart.ColumnMicroChartLabel}
getLeftTopLabel(): sap.suite.ui.microchart.ColumnMicroChartLabel
Gets content of aggregation leftTopLabel.

The label on the left top corner of the chart.

Returns:
{sap.suite.ui.microchart.ColumnMicroChartLabel}
getRightBottomLabel(): sap.suite.ui.microchart.ColumnMicroChartLabel
Gets content of aggregation rightBottomLabel.

The label on the right bottom corner of the chart.

Returns:
{sap.suite.ui.microchart.ColumnMicroChartLabel}
getRightTopLabel(): sap.suite.ui.microchart.ColumnMicroChartLabel
Gets content of aggregation rightTopLabel.

The label on the right top corner of the chart.

Returns:
{sap.suite.ui.microchart.ColumnMicroChartLabel}
getSize(): sap.m.Size
Gets current value of 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.m.Size} Value of property size
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

The width of the chart. If it is not set, the width of the control is defined by the size property.

Returns:
{sap.ui.core.CSSSize} Value of property width
indexOfColumn(oColumn): int
Checks for the provided sap.suite.ui.microchart.ColumnMicroChartData in the aggregation columns. and returns its index if found or -1 otherwise.
Parameters:
{sap.suite.ui.microchart.ColumnMicroChartData}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.microchart.ColumnMicroChart
Inserts a column into the aggregation columns.
Parameters:
{sap.suite.ui.microchart.ColumnMicroChartData}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.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
removeAllColumns(): sap.suite.ui.microchart.ColumnMicroChartData[]
Removes all the controls from the aggregation columns.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.suite.ui.microchart.ColumnMicroChartData[]} An array of the removed elements (might be empty)
removeColumn(vColumn): sap.suite.ui.microchart.ColumnMicroChartData
Removes a column from the aggregation columns.
Parameters:
{int|string|sap.suite.ui.microchart.ColumnMicroChartData}vColumn The columnto remove or its index or id
Returns:
{sap.suite.ui.microchart.ColumnMicroChartData} The removed column or null
setHeight(sHeight): sap.suite.ui.microchart.ColumnMicroChart
Sets a new value for property height.

The height of the chart. If it is not set, the height of the control is defined by the size property.

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

Parameters:
{sap.ui.core.CSSSize}sHeight New value for property height
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
setIsResponsive(bIsResponsive): sap.suite.ui.microchart.ColumnMicroChart
Sets a new value for property isResponsive.

If 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. Size, width and height properties are ignored in this 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:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
setLeftBottomLabel(oLeftBottomLabel): sap.suite.ui.microchart.ColumnMicroChart
Sets the aggregated leftBottomLabel.
Parameters:
{sap.suite.ui.microchart.ColumnMicroChartLabel}oLeftBottomLabel The leftBottomLabel to set
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
setLeftTopLabel(oLeftTopLabel): sap.suite.ui.microchart.ColumnMicroChart
Sets the aggregated leftTopLabel.
Parameters:
{sap.suite.ui.microchart.ColumnMicroChartLabel}oLeftTopLabel The leftTopLabel to set
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
setRightBottomLabel(oRightBottomLabel): sap.suite.ui.microchart.ColumnMicroChart
Sets the aggregated rightBottomLabel.
Parameters:
{sap.suite.ui.microchart.ColumnMicroChartLabel}oRightBottomLabel The rightBottomLabel to set
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
setRightTopLabel(oRightTopLabel): sap.suite.ui.microchart.ColumnMicroChart
Sets the aggregated rightTopLabel.
Parameters:
{sap.suite.ui.microchart.ColumnMicroChartLabel}oRightTopLabel The rightTopLabel to set
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
setSize(sSize): sap.suite.ui.microchart.ColumnMicroChart
Sets a new value for property size.

Updates the size of the chart. If not set then the default size is applied based on the device tile.

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

Default value is Auto.

Parameters:
{sap.m.Size}sSize New value for property size
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
setWidth(sWidth): sap.suite.ui.microchart.ColumnMicroChart
Sets a new value for property width.

The width of the chart. If it is not set, the width of the control is defined by the size property.

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

Parameters:
{sap.ui.core.CSSSize}sWidth New value for property width
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining
unbindColumns(): sap.suite.ui.microchart.ColumnMicroChart
Unbinds aggregation columns from model data.
Returns:
{sap.suite.ui.microchart.ColumnMicroChart} Reference to this in order to allow method chaining