Class sap.ca.ui.charts.ChartModule: sap/ca/ui/charts/Chart
extends Control
known direct subclasses: BubbleChart, CombinedChart, HorizontalBarChart, LineChart, StackedHorizontalBarChart, StackedVerticalColumnChart, VerticalBarChart
Chart implementation on top of sap.viz that takes care of common functionality. - Embedding in a scroll container - Common color palette - Minimum bar / dot / blip ... size - Integration with ChartToolbar and ChartPopover
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
Event Summary
selectDataPoint(oControlEvent)Event is fired when the data point is selected/unselected on the chart
Events borrowed from class sap.ui.core.Control
Events borrowed from class sap.ui.base.ManagedObject
Method Summary
sap.ca.ui.charts.Chart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ca.ui.charts.Chart with name
sClassName and enriches it with the information contained in oClassInfo.attachPopoverAfterOpen(oData?, fnFunction, oListener?)Attach event handler
fnFunction to the 'popoverAfterOpen' event of this sap.ca.ui.charts.Chart.attachPopoverBeforeOpen(oData?, fnFunction, oListener?)Attach event handler
fnFunction to the 'popoverBeforeOpen' event of this sap.ca.ui.charts.Chart.attachSelectDataPoint(oData?, fnFunction, oListener?)Attach event handler
fnFunction to the 'selectDataPoint' event of this sap.ca.ui.charts.Chart.detachPopoverAfterOpen(fnFunction, oListener)Detach event handler
fnFunction from the 'popoverAfterOpen' event of this sap.ca.ui.charts.Chart.detachPopoverBeforeOpen(fnFunction, oListener)Detach event handler
fnFunction from the 'popoverBeforeOpen' event of this sap.ca.ui.charts.Chart.detachSelectDataPoint(fnFunction, oListener)Detach event handler
fnFunction from the 'selectDataPoint' event of this sap.ca.ui.charts.Chart.setChartSemanticColorFormatter(oChartSemanticColorFormatter)Setter for property
chartSemanticColorFormatter.setStackedChartWidthEnhancer(bStackedChartWidthEnhancer)Setter for property
stackedChartWidthEnhancer.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.Chart(sId?, mSettings?)
Constructor for a new charts/Chart.
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
- width : sap.ui.core.CSSSize (default: '100%')
- height : sap.ui.core.CSSSize (default: '100%')
- dataset : object
- chartType : string (default: 'Bar')
- minShapeSize : sap.ui.core.CSSSize (default: '48px')
- label : string (default: '')
- title : string (default: '')
- icon : string (default: '')
- secondAxisVisible : boolean (default: true)
- showLegend : boolean (default: true)
- selectionMode : sap.ca.ui.charts.ChartSelectionMode (default: sap.ca.ui.charts.ChartSelectionMode.Multiple)
- showHoverBackground : boolean (default: false)
- showTooltip : boolean (default: false)
- showPopover : boolean (default: true)
- showDataLabel : boolean (default: true)
- yAxisLabelFormatter : string
- yAxis2LabelFormatter : string
- xAxisLabelFormatter : string
- xAxis2LabelFormatter : string
- plotAreaAxisTooltipFormatter : object
- tooltipFormatter : object
- dataLabelFormatter : object
- popoverFormatter : object
- popoverGroupFormatter : string
- chartSemanticColorFormatter : object
- internalVizChart : sap.ui.core.Control
- chartPopOver : sap.ui.core.Control
- popoverSubHeader : sap.ui.core.Control
- popoverFooter : sap.ui.core.Control
- advancedChartSettings : object
- stackedChartWidthEnhancer : boolean (default: false)
- noData : sap.ui.core.Control
- Aggregations
- Associations
- Events
- selectDataPoint : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- popoverBeforeOpen : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- popoverAfterOpen : 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.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.
Event Detail
popoverAfterOpen(oControlEvent)
Event is fired after the popover is opened
Parameters:
| {sap.ui.base.Event} | oControlEvent | |
| {sap.ui.base.EventProvider} | oControlEvent.getSource | |
| {object} | oControlEvent.getParameters |
popoverBeforeOpen(oControlEvent)
Event is fired before the popover is opened
Parameters:
| {sap.ui.base.Event} | oControlEvent | |
| {sap.ui.base.EventProvider} | oControlEvent.getSource | |
| {object} | oControlEvent.getParameters |
selectDataPoint(oControlEvent)
Event is fired when the data point is selected/unselected on the chart
Parameters:
| {sap.ui.base.Event} | oControlEvent | |
| {sap.ui.base.EventProvider} | oControlEvent.getSource | |
| {object} | oControlEvent.getParameters |
Method Detail
sap.ca.ui.charts.Chart.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ca.ui.charts.Chart 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.Chart.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ca.ui.charts.Chart.
Returns:
| {sap.ui.base.Metadata} | Metadata object describing this class |
advancedChartSettings(settings): sap.ca.ui.charts.Chart
Setter for property
advancedChartSettings. Parameters:
| {object} | settings | You can specify here any advanced viz chart settings that have not been exposed as a chart property. |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
attachPopoverAfterOpen(oData?, fnFunction, oListener?): sap.ca.ui.charts.Chart
Attach event handler
. When called, the context of the event handler (its
fnFunction to the 'popoverAfterOpen' event of this sap.ca.ui.charts.Chart.. When called, the context of the event handler (its
this) will be bound to oListener if specified otherwise to this sap.ca.ui.charts.Chart.
itself. Event is fired after the popover is opened
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.ca.ui.charts.Chart.itself. |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
attachPopoverBeforeOpen(oData?, fnFunction, oListener?): sap.ca.ui.charts.Chart
Attach event handler
. When called, the context of the event handler (its
fnFunction to the 'popoverBeforeOpen' event of this sap.ca.ui.charts.Chart.. When called, the context of the event handler (its
this) will be bound to oListener if specified otherwise to this sap.ca.ui.charts.Chart.
itself. Event is fired before the popover is opened
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.ca.ui.charts.Chart.itself. |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
attachSelectDataPoint(oData?, fnFunction, oListener?): sap.ca.ui.charts.Chart
Attach event handler
. When called, the context of the event handler (its
fnFunction to the 'selectDataPoint' event of this sap.ca.ui.charts.Chart.. When called, the context of the event handler (its
this) will be bound to oListener if specified otherwise to this sap.ca.ui.charts.Chart.
itself. Event is fired when the data point is selected/unselected on the 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.ca.ui.charts.Chart.itself. |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
bindLabel(sPath, fnFormatter?, sMode?): sap.ca.ui.charts.Chart
Binder for property
label. Parameters:
| {string} | sPath | path to a property in the model |
| {function} | fnFormatter? | the formatter function |
| {sap.ui.model.BindingMode} | sMode?, Default: Default | the binding mode to be used for this property binding (e.g. one way) |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
dataLabelFormatter(formatterArray): sap.ca.ui.charts.Chart
Setter for property
dataLabelFormatter. Parameters:
| {object} | formatterArray | new value for property dataLabelFormatter [formatterArray] must be a 2 dimensions array of formatters. [ [ measure 1 of X Axis , ..., [measure n of X Axis] ], [ measure 1 of X Axis 2 , ..., [measure n of X Axis 2] ] Each of these formatters can be: - a custom formatting function - a value of enum sap.ca.ui.charts.DefaultFormatterFunction If for an axis, formatters count < measures count, then first formatter of axis will be used for other measures. |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
detachPopoverAfterOpen(fnFunction, oListener): sap.ca.ui.charts.Chart
Detach event handler
fnFunction from the 'popoverAfterOpen' event of this sap.ca.ui.charts.Chart.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.ca.ui.charts.Chart} | this to allow method chaining |
detachPopoverBeforeOpen(fnFunction, oListener): sap.ca.ui.charts.Chart
Detach event handler
fnFunction from the 'popoverBeforeOpen' event of this sap.ca.ui.charts.Chart.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.ca.ui.charts.Chart} | this to allow method chaining |
detachSelectDataPoint(fnFunction, oListener): sap.ca.ui.charts.Chart
Detach event handler
fnFunction from the 'selectDataPoint' event of this sap.ca.ui.charts.Chart.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.ca.ui.charts.Chart} | this to allow method chaining |
firePopoverAfterOpen(mArguments?): sap.ca.ui.charts.Chart
Fire event popoverAfterOpen to attached listeners.
Parameters:
| {Map} | mArguments? | the arguments to pass along with the event. |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
firePopoverBeforeOpen(mArguments?): sap.ca.ui.charts.Chart
Fire event popoverBeforeOpen to attached listeners.
Parameters:
| {Map} | mArguments? | the arguments to pass along with the event. |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
fireSelectDataPoint(mArguments?): sap.ca.ui.charts.Chart
Fire event selectDataPoint to attached listeners.
Parameters:
| {Map} | mArguments? | the arguments to pass along with the event. |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
getAdvancedChartSettings(): object
Getter for property
advancedChartSettings. You can specify here any advanced viz chart settings that have not been exposed as a chart property. Default value is empty/undefined
Returns:
| {object} | the value of property advancedChartSettings |
getChartPopOver(): sap.m.ResponsivePopover
Getter for property
chartPopOver. chart PopOver Default value is empty/undefined
Returns:
| {sap.m.ResponsivePopover} | oChartPopOver the value of property chartPopOver |
getChartSemanticColorFormatter(): object
Getter for property
chartSemanticColorFormatter. Function that will be called when the chart is rendered in order to let the application decide which color should be use for each bar. The method should take the following parameter as input : - The data context of the current datashape And as output : - One of sap.ca.ui.charts.ChartSemanticColor type Default value is empty/undefined
Returns:
| {object} | the value of property chartSemanticColorFormatter |
getChartType(): string
Getter for property
chartType. Type of viz chart that will be displayed. Default value is Bar
Returns:
| {string} | the value of property chartType |
getDataLabelFormatter(): object
Getter for property
dataLabelFormatter. Formatter for Data Label Default value is empty/undefined
Returns:
| {object} | the value of property dataLabelFormatter |
getDataset(): object
Getter for property
dataset. Viz Dataset that will hold the data to be displayed. Default value is empty/undefined
Returns:
| {object} | oDataset the value of property dataset |
getHeight(): sap.ui.core.CSSSize
Getter for property
height. Target height for the charting area Default value is 100%
Returns:
| {sap.ui.core.CSSSize} | the value of property height |
getIcon(): string
Getter for property
icon. Icon of the Chart Default value is empty/undefined
Returns:
| {string} | the value of property icon |
getInternalVizChart(): object
Getter for property
internalVizChart. internal Viz Chart Default value is empty/undefined
Returns:
| {object} | oInternalVizChart the value of property internalVizChart |
getLabel(): string
Getter for property
label. User friendly name for the current chart type Default value is empty/undefined
Returns:
| {string} | the value of property label |
getMinShapeSize(): sap.ui.core.CSSSize
Getter for property
minShapeSize. Minimum shape size for touch enabled actions, default and minimum to 48px ! Default value is 48px
Returns:
| {sap.ui.core.CSSSize} | the value of property minShapeSize |
getNoData(): sap.ui.core.Control
Getter for aggregation noData in Viz Chart. Control tree to display when there is no data available
Returns:
| {sap.ui.core.Control} | the value for aggregation noData |
getPlotAreaAxisTooltipFormatter(): object
Getter for property
plotAreaAxisTooltipFormatter. Formatter for plotArea Axis Tooltip in bubble charts Default value is empty/undefined
Returns:
| {object} | the value of property plotAreaAxisTooltipFormatter |
getPopoverFooter(): sap.ui.core.Control
Getter for property
popoverFooter. custom footer for popover Default value is empty/undefined
Returns:
| {sap.ui.core.Control} | the value of property popoverFooter |
getPopoverFormatter(): object
Getter for property
popoverFormatter. Formatter for popover Default value is empty/undefined
Returns:
| {object} | the value of property popoverFormatter |
getPopoverGroupFormatter(): string
Getter for property
popoverGroupFormatter. Formatter for group label in the popover Default value is empty/undefined
Returns:
| {string} | the value of property popoverGroupFormatter |
getPopoverSubHeader(): sap.ui.core.Control
Getter for property
popoverSubHeader. custom subHeader for popover Default value is empty/undefined
Returns:
| {sap.ui.core.Control} | the value of property popoverSubHeader |
getSecondAxisVisible(): boolean
Getter for property
secondAxisVisible. Flag to show the second axis. Default is true Default value is true
Returns:
| {boolean} | the value of property secondAxisVisible |
getSelectionMode(): sap.ca.ui.charts.ChartSelectionMode
Getter for property
selectionMode. Returns:
| {sap.ca.ui.charts.ChartSelectionMode} | The selection mode |
getShowDataLabel(): boolean
Getter for property
showDataLabel. Flag to display data values on the bar, default is set to true Default value is true
Returns:
| {boolean} | the value of property showDataLabel |
getShowHoverBackground(): boolean
Getter for property
showHoverBackground. Hide / Show the hover background Default value is false
Returns:
| {boolean} | the value of property showHoverBackground |
getShowLegend(): boolean
Getter for property
showLegend. Hide / Show the legend of the chart Default value is true
Returns:
| {boolean} | the value of property showLegend |
getShowPopover(): boolean
Getter for property
showPopover. Hide / Show the sap.ca popover that gives information about what is available Default value is true
Returns:
| {boolean} | the value of property showPopover |
getShowTooltip(): boolean
Getter for property
showTooltip. Hide / Show the CVOM tooltip Default value is false
Returns:
| {boolean} | the value of property showTooltip |
getStackedChartWidthEnhancer(): boolean
Getter for property
stackedChartWidthEnhancer. You can use it if stacked bar width are to big. Disabled by default Default value is false
Returns:
| {boolean} | the value of property stackedChartWidthEnhancer |
getTitle(): string
Getter for property
title. Title of the chart Default value is empty/undefined
Returns:
| {string} | the value of property title |
getTooltipFormatter(): object
Getter for property
tooltipFormatter. Formatter for toolTip Default value is empty/undefined
Returns:
| {object} | the value of property tooltipFormatter |
getWidth(): sap.ui.core.CSSSize
Getter for property
width. Target width for the charting area Default value is 100%
Returns:
| {sap.ui.core.CSSSize} | the value of property width |
getXAxis2LabelFormatter(): string
Getter for property
xAxis2LabelFormatter. Formatter for X Axis 2 Label Default value is empty/undefined
Returns:
| {string} | the value of property xAxis2LabelFormatter |
getXAxisLabelFormatter(): string
Getter for property
xAxisLabelFormatter. Formatter for X Axis Label Default value is empty/undefined
Returns:
| {string} | the value of property xAxisLabelFormatter |
getYAxis2LabelFormatter(): string
Getter for property
yAxis2LabelFormatter. Formatter for Y Axis 2 Label Default value is empty/undefined
Returns:
| {string} | the value of property yAxis2LabelFormatter |
getYAxisLabelFormatter(): string
Getter for property
yAxisLabelFormatter. Formatter for Y Axis Label Default value is empty/undefined
Returns:
| {string} | the value of property yAxisLabelFormatter |
minShapeSize(sMinShapeSize): sap.ca.ui.charts.Chart
Setter for property
minShapeSize. Note: doesn't work for the bubble chart's bubbles sizes. Parameters:
| {string} | sMinShapeSize | Minimum shape size in pixels. |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
popoverFormatter(formatterArray): sap.ca.ui.charts.Chart
Setter for property
popoverFormatter. Parameters:
| {object} | formatterArray | new value for property popoverFormatter [formatterArray] must be a 2 dimensions array of formatters. [ [ measure 1 of X Axis , ..., [measure n of X Axis] ], [ measure 1 of X Axis 2 , ..., [measure n of X Axis 2] ] Each of these formatters can be: - a custom formatting function - a value of enum sap.ca.ui.charts.DefaultFormatterFunction If for an axis, formatters count < measures count, then first formatter of axis will be used for other measures. |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
popoverGroupFormatter(formatter): sap.ca.ui.charts.Chart
Setter for property
popoverGroupFormatter. Parameters:
| {object} | formatter | new value for property popoverGroupFormatter formatter can be: - a custom formatting function - a value of enum sap.ca.ui.charts.DefaultFormatterFunction |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setAdvancedChartSettings(oAdvancedChartSettings): sap.ca.ui.charts.Chart
Setter for property
advancedChartSettings. Default value is empty/undefined
Parameters:
| {object} | oAdvancedChartSettings | new value for property advancedChartSettings |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setChartPopOver(oChartPopOver): sap.m.ResponsivePopover
Setter for property
chartPopOver. Parameters:
| {sap.m.ResponsivePopover} | oChartPopOver | new value for property chartPopOver |
Returns:
| {sap.m.ResponsivePopover} | this to allow method chaining |
setChartSemanticColorFormatter(oChartSemanticColorFormatter): sap.ca.ui.charts.Chart
Setter for property
chartSemanticColorFormatter. Default value is empty/undefined
Parameters:
| {object} | oChartSemanticColorFormatter | new value for property chartSemanticColorFormatter |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setChartType(sChartType): sap.ca.ui.charts.Chart
Setter for property
chartType. Default value is Bar
Parameters:
| {string} | sChartType | new value for property chartType |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setDataLabelFormatter(oDataLabelFormatter): sap.ca.ui.charts.Chart
Setter for property
dataLabelFormatter. Default value is empty/undefined
Parameters:
| {object} | oDataLabelFormatter | new value for property dataLabelFormatter |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setDataset(oDataset): sap.ca.ui.charts.Chart
Setter for property
dataset. Default value is empty/undefined
Parameters:
| {sap.viz.ui5.data.Dataset} | oDataset | new value for property dataset |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setHeight(sHeight): sap.ca.ui.charts.Chart
Setter for property
height. Default value is 100%
Parameters:
| {sap.ui.core.CSSSize} | sHeight | new value for property height |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setIcon(sIcon): sap.ca.ui.charts.Chart
Setter for property
icon. Default value is empty/undefined
Parameters:
| {string} | sIcon | new value for property icon |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setInternalVizChart(oInternalVizChart): sap.ca.ui.charts.Chart
Setter for property
internalVizChart. Default value is oChart
Parameters:
| {sap.viz.ui5.BaseChart} | oInternalVizChart | new value for property title |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setLabel(sLabel): sap.ca.ui.charts.Chart
Setter for property
label. Default value is empty/undefined
Parameters:
| {string} | sLabel | new value for property label |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setMinShapeSize(sMinShapeSize): sap.ca.ui.charts.Chart
Setter for property
minShapeSize. Default value is 48px
Parameters:
| {sap.ui.core.CSSSize} | sMinShapeSize | new value for property minShapeSize |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setModel(oModel): sap.ca.ui.charts.Chart
Catch the setModel call and make sure we refresh the size of the chart.
Parameters:
| {sap.ui.model.Model} | oModel | the model to be set or null or undefined |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setNoData(oControl)
setter for aggregation noData in Viz Chart. Control tree to display when there is no data available
Parameters:
| {sap.ui.core.Control} | oControl | new value for aggregation noData |
setPlotAreaAxisTooltipFormatter(formatterArray?): sap.ca.ui.charts.Chart
Setter for property
plotAreaAxisTooltipFormatter. Parameters:
| {object} | formatterArray? | new value for property plotAreaAxisTooltipFormatter This is the tooltip for "bubbles" of bubble chart. [formatterArray] must be an array of 2 formatters (one for X Axis, one for Y axis). Each of these formatters can be: - a custom formatting function - a value of enum sap.ca.ui.charts.DefaultFormatterFunction |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setPopoverFooter(oFooter)
setter for footer in the Popover.
Parameters:
| {sap.m.Bar} | oFooter | new value for footer |
setPopoverFormatter(oPopoverFormatter): sap.ca.ui.charts.Chart
Setter for property
popoverFormatter. Default value is empty/undefined
Parameters:
| {object} | oPopoverFormatter | new value for property popoverFormatter |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setPopoverGroupFormatter(sPopoverGroupFormatter): sap.ca.ui.charts.Chart
Setter for property
popoverGroupFormatter. Default value is empty/undefined
Parameters:
| {string} | sPopoverGroupFormatter | new value for property popoverGroupFormatter |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setPopoverSubHeader(oSubHeader)
setter for subHeader in the Popover.
Parameters:
| {sap.m.Bar} | oSubHeader | new value for sub header |
setSecondAxisVisible(bSecondAxisVisible): sap.ca.ui.charts.Chart
Setter for property
secondAxisVisible. Default value is true
Parameters:
| {boolean} | bSecondAxisVisible | new value for property secondAxisVisible |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setSelectionMode(sSelectionMode): sap.ca.ui.charts.Chart
Setter for property
selectionMode. Default value is Multi
Parameters:
| {sap.ca.ui.charts.ChartSelectionMode} | sSelectionMode | new value for property selectionMode |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setShowDataLabel(bShowDataLabel): sap.ca.ui.charts.Chart
Setter for property
showDataLabel. Default value is true
Parameters:
| {boolean} | bShowDataLabel | new value for property showDataLabel |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setShowHoverBackground(bShowHoverBackground): sap.ca.ui.charts.Chart
Setter for property
showHoverBackground. Default value is false
Parameters:
| {boolean} | bShowHoverBackground | new value for property showHoverBackground |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setShowLegend(bShowLegend): sap.ca.ui.charts.Chart
Setter for property
showLegend. Default value is true
Parameters:
| {boolean} | bShowLegend | new value for property showLegend |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setShowPopover(bShowPopover): sap.ca.ui.charts.Chart
Setter for property
showPopover. Default value is true
Parameters:
| {boolean} | bShowPopover | new value for property showPopover |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setShowTooltip(bShowTooltip): sap.ca.ui.charts.Chart
Setter for property
showTooltip. Default value is false
Parameters:
| {boolean} | bShowTooltip | new value for property showTooltip |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setStackedChartWidthEnhancer(bStackedChartWidthEnhancer): sap.ca.ui.charts.Chart
Setter for property
stackedChartWidthEnhancer. Default value is false
Parameters:
| {boolean} | bStackedChartWidthEnhancer | new value for property stackedChartWidthEnhancer |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setTitle(sTitle): sap.ca.ui.charts.Chart
Setter for property
title. Default value is Chart
Parameters:
| {string} | sTitle | new value for property title |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setTooltipFormatter(oTooltipFormatter): sap.ca.ui.charts.Chart
Setter for property
tooltipFormatter. Default value is empty/undefined
Parameters:
| {object} | oTooltipFormatter | new value for property tooltipFormatter |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setWidth(sWidth): sap.ca.ui.charts.Chart
Setter for property
width. Default value is 100%
Parameters:
| {sap.ui.core.CSSSize} | sWidth | new value for property width |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setXAxis2LabelFormatter(sXAxis2LabelFormatter): sap.ca.ui.charts.Chart
Setter for property
xAxis2LabelFormatter. Default value is empty/undefined
Parameters:
| {string} | sXAxis2LabelFormatter | new value for property xAxis2LabelFormatter |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setXAxisLabelFormatter(sXAxisLabelFormatter): sap.ca.ui.charts.Chart
Setter for property
xAxisLabelFormatter. Default value is empty/undefined
Parameters:
| {string} | sXAxisLabelFormatter | new value for property xAxisLabelFormatter |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setYAxis2LabelFormatter(sYAxis2LabelFormatter): sap.ca.ui.charts.Chart
Setter for property
yAxis2LabelFormatter. Default value is empty/undefined
Parameters:
| {string} | sYAxis2LabelFormatter | new value for property yAxis2LabelFormatter |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
setYAxisLabelFormatter(sYAxisLabelFormatter): sap.ca.ui.charts.Chart
Setter for property
yAxisLabelFormatter. Default value is empty/undefined
Parameters:
| {string} | sYAxisLabelFormatter | new value for property yAxisLabelFormatter |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
tooltipFormatter(formatterArray): sap.ca.ui.charts.Chart
Setter for property
tooltipFormatter. Parameters:
| {object} | formatterArray | new value for property tooltipFormatter [formatterArray] must be a 2 dimensions array of formatters. [ [ measure 1 of X Axis , ..., [measure n of X Axis] ], [ measure 1 of X Axis 2 , ..., [measure n of X Axis 2] ] Each of these formatters can be: - a custom formatting function - a value of enum sap.ca.ui.charts.DefaultFormatterFunction If for an axis, formatters count < measures count, then first formatter of axis will be used for other measures. |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
unbindLabel(): sap.ca.ui.charts.Chart
Unbinder for property
label. Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
xAxis2LabelFormatter(formatter): sap.ca.ui.charts.Chart
Setter for property
xAxis2LabelFormatter. Parameters:
| {object} | formatter | new value for property xAxis2LabelFormatter formatter can be: - a custom formatting function - a value of enum sap.ca.ui.charts.DefaultFormatterFunction |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
xAxisLabelFormatter(formatter): sap.ca.ui.charts.Chart
Setter for property
xAxisLabelFormatter. Parameters:
| {object} | formatter | new value for property xAxisLabelFormatter formatter can be: - a custom formatting function - a value of enum sap.ca.ui.charts.DefaultFormatterFunction |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
yAxis2LabelFormatter(formatter): sap.ca.ui.charts.Chart
Setter for property
yAxis2LabelFormatter. Parameters:
| {object} | formatter | new value for property yAxis2LabelFormatter formatter can be: - a custom formatting function - a value of enum sap.ca.ui.charts.DefaultFormatterFunction |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |
yAxisLabelFormatter(formatter): sap.ca.ui.charts.Chart
Setter for property
yAxisLabelFormatter. Parameters:
| {object} | formatter | new value for property yAxisLabelFormatter formatter can be: - a custom formatting function - a value of enum sap.ca.ui.charts.DefaultFormatterFunction |
Returns:
| {sap.ca.ui.charts.Chart} | this to allow method chaining |