Class sap.ca.ui.charts.BubbleChartModule: sap/ca/ui/charts/BubbleChart
extends Chart
Bubble chart.
Deprecated API:Since version 1.24.
Sap.ca charts have been replaced with sap.viz and vizFrame in 1.24. The UI5 control "sap.viz.ui5.controls.VizFrame" serves as a single point of entry for all the new charts. Now that 1.24 is available you are asked to use sap.viz charts and the VizFrame instead! This control will not be supported anymore from 1.24.
Constructor Summary
Field Summary
clearVerticalLinesClears the array of saved vertical lines.
drawVerticalLineAtDraws a vertical line at the given x axis value.
Events borrowed from class sap.ca.ui.charts.Chart
Events borrowed from class sap.ui.core.Control
Events borrowed from class sap.ui.base.ManagedObject
Method Summary
sap.ca.ui.charts.BubbleChart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ca.ui.charts.BubbleChart with name
sClassName and enriches it with the information contained in oClassInfo.sap.ca.ui.charts.BubbleChart.getMetadata()Returns a metadata object for class sap.ca.ui.charts.BubbleChart.
indexOfContent(oContent)Checks for the provided
sap.ui.core.Control in the aggregation named content and returns its index if found or -1 otherwise.Methods borrowed from class sap.ca.ui.charts.Chart
_createId, advancedChartSettings, attachPopoverAfterOpen, attachPopoverBeforeOpen, attachSelectDataPoint, bindLabel, dataLabelFormatter, detachPopoverAfterOpen, detachPopoverBeforeOpen, detachSelectDataPoint, firePopoverAfterOpen, firePopoverBeforeOpen, fireSelectDataPoint, getAdvancedChartSettings, getChartPopOver, getChartSemanticColorFormatter, getChartType, getDataLabelFormatter, getDataset, getHeight, getIcon, getInternalVizChart, getLabel, getMinShapeSize, getNoData, getPlotAreaAxisTooltipFormatter, getPopoverFooter, getPopoverFormatter, getPopoverGroupFormatter, getPopoverSubHeader, getSecondAxisVisible, getSelectionMode, getShowDataLabel, getShowHoverBackground, getShowLegend, getShowPopover, getShowTooltip, getStackedChartWidthEnhancer, getTitle, getTooltipFormatter, getWidth, getXAxis2LabelFormatter, getXAxisLabelFormatter, getYAxis2LabelFormatter, getYAxisLabelFormatter, minShapeSize, popoverFormatter, popoverGroupFormatter, setAdvancedChartSettings, setChartPopOver, setChartSemanticColorFormatter, setChartType, setDataLabelFormatter, setDataset, setHeight, setIcon, setInternalVizChart, setLabel, setMinShapeSize, setModel, setNoData, setPlotAreaAxisTooltipFormatter, setPopoverFooter, setPopoverFormatter, setPopoverGroupFormatter, setPopoverSubHeader, setSecondAxisVisible, setSelectionMode, setShowDataLabel, setShowHoverBackground, setShowLegend, setShowPopover, setShowTooltip, setStackedChartWidthEnhancer, setTitle, setTooltipFormatter, setWidth, setXAxis2LabelFormatter, setXAxisLabelFormatter, setYAxis2LabelFormatter, setYAxisLabelFormatter, tooltipFormatter, unbindLabel, xAxis2LabelFormatter, xAxisLabelFormatter, yAxis2LabelFormatter, yAxisLabelFormatter
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, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, 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, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
Constructor Detail
new sap.ca.ui.charts.BubbleChart(sId?, mSettings?)
Constructor for a new charts/BubbleChart.
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
- dataLabelFormat : any
- showTitle : boolean (default: false)
- showXAxisLabel : boolean (default: true)
- xAxisFixedRange : boolean (default: false)
- xAxisMinValue : float (default: 0)
- xAxisMaxValue : float (default: 0)
- showYAxisLabel : boolean (default: true)
- yAxisFixedRange : boolean (default: false)
- yAxisMinValue : float (default: 0)
- yAxisMaxValue : float (default: 0)
- minimumLabelSize : int (default: 60)
- showSizeLegend : boolean (default: false)
- xAxisTitle : string
- yAxisTitle : string
- showCustomLabels : boolean (default: false)
- labelProperty : object
- xAxisFormatFunction : object
- xAxisFormatString : string
- yAxisFormatFunction : object
- yAxisFormatString : string
- axisTooltipFormatString : any
- axisFormatFunction : object
- Aggregations
- content : sap.ui.core.Control[]
- Associations
- Events
In addition, all settings applicable to the base type sap.ca.ui.charts.Chart 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 |
- Deprecated:
- Since version 1.24.
Sap.ca charts have been replaced with sap.viz and vizFrame in 1.24. The UI5 control "sap.viz.ui5.controls.VizFrame" serves as a single point of entry for all the new charts. Now that 1.24 is available you are asked to use sap.viz charts and the VizFrame instead! This control will not be supported anymore from 1.24.
Field Detail
Method Detail
sap.ca.ui.charts.BubbleChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ca.ui.charts.BubbleChart 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.ca.ui.charts.BubbleChart.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ca.ui.charts.BubbleChart.
Returns:
| {sap.ui.base.Metadata} | Metadata object describing this class |
getLabelProperty(): object
Getter for property
labelProperty. Set the binding property values for the labels as array eg. ['property1','property2']. Only 2 labels are supported. Default value is empty/undefined
Returns:
| {object} | the value of property labelProperty |
getMinimumLabelSize(): int
Getter for property
minimumLabelSize. The minimum size of the bubble before a label gets displayed Default value is 60
Returns:
| {int} | the value of property minimumLabelSize |
getShowCustomLabels(): boolean
Getter for property
showCustomLabels. Flag to show custom data labels Default value is false
Returns:
| {boolean} | the value of property showCustomLabels |
getShowSizeLegend(): boolean
Getter for property
showSizeLegend. Show / Hide the visibility the size legend of the chart Default value is false
Returns:
| {boolean} | the value of property showSizeLegend |
getShowTitle(): boolean
Getter for property
showTitle. Flag to display the title for the chart, default is set to false Default value is false
Returns:
| {boolean} | the value of property showTitle |
getShowXAxisLabel(): boolean
Getter for property
showXAxisLabel. Flag to set the visibility of x-axis label, default is set to true. Default value is true
Returns:
| {boolean} | the value of property showXAxisLabel |
getShowYAxisLabel(): boolean
Getter for property
showYAxisLabel. Flag to set the visibility of y-axis label, default is set to true. Default value is true
Returns:
| {boolean} | the value of property showYAxisLabel |
getXAxisFixedRange(): boolean
Getter for property
xAxisFixedRange. Flag to define x-axis scale range. Default value is false
Returns:
| {boolean} | the value of property xAxisFixedRange |
getXAxisMaxValue(): float
Getter for property
xAxisMaxValue. Define the max value for x-axis scale Default value is 0
Returns:
| {float} | the value of property xAxisMaxValue |
getXAxisMinValue(): float
Getter for property
xAxisMinValue. Define the minimum value for x-axis scale Default value is 0
Returns:
| {float} | the value of property xAxisMinValue |
getXAxisTitle(): string
Getter for property
xAxisTitle. Set x-axis title Default value is empty/undefined
Returns:
| {string} | the value of property xAxisTitle |
getYAxisFixedRange(): boolean
Getter for property
yAxisFixedRange. Flag to define y-axis scale range. Default value is false
Returns:
| {boolean} | the value of property yAxisFixedRange |
getYAxisMaxValue(): float
Getter for property
yAxisMaxValue. Define the max value for y-axis scale Default value is 0
Returns:
| {float} | the value of property yAxisMaxValue |
getYAxisMinValue(): float
Getter for property
yAxisMinValue. Define the minimum value for y-axis scale Default value is 0
Returns:
| {float} | the value of property yAxisMinValue |
getYAxisTitle(): string
Getter for property
yAxisTitle. Set y-axis title Default value is empty/undefined
Returns:
| {string} | the value of property yAxisTitle |
setLabelProperty(oLabelProperty): sap.ca.ui.charts.BubbleChart
Setter for property
labelProperty. Default value is empty/undefined
Parameters:
| {object} | oLabelProperty | new value for property labelProperty |
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setMinimumLabelSize(iMinimumLabelSize): sap.ca.ui.charts.BubbleChart
Setter for property
minimumLabelSize. Default value is 60
Parameters:
| {int} | iMinimumLabelSize | new value for property minimumLabelSize |
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setShowCustomLabels(bShowCustomLabels): sap.ca.ui.charts.BubbleChart
Setter for property
showCustomLabels. Default value is false
Parameters:
| {boolean} | bShowCustomLabels | new value for property showCustomLabels |
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setShowSizeLegend(bShowSizeLegend): sap.ca.ui.charts.BubbleChart
Setter for property
showSizeLegend. Default value is false
Parameters:
| {boolean} | bShowSizeLegend | new value for property showSizeLegend |
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setShowTitle(bShowTitle): sap.ca.ui.charts.BubbleChart
Setter for property
showTitle. Default value is false
Parameters:
| {boolean} | bShowTitle | new value for property showTitle |
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setShowXAxisLabel(bShowXAxisLabel): sap.ca.ui.charts.BubbleChart
Setter for property
showXAxisLabel. Default value is true
Parameters:
| {boolean} | bShowXAxisLabel | new value for property showXAxisLabel |
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setShowYAxisLabel(bShowYAxisLabel): sap.ca.ui.charts.BubbleChart
Setter for property
showYAxisLabel. Default value is true
Parameters:
| {boolean} | bShowYAxisLabel | new value for property showYAxisLabel |
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setXAxisFixedRange(bXAxisFixedRange): sap.ca.ui.charts.BubbleChart
Setter for property
xAxisFixedRange. Default value is false
Parameters:
| {boolean} | bXAxisFixedRange | new value for property xAxisFixedRange |
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setXAxisMaxValue(fXAxisMaxValue): sap.ca.ui.charts.BubbleChart
Setter for property
xAxisMaxValue. Default value is 0
Parameters:
| {float} | fXAxisMaxValue | new value for property xAxisMaxValue |
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setXAxisMinValue(fXAxisMinValue): sap.ca.ui.charts.BubbleChart
Setter for property
xAxisMinValue. Default value is 0
Parameters:
| {float} | fXAxisMinValue | new value for property xAxisMinValue |
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setXAxisTitle(sXAxisTitle): sap.ca.ui.charts.BubbleChart
Setter for property
xAxisTitle. Default value is empty/undefined
Parameters:
| {string} | sXAxisTitle | new value for property xAxisTitle |
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setYAxisFixedRange(bYAxisFixedRange): sap.ca.ui.charts.BubbleChart
Setter for property
yAxisFixedRange. Default value is false
Parameters:
| {boolean} | bYAxisFixedRange | new value for property yAxisFixedRange |
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setYAxisMaxValue(fYAxisMaxValue): sap.ca.ui.charts.BubbleChart
Setter for property
yAxisMaxValue. Default value is 0
Parameters:
| {float} | fYAxisMaxValue | new value for property yAxisMaxValue |
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setYAxisMinValue(fYAxisMinValue): sap.ca.ui.charts.BubbleChart
Setter for property
yAxisMinValue. Default value is 0
Parameters:
| {float} | fYAxisMinValue | new value for property yAxisMinValue |
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setYAxisTitle(sYAxisTitle): sap.ca.ui.charts.BubbleChart
Setter for property
yAxisTitle. Default value is empty/undefined
Parameters:
| {string} | sYAxisTitle | new value for property yAxisTitle |
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
addContent(oContent): sap.ca.ui.charts.BubbleChart
Adds some content
oContent to the aggregation named content. Parameters:
| {sap.ui.core.Control} | oContent | the content to add; if empty, nothing is inserted |
- Deprecated:
- Since version 7.20.0. This method is deprecated now.
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
destroyContent(): sap.ca.ui.charts.BubbleChart
Destroys all the content in the aggregation named
content. - Deprecated:
- Since version 7.20.0. This method is deprecated now.
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
getAxisFormatFunction(): object
Getter for property
axisFormatFunction. Set the formatter function for the axis labels or tooltips Default value is empty/undefined
- Deprecated:
- Since version 7.20.0. This method is deprecated now. Use the plotAreaAxisTooltipFormatter
Returns:
| {object} | the value of property axisFormatFunction |
getAxisTooltipFormatString(): any
Getter for property
axisTooltipFormatString. Flag to set the formatting of the tooltip on x-axis Default value is empty/undefined
- Deprecated:
- Since version 7.20.0. This method is deprecated now. Use the plotAreaAxisTooltipFormatter
Returns:
| {any} | the value of property axisTooltipFormatString |
getContent(): sap.ui.core.Control[]
Getter for aggregation
Deprecated aggregation, do not use. Left for compatibility purposes.
content.Deprecated aggregation, do not use. Left for compatibility purposes.
- Deprecated:
- Since version 7.20.0. This method is deprecated now.
Returns:
| {sap.ui.core.Control[]} |
getDataLabelFormat(): any
Getter for property
dataLabelFormat. Defines the formater string for the dataLabel value to be displayed on the bubble Default value is empty/undefined
- Deprecated:
- Since version 7.20.0. This method is deprecated now. Use the dataLabelFormatter for any formatting of data label
Returns:
| {any} | the value of property dataLabelFormat |
getXAxisFormatFunction(): object
Getter for property
xAxisFormatFunction. Set the formatter function for the x-axis. Default value is empty/undefined
- Deprecated:
- Since version 7.20.0. This method is deprecated now. Use the xAxisLabelFormatter for any formatting of the axis labels
Returns:
| {object} | the value of property xAxisFormatFunction |
getXAxisFormatString(): string
Getter for property
xAxisFormatString. Set the format string for x-axis Default value is empty/undefined
- Deprecated:
- Since version 7.20.0. This method is deprecated now. Use the xAxisLabelFormatter for any formatting of the axis labels
Returns:
| {string} | the value of property xAxisFormatString |
getYAxisFormatFunction(): object
Getter for property
yAxisFormatFunction. Set the formatter function for the y-axis. Default value is empty/undefined
- Deprecated:
- Since version 7.20.0. This method is deprecated now. Use the yAxisLabelFormatter for any formatting of the axis labels
Returns:
| {object} | the value of property yAxisFormatFunction |
getYAxisFormatString(): string
Getter for property
yAxisFormatString. Set the format string for y-axis Default value is empty/undefined
- Deprecated:
- Since version 7.20.0. This method is deprecated now. Use the yAxisLabelFormatter for any formatting of the axis labels
Returns:
| {string} | the value of property yAxisFormatString |
indexOfContent(oContent): int
Checks for the provided
sap.ui.core.Control in the aggregation named content and returns its index if found or -1 otherwise. Parameters:
| {sap.ui.core.Control} | oContent | the content whose index is looked for. |
- Deprecated:
- Since version 7.20.0. This method is deprecated now.
Returns:
| {int} | the index of the provided control in the aggregation if found, or -1 otherwise |
insertContent(oContent, iIndex): sap.ca.ui.charts.BubbleChart
Inserts a content into the aggregation named
content. Parameters:
| {sap.ui.core.Control} | oContent | the content to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the content should be inserted at; for a negative value of iIndex, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position |
- Deprecated:
- Since version 7.20.0. This method is deprecated now.
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
removeAllContent(): sap.ui.core.Control[]
Removes all the controls in the aggregation named
Additionally unregisters them from the hosting UIArea.
content.Additionally unregisters them from the hosting UIArea.
- Deprecated:
- Since version 7.20.0. This method is deprecated now.
Returns:
| {sap.ui.core.Control[]} | an array of the removed elements (might be empty) |
removeContent(vContent): sap.ui.core.Control
Removes an content from the aggregation named
content. Parameters:
| {int|string|sap.ui.core.Control} | vContent | the content to remove or its index or id |
- Deprecated:
- Since version 7.20.0. This method is deprecated now.
Returns:
| {sap.ui.core.Control} | the removed content or null |
setAxisFormatFunction(oAxisFormatFunction): sap.ca.ui.charts.BubbleChart
Setter for property
axisFormatFunction. Default value is empty/undefined
Parameters:
| {object} | oAxisFormatFunction | new value for property axisFormatFunction |
- Deprecated:
- Since version 7.20.0. This method is deprecated now. Use the plotAreaAxisTooltipFormatter
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setAxisTooltipFormatString(oAxisTooltipFormatString): sap.ca.ui.charts.BubbleChart
Setter for property
axisTooltipFormatString. Default value is empty/undefined
Parameters:
| {any} | oAxisTooltipFormatString | new value for property axisTooltipFormatString |
- Deprecated:
- Since version 7.20.0. This method is deprecated now. Use the plotAreaAxisTooltipFormatter
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setDataLabelFormat(oDataLabelFormat): sap.ca.ui.charts.BubbleChart
Setter for property
dataLabelFormat. Default value is empty/undefined
Parameters:
| {any} | oDataLabelFormat | new value for property dataLabelFormat |
- Deprecated:
- Since version 7.20.0. This method is deprecated now. Use the dataLabelFormatter for any formatting of data label
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setXAxisFormatFunction(oXAxisFormatFunction): sap.ca.ui.charts.BubbleChart
Setter for property
xAxisFormatFunction. Default value is empty/undefined
Parameters:
| {object} | oXAxisFormatFunction | new value for property xAxisFormatFunction |
- Deprecated:
- Since version 7.20.0. This method is deprecated now. Use the xAxisLabelFormatter for any formatting of the axis labels
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setXAxisFormatString(sXAxisFormatString): sap.ca.ui.charts.BubbleChart
Setter for property
xAxisFormatString. Default value is empty/undefined
Parameters:
| {string} | sXAxisFormatString | new value for property xAxisFormatString |
- Deprecated:
- Since version 7.20.0. This method is deprecated now. Use the xAxisLabelFormatter for any formatting of the axis labels
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setYAxisFormatFunction(oYAxisFormatFunction): sap.ca.ui.charts.BubbleChart
Setter for property
yAxisFormatFunction. Default value is empty/undefined
Parameters:
| {object} | oYAxisFormatFunction | new value for property yAxisFormatFunction |
- Deprecated:
- Since version 7.20.0. This method is deprecated now. Use the yAxisLabelFormatter for any formatting of the axis labels
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |
setYAxisFormatString(sYAxisFormatString): sap.ca.ui.charts.BubbleChart
Setter for property
yAxisFormatString. Default value is empty/undefined
Parameters:
| {string} | sYAxisFormatString | new value for property yAxisFormatString |
- Deprecated:
- Since version 7.20.0. This method is deprecated now. Use the yAxisLabelFormatter for any formatting of the axis labels
Returns:
| {sap.ca.ui.charts.BubbleChart} | this to allow method chaining |