Class sap.viz.ui5.types.controller.Interaction_panModule: sap/viz/ui5/types/controller/Interaction_pan


Structured Type sap.viz.ui5.types.controller.Interaction_pan

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


Since: 1.7.2.
Constructor Summary
new sap.viz.ui5.types.controller.Interaction_pan(sId?, mSettings?)Constructor for a new sap.viz.ui5.types.controller.Interaction_pan

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

Method Summary
sap.viz.ui5.types.controller.Interaction_pan.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.controller.Interaction_pan with name sClassName and enriches it with the information contained in oClassInfo.
sap.viz.ui5.types.controller.Interaction_pan.getMetadata()Returns a metadata object for class sap.viz.ui5.types.controller.Interaction_pan.
getEnable()Gets current value of property enable.
setEnable(bEnable)Sets a new value for property enable.
getOrientation()Gets current value of property orientation.
setOrientation(sOrientation)Sets a new value for property orientation.
Constructor Detail
new sap.viz.ui5.types.controller.Interaction_pan(sId?, mSettings?)
Constructor for a new sap.viz.ui5.types.controller.Interaction_pan

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
    • enable : boolean (default: true)
    • orientation : sap.viz.ui5.types.controller.Interaction_pan_orientation (default: both)

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.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
Method Detail
sap.viz.ui5.types.controller.Interaction_pan.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.viz.ui5.types.controller.Interaction_pan 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_pan.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.viz.ui5.types.controller.Interaction_pan.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getEnable(): boolean
Gets current value of property enable.

Enable/disable pan

Default value is true.

Returns:
{boolean} Value of property enable
Sets a new value for property enable.

Enable/disable pan

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

Default value is true.

Parameters:
{boolean}bEnable New value for property enable
Returns:
{sap.viz.ui5.types.controller.Interaction_pan} Reference to this in order to allow method chaining
Gets current value of property orientation.

Set orientation of pan

Default value is both.

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_orientation} Value of property orientation
setOrientation(sOrientation): sap.viz.ui5.types.controller.Interaction_pan
Sets a new value for property orientation.

Set orientation of pan

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

Default value is both.

Parameters:
{sap.viz.ui5.types.controller.Interaction_pan_orientation}sOrientation New value for property orientation
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} Reference to this in order to allow method chaining