Interaction_selectability

Settings for selectability

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

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

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

getAxisLabelSelection()Gets current value of property axisLabelSelection.

getLegendSelection()Gets current value of property legendSelection.

getMode()Gets current value of property mode.

getPlotLassoSelection()Gets current value of property plotLassoSelection.

getPlotStdSelection()Gets current value of property plotStdSelection.

setAxisLabelSelection(bAxisLabelSelection)Sets a new value for property axisLabelSelection.

setLegendSelection(bLegendSelection)Sets a new value for property legendSelection.

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

setPlotLassoSelection(bPlotLassoSelection)Sets a new value for property plotLassoSelection.

setPlotStdSelection(bPlotStdSelection)Sets a new value for property plotStdSelection.

getDataPointsCacheable()Gets current value of property dataPointsCacheable.

getLassoWithCtrlKey()Gets current value of property lassoWithCtrlKey.

setDataPointsCacheable(bDataPointsCacheable)Sets a new value for property dataPointsCacheable.

setLassoWithCtrlKey(bLassoWithCtrlKey)Sets a new value for property lassoWithCtrlKey.

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

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

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
- mode : sap.viz.ui5.types.controller.Interaction_selectability_mode (default: inclusive)
- axisLabelSelection : boolean (default: true)
- legendSelection : boolean (default: true)
- plotLassoSelection : boolean (default: true)
- plotStdSelection : boolean (default: true)
- lassoWithCtrlKey : boolean (default: false)
- dataPointsCacheable : boolean (default: true)

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

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

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getAxisLabelSelection(): boolean

Gets current value of property axisLabelSelection.

Set whether axis labels can be selected

Default value is true.

Returns:

{boolean} Value of property axisLabelSelection

getLegendSelection(): boolean

Gets current value of property legendSelection.

Set whether the legend can be selected

Default value is true.

Returns:

{boolean} Value of property legendSelection

getMode(): sap.viz.ui5.types.controller.Interaction_selectability_mode

Gets current value of property mode.

Set the selection mode. If this value is set to 'exclusive' or 'single', only one set of data points can be selected at once. If this value is set to 'inclusive' or 'multiple', multiple sets of data points can be selected at once. If this value is set to 'none', no sets of data points can be selected. The values 'single' and 'multiple' are deprecated; please remove them from your chart.

Default value is inclusive.

Returns:

{sap.viz.ui5.types.controller.Interaction_selectability_mode} Value of property mode

getPlotLassoSelection(): boolean

Gets current value of property plotLassoSelection.

Set whether lasso selection can be used in the plot area

Default value is true.

Returns:

{boolean} Value of property plotLassoSelection

getPlotStdSelection(): boolean

Gets current value of property plotStdSelection.

Set whether selection can be done in the plot area by clicking and tapping

Default value is true.

Returns:

{boolean} Value of property plotStdSelection

setAxisLabelSelection(bAxisLabelSelection): sap.viz.ui5.types.controller.Interaction_selectability

Sets a new value for property axisLabelSelection.

Set whether axis labels can be selected

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

Default value is true.

Parameters:

{boolean} bAxisLabelSelection New value for property axisLabelSelection

Returns:

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

setLegendSelection(bLegendSelection): sap.viz.ui5.types.controller.Interaction_selectability

Sets a new value for property legendSelection.

Set whether the legend can be selected

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

Default value is true.

Parameters:

{boolean} bLegendSelection New value for property legendSelection

Returns:

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

setMode(sMode): sap.viz.ui5.types.controller.Interaction_selectability

Sets a new value for property mode.

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

Default value is inclusive.

Parameters:

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

Returns:

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

setPlotLassoSelection(bPlotLassoSelection): sap.viz.ui5.types.controller.Interaction_selectability

Sets a new value for property plotLassoSelection.

Set whether lasso selection can be used in the plot area

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

Default value is true.

Parameters:

{boolean} bPlotLassoSelection New value for property plotLassoSelection

Returns:

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

setPlotStdSelection(bPlotStdSelection): sap.viz.ui5.types.controller.Interaction_selectability

Sets a new value for property plotStdSelection.

Set whether selection can be done in the plot area by clicking and tapping

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

Default value is true.

Parameters:

{boolean} bPlotStdSelection New value for property plotStdSelection

Returns:

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

getDataPointsCacheable(): boolean

Gets current value of property dataPointsCacheable.

Set whether data points can be cached. If it's true, data points might be cached by Interaction for better performance.

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 dataPointsCacheable

getLassoWithCtrlKey(): boolean

Gets current value of property lassoWithCtrlKey.

Set whether the user must hold the ctrl key to use lasso selection

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 lassoWithCtrlKey

setDataPointsCacheable(bDataPointsCacheable): sap.viz.ui5.types.controller.Interaction_selectability

Sets a new value for property dataPointsCacheable.

Set whether data points can be cached. If it's true, data points might be cached by Interaction for better performance.

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

Default value is true.

Parameters:

{boolean} bDataPointsCacheable New value for property dataPointsCacheable

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

setLassoWithCtrlKey(bLassoWithCtrlKey): sap.viz.ui5.types.controller.Interaction_selectability

Sets a new value for property lassoWithCtrlKey.

Set whether the user must hold the ctrl key to use lasso selection

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

Default value is false.

Parameters:

{boolean} bLassoWithCtrlKey New value for property lassoWithCtrlKey

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