Class sap.viz.ui5.VizContainerModule: sap/viz/ui5/VizContainer
Controls ui5/VizContainer
Deprecated API:Since version 1.32.0. The chart controls in the sap.viz.ui5
package (which were always marked as experimental) have been deprecated since 1.32.0. They are no longer actively developed and won't receive new features or improvements, only important bug fixes. They will only remain in the SAPUI5 distribution for backward compatibility.
SAP strongly recommends that existing consumers of those controls migrate to the new VizFrame control to benefit from new charting enhancements and timely support.
Note: As the feature set, design and API usage of VizFrame might differ from the old chart controls, make sure you evaluate it thoroughly before migration.
Experimental API:Since version 1.19.0 API is not finished yet and might change completely
Since: 1.19.0.
sClassName
and enriches it with the information contained in oClassInfo
.analysisObjectsForPicker
.fnFunction
to the deselectData
event of this sap.viz.ui5.VizContainer
.fnFunction
to the feedsChanged
event of this sap.viz.ui5.VizContainer
.fnFunction
to the hideTooltip
event of this sap.viz.ui5.VizContainer
.fnFunction
to the initialized
event of this sap.viz.ui5.VizContainer
.fnFunction
to the selectData
event of this sap.viz.ui5.VizContainer
.fnFunction
to the showTooltip
event of this sap.viz.ui5.VizContainer
.fnFunction
to the vizDefinitionChanged
event of this sap.viz.ui5.VizContainer
.fnFunction
to the vizTypeChanged
event of this sap.viz.ui5.VizContainer
.analysisObjectsForPicker
.fnFunction
from the deselectData
event of this sap.viz.ui5.VizContainer
.fnFunction
from the feedsChanged
event of this sap.viz.ui5.VizContainer
.fnFunction
from the hideTooltip
event of this sap.viz.ui5.VizContainer
.fnFunction
from the initialized
event of this sap.viz.ui5.VizContainer
.fnFunction
from the selectData
event of this sap.viz.ui5.VizContainer
.fnFunction
from the showTooltip
event of this sap.viz.ui5.VizContainer
.fnFunction
from the vizDefinitionChanged
event of this sap.viz.ui5.VizContainer
.fnFunction
from the vizTypeChanged
event of this sap.viz.ui5.VizContainer
.sap.viz.ui5.controls.common.feeds.AnalysisObject
in the aggregation analysisObjectsForPicker
.sap.viz.ui5.controls.common.feeds.FeedItem
in the aggregation feeds
.analysisObjectsForPicker
.analysisObjectsForPicker
.analysisObjectsForPicker
. 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
- vizType : string
- vizCss : string
- vizProperties : object
- enableMorphing : boolean
- Aggregations
- vizData : sap.viz.ui5.data.Dataset
- analysisObjectsForPicker : sap.viz.ui5.controls.common.feeds.AnalysisObject[]
- feeds : sap.viz.ui5.controls.common.feeds.FeedItem[]
- Events
- feedsChanged : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- vizTypeChanged : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- vizDefinitionChanged : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- selectData : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- deselectData : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- showTooltip : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- hideTooltip : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- initialized : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
In addition, all settings applicable to the base type sap.viz.ui5.controls.common.BaseControl can be used as well.
{string} | sId? | id for the new control, generated automatically if no id is given |
{object} | mSettings? | initial settings for the new control |
- Deprecated:
- Since version 1.32.0. The chart controls in the
sap.viz.ui5
package (which were always marked as experimental) have been deprecated since 1.32.0. They are no longer actively developed and won't receive new features or improvements, only important bug fixes. They will only remain in the SAPUI5 distribution for backward compatibility.SAP strongly recommends that existing consumers of those controls migrate to the new VizFrame control to benefit from new charting enhancements and timely support.
Note: As the feature set, design and API usage of VizFrame might differ from the old chart controls, make sure you evaluate it thoroughly before migration.
{name: "deselectData",data:["---the same as selectedData---"]}
Parameters:
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters |
feedsChanged(oControlEvent) Dispatches "feedsChanged" event when the feeding changes due to add/remove/change feeding items on feeding panel, drag and drop object onto VizFrame, or switch chart type by UI operation. Application should listen to "feedsChanged" event to get the corresponding data and set it back to VizFrame to to update the visualization with the new data. Parameters:{sap.ui.base.Event} oControlEvent {sap.ui.base.EventProvider} oControlEvent.getSource {object} oControlEvent.getParameters {sap.viz.ui5.controls.common.feeds.FeedItem[]} oControlEvent.getParameters.feeds An array of changed feeds.
hideTooltip(oControlEvent) Event fires when the mouse hover out of the specific part of chart, no data is passed. Parameters:{sap.ui.base.Event} oControlEvent {sap.ui.base.EventProvider} oControlEvent.getSource {object} oControlEvent.getParameters
initialized(oControlEvent) Event fires when the loading ends. To use the event listener when creating charts, you must use an event that is passed by the events option. For more information on events options, see the usrOptions section of the createViz function in the API document. Parameters:{sap.ui.base.Event} oControlEvent {sap.ui.base.EventProvider} oControlEvent.getSource {object} oControlEvent.getParameters
selectData(oControlEvent) Event fires when certain data point(s) is(are) selected, data context of selected item(s) would be passed in accordance with the following format.{name: "selectData",data:[{ //selected element's detail target:"Dom Element",//an object pointed to corresponding dom element data:[{val: "...",//value of this element ctx:{type:"Dimension"||"Measure"||"MND", //for Dimension path:{aa:"...",di:"...",dii:"..."}, //for Measure path:{mg:"...",mi:"...",dii_a1:"...",dii_a2:"..."}, //for MND path:{mg:"...",mi:"..."} //path: analysis path //aa: analysis axis index // 0 for analysis axis 1, 1 for analysis 2 //di: dimension index //zero based //dii: dimension item index //zero based //mg: measure group index // 0 for measure group 1,1 for measure group 2 //mi: measure index // measure index in measure group zero based //dii_a1: each dii of di in analysis axis 1 index //dii_a2: each dii of di in analysis axis 2 index }},{ //for bubble, tagcloud and scatter, there will be more than one values in one selected element. var:"...",ctx:"..."}]},{ //if under multi selection, there will be more than one selected elements target:"...",data:["..."]}]}
Parameters:
{sap.ui.base.Event} oControlEvent {sap.ui.base.EventProvider} oControlEvent.getSource {object} oControlEvent.getParameters
showTooltip(oControlEvent) Event fires when the mouse hover onto the specific part of chart, data context of tooltip would be passed in accordance with the following format.{name:"showTooltip",data:{body:[{ //data of one group name:"...",val:[{ //data of one row color:"...",label:"...",shape:"...",value:"..."},"..."]},"..."],footer:[{label:"...",value:"..."},"..."],plotArea:{ //this object specifies the plot area of the chart height:"...",width:"...",x:"...",y:"..."},point:{ //this object specifies a point which affects the position of tooltip x:"...",y:"..."}}}
Parameters:
{sap.ui.base.Event} oControlEvent {sap.ui.base.EventProvider} oControlEvent.getSource {object} oControlEvent.getParameters
vizDefinitionChanged(oControlEvent) Dispatches "vizDefinitionChanged" event when viz definition was changed. Parameters:{sap.ui.base.Event} oControlEvent {sap.ui.base.EventProvider} oControlEvent.getSource {object} oControlEvent.getParameters
vizTypeChanged(oControlEvent) Dispatches "vizTypeChanged" event when viz type was changed Parameters:{sap.ui.base.Event} oControlEvent {sap.ui.base.EventProvider} oControlEvent.getSource {object} oControlEvent.getParameters
Method Detail
sap.viz.ui5.VizContainer.extend(sClassName, oClassInfo?, FNMetaImpl?): function Creates a new subclass of class sap.viz.ui5.VizContainer with name sClassName
and enriches it with the information contained in oClassInfo
. oClassInfo
might contain the same kind of information as described in sap.viz.ui5.controls.common.BaseControl.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.viz.ui5.VizContainer.getMetadata(): sap.ui.base.Metadata Returns a metadata object for class sap.viz.ui5.VizContainer. Returns:{sap.ui.base.Metadata} Metadata object describing this class
addAnalysisObjectsForPicker(oAnalysisObjectsForPicker): sap.viz.ui5.VizContainer Adds some analysisObjectsForPicker to the aggregation analysisObjectsForPicker
. Parameters:{sap.viz.ui5.controls.common.feeds.AnalysisObject} oAnalysisObjectsForPicker the analysisObjectsForPicker to add; if empty, nothing is inserted
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
addFeed(oFeed): sap.viz.ui5.VizContainer Adds some feed to the aggregation feeds
. Parameters:{sap.viz.ui5.controls.common.feeds.FeedItem} oFeed the feed to add; if empty, nothing is inserted
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
attachDeselectData(oData?, fnFunction, oListener?): sap.viz.ui5.VizContainer Attaches event handler fnFunction
to the deselectData
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer
itself.
Event fires when certain data point(s) is(are) deselected, data context of deselected item(s) would be passed in accordance with the following format.{name: "deselectData",data:["---the same as selectedData---"]}
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.viz.ui5.VizContainer
itself
Returns:
{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
attachFeedsChanged(oData?, fnFunction, oListener?): sap.viz.ui5.VizContainer Attaches event handler fnFunction
to the feedsChanged
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer
itself.
Dispatches "feedsChanged" event when the feeding changes due to add/remove/change feeding items on feeding panel, drag and drop object onto VizFrame, or switch chart type by UI operation. Application should listen to "feedsChanged" event to get the corresponding data and set it back to VizFrame to to update the visualization with the new data.
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.viz.ui5.VizContainer
itself
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
attachHideTooltip(oData?, fnFunction, oListener?): sap.viz.ui5.VizContainer Attaches event handler fnFunction
to the hideTooltip
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer
itself.
Event fires when the mouse hover out of the specific part of chart, no data is passed.
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.viz.ui5.VizContainer
itself
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
attachInitialized(oData?, fnFunction, oListener?): sap.viz.ui5.VizContainer Attaches event handler fnFunction
to the initialized
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer
itself.
Event fires when the loading ends. To use the event listener when creating charts, you must use an event that is passed by the events option. For more information on events options, see the usrOptions section of the createViz function in the API document.
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.viz.ui5.VizContainer
itself
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
attachSelectData(oData?, fnFunction, oListener?): sap.viz.ui5.VizContainer Attaches event handler fnFunction
to the selectData
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer
itself.
Event fires when certain data point(s) is(are) selected, data context of selected item(s) would be passed in accordance with the following format.{name: "selectData",data:[{ //selected element's detail target:"Dom Element",//an object pointed to corresponding dom element data:[{val: "...",//value of this element ctx:{type:"Dimension"||"Measure"||"MND", //for Dimension path:{aa:"...",di:"...",dii:"..."}, //for Measure path:{mg:"...",mi:"...",dii_a1:"...",dii_a2:"..."}, //for MND path:{mg:"...",mi:"..."} //path: analysis path //aa: analysis axis index // 0 for analysis axis 1, 1 for analysis 2 //di: dimension index //zero based //dii: dimension item index //zero based //mg: measure group index // 0 for measure group 1,1 for measure group 2 //mi: measure index // measure index in measure group zero based //dii_a1: each dii of di in analysis axis 1 index //dii_a2: each dii of di in analysis axis 2 index }},{ //for bubble, tagcloud and scatter, there will be more than one values in one selected element. var:"...",ctx:"..."}]},{ //if under multi selection, there will be more than one selected elements target:"...",data:["..."]}]}
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.viz.ui5.VizContainer
itself
Returns:
{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
attachShowTooltip(oData?, fnFunction, oListener?): sap.viz.ui5.VizContainer Attaches event handler fnFunction
to the showTooltip
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer
itself.
Event fires when the mouse hover onto the specific part of chart, data context of tooltip would be passed in accordance with the following format.{name:"showTooltip",data:{body:[{ //data of one group name:"...",val:[{ //data of one row color:"...",label:"...",shape:"...",value:"..."},"..."]},"..."],footer:[{label:"...",value:"..."},"..."],plotArea:{ //this object specifies the plot area of the chart height:"...",width:"...",x:"...",y:"..."},point:{ //this object specifies a point which affects the position of tooltip x:"...",y:"..."}}}
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.viz.ui5.VizContainer
itself
Returns:
{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
attachVizDefinitionChanged(oData?, fnFunction, oListener?): sap.viz.ui5.VizContainer Attaches event handler fnFunction
to the vizDefinitionChanged
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer
itself.
Dispatches "vizDefinitionChanged" event when viz definition was changed.
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.viz.ui5.VizContainer
itself
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
attachVizTypeChanged(oData?, fnFunction, oListener?): sap.viz.ui5.VizContainer Attaches event handler fnFunction
to the vizTypeChanged
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer
itself.
Dispatches "vizTypeChanged" event when viz type was changed
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.viz.ui5.VizContainer
itself
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
destroyAnalysisObjectsForPicker(): sap.viz.ui5.VizContainer Destroys all the analysisObjectsForPicker in the aggregation analysisObjectsForPicker
. Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
destroyFeeds(): sap.viz.ui5.VizContainer Destroys all the feeds in the aggregation feeds
. Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
destroyVizData(): sap.viz.ui5.VizContainer Destroys the vizData in the aggregation vizData
. Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
detachDeselectData(fnFunction, oListener): sap.viz.ui5.VizContainer Detaches event handler fnFunction
from the deselectData
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
detachFeedsChanged(fnFunction, oListener): sap.viz.ui5.VizContainer Detaches event handler fnFunction
from the feedsChanged
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
detachHideTooltip(fnFunction, oListener): sap.viz.ui5.VizContainer Detaches event handler fnFunction
from the hideTooltip
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
detachInitialized(fnFunction, oListener): sap.viz.ui5.VizContainer Detaches event handler fnFunction
from the initialized
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
detachSelectData(fnFunction, oListener): sap.viz.ui5.VizContainer Detaches event handler fnFunction
from the selectData
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
detachShowTooltip(fnFunction, oListener): sap.viz.ui5.VizContainer Detaches event handler fnFunction
from the showTooltip
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
detachVizDefinitionChanged(fnFunction, oListener): sap.viz.ui5.VizContainer Detaches event handler fnFunction
from the vizDefinitionChanged
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
detachVizTypeChanged(fnFunction, oListener): sap.viz.ui5.VizContainer Detaches event handler fnFunction
from the vizTypeChanged
event of this sap.viz.ui5.VizContainer
. 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.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
fireDeselectData(mArguments?): sap.viz.ui5.VizContainer Fires event deselectData
to attached listeners. Parameters:{Map} mArguments? The arguments to pass along with the event
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
fireFeedsChanged(mArguments?): sap.viz.ui5.VizContainer Fires event feedsChanged
to attached listeners. Expects the following event parameters:
feeds
of type sap.viz.ui5.controls.common.feeds.FeedItem[]
An array of changed feeds.
Parameters:{Map} mArguments? The arguments to pass along with the event
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
fireHideTooltip(mArguments?): sap.viz.ui5.VizContainer Fires event hideTooltip
to attached listeners. Parameters:{Map} mArguments? The arguments to pass along with the event
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
fireInitialized(mArguments?): sap.viz.ui5.VizContainer Fires event initialized
to attached listeners. Parameters:{Map} mArguments? The arguments to pass along with the event
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
fireSelectData(mArguments?): sap.viz.ui5.VizContainer Fires event selectData
to attached listeners. Parameters:{Map} mArguments? The arguments to pass along with the event
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
fireShowTooltip(mArguments?): sap.viz.ui5.VizContainer Fires event showTooltip
to attached listeners. Parameters:{Map} mArguments? The arguments to pass along with the event
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
fireVizDefinitionChanged(mArguments?): sap.viz.ui5.VizContainer Fires event vizDefinitionChanged
to attached listeners. Parameters:{Map} mArguments? The arguments to pass along with the event
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
fireVizTypeChanged(mArguments?): sap.viz.ui5.VizContainer Fires event vizTypeChanged
to attached listeners. Parameters:{Map} mArguments? The arguments to pass along with the event
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
getAnalysisObjectsForPicker(): sap.viz.ui5.controls.common.feeds.AnalysisObject[] Gets content of aggregation analysisObjectsForPicker
. Available sap.viz.ui5.controls.common.feeds.AnalysisObject for object picker popup UI
Returns:{sap.viz.ui5.controls.common.feeds.AnalysisObject[]}
getEnableMorphing(): boolean Gets current value of property enableMorphing
. Enable morphing for visualization.
Returns:{boolean} Value of property enableMorphing
getFeeds(): sap.viz.ui5.controls.common.feeds.FeedItem[] Gets content of aggregation feeds
. All feeds for chart.
Returns:{sap.viz.ui5.controls.common.feeds.FeedItem[]}
getVizCss(): string Gets current value of property vizCss
. Css for visualization.
Returns:{string} Value of property vizCss
getVizData(): sap.viz.ui5.data.Dataset Gets content of aggregation vizData
. Dataset for chart.
Returns:{sap.viz.ui5.data.Dataset}
getVizProperties(): object Gets current value of property vizProperties
. Properties for visualization.
Returns:{object} Value of property vizProperties
getVizType(): string Gets current value of property vizType
. Type for visualization.
Returns:{string} Value of property vizType
indexOfAnalysisObjectsForPicker(oAnalysisObjectsForPicker): int Checks for the provided sap.viz.ui5.controls.common.feeds.AnalysisObject
in the aggregation analysisObjectsForPicker
. and returns its index if found or -1 otherwise. Parameters:{sap.viz.ui5.controls.common.feeds.AnalysisObject} oAnalysisObjectsForPicker The analysisObjectsForPicker whose index is looked for
Returns:{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfFeed(oFeed): int Checks for the provided sap.viz.ui5.controls.common.feeds.FeedItem
in the aggregation feeds
. and returns its index if found or -1 otherwise. Parameters:{sap.viz.ui5.controls.common.feeds.FeedItem} oFeed The feed whose index is looked for
Returns:{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertAnalysisObjectsForPicker(oAnalysisObjectsForPicker, iIndex): sap.viz.ui5.VizContainer Inserts a analysisObjectsForPicker into the aggregation analysisObjectsForPicker
. Parameters:{sap.viz.ui5.controls.common.feeds.AnalysisObject} oAnalysisObjectsForPicker the analysisObjectsForPicker to insert; if empty, nothing is inserted {int} iIndex the 0
-based index the analysisObjectsForPicker should be inserted at; for a negative value of iIndex
, the analysisObjectsForPicker is inserted at position 0; for a value greater than the current size of the aggregation, the analysisObjectsForPicker is inserted at the last position
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
insertFeed(oFeed, iIndex): sap.viz.ui5.VizContainer Inserts a feed into the aggregation feeds
. Parameters:{sap.viz.ui5.controls.common.feeds.FeedItem} oFeed the feed to insert; if empty, nothing is inserted {int} iIndex the 0
-based index the feed should be inserted at; for a negative value of iIndex
, the feed is inserted at position 0; for a value greater than the current size of the aggregation, the feed is inserted at the last position
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
removeAllAnalysisObjectsForPicker(): sap.viz.ui5.controls.common.feeds.AnalysisObject[] Removes all the controls from the aggregation analysisObjectsForPicker
. Additionally, it unregisters them from the hosting UIArea.
Returns:{sap.viz.ui5.controls.common.feeds.AnalysisObject[]} An array of the removed elements (might be empty)
removeAllFeeds(): sap.viz.ui5.controls.common.feeds.FeedItem[] Removes all the controls from the aggregation feeds
. Additionally, it unregisters them from the hosting UIArea.
Returns:{sap.viz.ui5.controls.common.feeds.FeedItem[]} An array of the removed elements (might be empty)
removeAnalysisObjectsForPicker(vAnalysisObjectsForPicker): sap.viz.ui5.controls.common.feeds.AnalysisObject Removes a analysisObjectsForPicker from the aggregation analysisObjectsForPicker
. Parameters:{int|string|sap.viz.ui5.controls.common.feeds.AnalysisObject} vAnalysisObjectsForPicker The analysisObjectsForPickerto remove or its index or id
Returns:{sap.viz.ui5.controls.common.feeds.AnalysisObject} The removed analysisObjectsForPicker or null
removeFeed(vFeed): sap.viz.ui5.controls.common.feeds.FeedItem Removes a feed from the aggregation feeds
. Parameters:{int|string|sap.viz.ui5.controls.common.feeds.FeedItem} vFeed The feedto remove or its index or id
Returns:{sap.viz.ui5.controls.common.feeds.FeedItem} The removed feed or null
setEnableMorphing(bEnableMorphing): sap.viz.ui5.VizContainer Setter for property enableMorphing. If set true, a tween animation will play when chart changed. Parameters:{boolean} bEnableMorphing
Returns:{sap.viz.ui5.VizContainer}
setVizCss(sVizCss): sap.viz.ui5.VizContainer Sets a new value for property vizCss
. Css for visualization.
When called with a value of null
or undefined
, the default value of the property will be restored.
Parameters:{string} sVizCss New value for property vizCss
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
setVizData(oVizData): sap.viz.ui5.VizContainer Sets the aggregated vizData
. Parameters:{sap.viz.ui5.data.Dataset} oVizData The vizData to set
Returns:{sap.viz.ui5.VizContainer} Reference to this
in order to allow method chaining
setVizProperties(oVizProperties): sap.viz.ui5.VizContainer Properties for visualization. Example: var vizContainer = new sap.viz.ui5.VizContainer(...);
var properties = {
'dataLabel' : {'visible' : true },
'legend' : { "visible" : true },
'direction' : 'horizontal',
'stacking' : 'normal'
};
vizContainer.setVizProperties(properties);
Parameters:{object} oVizProperties
Returns:{sap.viz.ui5.VizContainer}
setVizType(sVizType): sap.viz.ui5.VizContainer Setter for property vizType. A string of supported viz type: viz/column, viz/stacked_column, viz/dual_column, viz/line, viz/area, viz/combination, viz/dual_line, viz/dual_combination, viz/pie, viz/donut, viz/scatter, viz/bubble, viz/heatmap, viz/treemap. Parameters:{string} sVizType
Returns:{sap.viz.ui5.VizContainer}
vizSelection(aPoints, oAction): sap.viz.ui5.VizContainer Selections for visualization. Example: var vizContainer = new sap.viz.ui5.VizContainer(...);
var points = [{
data : {
"Country" : "China",
"Year" : "2001",
"Product" : "Car",
"Profit" : 25
}}, {
data : {
"Country" : "China",
"Year" : "2001",
"Product" : "Trunk",
"Profit" : 34
}}];
var action = {
clearSelection : true
};
vizContainer.vizSelection(points, action);
Parameters:{object[]} aPoints some data points of the chart {object} oAction whether to clear previous selection, by default the selection will be incremental selection
Returns:{sap.viz.ui5.VizContainer}
vizUpdate(oOptions): sap.viz.ui5.VizContainer Update VizContainer according to a JSON object, it can update css, properties, feeds and data model. Example: var vizContainer = new sap.viz.ui5.VizContainer(...);
var vizData = new sap.viz.ui5.data.FlattenedDataset({
'dimensions' : [{
axis: 1,
name: "Country",
value: "{Country}"
},{
axis: 2,
name: "City"
value: "{City}"
}],
'measures' : [{
group: 1,
name: "Quantity sold",
value: "{Quantity sold}"
}],
'data' : {
'path' : "/rawData"
}
});
var cssString = 'position:absolute;left:0px;top:0px;';
var properties = {
'dataLabel' : {'visible' : true },
'legend' : {"visible" : true},
'direction' : 'horizontal',
'stacking' : 'normal'
};
var FeedItem = sap.viz.ui5.controls.common.feeds.FeedItem;
var feeds = [
new FeedItem({'uid' : 'primaryValues',
'type' : 'Measure',
'values' []}),
new FeedItem({'uid' : 'regionColor',
'type' : 'Dimension',
'values' []})];
vizContainer.vizUpdate({
'data' : vizData,
'css' : cssString,
'properties' : properties,
'feeds' : feeds
});
Parameters:{object} oOptions a JSON object contains combination of css, properties, feeds and data model.
Returns:{sap.viz.ui5.VizContainer}