SmartChart

extends VBox

The SmartChart control creates a chart based on OData metadata and the configuration specified. The entitySet property must be specified to use the control. This property is used to fetch fields from OData metadata, from which the chart UI will be generated. It can also be used to fetch the actual chart data.
Based on the chartType property, this control will render the corresponding chart.
Note: Most of the attributes are not dynamic and cannot be changed once the control has been initialized.

A detailed description of the OData annotations handled by this control is available here.
Annotation Limitations: Qualifier support for entity types is limited for this control.

Constructor Summary

new sap.ui.comp.smartchart.SmartChart(sId?, mSettings?)Constructor for a new smartchart/SmartChart.

Event Summary

afterVariantApply(oControlEvent)This event is fired after a variant has been applied.

afterVariantInitialise(oControlEvent)This event is fired after the variant management in the SmartChart control has been initialized.

afterVariantSave(oControlEvent)This event is fired after a variant has been saved.

beforeRebindChart(oControlEvent)This event is fired right before the binding is done.

dataReceived(oControlEvent)This event is fired when data is received after binding.

initialise(oControlEvent)This event is fired once the control has been initialized.

showOverlay(oControlEvent)This event is fired right before the overlay is shown.

Events borrowed from class sap.ui.core.Control

validateFieldGroup

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.ui.comp.smartchart.SmartChart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.comp.smartchart.SmartChart with name sClassName and enriches it with the information contained in oClassInfo.

sap.ui.comp.smartchart.SmartChart.getMetadata()Returns a metadata object for class sap.ui.comp.smartchart.SmartChart.

applyVariant(oVariantJSON, sContext)Interface function for SmartVariantManagement control that applies the current variant.

attachAfterVariantApply(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterVariantApply event of this sap.ui.comp.smartchart.SmartChart.

attachAfterVariantInitialise(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterVariantInitialise event of this sap.ui.comp.smartchart.SmartChart.

attachAfterVariantSave(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterVariantSave event of this sap.ui.comp.smartchart.SmartChart.

attachBeforeRebindChart(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the beforeRebindChart event of this sap.ui.comp.smartchart.SmartChart.

attachDataReceived(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the dataReceived event of this sap.ui.comp.smartchart.SmartChart.

attachInitialise(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the initialise event of this sap.ui.comp.smartchart.SmartChart.

attachShowOverlay(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the showOverlay event of this sap.ui.comp.smartchart.SmartChart.

destroySemanticObjectController()Destroys the semanticObjectController in the aggregation semanticObjectController.

destroyToolbar()Destroys the toolbar in the aggregation toolbar.

detachAfterVariantApply(fnFunction, oListener)Detaches event handler fnFunction from the afterVariantApply event of this sap.ui.comp.smartchart.SmartChart.

detachAfterVariantInitialise(fnFunction, oListener)Detaches event handler fnFunction from the afterVariantInitialise event of this sap.ui.comp.smartchart.SmartChart.

detachAfterVariantSave(fnFunction, oListener)Detaches event handler fnFunction from the afterVariantSave event of this sap.ui.comp.smartchart.SmartChart.

detachBeforeRebindChart(fnFunction, oListener)Detaches event handler fnFunction from the beforeRebindChart event of this sap.ui.comp.smartchart.SmartChart.

detachDataReceived(fnFunction, oListener)Detaches event handler fnFunction from the dataReceived event of this sap.ui.comp.smartchart.SmartChart.

detachInitialise(fnFunction, oListener)Detaches event handler fnFunction from the initialise event of this sap.ui.comp.smartchart.SmartChart.

detachShowOverlay(fnFunction, oListener)Detaches event handler fnFunction from the showOverlay event of this sap.ui.comp.smartchart.SmartChart.

exit()Cleans up the control.

fetchVariant()Interface function for the SmartVariantManagement control that returns the currently used variant data.

fireAfterVariantApply(mArguments?)Fires event afterVariantApply to attached listeners.

fireAfterVariantInitialise(mArguments?)Fires event afterVariantInitialise to attached listeners.

fireAfterVariantSave(mArguments?)Fires event afterVariantSave to attached listeners.

fireBeforeRebindChart(mArguments?)Fires event beforeRebindChart to attached listeners.

fireDataReceived(mArguments?)Fires event dataReceived to attached listeners.

fireInitialise(mArguments?)Fires event initialise to attached listeners.

fireShowOverlay(mArguments?)Fires event showOverlay to attached listeners.

getChart()Returns the chart object used internally.

getChartBindingPath()Gets current value of property chartBindingPath.

getChartType()Gets current value of property chartType.

getCurrentVariantId()Returns the ID of the currently selected variant.

getEnableAutoBinding()Gets current value of property enableAutoBinding.

getEntitySet()Gets current value of property entitySet.

getHeader()Gets current value of property header.

getIgnoredChartTypes()Gets current value of property ignoredChartTypes.

getIgnoredFields()Gets current value of property ignoredFields.

getIgnoreFromPersonalisation()Gets current value of property ignoreFromPersonalisation.

getLegendVisible()Gets current value of property legendVisible.

getPersistencyKey()Gets current value of property persistencyKey.

getRequestAtLeastFields()Gets current value of property requestAtLeastFields.

getSelectionMode()Gets current value of property selectionMode.

getSemanticObjectController()Gets content of aggregation semanticObjectController.

getShowChartTooltip()Gets current value of property showChartTooltip.

getShowDetailsButton()Gets current value of property showDetailsButton.

getShowDrillBreadcrumbs()Gets current value of property showDrillBreadcrumbs.

getShowDrillButtons()Gets current value of property showDrillButtons.

getShowFullScreenButton()Gets current value of property showFullScreenButton.

getShowLegendButton()Gets current value of property showLegendButton.

getShowSemanticNavigationButton()Gets current value of property showSemanticNavigationButton.

getShowVariantManagement()Gets current value of property showVariantManagement.

getShowZoomButtons()Gets current value of property showZoomButtons.

getSmartFilterId()Gets current value of property smartFilterId.

getSmartVariant()ID of the element which is the current target of the association smartVariant, or null.

getToolbar()Gets content of aggregation toolbar.

getUseChartPersonalisation()Gets current value of property useChartPersonalisation.

getUseListForChartTypeSelection()Gets current value of property useListForChartTypeSelection.

getUseTooltip()Gets current value of property useTooltip.

getUseVariantManagement()Gets current value of property useVariantManagement.

rebindChart()This can be used to trigger binding on the chart used in the SmartChart

setChartBindingPath(sChartBindingPath)Sets a new value for property chartBindingPath.

setChartType(sChartType)Sets a new value for property chartType.

setCurrentVariantId(sVariantId)Applies the current variant based on the sVariantId parameter.

setEnableAutoBinding(bEnableAutoBinding)Sets a new value for property enableAutoBinding.

setEntitySet(sEntitySetName)The entity set name in the OData metadata against which the chart must be bound.

setHeader(sHeader)Sets a new value for property header.

setIgnoredChartTypes(sIgnoredChartTypes)Sets a new value for property ignoredChartTypes.

setIgnoredFields(sIgnoredFields)Sets a new value for property ignoredFields.

setIgnoreFromPersonalisation(sIgnoreFromPersonalisation)Sets a new value for property ignoreFromPersonalisation.

setPersistencyKey(sPersistencyKey)Sets a new value for property persistencyKey.

setRequestAtLeastFields(sRequestAtLeastFields)Sets a new value for property requestAtLeastFields.

setSelectionMode(sSelectionMode)Sets a new value for property selectionMode.

setSemanticObjectController(oSemanticObjectController)Sets the aggregated semanticObjectController.

setShowChartTooltip(bShowChartTooltip)Sets a new value for property showChartTooltip.

setShowDetailsButton(bShowDetailsButton)Sets a new value for property showDetailsButton.

setShowDrillBreadcrumbs(bShowDrillBreadcrumbs)Sets a new value for property showDrillBreadcrumbs.

setShowFullScreenButton(bShowFullScreenButton)Sets a new value for property showFullScreenButton.

setShowVariantManagement(bShowVariantManagement)Sets a new value for property showVariantManagement.

setSmartFilterId(sSmartFilterId)Sets a new value for property smartFilterId.

setSmartVariant(oSmartVariant)Sets the associated smartVariant.

setToolbar(oToolbar)Sets the aggregated toolbar.

setUseChartPersonalisation(bUseChartPersonalisation)Sets a new value for property useChartPersonalisation.

setUseListForChartTypeSelection(bUseListForChartTypeSelection)Sets a new value for property useListForChartTypeSelection.

setUseTooltip(bUseTooltip)Sets a new value for property useTooltip.

setUseVariantManagement(bUseVariantManagement)Sets a new value for property useVariantManagement.

Methods borrowed from class sap.m.FlexBox

Methods borrowed from class sap.ui.core.Control

Methods borrowed from class sap.ui.core.Element

Methods borrowed from class sap.ui.base.ManagedObject

addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, hasListeners

OData Annotation Summary

SemanticObject(com.sap.vocabularies.Common.v1) on EntitySet,EntityType,PropertyDefines a name of the SemanticObject that can be represented with an EntitySet, EntityType or identified by a Property.

FieldControlType/Hidden(com.sap.vocabularies.Common.v1) on PropertyDefines whether a field in the SmartChart control is visible.

PresentationVariant(com.sap.vocabularies.UI.v1) on EntitySet,EntityTypeRenders the initial chart fields for the SmartChart control.

Chart(com.sap.vocabularies.UI.v1) on EntityTypeRenders a chart based on the information that is provided within the Chart annotation.

Chart/ChartType(com.sap.vocabularies.UI.v1) on PropertyValueRenders a chart based on the ChartType information that is provided within Chart The Chart annotation contains an EnumMember where the ChartType must be defined.

Constructor Detail

new sap.ui.comp.smartchart.SmartChart(sId?, mSettings?)

Constructor for a new smartchart/SmartChart.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

Properties
- entitySet : string
- smartFilterId : string
- ignoredFields : string
- requestAtLeastFields : string
- ignoreFromPersonalisation : string
- chartType : string
- ignoredChartTypes : string
- useVariantManagement : boolean (default: true)
- useChartPersonalisation : boolean (default: true)
- header : string
- persistencyKey : string
- currentVariantId : string
- enableAutoBinding : boolean (default: false)
- chartBindingPath : string
- showDrillButtons : boolean (default: true)
- showZoomButtons : boolean (default: true)
- showSemanticNavigationButton : boolean (default: true)
- showVariantManagement : boolean (default: true)
- showDetailsButton : boolean (default: false)
- showDrillBreadcrumbs : boolean (default: false)
- showChartTooltip : boolean (default: true)
- showLegendButton : boolean (default: true)
- legendVisible : boolean (default: true)
- selectionMode : sap.chart.SelectionMode (default: Multi)
- showFullScreenButton : boolean (default: true)
- useTooltip : boolean (default: true)
- useListForChartTypeSelection : boolean (default: true)
Aggregations
- toolbar : sap.m.Toolbar
- semanticObjectController : sap.ui.comp.navpopover.SemanticObjectController
Events
- initialise : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- beforeRebindChart : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- dataReceived : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- afterVariantInitialise : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- afterVariantSave : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- afterVariantApply : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- showOverlay : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.m.VBox can be used as well.

Parameters:

{string}	sId?	ID for the new control that is generated automatically if no ID is given
{object}	mSettings?	Initial settings for the new control

Event Detail

afterVariantApply(oControlEvent)

This event is fired after a variant has been applied.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

afterVariantInitialise(oControlEvent)

This event is fired after the variant management in the SmartChart control has been initialized.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

afterVariantSave(oControlEvent)

This event is fired after a variant has been saved. This event can be used to retrieve the ID of the saved variant.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

beforeRebindChart(oControlEvent)

This event is fired right before the binding is done.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

dataReceived(oControlEvent)

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.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

initialise(oControlEvent)

This event is fired once the control has been initialized.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

showOverlay(oControlEvent)

This event is fired right before the overlay is shown.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

Method Detail

sap.ui.comp.smartchart.SmartChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

Parameters:

{string}	sClassName	Name of the class being created
{object}	oClassInfo?	Object literal with information about the class
{function}	FNMetaImpl?	Constructor function for the metadata object; if not given, it defaults to `sap.ui.core.ElementMetadata`

Returns:

{function}

Created class / constructor function

sap.ui.comp.smartchart.SmartChart.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.ui.comp.smartchart.SmartChart.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

applyVariant(oVariantJSON, sContext)

Interface function for SmartVariantManagement control that applies the current variant.

Parameters:

{Object}	oVariantJSON	The variant JSON
{string}	sContext	Describes the context in which the variant has been applied

attachAfterVariantApply(oData?, fnFunction, oListener?): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

attachAfterVariantInitialise(oData?, fnFunction, oListener?): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

attachAfterVariantSave(oData?, fnFunction, oListener?): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

attachBeforeRebindChart(oData?, fnFunction, oListener?): sap.ui.comp.smartchart.SmartChart

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 binding is done.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

attachDataReceived(oData?, fnFunction, oListener?): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

attachInitialise(oData?, fnFunction, oListener?): sap.ui.comp.smartchart.SmartChart

Attaches event handler fnFunction to the initialise 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.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

attachShowOverlay(oData?, fnFunction, oListener?): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

destroySemanticObjectController(): sap.ui.comp.smartchart.SmartChart

Destroys the semanticObjectController in the aggregation semanticObjectController.

Since:: 1.36

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

destroyToolbar(): sap.ui.comp.smartchart.SmartChart

Destroys the toolbar in the aggregation toolbar.

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

detachAfterVariantApply(fnFunction, oListener): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

detachAfterVariantInitialise(fnFunction, oListener): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

detachAfterVariantSave(fnFunction, oListener): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

detachBeforeRebindChart(fnFunction, oListener): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

detachDataReceived(fnFunction, oListener): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

detachInitialise(fnFunction, oListener): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

detachShowOverlay(fnFunction, oListener): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

exit()

Cleans up the control.

fetchVariant(): json

Interface function for the SmartVariantManagement control that returns the currently used variant data.

Returns:

{json}

The currently used variant

fireAfterVariantApply(mArguments?): sap.ui.comp.smartchart.SmartChart

Fires event afterVariantApply to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

fireAfterVariantInitialise(mArguments?): sap.ui.comp.smartchart.SmartChart

Fires event afterVariantInitialise to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

fireAfterVariantSave(mArguments?): sap.ui.comp.smartchart.SmartChart

Fires event afterVariantSave to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

fireBeforeRebindChart(mArguments?): sap.ui.comp.smartchart.SmartChart

Fires event beforeRebindChart to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

fireDataReceived(mArguments?): sap.ui.comp.smartchart.SmartChart

Fires event dataReceived to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

fireInitialise(mArguments?): sap.ui.comp.smartchart.SmartChart

Fires event initialise to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

fireShowOverlay(mArguments?): sap.ui.comp.smartchart.SmartChart

Fires event showOverlay to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

getChart(): object

Returns the chart object used internally.

Returns:

{object}

The chart

getChartBindingPath(): string

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)

Returns:

{string} Value of property chartBindingPath

getChartType(): string

Gets current value of property chartType.

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

Returns:

{string} Value of property chartType

getCurrentVariantId(): string

Returns the ID of the currently selected variant.

Returns:

{string}

ID of the currently selected variant

getEnableAutoBinding(): boolean

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.

Returns:

{boolean} Value of property enableAutoBinding

getEntitySet(): string

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.

Returns:

{string} Value of property entitySet

getHeader(): string

Gets current value of property header.

Specifies header text that is shown in the chart.

Returns:

{string} Value of property header

getIgnoredChartTypes(): string

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.

Returns:

{string} Value of property ignoredChartTypes

getIgnoredFields(): string

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.

Returns:

{string} Value of property ignoredFields

getIgnoreFromPersonalisation(): string

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.

Returns:

{string} Value of property ignoreFromPersonalisation

getLegendVisible(): boolean

Gets current value of property legendVisible.

Set chart's legend properties.

Default value is true.

Since:: 1.36

Returns:

{boolean} Value of property legendVisible

getPersistencyKey(): string

Gets current value of property persistencyKey.

Key used to access personalization data.

Returns:

{string} Value of property persistencyKey

getRequestAtLeastFields(): string

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.

Returns:

{string} Value of property requestAtLeastFields

getSelectionMode(): sap.chart.SelectionMode

Gets current value of property selectionMode.

Chart selection mode. Supported values are sap.chart.SelectionMode.Single or sap.chart.SelectionMode.Multi, case insensitive, always return in upper case. Unsupported values will be ignored.

Default value is Multi.

Since:: 1.36

Returns:

{sap.chart.SelectionMode} Value of property selectionMode

getSemanticObjectController(): sap.ui.comp.navpopover.SemanticObjectController

Gets content of aggregation semanticObjectController.

The Semantic Object Controller allows the user to specify and overwrite functionality for semantic object navigation.

Since:: 1.36

Returns:

{sap.ui.comp.navpopover.SemanticObjectController}

getShowChartTooltip(): boolean

Gets current value of property showChartTooltip.

Controls the visibility of the chart tooltip. If set to true , the chart tooltip will be shown when hovering over a data point.

Default value is true.

Since:: 1.38

Returns:

{boolean} Value of property showChartTooltip

getShowDetailsButton(): boolean

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.

Since:: 1.38

Returns:

{boolean} Value of property showDetailsButton

getShowDrillBreadcrumbs(): boolean

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.

Since:: 1.38

Returns:

{boolean} Value of property showDrillBreadcrumbs

getShowDrillButtons(): boolean

Gets current value of property showDrillButtons.

Controls the visibility of the Drill Up and Drill Down buttons.

Default value is true.

Returns:

{boolean} Value of property showDrillButtons

getShowFullScreenButton(): boolean

Gets current value of property showFullScreenButton.

Controls the visibility of the FullScreen button.

Default value is true.

Since:: 1.36

Returns:

{boolean} Value of property showFullScreenButton

getShowLegendButton(): boolean

Gets current value of property showLegendButton.

Controls the visibility of the Navigation button

Default value is true.

Since:: 1.36

Returns:

{boolean} Value of property showLegendButton

getShowSemanticNavigationButton(): boolean

Gets current value of property showSemanticNavigationButton.

Controls the visibility of the Navigation button

Default value is true.

Since:: 1.36

Returns:

{boolean} Value of property showSemanticNavigationButton

getShowVariantManagement(): boolean

Gets current value of property showVariantManagement.

Controls the visibility of the Variant Management.

Default value is true.

Since:: 1.38

Returns:

{boolean} Value of property showVariantManagement

getShowZoomButtons(): boolean

Gets current value of property showZoomButtons.

Controls the visibility of the Zoom In and Zoom Out buttons.

Default value is true.

Since:: 1.36

Returns:

{boolean} Value of property showZoomButtons

getSmartFilterId(): string

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.

Returns:

{string} Value of property smartFilterId

getSmartVariant(): sap.ui.core.Control

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

Since:: 1.38

Returns:

{sap.ui.core.Control}

getToolbar(): sap.m.Toolbar

Gets content of aggregation toolbar.

A toolbar that can be added by the user to define their own custom buttons, icons, etc. If this is specified, the SmartChart control does not create an additional toolbar, but uses this one.

Returns:

{sap.m.Toolbar}

getUseChartPersonalisation(): boolean

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.

Returns:

{boolean} Value of property useChartPersonalisation

getUseListForChartTypeSelection(): boolean

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.

Since:: 1.38

Returns:

{boolean} Value of property useListForChartTypeSelection

getUseTooltip(): boolean

Gets current value of property useTooltip.

Controls the usage either of the tooltip or the popover. If set to true, a tooltip will be displayed.

Default value is true.

Since:: 1.36

Returns:

{boolean} Value of property useTooltip

getUseVariantManagement(): boolean

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.

Returns:

{boolean} Value of property useVariantManagement

rebindChart()

This can be used to trigger binding on the chart used in the SmartChart

setChartBindingPath(sChartBindingPath): sap.ui.comp.smartchart.SmartChart

Sets a new value for property chartBindingPath.

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

Parameters:

{string} sChartBindingPath New value for property chartBindingPath

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setChartType(sChartType): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{string} sChartType New value for property chartType

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setCurrentVariantId(sVariantId)

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.

Parameters:

{string}

sVariantId

ID of the currently selected variant

setEnableAutoBinding(bEnableAutoBinding): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{boolean} bEnableAutoBinding New value for property enableAutoBinding

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setEntitySet(sEntitySetName)

The entity set name in the OData metadata against which the chart must be bound.

Parameters:

{string}

sEntitySetName

The entity set

setHeader(sHeader): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{string} sHeader New value for property header

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setIgnoredChartTypes(sIgnoredChartTypes): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{string} sIgnoredChartTypes New value for property ignoredChartTypes

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setIgnoredFields(sIgnoredFields): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{string} sIgnoredFields New value for property ignoredFields

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setIgnoreFromPersonalisation(sIgnoreFromPersonalisation): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{string} sIgnoreFromPersonalisation New value for property ignoreFromPersonalisation

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setPersistencyKey(sPersistencyKey): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{string} sPersistencyKey New value for property persistencyKey

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setRequestAtLeastFields(sRequestAtLeastFields): sap.ui.comp.smartchart.SmartChart

Sets a new value for property requestAtLeastFields.

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

Parameters:

{string} sRequestAtLeastFields New value for property requestAtLeastFields

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setSelectionMode(sSelectionMode): sap.ui.comp.smartchart.SmartChart

Sets a new value for property selectionMode.

Chart selection mode. Supported values are sap.chart.SelectionMode.Single or sap.chart.SelectionMode.Multi, case insensitive, always return in upper case. Unsupported values will be ignored.

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

Default value is Multi.

Parameters:

{sap.chart.SelectionMode} sSelectionMode New value for property selectionMode

Since:: 1.36

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setSemanticObjectController(oSemanticObjectController): sap.ui.comp.smartchart.SmartChart

Sets the aggregated semanticObjectController.

Parameters:

{sap.ui.comp.navpopover.SemanticObjectController}

oSemanticObjectController

The semanticObjectController to set

Since:: 1.36

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setShowChartTooltip(bShowChartTooltip): sap.ui.comp.smartchart.SmartChart

Sets a new value for property showChartTooltip.

Controls the visibility of the chart tooltip. If set to true , the chart tooltip will be 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.

Parameters:

{boolean} bShowChartTooltip New value for property showChartTooltip

Since:: 1.38

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setShowDetailsButton(bShowDetailsButton): sap.ui.comp.smartchart.SmartChart

Sets a new value for property showDetailsButton.

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

Default value is false.

Parameters:

{boolean} bShowDetailsButton New value for property showDetailsButton

Since:: 1.38

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setShowDrillBreadcrumbs(bShowDrillBreadcrumbs): sap.ui.comp.smartchart.SmartChart

Sets a new value for property showDrillBreadcrumbs.

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

Default value is false.

Parameters:

{boolean} bShowDrillBreadcrumbs New value for property showDrillBreadcrumbs

Since:: 1.38

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setShowFullScreenButton(bShowFullScreenButton): sap.ui.comp.smartchart.SmartChart

Sets a new value for property showFullScreenButton.

Controls the visibility of the FullScreen button.

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

Default value is true.

Parameters:

{boolean} bShowFullScreenButton New value for property showFullScreenButton

Since:: 1.36

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setShowVariantManagement(bShowVariantManagement): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{boolean} bShowVariantManagement New value for property showVariantManagement

Since:: 1.38

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setSmartFilterId(sSmartFilterId): sap.ui.comp.smartchart.SmartChart

Sets a new value for property smartFilterId.

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

Parameters:

{string} sSmartFilterId New value for property smartFilterId

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setSmartVariant(oSmartVariant): sap.ui.comp.smartchart.SmartChart

Sets the associated smartVariant.

Parameters:

{sap.ui.core.Control}

oSmartVariant

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

Since:: 1.38

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setToolbar(oToolbar): sap.ui.comp.smartchart.SmartChart

Sets the aggregated toolbar.

Parameters:

{sap.m.Toolbar}

oToolbar

The toolbar to set

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setUseChartPersonalisation(bUseChartPersonalisation): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{boolean} bUseChartPersonalisation New value for property useChartPersonalisation

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setUseListForChartTypeSelection(bUseListForChartTypeSelection): sap.ui.comp.smartchart.SmartChart

Sets a new value for property useListForChartTypeSelection.

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

Default value is true.

Parameters:

{boolean} bUseListForChartTypeSelection New value for property useListForChartTypeSelection

Since:: 1.38

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setUseTooltip(bUseTooltip): sap.ui.comp.smartchart.SmartChart

Sets a new value for property useTooltip.

Controls the usage either of the tooltip or the popover. If set to true, a tooltip will be displayed.

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

Default value is true.

Parameters:

{boolean} bUseTooltip New value for property useTooltip

Since:: 1.36

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

setUseVariantManagement(bUseVariantManagement): sap.ui.comp.smartchart.SmartChart

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.

Parameters:

{boolean} bUseVariantManagement New value for property useVariantManagement

Returns:

{sap.ui.comp.smartchart.SmartChart} Reference to this in order to allow method chaining

OData Annotation Detail

SemanticObject(com.sap.vocabularies.Common.v1)

Defines a name of the SemanticObject that can be represented with an EntitySet, EntityType or identified by a Property. With this annotation in place, the SemanticObjectController will provide all the available features for the SmartChart control.

XML Example of OData V4 with SemanticObject on ProductName

   <Annotations Target="ProductName">
     <Annotation Term="com.sap.vocabularies.Common.v1.SemanticObject" String="SemanticObjectName" />
  </Annotations>

Refer OData v4 annotations for details about annotations.

Target Type:

EntitySet

EntityType

Property

Applies to Aggregation/Property:

text

Since:: 1.34.1

FieldControlType/Hidden(com.sap.vocabularies.Common.v1)

Defines whether a field in the SmartChart control is visible. The SmartChart interprets the EnumMemberFieldControlType/Hidden of the FieldControl annotation for setting the visibility.

Note: Currently only FieldControlType/Hidden is supported for statically hiding the fields.

XML Example of OData V4 with hidden Customer and CompanyCode Properties

   <Property Name="Customer">
     <Annotation Term="UI.FieldControlType/Hidden"/>
   </Property>
   <Property Name="CompanyCode">
     <Annotation Term="UI.FieldControlTpye/Hidden"/>
   </Property>

For OData v2 the sap:visible annotation on the Property can be used to assign visibility.

   <Property Name="Customer" ... sap:visible="false"/>
   <Property Name="CompanyCode" ... sap:visible="false"/>

Refer OData v4 annotations for details about annotations.

Target Type:

Property

Applies to Aggregation/Property:

field/#/visible

Since:: 1.34.1

PresentationVariant(com.sap.vocabularies.UI.v1)

Renders the initial chart fields for the SmartChart control. A PropertyPath and an AnnotationPath can be used for constructing PresentationVariant annotation.

XML Example of OData V4 with Customer and CompanyCode Properties as PresentationVariant

   <Annotation Term="com.sap.vocabularies.UI.v1.PresentationVariant">
     <Record>
       <PropertyValue Property="Visualizations">
         <Collection>
           <AnnotationPath>@UI.LineItem</AnnotationPath>
         </Collection>
       </PropertyValue>
       <PropertyValue Property="RequestAtLeast">
         <Collection>
           <PropertyPath>Customer</PropertyPath>
           <PropertyPath>CompanyCode</PropertyPath>
         </Collection>
       </PropertyValue>
         <PropertyValue Property="SortOrder">
           <Collection>
             <Record>
               <PropertyValue Property="Property" PropertyPath="CompanyCode"/>
               <PropertyValue Property="Descending" Bool="true"/>
             </Record>
             <Record>
               <PropertyValue Property="Property" PropertyPath="Customer"/>
             </Record>
           </Collection>
         </PropertyValue>
       </Record>
     </Annotation>

Refer OData v4 annotations for details about annotations.

Target Type:

EntitySet

EntityType

Applies to Aggregation/Property:

chartFields

Since:: 1.34.1

Chart(com.sap.vocabularies.UI.v1)

Renders a chart based on the information that is provided within the Chart annotation. Chart annotation must be defined for an EntityType

XML Example of OData V4 with Chart Annotation

   <Annotations Target="Item" xmlns="http://docs.oasis-open.org/odata/ns/edm">
     <Annotation Term="com.sap.vocabularies.UI.v1.Chart">
       <Record>
         <PropertyValue Property="Title" String="Line Items" />
         <PropertyValue Property="ChartType"
            EnumMember="com.sap.vocabularies.UI.v1.ChartType/Column" />
         <PropertyValue Property="Dimensions">
           <Collection>
             <PropertyPath>CompanyCode</PropertyPath>
             <PropertyPath>Customer</PropertyPath>
           </Collection>
         </PropertyValue>
         <PropertyValue Property="Measures">
           <Collection>
             <PropertyPath>AmountInCompanyCodeCurrency</PropertyPath>
             <PropertyPath>AmountInTransactionCurrency</PropertyPath>
           </Collection>
         </PropertyValue>
       </Record>
     </Annotation>
   </Annotations>

Refer OData v4 annotations for details about annotations.

Target Type:

EntityType

Applies to Aggregation/Property:

chart

Since:: 1.34.1

Chart/ChartType(com.sap.vocabularies.UI.v1)

Renders a chart based on the ChartType information that is provided within Chart The Chart annotation contains an EnumMember where the ChartType must be defined. The annotation is defined as a parameter in the PropertyValue.

XML Example of OData V4 with ChartType as Column Chart

   <Annotations Target="Item" xmlns="http://docs.oasis-open.org/odata/ns/edm">
     <Annotation Term="com.sap.vocabularies.UI.v1.Chart">
       <Record>
         <PropertyValue Property="Title" String="Line Items" />
         <PropertyValue Property="ChartType"
            EnumMember="com.sap.vocabularies.UI.v1.ChartType/Column" />
         <PropertyValue Property="Dimensions">
           <Collection>
             <PropertyPath>CompanyCode</PropertyPath>
             <PropertyPath>Customer</PropertyPath>
           </Collection>
         </PropertyValue>
         <PropertyValue Property="Measures">
           <Collection>
             <PropertyPath>AmountInCompanyCodeCurrency</PropertyPath>
             <PropertyPath>AmountInTransactionCurrency</PropertyPath>
           </Collection>
         </PropertyValue>
       </Record>
     </Annotation>
   </Annotations>

Refer OData v4 annotations for details about annotations.

Target Type:

PropertyValue

Applies to Aggregation/Property:

chartType

Since:: 1.34.1