The SmartChart
control creates a chart based on the OData metadata and the provided configuration. To use the control, the entitySet
property must be specified. This property is used to fetch the metadata, from which the chart UI will be generated.
Based on the chartType
property, this control will render initially the corresponding chart.
Note: Most of the properties are not dynamic and cannot be changed once the control has been initialized.
Important: Keep in mind that SmartChart
, like all SAPUI5 smart controls, retrieves and analyzes the metadata and annotations of OData services. The OData metadata is its primary API. These OData services are not part of the SAPUI5 framework and are usually maintained by the backend developers of your application.
With time, SmartChart
can evolve and acquire new features. This means that its behavior or functionalities may change if the annotations that define this change are maintained in your backend metadata. To benefit from the new functionalities, your application should be able to adapt the backend metadata. Therefore, we recommend using SmartChart
only if you have control over the metadata of your application.
Constructor for a new SmartChart instance.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.ui.comp.smartchart.SmartChart(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new control that is generated automatically if no ID is given |
|
mSettings? | object | Initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
activateTimeSeries | boolean | false | Enables the use of timeseries on the inner chart when corresponding annotation is given |
chartBindingPath | string | Specifies the path that is used during the binding of the chart. If not specified, the entitySet property is used instead. (used only if binding is established internally/automatically - See enableAutoBinding) Visibility: public |
|
chartType | string | Specifies the type of chart to be created by the SmartChart control. Visibility: public |
|
currentVariantId | string | Retrieves or applies the current variant. Visibility: public |
|
enableAutoBinding | boolean | false | If set to |
entitySet | string | The entity set name from which to fetch data and generate the columns. |
|
header | string | Specifies header text that is shown in the chart. Visibility: public |
|
ignoreFromPersonalisation | string | CSV of fields that is not shown in the personalization dialog. |
|
ignoredChartTypes | string | CSV of fields that is not shown in the list of available chart types. |
|
ignoredFields | string | CSV of fields that must be ignored in the OData metadata by the SmartChart control. |
|
legendVisible | boolean | true | Set chart's legend properties. |
noData | string | Defines the custom text that will be displayed in case no data is found for the current binding. |
|
persistencyKey | string | Key used to access personalization data. Visibility: public |
|
requestAtLeastFields | string | CSV of fields that must be always requested by the backend system. |
|
selectionMode | sap.ui.comp.smartchart.SelectionMode | Multi | Chart selection mode. Supported values are sap.ui.comp.smartchart.SelectionMode.Single or sap.ui.comp.smartchart.SelectionMode.Multi, case insensitive, always return in upper case. Unsupported values will be ignored. |
showChartTooltip | boolean | true | Controls the visibility of the chart tooltip. If set to |
showChartTypeSelectionButton | boolean | true | Controls the visibility of the chart type selection button. |
showDetailsButton | boolean | false | Controls the visibility of the Details button. If set to |
showDimensionsTitle | boolean | true | Controls the visibility of the title in the dimension area of the chart. |
showDownloadButton | boolean | false | Controls the visibility of the chart download button. |
showDrillBreadcrumbs | boolean | false | Controls the visibility of the Breadcrumbs control for drilling up within the visible dimensions. If set to |
showDrillButtons | boolean | true | Controls the visibility of the Drill Up and Drill Down buttons. Visibility: public |
showFullScreenButton | boolean | true | Controls the visibility of the FullScreen button. |
showLegendButton | boolean | true | Controls the visibility of the Navigation button |
showMeasuresTitle | boolean | true | Controls the visibility of the title in the measure area of the chart. |
showSemanticNavigationButton | boolean | true | Controls the visibility of the Navigation button |
showToolbar | boolean | true | Controls the visibility of the toolbar. |
showVariantManagement | boolean | true | Controls the visibility of the Variant Management. |
showZoomButtons | boolean | true | Controls the visibility of the Zoom In and Zoom Out buttons. |
smartFilterId | string | ID of the corresponding SmartFilter control. If specified, the SmartChart control searches for the SmartFilter control (also in the closest parent view) and attaches to the relevant events of the SmartFilter control to fetch data, show overlay etc. Visibility: public |
|
toolbarStyle | sap.m.ToolbarStyle | Defines the visual style of the smart charts |
|
useChartPersonalisation | boolean | true | If set to |
useListForChartTypeSelection | boolean | true | Controls the visualization for chart type selection. If set to |
useTooltip | boolean | true | Specifies weather an instance of sap.viz.ui5.controls.VizTooltip or sap.viz.ui5.controls.Popover is used. If set to |
useVariantManagement | boolean | true | If set to |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
selectionDetailsActionGroups | 0..n | sap.ui.core.Item |
Actions on group level which can be specified for the selection details popover. |
selectionDetailsActions | 0..n | sap.ui.core.Item |
Actions on footer level which can be specified for the selection details popover. |
selectionDetailsItemActions | 0..n | sap.ui.core.Item |
Actions on item level which can be specified for the selection details popover. |
semanticObjectController | 0..1 | sap.ui.comp.navpopover.SemanticObjectController |
The Semantic Object Controller allows the user to specify and overwrite functionality for semantic object navigation. |
toolbar | 0..1 | sap.m.Toolbar |
A custom toolbar that can be specified by the user to define their own buttons, icons, etc. If this is added, the SmartChart control does not create its own toolbar, but uses this one instead. However, if default actions, such as showSemanticNavigation, showFullScreenButton etc. are set, these actions are added at the left-hand side of the toolbar. |
Name | Cardinality | Type | Description |
---|---|---|---|
smartVariant | 0..1 | sap.ui.core.Control |
Identifies the SmartVariant control which should be used for the personalization. Will be ignored if the advanced mode is set. |
Event | Description |
---|---|
afterVariantApply |
This event is fired after a variant has been applied. |
afterVariantInitialise |
This event is fired after the variant management in the SmartChart control has been initialized. |
afterVariantSave |
This event is fired after a variant has been saved. This event can be used to retrieve the ID of the saved variant. |
beforeRebindChart |
This event is fired right before the |
chartDataChanged |
This event is fired when |
dataReceived |
This event is fired when data is received after binding. This event is fired if the binding for the chart is done by the SmartChart control itself. |
fullScreenToggled |
This event is fired right after the full screen mode of the SmartChart control has been changed. |
initialise |
This event is fired once the control has been initialized. Note: For compatibility reasons the sap.chart library is loaded synchroniously as soon as a event handler for the |
initialized |
This event is fired once the control has been initialized, asynchronous successor of |
selectionDetailsActionPress |
This event is fired when any action in the selection details popover is pressed. |
showOverlay |
This event is fired right before the overlay is shown. |
This event is fired after a variant has been applied.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
currentVariantId | string |
ID of the currently selected variant |
This event is fired after the variant management in the SmartChart control has been initialized.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
This event is fired after a variant has been saved. This event can be used to retrieve the ID of the saved variant.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
currentVariantId | string |
ID of the currently selected variant |
This event is fired right before the SmartChart
control triggers the binding / rebinding of the inner chart.
Note: In certain cases the inner chart triggers a rebinding by itself. In these cases, the event is not fired.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
bindingParams | object |
The bindingParams object contains filters, sorters, and other binding-related information for the chart |
preventChartBind | boolean |
If set to |
filters | sap.ui.model.Filter[] |
The combined filter array containing a set of sap.ui.model.Filter instances of the SmartChart and SmartFilter controls; can be modified by users to influence filtering |
sorter | sap.ui.model.Sorter[] |
An array containing a set of sap.ui.model.Sorter instances of the SmartChart control (personalization); can be modified by users to influence sorting |
length | int |
The maximal number of items that is displayed for the |
parameters | object |
a map of parameters which is passed to the binding |
events | object |
map of event listeners for the binding events (since 1.56). The events listeners can only be registered while the binding is created. So, ensure that the events parameter is filled from the beginning, so that the registration can be done while the binding is created. |
This event is fired when SmartChart
control data changes, due to changes in the personalization dialog or drill operations.
The data can be changed via sorters, filters or drill-ups/drill-downs.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
changeTypes | object |
Object which contains a boolean flag for dimeasure, filter, sort. If set to |
This event is fired when data is received after binding. This event is fired if the binding for the chart is done by the SmartChart control itself.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
This event is fired right after the full screen mode of the SmartChart control has been changed.
Since: 1.46.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
fullScreen | boolean |
If |
This event is fired once the control has been initialized. Note: For compatibility reasons the sap.chart library is loaded synchroniously as soon as a event handler for the initialise
event has been attached. Since this event does not fulfill CSP requirements, please use event initialized
instead.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
This event is fired once the control has been initialized, asynchronous successor of initialise
.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
This event is fired when any action in the selection details popover is pressed.
Since: 1.48.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
action | sap.ui.core.Item |
The action that has to be processed once the action has been pressed |
itemContexts | sap.ui.model.Context |
If the action is pressed on one of the items, the parameter contains the context of the pressed item. If a custom action or action group of the SelectionDetails popover is pressed, this parameter contains all contexts of the items. |
level | sap.m.SelectionDetailsActionLevel |
The action level of action buttons. The available levels are Item, List and Group |
Method | Description |
---|---|
addSelectionDetailsAction |
Adds some selectionDetailsAction to the aggregation selectionDetailsActions. |
addSelectionDetailsActionGroup |
Adds some selectionDetailsActionGroup to the aggregation selectionDetailsActionGroups. |
addSelectionDetailsItemAction |
Adds some selectionDetailsItemAction to the aggregation selectionDetailsItemActions. |
applyVariant |
Interface function for SmartVariantManagement control that applies the current variant. |
attachAfterVariantApply |
Attaches event handler When called, the context of the event handler (its This event is fired after a variant has been applied. |
attachAfterVariantInitialise |
Attaches event handler When called, the context of the event handler (its This event is fired after the variant management in the SmartChart control has been initialized. |
attachAfterVariantSave |
Attaches event handler When called, the context of the event handler (its This event is fired after a variant has been saved. This event can be used to retrieve the ID of the saved variant. |
attachBeforeRebindChart |
Attaches event handler When called, the context of the event handler (its This event is fired right before the |
attachChartDataChanged |
Attaches event handler When called, the context of the event handler (its This event is fired when |
attachDataReceived |
Attaches event handler When called, the context of the event handler (its This event is fired when data is received after binding. This event is fired if the binding for the chart is done by the SmartChart control itself.
Since 1.56 Use <code>beforeRebindChart</code> event to attach/listen to the binding "events" directly
|
attachFullScreenToggled |
Attaches event handler When called, the context of the event handler (its This event is fired right after the full screen mode of the SmartChart control has been changed. |
attachInitialise |
Loads the chart lib synchronously before the event is attached. That is done for compatibility reasons. Note: Attaching to this event causes the inner chart to load synchronously. This does not fulfill CSP requirements. Please use event
Since 1.94 replaced by {@link #event:initialized}
|
attachInitialized |
Attaches event handler When called, the context of the event handler (its This event is fired once the control has been initialized, asynchronous successor of |
attachSelectionDetailsActionPress |
Attaches event handler When called, the context of the event handler (its This event is fired when any action in the selection details popover is pressed. |
attachShowOverlay |
Attaches event handler When called, the context of the event handler (its This event is fired right before the overlay is shown. |
destroySelectionDetailsActionGroups |
Destroys all the selectionDetailsActionGroups in the aggregation selectionDetailsActionGroups. |
destroySelectionDetailsActions |
Destroys all the selectionDetailsActions in the aggregation selectionDetailsActions. |
destroySelectionDetailsItemActions |
Destroys all the selectionDetailsItemActions in the aggregation selectionDetailsItemActions. |
destroySemanticObjectController |
Destroys the semanticObjectController in the aggregation semanticObjectController. |
destroyToolbar |
Destroys the toolbar in the aggregation toolbar. |
detachAfterVariantApply |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachAfterVariantInitialise |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachAfterVariantSave |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachBeforeRebindChart |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachChartDataChanged |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachDataReceived |
Detaches event handler The passed function and listener object must match the ones used for event registration.
Since 1.56 Use <code>beforeRebindChart</code> event to attach/listen to the binding "events" directly
|
detachFullScreenToggled |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachInitialise |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachInitialized |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachSelectionDetailsActionPress |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachShowOverlay |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
exit |
Cleans up the control. |
sap.ui.comp.smartchart.SmartChart.extend |
Creates a new subclass of class sap.ui.comp.smartchart.SmartChart with name
|
fetchVariant |
Function for the sap.ui.comp.smartvariants.SmartVariantManagement control that returns the currently used variant data in an internal format. Note: This function must not be used by applications. |
fireAfterVariantApply |
Fires event afterVariantApply to attached listeners. |
fireAfterVariantInitialise |
Fires event afterVariantInitialise to attached listeners. |
fireAfterVariantSave |
Fires event afterVariantSave to attached listeners. |
fireBeforeRebindChart |
Fires event beforeRebindChart to attached listeners. |
fireChartDataChanged |
Fires event chartDataChanged to attached listeners. |
fireDataReceived |
Fires event dataReceived to attached listeners.
Since 1.56 Use <code>beforeRebindChart</code> event to attach/listen to the binding "events" directly
|
fireFullScreenToggled |
Fires event fullScreenToggled to attached listeners. |
fireInitialise |
Fires event initialise to attached listeners. |
fireInitialized |
Fires event initialized to attached listeners. |
fireSelectionDetailsActionPress |
Fires event selectionDetailsActionPress to attached listeners. |
fireShowOverlay |
Fires event showOverlay to attached listeners. |
getActivateTimeSeries |
Gets current value of property activateTimeSeries. Enables the use of timeseries on the inner chart when corresponding annotation is given Default value is |
getChart |
Returns the chart object used internally.
Since 1.57 replaced by {@link #getChartAsync}
|
getChartAsync |
Returns a promise which will be resolved with the internally used chart object, once all dependencies have been loaded. |
getChartBindingPath |
Gets current value of property chartBindingPath. Specifies the path that is used during the binding of the chart. If not specified, the entitySet property is used instead. (used only if binding is established internally/automatically - See enableAutoBinding) |
getChartType |
Gets current value of property chartType. Specifies the type of chart to be created by the SmartChart control. |
getCurrentVariantId |
Returns the ID of the currently selected variant. |
getEnableAutoBinding |
Gets current value of property enableAutoBinding. If set to Default value is |
getEntitySet |
Gets current value of property entitySet. The entity set name from which to fetch data and generate the columns. |
getHeader |
Gets current value of property header. Specifies header text that is shown in the chart. |
getIgnoredChartTypes |
Gets current value of property ignoredChartTypes. CSV of fields that is not shown in the list of available chart types. |
getIgnoredFields |
Gets current value of property ignoredFields. CSV of fields that must be ignored in the OData metadata by the SmartChart control. |
getIgnoreFromPersonalisation |
Gets current value of property ignoreFromPersonalisation. CSV of fields that is not shown in the personalization dialog. |
getLegendVisible |
Gets current value of property legendVisible. Set chart's legend properties. Default value is |
sap.ui.comp.smartchart.SmartChart.getMetadata |
Returns a metadata object for class sap.ui.comp.smartchart.SmartChart. |
getNoData |
Gets current value of property noData. Defines the custom text that will be displayed in case no data is found for the current binding. |
getPersistencyKey |
Gets current value of property persistencyKey. Key used to access personalization data. |
getRequestAtLeastFields |
Gets current value of property requestAtLeastFields. CSV of fields that must be always requested by the backend system. |
getSelectionDetailsActionGroups |
Gets content of aggregation selectionDetailsActionGroups. Actions on group level which can be specified for the selection details popover. |
getSelectionDetailsActions |
Gets content of aggregation selectionDetailsActions. Actions on footer level which can be specified for the selection details popover. |
getSelectionDetailsItemActions |
Gets content of aggregation selectionDetailsItemActions. Actions on item level which can be specified for the selection details popover. |
getSelectionMode |
Gets current value of property selectionMode. Chart selection mode. Supported values are sap.ui.comp.smartchart.SelectionMode.Single or sap.ui.comp.smartchart.SelectionMode.Multi, case insensitive, always return in upper case. Unsupported values will be ignored. Default value is |
getSemanticObjectController |
Gets content of aggregation semanticObjectController. The Semantic Object Controller allows the user to specify and overwrite functionality for semantic object navigation. |
getShowChartTooltip |
Gets current value of property showChartTooltip. Controls the visibility of the chart tooltip. If set to Default value is |
getShowChartTypeSelectionButton |
Gets current value of property showChartTypeSelectionButton. Controls the visibility of the chart type selection button. Default value is |
getShowDetailsButton |
Gets current value of property showDetailsButton. Controls the visibility of the Details button. If set to Default value is |
getShowDimensionsTitle |
Gets current value of property showDimensionsTitle. Controls the visibility of the title in the dimension area of the chart. Default value is |
getShowDownloadButton |
Gets current value of property showDownloadButton. Controls the visibility of the chart download button. Default value is |
getShowDrillBreadcrumbs |
Gets current value of property showDrillBreadcrumbs. Controls the visibility of the Breadcrumbs control for drilling up within the visible dimensions. If set to Default value is |
getShowDrillButtons |
Gets current value of property showDrillButtons. Controls the visibility of the Drill Up and Drill Down buttons. Default value is |
getShowFullScreenButton |
Gets current value of property showFullScreenButton. Controls the visibility of the FullScreen button. Default value is |
getShowLegendButton |
Gets current value of property showLegendButton. Controls the visibility of the Navigation button Default value is |
getShowMeasuresTitle |
Gets current value of property showMeasuresTitle. Controls the visibility of the title in the measure area of the chart. Default value is |
getShowSemanticNavigationButton |
Gets current value of property showSemanticNavigationButton. Controls the visibility of the Navigation button Default value is |
getShowToolbar |
Gets current value of property showToolbar. Controls the visibility of the toolbar. Default value is |
getShowVariantManagement |
Gets current value of property showVariantManagement. Controls the visibility of the Variant Management. Default value is |
getShowZoomButtons |
Gets current value of property showZoomButtons. Controls the visibility of the Zoom In and Zoom Out buttons. Default value is |
getSmartFilterId |
Gets current value of property smartFilterId. ID of the corresponding SmartFilter control. If specified, the SmartChart control searches for the SmartFilter control (also in the closest parent view) and attaches to the relevant events of the SmartFilter control to fetch data, show overlay etc. |
getSmartVariant |
ID of the element which is the current target of the association smartVariant, or |
getToolbar |
Gets content of aggregation toolbar. A custom toolbar that can be specified by the user to define their own buttons, icons, etc. If this is added, the SmartChart control does not create its own toolbar, but uses this one instead. However, if default actions, such as showSemanticNavigation, showFullScreenButton etc. are set, these actions are added at the left-hand side of the toolbar. |
getToolbarStyle |
Gets current value of property toolbarStyle. Defines the visual style of the smart charts |
getUiState |
The method returns the current UI state of SmartChart control. |
getUseChartPersonalisation |
Gets current value of property useChartPersonalisation. If set to Default value is |
getUseListForChartTypeSelection |
Gets current value of property useListForChartTypeSelection. Controls the visualization for chart type selection. If set to Default value is
Since 1.48.0 Setting the property to <code>false</code> will have no effect on the visualization of chart type selection. <code>SmartChart</code> will always show a list of chart types.
|
getUseTooltip |
Gets current value of property useTooltip. Specifies weather an instance of sap.viz.ui5.controls.VizTooltip or sap.viz.ui5.controls.Popover is used. If set to Default value is |
getUseVariantManagement |
Gets current value of property useVariantManagement. If set to Default value is |
getVariantManagement |
Returns the associated SmartVariantManagement control. |
indexOfSelectionDetailsAction |
Checks for the provided |
indexOfSelectionDetailsActionGroup |
Checks for the provided |
indexOfSelectionDetailsItemAction |
Checks for the provided |
insertSelectionDetailsAction |
Inserts a selectionDetailsAction into the aggregation selectionDetailsActions. |
insertSelectionDetailsActionGroup |
Inserts a selectionDetailsActionGroup into the aggregation selectionDetailsActionGroups. |
insertSelectionDetailsItemAction |
Inserts a selectionDetailsItemAction into the aggregation selectionDetailsItemActions. |
isInitialised |
Checks whether the control is initialized. |
openDialogForKeyUser |
Opens the View Settings Dialog for the UI adaptation. |
rebindChart |
This can be used to trigger binding on the chart used in the SmartChart |
removeAllSelectionDetailsActionGroups |
Removes all the controls from the aggregation selectionDetailsActionGroups. Additionally, it unregisters them from the hosting UIArea. |
removeAllSelectionDetailsActions |
Removes all the controls from the aggregation selectionDetailsActions. Additionally, it unregisters them from the hosting UIArea. |
removeAllSelectionDetailsItemActions |
Removes all the controls from the aggregation selectionDetailsItemActions. Additionally, it unregisters them from the hosting UIArea. |
removeSelectionDetailsAction |
Removes a selectionDetailsAction from the aggregation selectionDetailsActions. |
removeSelectionDetailsActionGroup |
Removes a selectionDetailsActionGroup from the aggregation selectionDetailsActionGroups. |
removeSelectionDetailsItemAction |
Removes a selectionDetailsItemAction from the aggregation selectionDetailsItemActions. |
setActivateTimeSeries |
Sets a new value for property activateTimeSeries. Enables the use of timeseries on the inner chart when corresponding annotation is given When called with a value of Default value is |
setChartBindingPath |
Sets a new value for property chartBindingPath. Specifies the path that is used during the binding of the chart. If not specified, the entitySet property is used instead. (used only if binding is established internally/automatically - See enableAutoBinding) When called with a value of |
setChartType |
Sets a new value for property chartType. Specifies the type of chart to be created by the SmartChart control. When called with a value of |
setCurrentVariantId |
Applies the current variant based on the sVariantId parameter. If an empty string or null or undefined have been passed, the standard variant will be used. The standard variant will also be used if the passed sVariantId cannot be found. If the flexibility variant, the content for the standard variant, or the personalizable control cannot be obtained, no changes will be made. |
setEnableAutoBinding |
Sets a new value for property enableAutoBinding. If set to When called with a value of Default value is |
setEntitySet |
The entity set name in the OData metadata against which the chart must be bound. |
setHeader |
Sets a new value for property header. Specifies header text that is shown in the chart. When called with a value of |
setIgnoredChartTypes |
Sets a new value for property ignoredChartTypes. CSV of fields that is not shown in the list of available chart types. When called with a value of |
setIgnoredFields |
Sets a new value for property ignoredFields. CSV of fields that must be ignored in the OData metadata by the SmartChart control. When called with a value of |
setIgnoreFromPersonalisation |
Sets a new value for property ignoreFromPersonalisation. CSV of fields that is not shown in the personalization dialog. When called with a value of |
setNoData |
Sets a new value for property noData. Defines the custom text that will be displayed in case no data is found for the current binding. When called with a value of |
setPersistencyKey |
Sets a new value for property persistencyKey. Key used to access personalization data. When called with a value of |
setRequestAtLeastFields |
Sets a new value for property requestAtLeastFields. CSV of fields that must be always requested by the backend system. When called with a value of |
setSemanticObjectController |
Sets the aggregated semanticObjectController. |
setShowChartTooltip |
Sets a new value for property showChartTooltip. Controls the visibility of the chart tooltip. If set to When called with a value of Default value is |
setShowChartTypeSelectionButton |
Sets a new value for property showChartTypeSelectionButton. Controls the visibility of the chart type selection button. When called with a value of Default value is |
setShowDetailsButton |
Sets a new value for property showDetailsButton. Controls the visibility of the Details button. If set to When called with a value of Default value is |
setShowDownloadButton |
Sets a new value for property showDownloadButton. Controls the visibility of the chart download button. When called with a value of Default value is |
setShowDrillBreadcrumbs |
Sets a new value for property showDrillBreadcrumbs. Controls the visibility of the Breadcrumbs control for drilling up within the visible dimensions. If set to When called with a value of Default value is |
setShowToolbar |
Change the visibility of the toolbar |
setShowVariantManagement |
Sets a new value for property showVariantManagement. Controls the visibility of the Variant Management. When called with a value of Default value is |
setSmartFilterId |
Sets a new value for property smartFilterId. ID of the corresponding SmartFilter control. If specified, the SmartChart control searches for the SmartFilter control (also in the closest parent view) and attaches to the relevant events of the SmartFilter control to fetch data, show overlay etc. When called with a value of |
setSmartVariant |
Sets the associated smartVariant. |
setToolbarStyle |
Change the style of the toolbar |
setUiState |
The method replaces the current UI state of SmartChart control with the data represented in |
setUseChartPersonalisation |
Sets a new value for property useChartPersonalisation. If set to When called with a value of Default value is |
setUseListForChartTypeSelection |
Sets a new value for property useListForChartTypeSelection. Controls the visualization for chart type selection. If set to When called with a value of Default value is
Since 1.48.0 Setting the property to <code>false</code> will have no effect on the visualization of chart type selection. <code>SmartChart</code> will always show a list of chart types.
|
setUseTooltip |
Sets a new value for property useTooltip. Specifies weather an instance of sap.viz.ui5.controls.VizTooltip or sap.viz.ui5.controls.Popover is used. If set to When called with a value of Default value is |
setUseVariantManagement |
Sets a new value for property useVariantManagement. If set to When called with a value of Default value is |
showOverlay |
Sets the ShowOverlay property on the inner chart, fires the ShowOverlay event |
Adds some selectionDetailsAction to the aggregation selectionDetailsActions.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSelectionDetailsAction | sap.ui.core.Item |
The selectionDetailsAction to add; if empty, nothing is inserted |
Adds some selectionDetailsActionGroup to the aggregation selectionDetailsActionGroups.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSelectionDetailsActionGroup | sap.ui.core.Item |
The selectionDetailsActionGroup to add; if empty, nothing is inserted |
Adds some selectionDetailsItemAction to the aggregation selectionDetailsItemActions.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSelectionDetailsItemAction | sap.ui.core.Item |
The selectionDetailsItemAction to add; if empty, nothing is inserted |
Interface function for SmartVariantManagement control that applies the current variant.
Param | Type | DefaultValue | Description |
---|---|---|---|
oVariantJSON | Object |
The variant JSON |
|
sContext | string |
Describes the context in which the variant has been applied |
Attaches event handler fnFunction
to the afterVariantApply event of this sap.ui.comp.smartchart.SmartChart
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.comp.smartchart.SmartChart
itself.
This event is fired after a variant has been applied.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the afterVariantInitialise event of this sap.ui.comp.smartchart.SmartChart
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.comp.smartchart.SmartChart
itself.
This event is fired after the variant management in the SmartChart control has been initialized.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the afterVariantSave event of this sap.ui.comp.smartchart.SmartChart
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.comp.smartchart.SmartChart
itself.
This event is fired after a variant has been saved. This event can be used to retrieve the ID of the saved variant.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the beforeRebindChart event of this sap.ui.comp.smartchart.SmartChart
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.comp.smartchart.SmartChart
itself.
This event is fired right before the SmartChart
control triggers the binding / rebinding of the inner chart.
Note: In certain cases the inner chart triggers a rebinding by itself. In these cases, the event is not fired.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the chartDataChanged event of this sap.ui.comp.smartchart.SmartChart
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.comp.smartchart.SmartChart
itself.
This event is fired when SmartChart
control data changes, due to changes in the personalization dialog or drill operations.
The data can be changed via sorters, filters or drill-ups/drill-downs.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the dataReceived event of this sap.ui.comp.smartchart.SmartChart
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.comp.smartchart.SmartChart
itself.
This event is fired when data is received after binding. This event is fired if the binding for the chart is done by the SmartChart control itself.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the fullScreenToggled event of this sap.ui.comp.smartchart.SmartChart
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.comp.smartchart.SmartChart
itself.
This event is fired right after the full screen mode of the SmartChart control has been changed.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Loads the chart lib synchronously before the event is attached. That is done for compatibility reasons. Note: Attaching to this event causes the inner chart to load synchronously. This does not fulfill CSP requirements. Please use event initialized
instead.
Attaches event handler fnFunction
to the initialized event of this sap.ui.comp.smartchart.SmartChart
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.comp.smartchart.SmartChart
itself.
This event is fired once the control has been initialized, asynchronous successor of initialise
.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the selectionDetailsActionPress event of this sap.ui.comp.smartchart.SmartChart
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.comp.smartchart.SmartChart
itself.
This event is fired when any action in the selection details popover is pressed.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the showOverlay event of this sap.ui.comp.smartchart.SmartChart
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.comp.smartchart.SmartChart
itself.
This event is fired right before the overlay is shown.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Destroys all the selectionDetailsActionGroups in the aggregation selectionDetailsActionGroups.
Destroys all the selectionDetailsActions in the aggregation selectionDetailsActions.
Destroys all the selectionDetailsItemActions in the aggregation selectionDetailsItemActions.
Destroys the semanticObjectController in the aggregation semanticObjectController.
Detaches event handler fnFunction
from the afterVariantApply event of this sap.ui.comp.smartchart.SmartChart
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the afterVariantInitialise event of this sap.ui.comp.smartchart.SmartChart
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the afterVariantSave event of this sap.ui.comp.smartchart.SmartChart
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the beforeRebindChart event of this sap.ui.comp.smartchart.SmartChart
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the chartDataChanged event of this sap.ui.comp.smartchart.SmartChart
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the dataReceived event of this sap.ui.comp.smartchart.SmartChart
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the fullScreenToggled event of this sap.ui.comp.smartchart.SmartChart
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the initialise event of this sap.ui.comp.smartchart.SmartChart
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the initialized event of this sap.ui.comp.smartchart.SmartChart
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the selectionDetailsActionPress event of this sap.ui.comp.smartchart.SmartChart
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the showOverlay event of this sap.ui.comp.smartchart.SmartChart
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Creates a new subclass of class sap.ui.comp.smartchart.SmartChart with name sClassName
and enriches it with the information contained in oClassInfo
.
oClassInfo
might contain the same kind of information as described in sap.m.VBox.extend.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Function for the sap.ui.comp.smartvariants.SmartVariantManagement control that returns the currently used variant data in an internal format. Note: This function must not be used by applications.
Fires event afterVariantApply to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
currentVariantId | string |
ID of the currently selected variant |
Fires event afterVariantInitialise to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event afterVariantSave to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
currentVariantId | string |
ID of the currently selected variant |
Fires event beforeRebindChart to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event chartDataChanged to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
changeTypes | object |
Object which contains a boolean flag for dimeasure, filter, sort. If set to |
Fires event dataReceived to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event fullScreenToggled to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
fullScreen | boolean |
If |
Fires event initialise to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event initialized to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event selectionDetailsActionPress to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
action | sap.ui.core.Item |
The action that has to be processed once the action has been pressed |
|
itemContexts | sap.ui.model.Context |
If the action is pressed on one of the items, the parameter contains the context of the pressed item. If a custom action or action group of the SelectionDetails popover is pressed, this parameter contains all contexts of the items. |
|
level | sap.m.SelectionDetailsActionLevel |
The action level of action buttons. The available levels are Item, List and Group |
Fires event showOverlay to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Gets current value of property activateTimeSeries.
Enables the use of timeseries on the inner chart when corresponding annotation is given
Default value is false
.
Returns the chart object used internally.
Note: Direct changes made to the inner chart object or its vizFrame might lead to inconsistencies and side effects during runtime, as the SmartChart
control doesn't listen to all changes made to the inner chart instance. To avoid this, please use the API provided by the SmartChart
control itself. Note: Calling this method when the chart is not yet initialized causes the inner chart to load synchronously. This does not fulfill CSP requirements. Please use getChartAsync
instead.
Returns a promise which will be resolved with the internally used chart object, once all dependencies have been loaded.
Note: Direct changes made to the inner chart object or its vizFrame might lead to inconsistencies and side effects during runtime, as the SmartChart
control doesn't listen to all changes made to the inner chart instance. To avoid this, please use the API provided by the SmartChart
control itself.
Gets current value of property chartBindingPath.
Specifies the path that is used during the binding of the chart. If not specified, the entitySet property is used instead. (used only if binding is established internally/automatically - See enableAutoBinding)
Gets current value of property chartType.
Specifies the type of chart to be created by the SmartChart control.
Gets current value of property enableAutoBinding.
If set to true
, this enables automatic binding of the chart using the chartBindingPath (if it exists) or entitySet property. This happens right after the initialise
event has been fired.
Default value is false
.
Gets current value of property entitySet.
The entity set name from which to fetch data and generate the columns.
Note This is not a dynamic property.
Gets current value of property ignoredChartTypes.
CSV of fields that is not shown in the list of available chart types.
Note: No validation is done. Please ensure that you do not add spaces or special characters.
Gets current value of property ignoredFields.
CSV of fields that must be ignored in the OData metadata by the SmartChart control.
Note: No validation is done. Please ensure that you do not add spaces or special characters.
Gets current value of property ignoreFromPersonalisation.
CSV of fields that is not shown in the personalization dialog.
Note: No validation is done. Please ensure that you do not add spaces or special characters.
Gets current value of property legendVisible.
Set chart's legend properties.
Default value is true
.
Returns a metadata object for class sap.ui.comp.smartchart.SmartChart.
Gets current value of property noData.
Defines the custom text that will be displayed in case no data is found for the current binding.
Gets current value of property persistencyKey.
Key used to access personalization data.
Gets current value of property requestAtLeastFields.
CSV of fields that must be always requested by the backend system.
This property is mainly meant to be used if there is no PresentationVariant annotation.
If both this property and the PresentationVariant annotation exist, the select request sent to the backend would be a combination of both.
Note: No validation is done. Please ensure that you do not add spaces or special characters. Also, setting this property during runtime, will delete the current drill-stack and lead to a loss of the drill history.
Gets content of aggregation selectionDetailsActionGroups.
Actions on group level which can be specified for the selection details popover.
Gets content of aggregation selectionDetailsActions.
Actions on footer level which can be specified for the selection details popover.
Gets content of aggregation selectionDetailsItemActions.
Actions on item level which can be specified for the selection details popover.
Gets current value of property selectionMode.
Chart selection mode. Supported values are sap.ui.comp.smartchart.SelectionMode.Single or sap.ui.comp.smartchart.SelectionMode.Multi, case insensitive, always return in upper case. Unsupported values will be ignored.
Default value is Multi
.
Gets content of aggregation semanticObjectController.
The Semantic Object Controller allows the user to specify and overwrite functionality for semantic object navigation.
Gets current value of property showChartTooltip.
Controls the visibility of the chart tooltip. If set to true
, an instance of sap.viz.ui5.controls.VizTooltip will be created and shown when hovering over a data point.
Default value is true
.
Gets current value of property showChartTypeSelectionButton.
Controls the visibility of the chart type selection button.
Default value is true
.
Gets current value of property showDetailsButton.
Controls the visibility of the Details button. If set to true
, the datapoint tooltip will be disabled as the information of selected datapoints will be found in the details popover. This will also set the drill-down button to invisible.
Default value is false
.
Gets current value of property showDimensionsTitle.
Controls the visibility of the title in the dimension area of the chart.
Default value is true
.
Gets current value of property showDownloadButton.
Controls the visibility of the chart download button.
Default value is false
.
Gets current value of property showDrillBreadcrumbs.
Controls the visibility of the Breadcrumbs control for drilling up within the visible dimensions. If set to true
, the toolbar header will be replaced by the Breadcrumbs control. This will also set the drill-up button to invisible.
Default value is false
.
Gets current value of property showDrillButtons.
Controls the visibility of the Drill Up and Drill Down buttons.
Default value is true
.
Gets current value of property showFullScreenButton.
Controls the visibility of the FullScreen button.
Default value is true
.
Gets current value of property showLegendButton.
Controls the visibility of the Navigation button
Default value is true
.
Gets current value of property showMeasuresTitle.
Controls the visibility of the title in the measure area of the chart.
Default value is true
.
Gets current value of property showToolbar.
Controls the visibility of the toolbar.
Default value is true
.
Gets current value of property showVariantManagement.
Controls the visibility of the Variant Management.
Default value is true
.
Gets current value of property showZoomButtons.
Controls the visibility of the Zoom In and Zoom Out buttons.
Default value is true
.
Gets current value of property smartFilterId.
ID of the corresponding SmartFilter control. If specified, the SmartChart control searches for the SmartFilter control (also in the closest parent view) and attaches to the relevant events of the SmartFilter control to fetch data, show overlay etc.
ID of the element which is the current target of the association smartVariant, or null
.
Gets content of aggregation toolbar.
A custom toolbar that can be specified by the user to define their own buttons, icons, etc. If this is added, the SmartChart control does not create its own toolbar, but uses this one instead. However, if default actions, such as showSemanticNavigation, showFullScreenButton etc. are set, these actions are added at the left-hand side of the toolbar.
Gets current value of property toolbarStyle.
Defines the visual style of the smart charts Toolbar
. Note: The visual styles are theme-dependent.
Gets current value of property useChartPersonalisation.
If set to true
, personalized chart settings are defined. If you want to persist the chart personalization, you need to specify the persistencyKey property.
Default value is true
.
Gets current value of property useListForChartTypeSelection.
Controls the visualization for chart type selection. If set to true
, the list of available chart types will be displayed. If set to false
and there are three or fewer available chart types, the chart types will be displayed as separate buttons in the toolbar. If there are more than three chart types, a list will be shown.
Default value is true
.
Gets current value of property useTooltip.
Specifies weather an instance of sap.viz.ui5.controls.VizTooltip or sap.viz.ui5.controls.Popover is used. If set to true
, a tooltip will be displayed, a popover otherwise.
Default value is true
.
Gets current value of property useVariantManagement.
If set to true
, variants are used. As a prerequisite, you need to specify the persistencyKey property.
Default value is true
.
Checks for the provided sap.ui.core.Item
in the aggregation selectionDetailsActions. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSelectionDetailsAction | sap.ui.core.Item |
The selectionDetailsAction whose index is looked for |
Checks for the provided sap.ui.core.Item
in the aggregation selectionDetailsActionGroups. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSelectionDetailsActionGroup | sap.ui.core.Item |
The selectionDetailsActionGroup whose index is looked for |
Checks for the provided sap.ui.core.Item
in the aggregation selectionDetailsItemActions. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSelectionDetailsItemAction | sap.ui.core.Item |
The selectionDetailsItemAction whose index is looked for |
Inserts a selectionDetailsAction into the aggregation selectionDetailsActions.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSelectionDetailsAction | sap.ui.core.Item |
The selectionDetailsAction to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a selectionDetailsActionGroup into the aggregation selectionDetailsActionGroups.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSelectionDetailsActionGroup | sap.ui.core.Item |
The selectionDetailsActionGroup to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a selectionDetailsItemAction into the aggregation selectionDetailsItemActions.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSelectionDetailsItemAction | sap.ui.core.Item |
The selectionDetailsItemAction to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Opens the View Settings Dialog for the UI adaptation.
Note: This function must only be used internally during the UI adaptation.
Param | Type | DefaultValue | Description |
---|---|---|---|
sStyleClass | String |
indicating the ui adaption area |
|
fCallBack | function |
will be executed, once the dialog closes. |
Removes all the controls from the aggregation selectionDetailsActionGroups.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation selectionDetailsActions.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation selectionDetailsItemActions.
Additionally, it unregisters them from the hosting UIArea.
Removes a selectionDetailsAction from the aggregation selectionDetailsActions.
Param | Type | DefaultValue | Description |
---|---|---|---|
vSelectionDetailsAction | int string sap.ui.core.Item |
The selectionDetailsAction to remove or its index or id |
Removes a selectionDetailsActionGroup from the aggregation selectionDetailsActionGroups.
Param | Type | DefaultValue | Description |
---|---|---|---|
vSelectionDetailsActionGroup | int string sap.ui.core.Item |
The selectionDetailsActionGroup to remove or its index or id |
Removes a selectionDetailsItemAction from the aggregation selectionDetailsItemActions.
Param | Type | DefaultValue | Description |
---|---|---|---|
vSelectionDetailsItemAction | int string sap.ui.core.Item |
The selectionDetailsItemAction to remove or its index or id |
Sets a new value for property activateTimeSeries.
Enables the use of timeseries on the inner chart when corresponding annotation is given
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bActivateTimeSeries | boolean | false |
New value for property |
Sets a new value for property chartBindingPath.
Specifies the path that is used during the binding of the chart. If not specified, the entitySet property is used instead. (used only if binding is established internally/automatically - See enableAutoBinding)
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sChartBindingPath | string |
New value for property |
Sets a new value for property chartType.
Specifies the type of chart to be created by the SmartChart control.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sChartType | string |
New value for property |
Applies the current variant based on the sVariantId parameter. If an empty string or null or undefined have been passed, the standard variant will be used. The standard variant will also be used if the passed sVariantId cannot be found. If the flexibility variant, the content for the standard variant, or the personalizable control cannot be obtained, no changes will be made.
Param | Type | DefaultValue | Description |
---|---|---|---|
sVariantId | string |
ID of the currently selected variant |
Sets a new value for property enableAutoBinding.
If set to true
, this enables automatic binding of the chart using the chartBindingPath (if it exists) or entitySet property. This happens right after the initialise
event has been fired.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bEnableAutoBinding | boolean | false |
New value for property |
The entity set name in the OData metadata against which the chart must be bound.
Param | Type | DefaultValue | Description |
---|---|---|---|
sEntitySetName | string |
The entity set |
Sets a new value for property header.
Specifies header text that is shown in the chart.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sHeader | string |
New value for property |
Sets a new value for property ignoredChartTypes.
CSV of fields that is not shown in the list of available chart types.
Note: No validation is done. Please ensure that you do not add spaces or special characters.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIgnoredChartTypes | string |
New value for property |
Sets a new value for property ignoredFields.
CSV of fields that must be ignored in the OData metadata by the SmartChart control.
Note: No validation is done. Please ensure that you do not add spaces or special characters.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIgnoredFields | string |
New value for property |
Sets a new value for property ignoreFromPersonalisation.
CSV of fields that is not shown in the personalization dialog.
Note: No validation is done. Please ensure that you do not add spaces or special characters.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIgnoreFromPersonalisation | string |
New value for property |
Sets a new value for property noData.
Defines the custom text that will be displayed in case no data is found for the current binding.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sNoData | string |
New value for property |
Sets a new value for property persistencyKey.
Key used to access personalization data.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sPersistencyKey | string |
New value for property |
Sets a new value for property requestAtLeastFields.
CSV of fields that must be always requested by the backend system.
This property is mainly meant to be used if there is no PresentationVariant annotation.
If both this property and the PresentationVariant annotation exist, the select request sent to the backend would be a combination of both.
Note: No validation is done. Please ensure that you do not add spaces or special characters. Also, setting this property during runtime, will delete the current drill-stack and lead to a loss of the drill history.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sRequestAtLeastFields | string |
New value for property |
Sets the aggregated semanticObjectController.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSemanticObjectController | sap.ui.comp.navpopover.SemanticObjectController |
The semanticObjectController to set |
Sets a new value for property showChartTooltip.
Controls the visibility of the chart tooltip. If set to true
, an instance of sap.viz.ui5.controls.VizTooltip will be created and shown when hovering over a data point.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bShowChartTooltip | boolean | true |
New value for property |
Sets a new value for property showChartTypeSelectionButton.
Controls the visibility of the chart type selection button.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bShowChartTypeSelectionButton | boolean | true |
New value for property |
Sets a new value for property showDetailsButton.
Controls the visibility of the Details button. If set to true
, the datapoint tooltip will be disabled as the information of selected datapoints will be found in the details popover. This will also set the drill-down button to invisible.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bShowDetailsButton | boolean | false |
New value for property |
Sets a new value for property showDownloadButton.
Controls the visibility of the chart download button.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bShowDownloadButton | boolean | false |
New value for property |
Sets a new value for property showDrillBreadcrumbs.
Controls the visibility of the Breadcrumbs control for drilling up within the visible dimensions. If set to true
, the toolbar header will be replaced by the Breadcrumbs control. This will also set the drill-up button to invisible.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bShowDrillBreadcrumbs | boolean | false |
New value for property |
Change the visibility of the toolbar
Param | Type | DefaultValue | Description |
---|---|---|---|
bShowToolbar | boolean |
If set to |
Sets a new value for property showVariantManagement.
Controls the visibility of the Variant Management.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bShowVariantManagement | boolean | true |
New value for property |
Sets a new value for property smartFilterId.
ID of the corresponding SmartFilter control. If specified, the SmartChart control searches for the SmartFilter control (also in the closest parent view) and attaches to the relevant events of the SmartFilter control to fetch data, show overlay etc.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sSmartFilterId | string |
New value for property |
Sets the associated smartVariant.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSmartVariant | sap.ui.core.ID sap.ui.core.Control |
ID of an element which becomes the new target of this smartVariant association; alternatively, an element instance may be given |
Change the style of the toolbar
Param | Type | DefaultValue | Description |
---|---|---|---|
sStyle | sap.m.ToolbarStyle |
The style of the toolbar. |
The method replaces the current UI state of SmartChart control with the data represented in uiState
.
Param | Type | DefaultValue | Description |
---|---|---|---|
oUiState | sap.ui.comp.state.UIState |
the new representation of UI state |
Sets a new value for property useChartPersonalisation.
If set to true
, personalized chart settings are defined. If you want to persist the chart personalization, you need to specify the persistencyKey property.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bUseChartPersonalisation | boolean | true |
New value for property |
Sets a new value for property useListForChartTypeSelection.
Controls the visualization for chart type selection. If set to true
, the list of available chart types will be displayed. If set to false
and there are three or fewer available chart types, the chart types will be displayed as separate buttons in the toolbar. If there are more than three chart types, a list will be shown.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bUseListForChartTypeSelection | boolean | true |
New value for property |
Sets a new value for property useTooltip.
Specifies weather an instance of sap.viz.ui5.controls.VizTooltip or sap.viz.ui5.controls.Popover is used. If set to true
, a tooltip will be displayed, a popover otherwise.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bUseTooltip | boolean | true |
New value for property |
Sets a new value for property useVariantManagement.
If set to true
, variants are used. As a prerequisite, you need to specify the persistencyKey property.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bUseVariantManagement | boolean | true |
New value for property |