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

extends Control

This control shows a column chart.

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

Constructor Summary
new sap.suite.ui.commons.ColumnMicroChart(sId?, mSettings?)Constructor for a new ColumnMicroChart.
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.commons.ColumnMicroChart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.ColumnMicroChart with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.ColumnMicroChart.getMetadata()Returns a metadata object for class sap.suite.ui.commons.ColumnMicroChart.
addColumn(oColumn)Adds some column oColumn to the aggregation named columns.
attachPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.ColumnMicroChart.
destroyColumns()Destroys all the columns in the aggregation named columns.
destroyLeftBottomLabel()Destroys the leftBottomLabel in the aggregation named leftBottomLabel.
destroyLeftTopLabel()Destroys the leftTopLabel in the aggregation named leftTopLabel.
destroyRightBottomLabel()Destroys the rightBottomLabel in the aggregation named rightBottomLabel.
destroyRightTopLabel()Destroys the rightTopLabel in the aggregation named rightTopLabel.
detachPress(fnFunction, oListener)Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.ColumnMicroChart.
firePress(mArguments?)Fire event press to attached listeners.
getColumns()Getter for aggregation columns.
getHeight()Getter for property height.
getLeftBottomLabel()Getter for aggregation leftBottomLabel.
getLeftTopLabel()Getter for aggregation leftTopLabel.
getRightBottomLabel()Getter for aggregation rightBottomLabel.
getRightTopLabel()Getter for aggregation rightTopLabel.
getSize()Getter for property size.
getWidth()Getter for property width.
indexOfColumn(oColumn)Checks for the provided sap.suite.ui.commons.ColumnData in the aggregation named columns and returns its index if found or -1 otherwise.
insertColumn(oColumn, iIndex)Inserts a column into the aggregation named columns.
removeAllColumns()Removes all the controls in the aggregation named columns.
removeColumn(vColumn)Removes an column from the aggregation named columns.
setHeight(sHeight)Setter for property height.
setLeftBottomLabel(oLeftBottomLabel)Setter for the aggregated leftBottomLabel.
setLeftTopLabel(oLeftTopLabel)Setter for the aggregated leftTopLabel.
setRightBottomLabel(oRightBottomLabel)Setter for the aggregated rightBottomLabel.
setRightTopLabel(oRightTopLabel)Setter for the aggregated rightTopLabel.
setSize(oSize)Setter for property size.
setWidth(sWidth)Setter for property width.
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.commons.ColumnMicroChart(sId?, mSettings?)
Constructor for a new ColumnMicroChart.

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
    • size : sap.suite.ui.commons.InfoTileSize (default: sap.suite.ui.commons.InfoTileSize.Auto)
    • width : sap.ui.core.CSSSize
    • height : sap.ui.core.CSSSize
  • Aggregations
  • 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.ColumnMicroChart should be used.
    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.commons.ColumnMicroChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.suite.ui.commons.ColumnMicroChart 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.ColumnMicroChart.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.suite.ui.commons.ColumnMicroChart.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    addColumn(oColumn): sap.suite.ui.commons.ColumnMicroChart
    Adds some column oColumn to the aggregation named columns.
    Parameters:
    {sap.suite.ui.commons.ColumnData}oColumn the column to add; if empty, nothing is inserted
    Returns:
    {sap.suite.ui.commons.ColumnMicroChart}this to allow method chaining
    attachPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.ColumnMicroChart
    Attach event handler 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