Interaction

Module sap.viz.ui5.types.controller.Interaction

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

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

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

destroySelectability()Destroys the selectability in the aggregation selectability.

getDecorations()Gets current value of property decorations.

getSelectability()Gets content of aggregation selectability.

setDecorations(oDecorations)Sets a new value for property decorations.

setSelectability(oSelectability)Sets the aggregated selectability.

destroyPan()Destroys the pan in the aggregation pan.

getEnableMouseMove()Gets current value of property enableMouseMove.

getEnableMouseOut()Gets current value of property enableMouseOut.

getEnableMouseOver()Gets current value of property enableMouseOver.

getHandlers()Gets current value of property handlers.

getHoldSelection()Gets current value of property holdSelection.

getPan()Gets content of aggregation pan.

getPreserveSelectionWhenDragging()Gets current value of property preserveSelectionWhenDragging.

getSupportedEventNames()Gets current value of property supportedEventNames.

getSupportLassoEvent()Gets current value of property supportLassoEvent.

getTriggers()Gets current value of property triggers.

setEnableMouseMove(bEnableMouseMove)Sets a new value for property enableMouseMove.

setEnableMouseOut(bEnableMouseOut)Sets a new value for property enableMouseOut.

setEnableMouseOver(bEnableMouseOver)Sets a new value for property enableMouseOver.

setHandlers(oHandlers)Sets a new value for property handlers.

setHoldSelection(bHoldSelection)Sets a new value for property holdSelection.

setPan(oPan)Sets the aggregated pan.

setPreserveSelectionWhenDragging(bPreserveSelectionWhenDragging)Sets a new value for property preserveSelectionWhenDragging.

setSupportedEventNames(sSupportedEventNames)Sets a new value for property supportedEventNames.

setSupportLassoEvent(bSupportLassoEvent)Sets a new value for property supportLassoEvent.

setTriggers(oTriggers)Sets a new value for property triggers.

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

Constructor for a new sap.viz.ui5.types.controller.Interaction

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
- supportedEventNames : string[] (default: ???)
- enableMouseMove : boolean (default: true)
- enableMouseOver : boolean (default: true)
- enableMouseOut : boolean (default: true)
- supportLassoEvent : boolean (default: true)
- holdSelection : boolean (default: false)
- preserveSelectionWhenDragging : boolean (default: false)
- decorations : any
- triggers : any
- handlers : any
Aggregations
- selectability : sap.viz.ui5.types.controller.Interaction_selectability
- pan : sap.viz.ui5.types.controller.Interaction_pan

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

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

Returns a metadata object for class sap.viz.ui5.types.controller.Interaction.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

destroySelectability(): sap.viz.ui5.types.controller.Interaction

Destroys the selectability in the aggregation selectability.

Returns:

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

getDecorations(): any

Gets current value of property decorations.

Set decorations relating to interaction. Each item that is an object of {name: 'decoration name', fn: 'decoration callback function'} is a decoration. Currently two decorations are supported: showDetail and hideDetail. These two decorations can be used to create a user-defined tooltip.

If these 2 decorations are used, the default tooltip is not used, and the user should implement a custom tooltip. The showDetail decoration is called when the tooltip is shown, and the hideDetail decoration is called when the tooltip is hidden.

The arguments of showDetail are one object of {mode: 'tooltip mode', data: 'data of hovering selected data point', position: 'mouse position', container: 'chart container dom element', selectedNumber: 'number of selected data points'}. 'tooltip mode' is either 'infoMode' or 'actionMode'. Hovering over an unselected data point displays the infoMode tooltip, while hovering over a selected data point displays the actionMode tooltip. 'data' is an array of dimensions and measures, where each item is an object of {name: 'dimension name or measure name', value: 'dimension member or measure value', type: 'literal string of dimension or measure'}. For instance, {name: 'Country', value: 'China', type: 'dimension'}, or {name: 'Profit', value: 159, type: 'measure'}.

The arguments of hideDetail are a string representing tooltip mode, i.e. what kind of tooltip should be hidden.

Returns:

{any} Value of property decorations

getSelectability(): sap.viz.ui5.types.controller.Interaction_selectability

Gets content of aggregation selectability.

Settings for selectability

Returns:

{sap.viz.ui5.types.controller.Interaction_selectability}

setDecorations(oDecorations): sap.viz.ui5.types.controller.Interaction

Sets a new value for property decorations.

The arguments of hideDetail are a string representing tooltip mode, i.e. what kind of tooltip should be hidden.

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

Parameters:

{any} oDecorations New value for property decorations

Returns:

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

setSelectability(oSelectability): sap.viz.ui5.types.controller.Interaction

Sets the aggregated selectability.

Parameters:

{sap.viz.ui5.types.controller.Interaction_selectability}

oSelectability

The selectability to set

Returns:

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

destroyPan(): sap.viz.ui5.types.controller.Interaction

Destroys the pan in the aggregation pan.

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

getEnableMouseMove(): boolean

Gets current value of property enableMouseMove.

Set whether mouse move is enabled

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 enableMouseMove

getEnableMouseOut(): boolean

Gets current value of property enableMouseOut.

Set whether mouse out is enabled

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 enableMouseOut

getEnableMouseOver(): boolean

Gets current value of property enableMouseOver.

Set whether mouse over is enabled

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 enableMouseOver

getHandlers(): any

Gets current value of property handlers.

Set handlers for behavior decration.

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:

{any} Value of property handlers

getHoldSelection(): boolean

Gets current value of property holdSelection.

Set whether hold selection is enabled

Default value is false.

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 holdSelection

getPan(): sap.viz.ui5.types.controller.Interaction_pan

Gets content of aggregation pan.

add documentation for aggregation pan

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.controller.Interaction_pan}

getPreserveSelectionWhenDragging(): boolean

Gets current value of property preserveSelectionWhenDragging.

Set whether preserve selection when dragging is enabled

Default value is false.

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 preserveSelectionWhenDragging

getSupportedEventNames(): string[]

Gets current value of property supportedEventNames.

Set supported event names

Default value is ???.

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:

{string[]} Value of property supportedEventNames

getSupportLassoEvent(): boolean

Gets current value of property supportLassoEvent.

Set whether support lasso event is enabled

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 supportLassoEvent

getTriggers(): any

Gets current value of property triggers.

Set triggers for behavior decration.

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:

{any} Value of property triggers

setEnableMouseMove(bEnableMouseMove): sap.viz.ui5.types.controller.Interaction

Sets a new value for property enableMouseMove.

Set whether mouse move is enabled

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

Default value is true.

Parameters:

{boolean} bEnableMouseMove New value for property enableMouseMove

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

setEnableMouseOut(bEnableMouseOut): sap.viz.ui5.types.controller.Interaction

Sets a new value for property enableMouseOut.

Set whether mouse out is enabled

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

Default value is true.

Parameters:

{boolean} bEnableMouseOut New value for property enableMouseOut

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

setEnableMouseOver(bEnableMouseOver): sap.viz.ui5.types.controller.Interaction

Sets a new value for property enableMouseOver.

Set whether mouse over is enabled

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

Default value is true.

Parameters:

{boolean} bEnableMouseOver New value for property enableMouseOver

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

setHandlers(oHandlers): sap.viz.ui5.types.controller.Interaction

Sets a new value for property handlers.

Set handlers for behavior decration.

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

Parameters:

{any} oHandlers New value for property handlers

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

setHoldSelection(bHoldSelection): sap.viz.ui5.types.controller.Interaction

Sets a new value for property holdSelection.

Set whether hold selection is enabled

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

Default value is false.

Parameters:

{boolean} bHoldSelection New value for property holdSelection

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

setPan(oPan): sap.viz.ui5.types.controller.Interaction

Sets the aggregated pan.

Parameters:

{sap.viz.ui5.types.controller.Interaction_pan}

oPan

The pan 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.controller.Interaction} Reference to this in order to allow method chaining

setPreserveSelectionWhenDragging(bPreserveSelectionWhenDragging): sap.viz.ui5.types.controller.Interaction

Sets a new value for property preserveSelectionWhenDragging.

Set whether preserve selection when dragging is enabled

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

Default value is false.

Parameters:

{boolean} bPreserveSelectionWhenDragging New value for property preserveSelectionWhenDragging

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

setSupportedEventNames(sSupportedEventNames): sap.viz.ui5.types.controller.Interaction

Sets a new value for property supportedEventNames.

Set supported event names

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

Default value is ???.

Parameters:

{string[]} sSupportedEventNames New value for property supportedEventNames

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

setSupportLassoEvent(bSupportLassoEvent): sap.viz.ui5.types.controller.Interaction

Sets a new value for property supportLassoEvent.

Set whether support lasso event is enabled

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

Default value is true.

Parameters:

{boolean} bSupportLassoEvent New value for property supportLassoEvent

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

setTriggers(oTriggers): sap.viz.ui5.types.controller.Interaction

Sets a new value for property triggers.

Set triggers for behavior decration.

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

Parameters:

{any} oTriggers New value for property triggers

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