Class sap.suite.ui.commons.ChartContainerModule: sap/suite/ui/commons/ChartContainer

extends Control

Provides a toolbar with generic functions for tables and charts based on the VizFrame control like zoom, display in fullscreen mode, toggle the legend, switch between chart types, and changes of the chart dimension. The controls of the content aggregation are positioned below the toolbar. Additional functions can be added to the toolbar with the customIcons aggregation.

Constructor Summary
new sap.suite.ui.commons.ChartContainer(sId?, mSettings?)Constructor for a new ChartContainer.
Event Summary
contentChange(oControlEvent)Event fired when a user changes the displayed content.
customZoomInPress(oControlEvent)Custom event for zoom in.
customZoomOutPress(oControlEvent)Custom event for zoom out.
personalizationPress(oControlEvent)Event fired when a user clicks on the personalization icon.
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.ChartContainer.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.ChartContainer with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.ChartContainer.getMetadata()Returns a metadata object for class sap.suite.ui.commons.ChartContainer.
addContent(oContent)Adds some content oContent to the aggregation named content.
addCustomIcon(oCustomIcon)Adds some customIcon oCustomIcon to the aggregation named customIcons.
addDimensionSelector(oDimensionSelector)Adds some dimensionSelector oDimensionSelector to the aggregation named dimensionSelectors.
attachContentChange(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'contentChange' event of this sap.suite.ui.commons.ChartContainer.
attachCustomZoomInPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'customZoomInPress' event of this sap.suite.ui.commons.ChartContainer.
attachCustomZoomOutPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'customZoomOutPress' event of this sap.suite.ui.commons.ChartContainer.
attachPersonalizationPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'personalizationPress' event of this sap.suite.ui.commons.ChartContainer.
destroyContent()Destroys all the content in the aggregation named content.
destroyCustomIcons()Destroys all the customIcons in the aggregation named customIcons.
destroyDimensionSelectors()Destroys all the dimensionSelectors in the aggregation named dimensionSelectors.
detachContentChange(fnFunction, oListener)Detach event handler fnFunction from the 'contentChange' event of this sap.suite.ui.commons.ChartContainer.
detachCustomZoomInPress(fnFunction, oListener)Detach event handler fnFunction from the 'customZoomInPress' event of this sap.suite.ui.commons.ChartContainer.
detachCustomZoomOutPress(fnFunction, oListener)Detach event handler fnFunction from the 'customZoomOutPress' event of this sap.suite.ui.commons.ChartContainer.
detachPersonalizationPress(fnFunction, oListener)Detach event handler fnFunction from the 'personalizationPress' event of this sap.suite.ui.commons.ChartContainer.
fireContentChange(mArguments?)Fire event contentChange to attached listeners.
fireCustomZoomInPress(mArguments?)Fire event customZoomInPress to attached listeners.
fireCustomZoomOutPress(mArguments?)Fire event customZoomOutPress to attached listeners.
firePersonalizationPress(mArguments?)Fire event personalizationPress to attached listeners.
getAutoAdjustHeight()Getter for property autoAdjustHeight.
getContent()Getter for aggregation content.
getCustomIcons()Getter for aggregation customIcons.
getDimensionSelectors()Getter for aggregation dimensionSelectors.
getFullScreen()Getter for property fullScreen.
getScrollDelegate()Returns the current instance of the delegate to other controls.
getSelectedContent()Returns the currently selected content control.
getShowFullScreen()Getter for property showFullScreen.
getShowLegend()Getter for property showLegend.
getShowLegendButton()Getter for property showLegendButton.
getShowPersonalization()Getter for property showPersonalization.
getShowZoom()Getter for property showZoom.
getTitle()Getter for property title.
indexOfContent(oContent)Checks for the provided sap.suite.ui.commons.ChartContainerContent in the aggregation named content and returns its index if found or -1 otherwise.
indexOfCustomIcon(oCustomIcon)Checks for the provided sap.ui.core.Icon in the aggregation named customIcons and returns its index if found or -1 otherwise.
indexOfDimensionSelector(oDimensionSelector)Checks for the provided sap.ui.core.Control in the aggregation named dimensionSelectors and returns its index if found or -1 otherwise.
insertContent(oContent, iIndex)Inserts a content into the aggregation named content.
insertCustomIcon(oCustomIcon, iIndex)Inserts a customIcon into the aggregation named customIcons.
insertDimensionSelector(oDimensionSelector, iIndex)Inserts a dimensionSelector into the aggregation named dimensionSelectors.
removeAllContent()Removes all the controls in the aggregation named content.
removeAllCustomIcons()Removes all the controls in the aggregation named customIcons.
removeAllDimensionSelectors()Removes all the controls in the aggregation named dimensionSelectors.
removeContent(vContent)Removes an content from the aggregation named content.
removeCustomIcon(vCustomIcon)Removes an customIcon from the aggregation named customIcons.
removeDimensionSelector(vDimensionSelector)Removes an dimensionSelector from the aggregation named dimensionSelectors.
setAutoAdjustHeight(bAutoAdjustHeight)Setter for property autoAdjustHeight.
setFullScreen(bFullScreen)Setter for property fullScreen.
setShowFullScreen(bShowFullScreen)Setter for property showFullScreen.
setShowLegend(bShowLegend)Setter for property showLegend.
setShowLegendButton(bShowLegendButton)Setter for property showLegendButton.
setShowPersonalization(bShowPersonalization)Setter for property showPersonalization.
setShowZoom(bShowZoom)Setter for property showZoom.
setTitle(sTitle)Setter for property title.
switchChart(chart)Switches the currently viewed content (triggers re-rendering).
updateChartContainer()Updates ChartContainer and re-renders all its contents.
getSelectorGroupLabel()Getter for property selectorGroupLabel.
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.ChartContainer(sId?, mSettings?)
Constructor for a new ChartContainer.

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:

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Event Detail
contentChange(oControlEvent)
Event fired when a user changes the displayed content.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.selectedItemId Id of the selected item.
customZoomInPress(oControlEvent)
Custom event for zoom in.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
customZoomOutPress(oControlEvent)
Custom event for zoom out.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
personalizationPress(oControlEvent)
Event fired when a user clicks on the personalization icon.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.suite.ui.commons.ChartContainer.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.commons.ChartContainer 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.ChartContainer.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.suite.ui.commons.ChartContainer.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addContent(oContent): sap.suite.ui.commons.ChartContainer
Adds some content oContent to the aggregation named content.
Parameters:
{sap.suite.ui.commons.ChartContainerContent}oContent the content to add; if empty, nothing is inserted
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
addCustomIcon(oCustomIcon): sap.suite.ui.commons.ChartContainer
Adds some customIcon oCustomIcon to the aggregation named customIcons.
Parameters:
{sap.ui.core.Icon}oCustomIcon the customIcon to add; if empty, nothing is inserted
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
addDimensionSelector(oDimensionSelector): sap.suite.ui.commons.ChartContainer
Adds some dimensionSelector oDimensionSelector to the aggregation named dimensionSelectors.
Parameters:
{sap.ui.core.Control}oDimensionSelector the dimensionSelector to add; if empty, nothing is inserted
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
attachContentChange(oData?, fnFunction, oListener?): sap.suite.ui.commons.ChartContainer
Attach event handler fnFunction to the 'contentChange' event of this sap.suite.ui.commons.ChartContainer.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.ChartContainer.
itself.

Event fired when a user changes the displayed content.

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.ChartContainer.
itself.
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
attachCustomZoomInPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.ChartContainer
Attach event handler fnFunction to the 'customZoomInPress' event of this sap.suite.ui.commons.ChartContainer.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.ChartContainer.
itself.

Custom event for zoom in.

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.ChartContainer.
itself.
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
attachCustomZoomOutPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.ChartContainer
Attach event handler fnFunction to the 'customZoomOutPress' event of this sap.suite.ui.commons.ChartContainer.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.ChartContainer.
itself.

Custom event for zoom out.

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.ChartContainer.
itself.
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
attachPersonalizationPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.ChartContainer
Attach event handler fnFunction to the 'personalizationPress' event of this sap.suite.ui.commons.ChartContainer.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.ChartContainer.
itself.

Event fired when a user clicks on the personalization icon.

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.ChartContainer.
itself.
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
destroyContent(): sap.suite.ui.commons.ChartContainer
Destroys all the content in the aggregation named content.
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
destroyCustomIcons(): sap.suite.ui.commons.ChartContainer
Destroys all the customIcons in the aggregation named customIcons.
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
destroyDimensionSelectors(): sap.suite.ui.commons.ChartContainer
Destroys all the dimensionSelectors in the aggregation named dimensionSelectors.
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
detachContentChange(fnFunction, oListener): sap.suite.ui.commons.ChartContainer
Detach event handler fnFunction from the 'contentChange' event of this sap.suite.ui.commons.ChartContainer.

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.ChartContainer}this to allow method chaining
detachCustomZoomInPress(fnFunction, oListener): sap.suite.ui.commons.ChartContainer
Detach event handler fnFunction from the 'customZoomInPress' event of this sap.suite.ui.commons.ChartContainer.

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.ChartContainer}this to allow method chaining
detachCustomZoomOutPress(fnFunction, oListener): sap.suite.ui.commons.ChartContainer
Detach event handler fnFunction from the 'customZoomOutPress' event of this sap.suite.ui.commons.ChartContainer.

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.ChartContainer}this to allow method chaining
detachPersonalizationPress(fnFunction, oListener): sap.suite.ui.commons.ChartContainer
Detach event handler fnFunction from the 'personalizationPress' event of this sap.suite.ui.commons.ChartContainer.

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.ChartContainer}this to allow method chaining
fireContentChange(mArguments?): sap.suite.ui.commons.ChartContainer
Fire event contentChange to attached listeners.

Expects following event parameters:

  • 'selectedItemId' of type string Id of the selected item.
Parameters:
{Map}mArguments? the arguments to pass along with the event.
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
fireCustomZoomInPress(mArguments?): sap.suite.ui.commons.ChartContainer
Fire event customZoomInPress to attached listeners.
Parameters:
{Map}mArguments? the arguments to pass along with the event.
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
fireCustomZoomOutPress(mArguments?): sap.suite.ui.commons.ChartContainer
Fire event customZoomOutPress to attached listeners.
Parameters:
{Map}mArguments? the arguments to pass along with the event.
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
firePersonalizationPress(mArguments?): sap.suite.ui.commons.ChartContainer
Fire event personalizationPress to attached listeners.
Parameters:
{Map}mArguments? the arguments to pass along with the event.
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
getAutoAdjustHeight(): boolean
Getter for property autoAdjustHeight. Determine whether to stretch the chart height to the maximum possible height of ChartContainer's parent container. As a prerequisite, the parent container needs to have a fixed value height or be able to determine height from its parent.

Default value is false

Returns:
{boolean} the value of property autoAdjustHeight
getContent(): sap.suite.ui.commons.ChartContainerContent[]
Getter for aggregation content.
ChartToolBar Content aggregation. Only vizFrame, sap.m.Table and sap.ui.table.Table can be embedded. If not specified explicitly, the rendering order of the charts is determined by the sequence of contents provided by the application via this aggregation. That means, per default the first chart of the aggregation will be rendered within the container.

Note: this is the default aggregation for ChartContainer.

Returns:
{sap.suite.ui.commons.ChartContainerContent[]}
getCustomIcons(): sap.ui.core.Icon[]
Getter for aggregation customIcons.
This aggregation contains the custom icons that should be displayed additionally on the toolbar. It is not guaranteed that the same instance of the sap.ui.core.Icon control will be used within the toolbar, but the toolbar will contain a sap.m.OverflowToolbarButton with an icon property equal to the src property of the sap.ui.core.Icon provided in the aggregation. If a press event is triggered by the icon displayed on the toolbar, then the press handler of the original sap.ui.core.Icon control is used. The instance of the control, that has triggered the press event, can be accessed using the "controlReference" parameter of the event object.
Returns:
{sap.ui.core.Icon[]}
getDimensionSelectors(): sap.ui.core.Control[]
Getter for aggregation dimensionSelectors.
Dimension Selects.
Returns:
{sap.ui.core.Control[]}
getFullScreen(): boolean
Getter for property fullScreen. Display the chart and the toolbar in full screen or normal mode.

Default value is false

Returns:
{boolean} the value of property fullScreen
getScrollDelegate(): sap.ui.core.delegate.ScrollEnablement
Returns the current instance of the delegate to other controls.
Returns:
{sap.ui.core.delegate.ScrollEnablement} The current instance of the delegate
getSelectedContent(): sap.ui.core.Control
Returns the currently selected content control.
Returns:
{sap.ui.core.Control} The currently selected content
getShowFullScreen(): boolean
Getter for property showFullScreen. Set to true to display the full screen icon. Set to false to hide it.

Default value is false

Returns:
{boolean} the value of property showFullScreen
getShowLegend(): boolean
Getter for property showLegend. Set to true to display the charts' legends. Set to false to hide them. See also showLegendButton.

Default value is true

Returns:
{boolean} the value of property showLegend
getShowLegendButton(): boolean
Getter for property showLegendButton. Set to true or false to display or hide a button for controlling the visbility of the chart's legend. Please be aware that setting this property to true indirectly is setting showLegend to false. If you need to hide the button but to show the legend, you need to set showLegend at a later point in time (onBeforeRendering). The execution order of the combined properties is not guaranteed by the control.

Default value is true

Returns:
{boolean} the value of property showLegendButton
getShowPersonalization(): boolean
Getter for property showPersonalization. Set to true to display the personalization icon. Set to false to hide it.

Default value is false

Returns:
{boolean} the value of property showPersonalization
getShowZoom(): boolean
Getter for property showZoom. Set to true to display zoom icons. Set to false to hide them.

Default value is true

Returns:
{boolean} the value of property showZoom
getTitle(): string
Getter for property title. String shown if there are no dimensions to display.

Default value is empty/undefined

Returns:
{string} the value of property title
indexOfContent(oContent): int
Checks for the provided sap.suite.ui.commons.ChartContainerContent in the aggregation named content and returns its index if found or -1 otherwise.
Parameters:
{sap.suite.ui.commons.ChartContainerContent}oContent the content whose index is looked for.
Returns:
{int} the index of the provided control in the aggregation if found, or -1 otherwise
indexOfCustomIcon(oCustomIcon): int
Checks for the provided sap.ui.core.Icon in the aggregation named customIcons and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Icon}oCustomIcon the customIcon whose index is looked for.
Returns:
{int} the index of the provided control in the aggregation if found, or -1 otherwise
indexOfDimensionSelector(oDimensionSelector): int
Checks for the provided sap.ui.core.Control in the aggregation named dimensionSelectors and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oDimensionSelector the dimensionSelector whose index is looked for.
Returns:
{int} the index of the provided control in the aggregation if found, or -1 otherwise
insertContent(oContent, iIndex): sap.suite.ui.commons.ChartContainer
Inserts a content into the aggregation named content.
Parameters:
{sap.suite.ui.commons.ChartContainerContent}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
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
insertCustomIcon(oCustomIcon, iIndex): sap.suite.ui.commons.ChartContainer
Inserts a customIcon into the aggregation named customIcons.
Parameters:
{sap.ui.core.Icon}oCustomIcon the customIcon to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the customIcon should be inserted at; for a negative value of iIndex, the customIcon is inserted at position 0; for a value greater than the current size of the aggregation, the customIcon is inserted at the last position
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
insertDimensionSelector(oDimensionSelector, iIndex): sap.suite.ui.commons.ChartContainer
Inserts a dimensionSelector into the aggregation named dimensionSelectors.
Parameters:
{sap.ui.core.Control}oDimensionSelector the dimensionSelector to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the dimensionSelector should be inserted at; for a negative value of iIndex, the dimensionSelector is inserted at position 0; for a value greater than the current size of the aggregation, the dimensionSelector is inserted at the last position
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
removeAllContent(): sap.suite.ui.commons.ChartContainerContent[]
Removes all the controls in the aggregation named content.
Additionally unregisters them from the hosting UIArea.
Returns:
{sap.suite.ui.commons.ChartContainerContent[]} an array of the removed elements (might be empty)
removeAllCustomIcons(): sap.ui.core.Icon[]
Removes all the controls in the aggregation named customIcons.
Additionally unregisters them from the hosting UIArea.
Returns:
{sap.ui.core.Icon[]} an array of the removed elements (might be empty)
removeAllDimensionSelectors(): sap.ui.core.Control[]
Removes all the controls in the aggregation named dimensionSelectors.
Additionally unregisters them from the hosting UIArea.
Returns:
{sap.ui.core.Control[]} an array of the removed elements (might be empty)
removeContent(vContent): sap.suite.ui.commons.ChartContainerContent
Removes an content from the aggregation named content.
Parameters:
{int|string|sap.suite.ui.commons.ChartContainerContent}vContent the content to remove or its index or id
Returns:
{sap.suite.ui.commons.ChartContainerContent} the removed content or null
removeCustomIcon(vCustomIcon): sap.ui.core.Icon
Removes an customIcon from the aggregation named customIcons.
Parameters:
{int|string|sap.ui.core.Icon}vCustomIcon the customIcon to remove or its index or id
Returns:
{sap.ui.core.Icon} the removed customIcon or null
removeDimensionSelector(vDimensionSelector): sap.ui.core.Control
Removes an dimensionSelector from the aggregation named dimensionSelectors.
Parameters:
{int|string|sap.ui.core.Control}vDimensionSelector the dimensionSelector to remove or its index or id
Returns:
{sap.ui.core.Control} the removed dimensionSelector or null
setAutoAdjustHeight(bAutoAdjustHeight): sap.suite.ui.commons.ChartContainer
Setter for property autoAdjustHeight.

Default value is false

Parameters:
{boolean}bAutoAdjustHeight new value for property autoAdjustHeight
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
setFullScreen(bFullScreen): sap.suite.ui.commons.ChartContainer
Setter for property fullScreen.

Default value is false

Parameters:
{boolean}bFullScreen new value for property fullScreen
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
setShowFullScreen(bShowFullScreen): sap.suite.ui.commons.ChartContainer
Setter for property showFullScreen.

Default value is false

Parameters:
{boolean}bShowFullScreen new value for property showFullScreen
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
setShowLegend(bShowLegend): sap.suite.ui.commons.ChartContainer
Setter for property showLegend.

Default value is true

Parameters:
{boolean}bShowLegend new value for property showLegend
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
setShowLegendButton(bShowLegendButton): sap.suite.ui.commons.ChartContainer
Setter for property showLegendButton.

Default value is true

Parameters:
{boolean}bShowLegendButton new value for property showLegendButton
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
setShowPersonalization(bShowPersonalization): sap.suite.ui.commons.ChartContainer
Setter for property showPersonalization.

Default value is false

Parameters:
{boolean}bShowPersonalization new value for property showPersonalization
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
setShowZoom(bShowZoom): sap.suite.ui.commons.ChartContainer
Setter for property showZoom.

Default value is true

Parameters:
{boolean}bShowZoom new value for property showZoom
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
setTitle(sTitle): sap.suite.ui.commons.ChartContainer
Setter for property title.

Default value is empty/undefined

Parameters:
{string}sTitle new value for property title
Returns:
{sap.suite.ui.commons.ChartContainer}this to allow method chaining
switchChart(chart)
Switches the currently viewed content (triggers re-rendering).
Parameters:
{sap.ui.core.Control}chart The new content (Chart or Table) to be displayed
updateChartContainer(): sap.suite.ui.commons.ChartContainer
Updates ChartContainer and re-renders all its contents.
Returns:
{sap.suite.ui.commons.ChartContainer} Reference to this in order to allow method chaining
getSelectorGroupLabel(): string
Getter for property selectorGroupLabel. Custom Label for Selectors Group.

Default value is empty/undefined

Deprecated:
Since version 1.32.0. Obsolete property as sap.m.Toolbar is replaced by sap.m.OverflowToolbar.
Returns:
{string} the value of property selectorGroupLabel