namespace sap.ui.mdc.chart

Control sample: sap.ui.mdc.chart
Visiblity:
Available since: N/A
Module:
Application Component: CA-UI5-MDC

Nodes Overview

Node Description
sap.ui.mdc.chart.DimensionItem

The Item for the field/property metadata used within MDC controls, an instance can be created to override the default/metadata behavior.

sap.ui.mdc.chart.Item

The Item for the field/property metadata used within MDC controls, an instance can be created to override the default/metadata behavior.

sap.ui.mdc.chart.MeasureItem

The Item for the field/property metadata used within MDC controls, an instance can be created to override the default/metadata behavior.

sap.ui.mdc.chart.SelectionDetailsActions

The aggregation to feed details actions for dapaoint selection in the mdc chart


Methods Overview

Method Description
"200">Name Type Default Value Description _colorings object

The coloring

Since: 1.64.

Visibility: hidden autoBindOnInit boolean true Visibility: public chartType string column

Specifies the type of chart to be created by the SmartChart control.

Visibility: public delegate object ...see text or source

Defines the module path of the metadata delegate.

Visibility: public header string

Specifies header text that is shown in chart

Visibility: public height sap.ui.core.CSSSize 100%

Defines the height of the chart.

Visibility: public ignoreToolbarActions sap.ui.mdc.ChartToolbarActionType[]

Specifies which actions should not be available in the chart's toolbar.

Since: 1.64.

Visibility: public legendVisible boolean true

Set chart's legend properties.

Since: 1.62.

Visibility: public minHeight sap.ui.core.CSSSize 400px

The minimal height

Visibility: public minWidth sap.ui.core.CSSSize 240px

The minimal width

Visibility: public noDataText string

Defines the no data text shown in the chart.

Since: 1.78.

Visibility: public p13nMode sap.ui.mdc.ChartP13nMode[]

Specifies the personalization options available for the chart.
Note: The order of the provided options does not influence the arrangement of the icons on the UI.

Since: 1.75.

Visibility: public selectionMode string MULTIPLE

the selection mode of the chart

Visibility: public showChartTooltip boolean true

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.

Since: 1.86.

Visibility: public sortConditions object

Defines the sort conditions.

Note: This property is exclusively used for handling flexibility changes. Do not use it for anything else.

Since: 1.74.

Visibility: public vizProperties object

The vizProperties

Since: 1.62.

Visibility: public width sap.ui.core.CSSSize 100%

Defines the width of the chart.

Visibility: public

Borrowed Properties

Name Type Default Value Description
delegate object

Path to the Delegate module that provides the required APIs to execute model-specific logic.
Note: Ensure that the related file can be requested (any required library has to be loaded before that).
Do not bind or modify the module. This property can only be configured during control initialization.

Visibility: public

Aggregations

Default Aggregation: items

Name Cardinality Type Description
_breadcrumbs 0..1 sap.m.Breadcrumbs
_chart 0..1 sap.chart.Chart
_noDataStruct 0..1 sap.m.VBox
_toolbar 0..1 sap.ui.mdc.ActionToolbar
actions 0..n sap.ui.core.Control
data 0..n sap.ui.core.Control
items (default) 0..n sap.ui.mdc.chart.Item
selectionDetailsActions 0..1 sap.ui.mdc.chart.SelectionDetailsActions

Associations

Name Cardinality Type Description
filter 0..1 sap.ui.mdc.IFilter

Control or object which enables the chart to do filtering, such as sap.ui.mdc.FilterBar. Also see sap.ui.mdc.IFilter.

Since: 1.78.


Events Overview

Event Description
dataPointsSelected

This event is fired when the selection in the inner chart changes.

selectionDetailsActionPressed

This event is fired when a SelectionDetailsAction is pressed.

dataPointsSelected

This event is fired when the selection in the inner chart changes.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
dataContext object

The context of selected / deselected data points

selectionDetailsActionPressed

This event is fired when a SelectionDetailsAction is pressed.

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


Methods Overview

Method Description
_addCriticality

Adds criticality to an item

_createDrillBreadcrumbs

shows the Breadcrumbs for current drill-path and drilling up.

_createInnerChart

Creates inner chart

_getNoDataText

Gets the text shown for when there is no data on the inner chart

_getSorters

Returns sorters available for the data

_onFiltersChanged

Callback for when fuilters changed Activates the overlay on the MDC Chart

_renderOverlay

Adds/Removes the overlay shown above the inner chart

_showDrillDown

shows the drill-down popover for selection a dimension to drill down to.

_update

Updates the inner chart

_updateColoring

Updates the coloring on the inner chart

_updateInnerChartNoDataText

Updates the text shown when there is no data for the inner chart

_updateSemanticalPattern

Updates the semantical pattern for given measures

addAction

Adds some action to the aggregation actions.

addData

Adds some data to the aggregation data.

addItem

Adds a Item to the chart

applySettings

Applies given settings onto the MDC Chart and initialized it

attachDataPointsSelected

Attaches event handler fnFunction to the dataPointsSelected event of this sap.ui.mdc.Chart.

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.mdc.Chart itself.

This event is fired when the selection in the inner chart changes.

attachSelectionDetailsActionPressed

Attaches event handler fnFunction to the selectionDetailsActionPressed event of this sap.ui.mdc.Chart.

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.mdc.Chart itself.

This event is fired when a SelectionDetailsAction is pressed.

bindAggregation

Calls the Delegates to bind the aggregation onto the inner chart

destroyActions

Destroys all the actions in the aggregation actions.

destroyData

Destroys all the data in the aggregation data.

destroyItems

Destroys all the items in the aggregation items.

destroySelectionDetailsActions

Destroys the selectionDetailsActions in the aggregation selectionDetailsActions.

detachDataPointsSelected

Detaches event handler fnFunction from the dataPointsSelected event of this sap.ui.mdc.Chart.

The passed function and listener object must match the ones used for event registration.

detachSelectionDetailsActionPressed

Detaches event handler fnFunction from the selectionDetailsActionPressed event of this sap.ui.mdc.Chart.

The passed function and listener object must match the ones used for event registration.

done

Returns a Promise that resolves after the chart has been initialized after being created and after changing the type.

sap.ui.mdc.Chart.extend

Creates a new subclass of class sap.ui.mdc.Chart with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.mdc.Control.extend.

fireDataPointsSelected

Fires event dataPointsSelected to attached listeners.

fireSelectionDetailsActionPressed

Fires event selectionDetailsActionPressed to attached listeners.

getActions

Gets content of aggregation actions.

getAutoBindOnInit

Gets current value of property autoBindOnInit.

Default value is true.

getAvailableChartTypes

Gets the available chart types for the current state of the inner chart

getBindingInfo

Gets information about the current data binding

getChartType

Gets current value of property chartType.

Specifies the type of chart to be created by the SmartChart control.

Default value is "column".

getCollectionModel

Gets the collection model from the binding information

getCollectionPath

Gets the collection path from the binding information

getCurrentState

Fetches the current state of the chart (as a JSON)

getData

Gets content of aggregation data.

getDelegate

Gets current value of property delegate.

Defines the module path of the metadata delegate.

Default value is ...see text or source.

getFilter

ID of the element which is the current target of the association filter, or null.

getHeader

Gets current value of property header.

Specifies header text that is shown in chart

getHeight

Gets current value of property height.

Defines the height of the chart.

Default value is "100%".

getIgnoreToolbarActions

Gets current value of property ignoreToolbarActions.

Specifies which actions should not be available in the chart's toolbar.

Default value is [].

getItems

Gets content of aggregation items.

getItemsByKeys

Gets the item from the aggregation named items that matches the given aItemKeys.

getLegendVisible

Gets current value of property legendVisible.

Set chart's legend properties.

Default value is true.

getManagedObjectModel

Gets the managed object model.

sap.ui.mdc.Chart.getMetadata

Returns a metadata object for class sap.ui.mdc.Chart.

getMinHeight

Gets current value of property minHeight.

The minimal height

Default value is "400px".

getMinWidth

Gets current value of property minWidth.

The minimal width

Default value is "240px".

getNoDataText

Gets current value of property noDataText.

Defines the no data text shown in the chart.

getP13nMode

Gets current value of property p13nMode.

Specifies the personalization options available for the chart.
Note: The order of the provided options does not influence the arrangement of the icons on the UI.

getSelectionDetailsActions

Gets content of aggregation selectionDetailsActions.

getSelectionMode

Gets current value of property selectionMode.

the selection mode of the chart

Default value is "MULTIPLE".

getShowChartTooltip

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.

getSortConditions

Gets current value of property sortConditions.

Defines the sort conditions.

Note: This property is exclusively used for handling flexibility changes. Do not use it for anything else.

getTypeInfo

Gets information about the current chart type.

getVizProperties

Gets current value of property vizProperties.

The vizProperties

getWidth

Gets current value of property width.

Defines the width of the chart.

Default value is "100%".

indexOfAction

Checks for the provided sap.ui.core.Control in the aggregation actions. and returns its index if found or -1 otherwise.

indexOfData

Checks for the provided sap.ui.core.Control in the aggregation data. and returns its index if found or -1 otherwise.

indexOfItem

Checks for the provided sap.ui.mdc.chart.Item in the aggregation items. and returns its index if found or -1 otherwise.

init

Initialises the MDC Chart

initialized

Returns a Promise that resolves after the chart has been initialized after being created and after changing the type.

initModules

Initializes modules needed for MDC Chart

insertAction

Inserts a action into the aggregation actions.

insertData

Inserts a data into the aggregation data.

insertItem

Inserts an Item into the chart

isFilteringEnabled

Gets whether filtering is enabled for p13n

isInnerChartBound

Checks whether inner chart is bound

rebind

Updates the delegate binding info and updates inner chart if necessary

removeAction

Removes a action from the aggregation actions.

removeAllActions

Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

removeAllData

Removes all the controls from the aggregation data.

Additionally, it unregisters them from the hosting UIArea.

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeData

Removes a data from the aggregation data.

removeItem

Removes the chart item

setAutoBindOnInit

Sets a new value for property autoBindOnInit.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

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 null or undefined, the default value of the property will be restored.

Default value is "column".

setDelegate

Sets a new value for property delegate.

Defines the module path of the metadata delegate.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is ...see text or source.

setFilter

Sets the associated filter.

setHeader

Sets a new value for property header.

Specifies header text that is shown in chart

When called with a value of null or undefined, the default value of the property will be restored.

setHeight

Sets a new value for property height.

Defines the height of the chart.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "100%".

setIgnoreToolbarActions

Sets a new value for property ignoreToolbarActions.

Specifies which actions should not be available in the chart's toolbar.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is [].

setLegendVisible

Sets the visibility of the legend

setMinHeight

Sets a new value for property minHeight.

The minimal height

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "400px".

setMinWidth

Sets a new value for property minWidth.

The minimal width

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "240px".

setNoDataText

Sets the text shown for when there is no data for the chart

setP13nMode

Sets a new value for property p13nMode.

Specifies the personalization options available for the chart.
Note: The order of the provided options does not influence the arrangement of the icons on the UI.

When called with a value of null or undefined, the default value of the property will be restored.

setSelectionDetailsActions

Sets the aggregated selectionDetailsActions.

setSelectionMode

Sets the selectionMode property

setSortConditions

Sets a new value for property sortConditions.

Defines the sort conditions.

Note: This property is exclusively used for handling flexibility changes. Do not use it for anything else.

When called with a value of null or undefined, the default value of the property will be restored.

setVizProperties

Sets a new value for property vizProperties.

The vizProperties

When called with a value of null or undefined, the default value of the property will be restored.

setWidth

Sets a new value for property width.

Defines the width of the chart.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "100%".

update

Updates the inner chart

_addCriticality

Adds criticality to an item

Param Type DefaultValue Description
oItem undefined

item to add criticality to

_createDrillBreadcrumbs

shows the Breadcrumbs for current drill-path and drilling up.

_createInnerChart

Creates inner chart

_getNoDataText

Gets the text shown for when there is no data on the inner chart

_getSorters

Returns sorters available for the data

_onFiltersChanged

Callback for when fuilters changed Activates the overlay on the MDC Chart

Param Type DefaultValue Description
oEvent undefined

filter changed event

_renderOverlay

Adds/Removes the overlay shown above the inner chart

Param Type DefaultValue Description
bShow boolean

true to show overlay, false to hide

_showDrillDown

shows the drill-down popover for selection a dimension to drill down to.

_update

Updates the inner chart

Param Type DefaultValue Description
oChart sap.chart.Chart

the inner chart to update

oChanges object

Object containing the changes to update with

_updateColoring

Updates the coloring on the inner chart

Param Type DefaultValue Description
oChart sap.chart.Chart

inner chart

aVisibleDimensions array

visible dimensions for inner chart

aVisibleMeasures array

visible measures for inner chart

_updateInnerChartNoDataText

Updates the text shown when there is no data for the inner chart

_updateSemanticalPattern

Updates the semantical pattern for given measures

Param Type DefaultValue Description
oChart sap.chart.Chart

the inner chart

aVisibleMeasures array

array containing the visible measures on the inner chart

mDataPoints any

data points of the inner chart

addAction

Adds some action to the aggregation actions.

Param Type DefaultValue Description
oAction sap.ui.core.Control

The action to add; if empty, nothing is inserted

addData

Adds some data to the aggregation data.

Param Type DefaultValue Description
oData sap.ui.core.Control

The data to add; if empty, nothing is inserted

addItem

Adds a Item to the chart

Param Type DefaultValue Description
oItem sap.ui.mdc.chart.Item

a chart Item

bSuppressInvalidate boolean

Suppress invalidation of the control

applySettings

Applies given settings onto the MDC Chart and initialized it

Param Type DefaultValue Description
mSettings any

settings to apply

attachDataPointsSelected

Attaches event handler fnFunction to the dataPointsSelected event of this sap.ui.mdc.Chart.

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.mdc.Chart itself.

This event is fired when the selection in the inner chart changes.

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 sap.ui.mdc.Chart itself

attachSelectionDetailsActionPressed

Attaches event handler fnFunction to the selectionDetailsActionPressed event of this sap.ui.mdc.Chart.

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.mdc.Chart itself.

This event is fired when a SelectionDetailsAction 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 sap.ui.mdc.Chart itself

bindAggregation

Calls the Delegates to bind the aggregation onto the inner chart

Param Type DefaultValue Description
sName string

Name of a public aggregation to bind

oBindingInfo sap.ui.base.ManagedObject.AggregationBindingInfo

binding info for the aggregation

sSearchText string

search text (optional)

destroyActions

Destroys all the actions in the aggregation actions.

destroyData

Destroys all the data in the aggregation data.

destroyItems

Destroys all the items in the aggregation items.

destroySelectionDetailsActions

Destroys the selectionDetailsActions in the aggregation selectionDetailsActions.

detachDataPointsSelected

Detaches event handler fnFunction from the dataPointsSelected event of this sap.ui.mdc.Chart.

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

detachSelectionDetailsActionPressed

Detaches event handler fnFunction from the selectionDetailsActionPressed event of this sap.ui.mdc.Chart.

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

done

Returns a Promise that resolves after the chart has been initialized after being created and after changing the type.

sap.ui.mdc.Chart.extend

Creates a new subclass of class sap.ui.mdc.Chart with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.mdc.Control.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

fireDataPointsSelected

Fires event dataPointsSelected to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

dataContext object

The context of selected / deselected data points

fireSelectionDetailsActionPressed

Fires event selectionDetailsActionPressed 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

getActions

Gets content of aggregation actions.

getAutoBindOnInit

Gets current value of property autoBindOnInit.

Default value is true.

getAvailableChartTypes

Gets the available chart types for the current state of the inner chart

getBindingInfo

Gets information about the current data binding

getChartType

Gets current value of property chartType.

Specifies the type of chart to be created by the SmartChart control.

Default value is "column".

getCollectionModel

Gets the collection model from the binding information

getCollectionPath

Gets the collection path from the binding information

getCurrentState

Fetches the current state of the chart (as a JSON)

getData

Gets content of aggregation data.

getDelegate

Gets current value of property delegate.

Defines the module path of the metadata delegate.

Default value is ...see text or source.

getFilter

ID of the element which is the current target of the association filter, or null.

getHeader

Gets current value of property header.

Specifies header text that is shown in chart

getHeight

Gets current value of property height.

Defines the height of the chart.

Default value is "100%".

getIgnoreToolbarActions

Gets current value of property ignoreToolbarActions.

Specifies which actions should not be available in the chart's toolbar.

Default value is [].

getItems

Gets content of aggregation items.

getItemsByKeys

Gets the item from the aggregation named items that matches the given aItemKeys.

Param Type DefaultValue Description
aItemKeys array

The item keys that specify the item to be retrieved

getLegendVisible

Gets current value of property legendVisible.

Set chart's legend properties.

Default value is true.

getManagedObjectModel

Gets the managed object model.

sap.ui.mdc.Chart.getMetadata

Returns a metadata object for class sap.ui.mdc.Chart.

getMinHeight

Gets current value of property minHeight.

The minimal height

Default value is "400px".

getMinWidth

Gets current value of property minWidth.

The minimal width

Default value is "240px".

getNoDataText

Gets current value of property noDataText.

Defines the no data text shown in the chart.

getP13nMode

Gets current value of property p13nMode.

Specifies the personalization options available for the chart.
Note: The order of the provided options does not influence the arrangement of the icons on the UI.

getSelectionDetailsActions

Gets content of aggregation selectionDetailsActions.

getSelectionMode

Gets current value of property selectionMode.

the selection mode of the chart

Default value is "MULTIPLE".

getShowChartTooltip

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.

getSortConditions

Gets current value of property sortConditions.

Defines the sort conditions.

Note: This property is exclusively used for handling flexibility changes. Do not use it for anything else.

getTypeInfo

Gets information about the current chart type.

getVizProperties

Gets current value of property vizProperties.

The vizProperties

getWidth

Gets current value of property width.

Defines the width of the chart.

Default value is "100%".

indexOfAction

Checks for the provided sap.ui.core.Control in the aggregation actions. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oAction sap.ui.core.Control

The action whose index is looked for

indexOfData

Checks for the provided sap.ui.core.Control in the aggregation data. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oData sap.ui.core.Control

The data whose index is looked for

indexOfItem

Checks for the provided sap.ui.mdc.chart.Item in the aggregation items. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oItem sap.ui.mdc.chart.Item

The item whose index is looked for

init

Initialises the MDC Chart

initialized

Returns a Promise that resolves after the chart has been initialized after being created and after changing the type.

initModules

Initializes modules needed for MDC Chart

Param Type DefaultValue Description
aModules array

Modules to initialize

insertAction

Inserts a action into the aggregation actions.

Param Type DefaultValue Description
oAction sap.ui.core.Control

The action to insert; if empty, nothing is inserted

iIndex int

The 0-based index the action should be inserted at; for a negative value of iIndex, the action is inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted at the last position

insertData

Inserts a data into the aggregation data.

Param Type DefaultValue Description
oData sap.ui.core.Control

The data to insert; if empty, nothing is inserted

iIndex int

The 0-based index the data should be inserted at; for a negative value of iIndex, the data is inserted at position 0; for a value greater than the current size of the aggregation, the data is inserted at the last position

insertItem

Inserts an Item into the chart

Param Type DefaultValue Description
oItem sap.ui.mdc.chart.Item

a chart Item

iIndex int

the index

bSuppressInvalidate boolean

Suppress invalidation of the control

isFilteringEnabled

Gets whether filtering is enabled for p13n

isInnerChartBound

Checks whether inner chart is bound

rebind

Updates the delegate binding info and updates inner chart if necessary

removeAction

Removes a action from the aggregation actions.

Param Type DefaultValue Description
vAction int string sap.ui.core.Control

The action to remove or its index or id

removeAllActions

Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

removeAllData

Removes all the controls from the aggregation data.

Additionally, it unregisters them from the hosting UIArea.

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeData

Removes a data from the aggregation data.

Param Type DefaultValue Description
vData int string sap.ui.core.Control

The data to remove or its index or id

removeItem

Removes the chart item

Param Type DefaultValue Description
oItem sap.ui.mdc.chart.Item

oItem a chart Item

bSuppressInvalidate undefined

Suppress invalidation of the control

setAutoBindOnInit

Sets a new value for property autoBindOnInit.

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
bAutoBindOnInit boolean true

New value for property autoBindOnInit

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 null or undefined, the default value of the property will be restored.

Default value is "column".

Param Type DefaultValue Description
sChartType string "column"

New value for property chartType

setDelegate

Sets a new value for property delegate.

Defines the module path of the metadata delegate.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is ...see text or source.

Param Type DefaultValue Description
oDelegate object ...see text or source

New value for property delegate

setFilter

Sets the associated filter.

Param Type DefaultValue Description
oFilter sap.ui.core.ID sap.ui.mdc.IFilter

ID of an element which becomes the new target of this filter association; alternatively, an element instance may be given

setHeader

Sets a new value for property header.

Specifies header text that is shown in 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 header

setHeight

Sets a new value for property height.

Defines the height of the chart.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "100%".

Param Type DefaultValue Description
sHeight sap.ui.core.CSSSize "100%"

New value for property height

setIgnoreToolbarActions

Sets a new value for property ignoreToolbarActions.

Specifies which actions should not be available in the chart's toolbar.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is [].

Param Type DefaultValue Description
sIgnoreToolbarActions sap.ui.mdc.ChartToolbarActionType[] []

New value for property ignoreToolbarActions

setLegendVisible

Sets the visibility of the legend

Param Type DefaultValue Description
bVisible boolean

true to show legend, false to hide

setMinHeight

Sets a new value for property minHeight.

The minimal height

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "400px".

Param Type DefaultValue Description
sMinHeight sap.ui.core.CSSSize "400px"

New value for property minHeight

setMinWidth

Sets a new value for property minWidth.

The minimal width

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "240px".

Param Type DefaultValue Description
sMinWidth sap.ui.core.CSSSize "240px"

New value for property minWidth

setNoDataText

Sets the text shown for when there is no data for the chart

Param Type DefaultValue Description
sNoData string

text to show when no data is shown

setP13nMode

Sets a new value for property p13nMode.

Specifies the personalization options available for the chart.
Note: The order of the provided options does not influence the arrangement of the icons on the UI.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sP13nMode sap.ui.mdc.ChartP13nMode[]

New value for property p13nMode

setSelectionDetailsActions

Sets the aggregated selectionDetailsActions.

Param Type DefaultValue Description
oSelectionDetailsActions sap.ui.mdc.chart.SelectionDetailsActions

The selectionDetailsActions to set

setSelectionMode

Sets the selectionMode property

Param Type DefaultValue Description
vValue string

the selection mode to set the chart to

setSortConditions

Sets a new value for property sortConditions.

Defines the sort conditions.

Note: This property is exclusively used for handling flexibility changes. Do not use it for anything else.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
oSortConditions object

New value for property sortConditions

setVizProperties

Sets a new value for property vizProperties.

The vizProperties

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
oVizProperties object

New value for property vizProperties

setWidth

Sets a new value for property width.

Defines the width of the chart.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "100%".

Param Type DefaultValue Description
sWidth sap.ui.core.CSSSize "100%"

New value for property width

update

Updates the inner chart

Param Type DefaultValue Description
oChanges object

Object containing the changes to update with