StackedVerticalBar

Module sap.viz.ui5.types.StackedVerticalBar

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.7.2. Charting API is not finished yet and might change completely.

Since: 1.7.2.

Constructor Summary

new sap.viz.ui5.types.StackedVerticalBar(sId?, mSettings?)Constructor for a new sap.viz.ui5.types.StackedVerticalBar

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.viz.ui5.types.StackedVerticalBar.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.StackedVerticalBar with name sClassName and enriches it with the information contained in oClassInfo.

sap.viz.ui5.types.StackedVerticalBar.getMetadata()Returns a metadata object for class sap.viz.ui5.types.StackedVerticalBar.

destroyAnimation()Destroys the animation in the aggregation animation.

getAnimation()Gets content of aggregation animation.

getColorPalette()Gets current value of property colorPalette.

getDrawingEffect()Gets current value of property drawingEffect.

getFormatRules()Gets current value of property formatRules.

getMode()Gets current value of property mode.

getPrimaryValuesColorPalette()Gets current value of property primaryValuesColorPalette.

getSecondaryValuesColorPalette()Gets current value of property secondaryValuesColorPalette.

setAnimation(oAnimation)Sets the aggregated animation.

setColorPalette(sColorPalette)Sets a new value for property colorPalette.

setDrawingEffect(sDrawingEffect)Sets a new value for property drawingEffect.

setFormatRules(sFormatRules)Sets a new value for property formatRules.

setMode(sMode)Sets a new value for property mode.

setPrimaryValuesColorPalette(sPrimaryValuesColorPalette)Sets a new value for property primaryValuesColorPalette.

setSecondaryValuesColorPalette(sSecondaryValuesColorPalette)Sets a new value for property secondaryValuesColorPalette.

destroyToolTip()Destroys the toolTip in the aggregation toolTip.

getIsRoundCorner()Gets current value of property isRoundCorner.

getOrientation()Gets current value of property orientation.

getToolTip()Gets content of aggregation toolTip.

setIsRoundCorner(bIsRoundCorner)Sets a new value for property isRoundCorner.

setOrientation(sOrientation)Sets a new value for property orientation.

setToolTip(oToolTip)Sets the aggregated toolTip.

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, invalidate, 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

Constructor Detail

new sap.viz.ui5.types.StackedVerticalBar(sId?, mSettings?)

Constructor for a new sap.viz.ui5.types.StackedVerticalBar

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
- orientation : sap.viz.ui5.types.StackedVerticalBar_orientation (default: vertical)
- colorPalette : string[] (default: ???)
- primaryValuesColorPalette : string[] (default: ???)
- secondaryValuesColorPalette : string[] (default: ???)
- drawingEffect : sap.viz.ui5.types.StackedVerticalBar_drawingEffect (default: normal)
- isRoundCorner : boolean (default: false)
- formatRules : object[]
- mode : sap.viz.ui5.types.StackedVerticalBar_mode (default: comparison)
Aggregations
- toolTip : sap.viz.ui5.types.StackedVerticalBar_tooltip
- animation : sap.viz.ui5.types.StackedVerticalBar_animation

In addition, all settings applicable to the base type sap.viz.ui5.core.BaseStructuredType can be used as well.

Parameters:

{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.

Method Detail

sap.viz.ui5.types.StackedVerticalBar.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.viz.ui5.types.StackedVerticalBar 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.core.BaseStructuredType.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.types.StackedVerticalBar.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.viz.ui5.types.StackedVerticalBar.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

destroyAnimation(): sap.viz.ui5.types.StackedVerticalBar

Destroys the animation in the aggregation animation.

Returns:

{sap.viz.ui5.types.StackedVerticalBar} Reference to this in order to allow method chaining

getAnimation(): sap.viz.ui5.types.StackedVerticalBar_animation

Gets content of aggregation animation.

Settings for animations in the plot area

Returns:

{sap.viz.ui5.types.StackedVerticalBar_animation}

getColorPalette(): string[]

Gets current value of property colorPalette.

Set the color palette for the chart. This is not supported for dual axis charts that have measureNamesDimension bound to the legend.

Default value is ???.

Returns:

{string[]} Value of property colorPalette

getDrawingEffect(): sap.viz.ui5.types.StackedVerticalBar_drawingEffect

Gets current value of property drawingEffect.

Set the drawing effect for the plot area. If this value is set to 'glossy', the plot area is glossy. If this value is set to 'normal', the plot area is matte.

Default value is normal.

Returns:

{sap.viz.ui5.types.StackedVerticalBar_drawingEffect} Value of property drawingEffect

getFormatRules(): object[]

Gets current value of property formatRules.

Sample value for formatRules: [{condition: [{Key1:Value1, Key2:Value2}], color:"#00ff00"}, {condition: [{Key3:Value3}], color:"#00ffff"}]. Each rule has two properties: the "condition" and the "color". Value1, Value2 and Value3 are values.
The value of a dimension may be
1, Single value (string), like "China" .
2. Array (enumeration), like ["UK","USA"] .
The value of a measure may be
1, Single value (number), like 20 .
2. Arry (enumeration), like [121,122] .
3. Object (range), like {min:100, max 200} . Min and max are inclusive. If users want to inlcude 200, but not 100 in the range, they may use {min:100.00001, max:200}. If users want values larger than 100, they may write {min:100}.
The color is applied if one or more conditions in the condition array is met. If multiple rules could apply on the same data point, it is the last rule that takes effect.

Returns:

{object[]} Value of property formatRules

getMode(): sap.viz.ui5.types.StackedVerticalBar_mode

Gets current value of property mode.

Set the display mode for stacked vertical bar charts

Default value is comparison.

Returns:

{sap.viz.ui5.types.StackedVerticalBar_mode} Value of property mode

getPrimaryValuesColorPalette(): string[]

Gets current value of property primaryValuesColorPalette.

Set the color palette for axis 1 in dual charts.

Default value is ???.

Returns:

{string[]} Value of property primaryValuesColorPalette

getSecondaryValuesColorPalette(): string[]

Gets current value of property secondaryValuesColorPalette.

Set the color palette for axis 2 in dual chart.

Default value is ???.

Returns:

{string[]} Value of property secondaryValuesColorPalette

setAnimation(oAnimation): sap.viz.ui5.types.StackedVerticalBar

Sets the aggregated animation.

Parameters:

{sap.viz.ui5.types.StackedVerticalBar_animation}

oAnimation

The animation to set

Returns:

{sap.viz.ui5.types.StackedVerticalBar} Reference to this in order to allow method chaining

setColorPalette(sColorPalette): sap.viz.ui5.types.StackedVerticalBar

Sets a new value for property colorPalette.

Set the color palette for the chart. This is not supported for dual axis charts that have measureNamesDimension bound to the legend.

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

Default value is ???.

Parameters:

{string[]} sColorPalette New value for property colorPalette

Returns:

{sap.viz.ui5.types.StackedVerticalBar} Reference to this in order to allow method chaining

setDrawingEffect(sDrawingEffect): sap.viz.ui5.types.StackedVerticalBar

Sets a new value for property drawingEffect.

Set the drawing effect for the plot area. If this value is set to 'glossy', the plot area is glossy. If this value is set to 'normal', the plot area is matte.

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

Default value is normal.

Parameters:

{sap.viz.ui5.types.StackedVerticalBar_drawingEffect} sDrawingEffect New value for property drawingEffect

Returns:

{sap.viz.ui5.types.StackedVerticalBar} Reference to this in order to allow method chaining

setFormatRules(sFormatRules): sap.viz.ui5.types.StackedVerticalBar

Sets a new value for property formatRules.

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

Parameters:

{object[]} sFormatRules New value for property formatRules

Returns:

{sap.viz.ui5.types.StackedVerticalBar} Reference to this in order to allow method chaining

setMode(sMode): sap.viz.ui5.types.StackedVerticalBar

Sets a new value for property mode.

Set the display mode for stacked vertical bar charts

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

Default value is comparison.

Parameters:

{sap.viz.ui5.types.StackedVerticalBar_mode} sMode New value for property mode

Returns:

{sap.viz.ui5.types.StackedVerticalBar} Reference to this in order to allow method chaining

setPrimaryValuesColorPalette(sPrimaryValuesColorPalette): sap.viz.ui5.types.StackedVerticalBar

Sets a new value for property primaryValuesColorPalette.

Set the color palette for axis 1 in dual charts.

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

Default value is ???.

Parameters:

{string[]} sPrimaryValuesColorPalette New value for property primaryValuesColorPalette

Returns:

{sap.viz.ui5.types.StackedVerticalBar} Reference to this in order to allow method chaining

setSecondaryValuesColorPalette(sSecondaryValuesColorPalette): sap.viz.ui5.types.StackedVerticalBar

Sets a new value for property secondaryValuesColorPalette.

Set the color palette for axis 2 in dual chart.

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

Default value is ???.

Parameters:

{string[]} sSecondaryValuesColorPalette New value for property secondaryValuesColorPalette

Returns:

{sap.viz.ui5.types.StackedVerticalBar} Reference to this in order to allow method chaining

destroyToolTip(): sap.viz.ui5.types.StackedVerticalBar

Destroys the toolTip in the aggregation toolTip.

Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.

Returns:

{sap.viz.ui5.types.StackedVerticalBar} Reference to this in order to allow method chaining

getIsRoundCorner(): boolean

Gets current value of property isRoundCorner.

Set whether bars have rounded corners

Default value is false.

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.

Returns:

{boolean} Value of property isRoundCorner

getOrientation(): sap.viz.ui5.types.StackedVerticalBar_orientation

Gets current value of property orientation.

Set the orientation of the plot area.

Default value is vertical.

Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.

Returns:

{sap.viz.ui5.types.StackedVerticalBar_orientation} Value of property orientation

getToolTip(): sap.viz.ui5.types.StackedVerticalBar_tooltip

Gets content of aggregation toolTip.

Settings for tooltip related properties

Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.

Returns:

{sap.viz.ui5.types.StackedVerticalBar_tooltip}

setIsRoundCorner(bIsRoundCorner): sap.viz.ui5.types.StackedVerticalBar

Sets a new value for property isRoundCorner.

Set whether bars have rounded corners

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

Default value is false.

Parameters:

{boolean} bIsRoundCorner New value for property isRoundCorner

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.

Returns:

{sap.viz.ui5.types.StackedVerticalBar} Reference to this in order to allow method chaining

setOrientation(sOrientation): sap.viz.ui5.types.StackedVerticalBar

Sets a new value for property orientation.

Set the orientation of the plot area.

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

Default value is vertical.

Parameters:

{sap.viz.ui5.types.StackedVerticalBar_orientation} sOrientation New value for property orientation

Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.

Returns:

{sap.viz.ui5.types.StackedVerticalBar} Reference to this in order to allow method chaining

setToolTip(oToolTip): sap.viz.ui5.types.StackedVerticalBar

Sets the aggregated toolTip.

Parameters:

{sap.viz.ui5.types.StackedVerticalBar_tooltip}

oToolTip

The toolTip to set

Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.

Returns:

{sap.viz.ui5.types.StackedVerticalBar} Reference to this in order to allow method chaining