Scatter

Module sap.viz.ui5.types.Scatter

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.Scatter(sId?, mSettings?)Constructor for a new sap.viz.ui5.types.Scatter

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.Scatter.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.Scatter with name sClassName and enriches it with the information contained in oClassInfo.

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

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.

getMarkerSize()Gets current value of property markerSize.

getShapePalette()Gets current value of property shapePalette.

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.

setMarkerSize(iMarkerSize)Sets a new value for property markerSize.

setShapePalette(sShapePalette)Sets a new value for property shapePalette.

destroyAxisTooltip()Destroys the axisTooltip in the aggregation axisTooltip.

destroyHoverline()Destroys the hoverline in the aggregation hoverline.

getAxisTooltip()Gets content of aggregation axisTooltip.

getHoverline()Gets content of aggregation hoverline.

getMaxPriValue()Gets current value of property maxPriValue.

getMaxSecValue()Gets current value of property maxSecValue.

getMinPriValue()Gets current value of property minPriValue.

getMinSecValue()Gets current value of property minSecValue.

getShowNegativeValues()Gets current value of property showNegativeValues.

getTimeBased()Gets current value of property timeBased.

setAxisTooltip(oAxisTooltip)Sets the aggregated axisTooltip.

setHoverline(oHoverline)Sets the aggregated hoverline.

setMaxPriValue(fMaxPriValue)Sets a new value for property maxPriValue.

setMaxSecValue(fMaxSecValue)Sets a new value for property maxSecValue.

setMinPriValue(fMinPriValue)Sets a new value for property minPriValue.

setMinSecValue(fMinSecValue)Sets a new value for property minSecValue.

setShowNegativeValues(bShowNegativeValues)Sets a new value for property showNegativeValues.

setTimeBased(bTimeBased)Sets a new value for property timeBased.

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.Scatter(sId?, mSettings?)

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

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
- colorPalette : string[] (default: ???)
- shapePalette : string[] (default: ???)
- maxPriValue : float (default: 0)
- minPriValue : float (default: 0)
- maxSecValue : float (default: 0)
- minSecValue : float (default: 0)
- timeBased : boolean (default: false)
- drawingEffect : sap.viz.ui5.types.Scatter_drawingEffect (default: normal)
- formatRules : object[]
- showNegativeValues : boolean (default: true)
- markerSize : int (default: 10)
Aggregations
- animation : sap.viz.ui5.types.Scatter_animation
- axisTooltip : sap.viz.ui5.types.Scatter_axisTooltip
- hoverline : sap.viz.ui5.types.Scatter_hoverline

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.Scatter.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

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

Destroys the animation in the aggregation animation.

Returns:

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

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

Gets content of aggregation animation.

Settings for animations in bubble and scatter charts

Returns:

{sap.viz.ui5.types.Scatter_animation}

getColorPalette(): string[]

Gets current value of property colorPalette.

Set the color of the bubbles

Default value is ???.

Returns:

{string[]} Value of property colorPalette

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

Gets current value of property drawingEffect.

Set the drawing effect for the bubbles

Default value is normal.

Returns:

{sap.viz.ui5.types.Scatter_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

getMarkerSize(): int

Gets current value of property markerSize.

Set the marker size for data points. The available range is from '4' to '32'.

Default value is 10.

Returns:

{int} Value of property markerSize

getShapePalette(): string[]

Gets current value of property shapePalette.

Set the shape of the bubbles

Default value is ???.

Returns:

{string[]} Value of property shapePalette

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

Sets the aggregated animation.

Parameters:

{sap.viz.ui5.types.Scatter_animation}

oAnimation

The animation to set

Returns:

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

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

Sets a new value for property colorPalette.

Set the color of the bubbles

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.Scatter} Reference to this in order to allow method chaining

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

Sets a new value for property drawingEffect.

Set the drawing effect for the bubbles

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.Scatter_drawingEffect} sDrawingEffect New value for property drawingEffect

Returns:

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

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

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.Scatter} Reference to this in order to allow method chaining

setMarkerSize(iMarkerSize): sap.viz.ui5.types.Scatter

Sets a new value for property markerSize.

Set the marker size for data points. The available range is from '4' to '32'.

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

Default value is 10.

Parameters:

{int} iMarkerSize New value for property markerSize

Returns:

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

setShapePalette(sShapePalette): sap.viz.ui5.types.Scatter

Sets a new value for property shapePalette.

Set the shape of the bubbles

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

Default value is ???.

Parameters:

{string[]} sShapePalette New value for property shapePalette

Returns:

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

destroyAxisTooltip(): sap.viz.ui5.types.Scatter

Destroys the axisTooltip in the aggregation axisTooltip.

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.Scatter} Reference to this in order to allow method chaining

destroyHoverline(): sap.viz.ui5.types.Scatter

Destroys the hoverline in the aggregation hoverline.

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.Scatter} Reference to this in order to allow method chaining

getAxisTooltip(): sap.viz.ui5.types.Scatter_axisTooltip

Gets content of aggregation axisTooltip.

Set tooltip related properties.

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.Scatter_axisTooltip}

getHoverline(): sap.viz.ui5.types.Scatter_hoverline

Gets content of aggregation hoverline.

Settings for hoverline properties.

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.Scatter_hoverline}

getMaxPriValue(): float

Gets current value of property maxPriValue.

Set the max value of primary values

Default value is 0.

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

Returns:

{float} Value of property maxPriValue

getMaxSecValue(): float

Gets current value of property maxSecValue.

Set the max value of secondary values

Default value is 0.

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

Returns:

{float} Value of property maxSecValue

getMinPriValue(): float

Gets current value of property minPriValue.

Set the minimum value of primary values

Default value is 0.

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

Returns:

{float} Value of property minPriValue

getMinSecValue(): float

Gets current value of property minSecValue.

Set the minimum value of secondary values

Default value is 0.

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

Returns:

{float} Value of property minSecValue

getShowNegativeValues(): boolean

Gets current value of property showNegativeValues.

Show/hide the data of negetive value.

Default value is true.

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:

{boolean} Value of property showNegativeValues

getTimeBased(): boolean

Gets current value of property timeBased.

Set whether it is time based scatter/bubble

Default value is false.

Deprecated:
Since version 1.20. 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 timeBased

setAxisTooltip(oAxisTooltip): sap.viz.ui5.types.Scatter

Sets the aggregated axisTooltip.

Parameters:

{sap.viz.ui5.types.Scatter_axisTooltip}

oAxisTooltip

The axisTooltip to set

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.Scatter} Reference to this in order to allow method chaining

setHoverline(oHoverline): sap.viz.ui5.types.Scatter

Sets the aggregated hoverline.

Parameters:

{sap.viz.ui5.types.Scatter_hoverline}

oHoverline

The hoverline to set

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.Scatter} Reference to this in order to allow method chaining

setMaxPriValue(fMaxPriValue): sap.viz.ui5.types.Scatter

Sets a new value for property maxPriValue.

Set the max value of primary values

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

Default value is 0.

Parameters:

{float} fMaxPriValue New value for property maxPriValue

Deprecated:
Since version 1.20. 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.Scatter} Reference to this in order to allow method chaining

setMaxSecValue(fMaxSecValue): sap.viz.ui5.types.Scatter

Sets a new value for property maxSecValue.

Set the max value of secondary values

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

Default value is 0.

Parameters:

{float} fMaxSecValue New value for property maxSecValue

Deprecated:
Since version 1.20. 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.Scatter} Reference to this in order to allow method chaining

setMinPriValue(fMinPriValue): sap.viz.ui5.types.Scatter

Sets a new value for property minPriValue.

Set the minimum value of primary values

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

Default value is 0.

Parameters:

{float} fMinPriValue New value for property minPriValue

Deprecated:
Since version 1.20. 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.Scatter} Reference to this in order to allow method chaining

setMinSecValue(fMinSecValue): sap.viz.ui5.types.Scatter

Sets a new value for property minSecValue.

Set the minimum value of secondary values

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

Default value is 0.

Parameters:

{float} fMinSecValue New value for property minSecValue

Deprecated:
Since version 1.20. 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.Scatter} Reference to this in order to allow method chaining

setShowNegativeValues(bShowNegativeValues): sap.viz.ui5.types.Scatter

Sets a new value for property showNegativeValues.

Show/hide the data of negetive value.

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

Default value is true.

Parameters:

{boolean} bShowNegativeValues New value for property showNegativeValues

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.Scatter} Reference to this in order to allow method chaining

setTimeBased(bTimeBased): sap.viz.ui5.types.Scatter

Sets a new value for property timeBased.

Set whether it is time based scatter/bubble

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

Default value is false.

Parameters:

{boolean} bTimeBased New value for property timeBased

Deprecated:
Since version 1.20. 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.Scatter} Reference to this in order to allow method chaining