Class sap.viz.ui5.DualStackedColumn100Module: sap/viz/ui5/DualStackedColumn100
Chart sap.viz.ui5.DualStackedColumn100
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(new sap.viz.ui5.controls.VizFrame({'vizType': '100_dual_stacked_column'})
) 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.7.2. Charting API is not finished yet and might change completely.
Since: 1.7.2.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers.
sClassName
and enriches it with the information contained in oClassInfo
.fnFunction
to the deselectData
event of this sap.viz.ui5.DualStackedColumn100
.fnFunction
to the initialized
event of this sap.viz.ui5.DualStackedColumn100
.fnFunction
to the selectData
event of this sap.viz.ui5.DualStackedColumn100
.fnFunction
from the deselectData
event of this sap.viz.ui5.DualStackedColumn100
.fnFunction
from the initialized
event of this sap.viz.ui5.DualStackedColumn100
.fnFunction
from the selectData
event of this sap.viz.ui5.DualStackedColumn100
.fnFunction
to the hideTooltip
event of this sap.viz.ui5.DualStackedColumn100
.fnFunction
to the showTooltip
event of this sap.viz.ui5.DualStackedColumn100
.fnFunction
from the hideTooltip
event of this sap.viz.ui5.DualStackedColumn100
.fnFunction
from the showTooltip
event of this sap.viz.ui5.DualStackedColumn100
. 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:
- Aggregations
- general : sap.viz.ui5.types.RootContainer
- interaction : sap.viz.ui5.types.controller.Interaction
- title : sap.viz.ui5.types.Title
- legendGroup : sap.viz.ui5.types.Legend
- legend : sap.viz.ui5.types.legend.Common
- toolTip : sap.viz.ui5.types.Tooltip
- xyContainer : sap.viz.ui5.types.XYContainer
- dataLabel : sap.viz.ui5.types.Datalabel
- yAxis : sap.viz.ui5.types.Axis
- xAxis : sap.viz.ui5.types.Axis
- background : sap.viz.ui5.types.Background
- plotArea : sap.viz.ui5.types.StackedVerticalBar
- yAxis2 : sap.viz.ui5.types.Axis
- Events
- 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.core.BaseChart 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(
new sap.viz.ui5.controls.VizFrame({'vizType': '100_dual_stacked_column'})
) 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---"]}
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters |
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters |
{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:["..."]}]}
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters |
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters |
- Deprecated:
- Since version 1.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
{name:"showTooltip",data:{body:[{ //All measures name:"...",val:[{//measure value is an array containing only one item 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:"..."},selectedValues:...//this number specify how many values are selected}}
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters |
- Deprecated:
- Since version 1.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
sClassName
and enriches it with the information contained in oClassInfo
. oClassInfo
might contain the same kind of information as described in sap.viz.ui5.core.BaseChart.extend.
{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 |
{function} | Created class / constructor function |
{sap.ui.base.Metadata} | Metadata object describing this class |
fnFunction
to the deselectData
event of this sap.viz.ui5.DualStackedColumn100
. 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.DualStackedColumn100
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---"]}
{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.DualStackedColumn100 itself |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
fnFunction
to the initialized
event of this sap.viz.ui5.DualStackedColumn100
. 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.DualStackedColumn100
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.
{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.DualStackedColumn100 itself |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
fnFunction
to the selectData
event of this sap.viz.ui5.DualStackedColumn100
. 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.DualStackedColumn100
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:["..."]}]}
{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.DualStackedColumn100 itself |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
background
. {sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
dataLabel
. {sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
general
. {sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
interaction
. {sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
legend
. {sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
legendGroup
. {sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
plotArea
. {sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
title
. {sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
toolTip
. {sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
xAxis
. {sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
xyContainer
. {sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
yAxis
. {sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
yAxis2
. {sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
fnFunction
from the deselectData
event of this sap.viz.ui5.DualStackedColumn100
. The passed function and listener object must match the ones used for event registration.
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
fnFunction
from the initialized
event of this sap.viz.ui5.DualStackedColumn100
. The passed function and listener object must match the ones used for event registration.
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
fnFunction
from the selectData
event of this sap.viz.ui5.DualStackedColumn100
. The passed function and listener object must match the ones used for event registration.
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
deselectData
to attached listeners. {Map} | mArguments? | The arguments to pass along with the event |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
initialized
to attached listeners. {Map} | mArguments? | The arguments to pass along with the event |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
selectData
to attached listeners. {Map} | mArguments? | The arguments to pass along with the event |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
background
. Module sap.viz.modules.background
{sap.viz.ui5.types.Background} |
dataLabel
. Module sap.viz.modules.datalabel
{sap.viz.ui5.types.Datalabel} |
general
. Module sap.viz.modules.rootContainer
{sap.viz.ui5.types.RootContainer} |
interaction
. Module sap.viz.modules.controller.interaction
{sap.viz.ui5.types.controller.Interaction} |
legend
. Module sap.viz.modules.legend.common
{sap.viz.ui5.types.legend.Common} |
legendGroup
. Module sap.viz.modules.legend
{sap.viz.ui5.types.Legend} |
plotArea
. Module sap.viz.modules.stackedverticalbar
{sap.viz.ui5.types.StackedVerticalBar} |
title
. Module sap.viz.modules.title
{sap.viz.ui5.types.Title} |
toolTip
. Module sap.viz.chart.elements.Tooltip
{sap.viz.ui5.types.Tooltip} |
xAxis
. Module sap.viz.modules.axis
{sap.viz.ui5.types.Axis} |
xyContainer
. Module sap.viz.modules.xycontainer
{sap.viz.ui5.types.XYContainer} |
yAxis
. Module sap.viz.modules.axis
{sap.viz.ui5.types.Axis} |
yAxis2
. Module sap.viz.modules.axis
{sap.viz.ui5.types.Axis} |
background
. {sap.viz.ui5.types.Background} | oBackground | The background to set |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
dataLabel
. {sap.viz.ui5.types.Datalabel} | oDataLabel | The dataLabel to set |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
general
. {sap.viz.ui5.types.RootContainer} | oGeneral | The general to set |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
interaction
. {sap.viz.ui5.types.controller.Interaction} | oInteraction | The interaction to set |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
legend
. {sap.viz.ui5.types.legend.Common} | oLegend | The legend to set |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
legendGroup
. {sap.viz.ui5.types.Legend} | oLegendGroup | The legendGroup to set |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
plotArea
. {sap.viz.ui5.types.StackedVerticalBar} | oPlotArea | The plotArea to set |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
title
. {sap.viz.ui5.types.Title} | oTitle | The title to set |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
toolTip
. {sap.viz.ui5.types.Tooltip} | oToolTip | The toolTip to set |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
xAxis
. {sap.viz.ui5.types.Axis} | oXAxis | The xAxis to set |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
xyContainer
. {sap.viz.ui5.types.XYContainer} | oXyContainer | The xyContainer to set |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
yAxis
. {sap.viz.ui5.types.Axis} | oYAxis | The yAxis to set |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
yAxis2
. {sap.viz.ui5.types.Axis} | oYAxis2 | The yAxis2 to set |
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
fnFunction
to the hideTooltip
event of this sap.viz.ui5.DualStackedColumn100
. 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.DualStackedColumn100
itself.
This event is deprecated, please use hideDetail decoration (refer to properties: interaction.decorations) instead. Event fires when the mouse hover out of the specific part of chart, no data is passed.
{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.DualStackedColumn100 itself |
- Deprecated:
- Since version 1.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
fnFunction
to the showTooltip
event of this sap.viz.ui5.DualStackedColumn100
. 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.DualStackedColumn100
itself.
This event is deprecated, please use showDetail decoration (refer to properties: interaction.decorations) instead. 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:[{ //All measures name:"...",val:[{//measure value is an array containing only one item 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:"..."},selectedValues:...//this number specify how many values are selected}}
{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.DualStackedColumn100 itself |
- Deprecated:
- Since version 1.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
fnFunction
from the hideTooltip
event of this sap.viz.ui5.DualStackedColumn100
. The passed function and listener object must match the ones used for event registration.
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
- Deprecated:
- Since version 1.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
fnFunction
from the showTooltip
event of this sap.viz.ui5.DualStackedColumn100
. The passed function and listener object must match the ones used for event registration.
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
- Deprecated:
- Since version 1.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
hideTooltip
to attached listeners. {Map} | mArguments? | The arguments to pass along with the event |
- Deprecated:
- Since version 1.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |
showTooltip
to attached listeners. {Map} | mArguments? | The arguments to pass along with the event |
- Deprecated:
- Since version 1.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
{sap.viz.ui5.DualStackedColumn100} | Reference to this in order to allow method chaining |