Class sap.suite.ui.commons.HarveyBallMicroChartModule: sap/suite/ui/commons/HarveyBallMicroChart

extends Control

This chart shows the part comparative to total.

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

Constructor Summary
new sap.suite.ui.commons.HarveyBallMicroChart(sId?, mSettings?)Constructor for a new HarveyBallMicroChart.
Event Summary
press(oControlEvent)The event is fired when the user chooses the control.
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.HarveyBallMicroChart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.HarveyBallMicroChart with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.HarveyBallMicroChart.getMetadata()Returns a metadata object for class sap.suite.ui.commons.HarveyBallMicroChart.
addItem(oItem)Adds some item oItem to the aggregation named items.
attachPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.HarveyBallMicroChart.
destroyItems()Destroys all the items in the aggregation named items.
detachPress(fnFunction, oListener)Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.HarveyBallMicroChart.
firePress(mArguments?)Fire event press to attached listeners.
getColorPalette()Getter for property colorPalette.
getFormattedLabel()Getter for property formattedLabel.
getItems()Getter for aggregation items.
getShowFractions()Getter for property showFractions.
getShowTotal()Getter for property showTotal.
getSize()Getter for property size.
getTotal()Getter for property total.
getTotalLabel()Getter for property totalLabel.
getTotalScale()Getter for property totalScale.
getWidth()Getter for property width.
indexOfItem(oItem)Checks for the provided sap.suite.ui.commons.HarveyBallMicroChartItem in the aggregation named items and returns its index if found or -1 otherwise.
insertItem(oItem, iIndex)Inserts a item into the aggregation named items.
removeAllItems()Removes all the controls in the aggregation named items.
removeItem(vItem)Removes an item from the aggregation named items.
setColorPalette(aColorPalette)Setter for property colorPalette.
setFormattedLabel(bFormattedLabel)Setter for property formattedLabel.
setShowFractions(bShowFractions)Setter for property showFractions.
setShowTotal(bShowTotal)Setter for property showTotal.
setSize(oSize)Setter for property size.
setTotal(fTotal)Setter for property total.
setTotalLabel(sTotalLabel)Setter for property totalLabel.
setTotalScale(sTotalScale)Setter for property totalScale.
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.HarveyBallMicroChart(sId?, mSettings?)
Constructor for a new HarveyBallMicroChart.

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
    • items : sap.suite.ui.commons.HarveyBallMicroChartItem[]
  • 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.HarveyBallMicroChart should be used.
    Event Detail
    press(oControlEvent)
    The event is fired when the user chooses the control.
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    Method Detail
    sap.suite.ui.commons.HarveyBallMicroChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.suite.ui.commons.HarveyBallMicroChart 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.HarveyBallMicroChart.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.suite.ui.commons.HarveyBallMicroChart.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    addItem(oItem): sap.suite.ui.commons.HarveyBallMicroChart
    Adds some item oItem to the aggregation named items.
    Parameters:
    {sap.suite.ui.commons.HarveyBallMicroChartItem}oItem the item to add; if empty, nothing is inserted
    Returns:
    {sap.suite.ui.commons.HarveyBallMicroChart}this to allow method chaining
    attachPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.HarveyBallMicroChart
    Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.HarveyBallMicroChart.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.HarveyBallMicroChart.
    itself.

    The event is fired when the user chooses the control.

    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.HarveyBallMicroChart.
    itself.
    Returns:
    {sap.suite.ui.commons.HarveyBallMicroChart}this to allow method chaining
    destroyItems(): sap.suite.ui.commons.HarveyBallMicroChart
    Destroys all the items in the aggregation named items.
    Returns:
    {sap.suite.ui.commons.HarveyBallMicroChart}this to allow method chaining
    detachPress(fnFunction, oListener): sap.suite.ui.commons.HarveyBallMicroChart
    Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.HarveyBallMicroChart.

    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.HarveyBallMicroChart}this to allow method chaining
    firePress(mArguments?): sap.suite.ui.commons.HarveyBallMicroChart
    Fire event press to attached listeners.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.suite.ui.commons.HarveyBallMicroChart}this to allow method chaining
    getColorPalette(): string[]
    Getter for property colorPalette. The color palette for the chart. If this property is set, semantic colors defined in HarveyBallMicroChart are ignored. Colors from the palette are assigned to each slice consequentially. When all the palette colors are used, assignment of the colors begins from the first palette color.

    Default value is []

    Returns:
    {string[]} the value of property colorPalette
    getFormattedLabel(): boolean
    Getter for property formattedLabel. If set to true, the totalLabel parameter is considered as the combination of the total value and its scaling factor. The default value is false. It means that the total value and the scaling factor are defined separately by the total and the totalScale properties accordingly.

    Default value is false

    Returns:
    {boolean} the value of property formattedLabel
    getItems(): sap.suite.ui.commons.HarveyBallMicroChartItem[]
    Getter for aggregation items.
    The pie chart slices.
    Returns:
    {sap.suite.ui.commons.HarveyBallMicroChartItem[]}
    getShowFractions(): boolean
    Getter for property showFractions. If it is set to true, the fraction values are displayed next to the chart. The default setting is true.

    Default value is true

    Returns:
    {boolean} the value of property showFractions
    getShowTotal(): boolean
    Getter for property showTotal. If it is set to true, the total value is displayed next to the chart. The default setting is true.

    Default value is true

    Returns:
    {boolean} the value of property showTotal
    getSize(): sap.suite.ui.commons.InfoTileSize
    Getter for property size. The size of the chart. If it is not set, the default size is applied based on the device type.

    Default value is Auto

    Returns:
    {sap.suite.ui.commons.InfoTileSize} the value of property size
    getTotal(): float
    Getter for property total. The total value. This is taken as 360 degrees value on the chart.

    Default value is 0

    Returns:
    {float} the value of property total
    getTotalLabel(): string
    Getter for property totalLabel. The total label. If specified, it is displayed instead of the total value.

    Default value is empty/undefined

    Returns:
    {string} the value of property totalLabel
    getTotalScale(): string
    Getter for property totalScale. The scaling factor that is displayed next to the total value.

    Default value is empty/undefined

    Returns:
    {string} the value of property totalScale
    getWidth(): sap.ui.core.CSSSize
    Getter for property width. The width of the chart. If it is not set, the size of the control is defined by the size property.

    Default value is empty/undefined

    Returns:
    {sap.ui.core.CSSSize} the value of property width
    indexOfItem(oItem): int
    Checks for the provided sap.suite.ui.commons.HarveyBallMicroChartItem in the aggregation named items and returns its index if found or -1 otherwise.
    Parameters:
    {sap.suite.ui.commons.HarveyBallMicroChartItem}oItem the item whose index is looked for.
    Returns:
    {int} the index of the provided control in the aggregation if found, or -1 otherwise
    insertItem(oItem, iIndex): sap.suite.ui.commons.HarveyBallMicroChart
    Inserts a item into the aggregation named items.
    Parameters:
    {sap.suite.ui.commons.HarveyBallMicroChartItem}oItem the item to insert; if empty, nothing is inserted
    {int}iIndex the 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
    Returns:
    {sap.suite.ui.commons.HarveyBallMicroChart}this to allow method chaining
    removeAllItems(): sap.suite.ui.commons.HarveyBallMicroChartItem[]
    Removes all the controls in the aggregation named items.
    Additionally unregisters them from the hosting UIArea.
    Returns:
    {sap.suite.ui.commons.HarveyBallMicroChartItem[]} an array of the removed elements (might be empty)
    removeItem(vItem): sap.suite.ui.commons.HarveyBallMicroChartItem
    Removes an item from the aggregation named items.
    Parameters:
    {int|string|sap.suite.ui.commons.HarveyBallMicroChartItem}vItem the item to remove or its index or id
    Returns:
    {sap.suite.ui.commons.HarveyBallMicroChartItem} the removed item or null
    setColorPalette(aColorPalette): sap.suite.ui.commons.HarveyBallMicroChart
    Setter for property colorPalette.

    Default value is []

    Parameters:
    {string[]}aColorPalette new value for property colorPalette
    Returns:
    {sap.suite.ui.commons.HarveyBallMicroChart}this to allow method chaining
    setFormattedLabel(bFormattedLabel): sap.suite.ui.commons.HarveyBallMicroChart
    Setter for property formattedLabel.

    Default value is false

    Parameters:
    {boolean}bFormattedLabel new value for property formattedLabel
    Returns:
    {sap.suite.ui.commons.HarveyBallMicroChart}this to allow method chaining
    setShowFractions(bShowFractions): sap.suite.ui.commons.HarveyBallMicroChart
    Setter for property showFractions.

    Default value is true

    Parameters:
    {boolean}bShowFractions new value for property showFractions
    Returns:
    {sap.suite.ui.commons.HarveyBallMicroChart}this to allow method chaining
    setShowTotal(bShowTotal): sap.suite.ui.commons.HarveyBallMicroChart
    Setter for property showTotal.

    Default value is true

    Parameters:
    {boolean}bShowTotal new value for property showTotal
    Returns:
    {sap.suite.ui.commons.HarveyBallMicroChart}this to allow method chaining
    setSize(oSize): sap.suite.ui.commons.HarveyBallMicroChart
    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.HarveyBallMicroChart}this to allow method chaining
    setTotal(fTotal): sap.suite.ui.commons.HarveyBallMicroChart
    Setter for property total.

    Default value is 0

    Parameters:
    {float}fTotal new value for property total
    Returns:
    {sap.suite.ui.commons.HarveyBallMicroChart}this to allow method chaining
    setTotalLabel(sTotalLabel): sap.suite.ui.commons.HarveyBallMicroChart
    Setter for property totalLabel.

    Default value is empty/undefined

    Parameters:
    {string}sTotalLabel new value for property totalLabel
    Returns:
    {sap.suite.ui.commons.HarveyBallMicroChart}this to allow method chaining
    setTotalScale(sTotalScale): sap.suite.ui.commons.HarveyBallMicroChart
    Setter for property totalScale.

    Default value is empty/undefined

    Parameters:
    {string}sTotalScale new value for property totalScale
    Returns:
    {sap.suite.ui.commons.HarveyBallMicroChart}this to allow method chaining
    setWidth(sWidth): sap.suite.ui.commons.HarveyBallMicroChart
    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.HarveyBallMicroChart}this to allow method chaining