class sap.ui.vbm.Feature

Control sample: sap.ui.vbm.Feature
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vbm/Feature
Application Component: CA-GTF-VBZ

The Feature element can be added to the items aggregation of a FeatureCollection. By matching the id it allows to redefine the color of a GeoJSON feature and adds interactivity.


Constructor

Constructor for a new Feature.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.vbm.Feature(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
color sap.ui.core.CSSColor

The color, this should be provided in the rgba(r,g,b,a) format.

Visibility: public
featureId string

The Feature ID. Used to match with the feature in the GeoJSON given to the parent (FeatureCollection).

Visibility: public

Events Overview

Event Description
click

The event is raised when there is a click action on a Feature.

contextMenu

The event is raised when there is a right click or a tap and hold action on a Feature.

click

The event is raised when there is a click action on a Feature.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

contextMenu

The event is raised when there is a right click or a tap and hold action on a Feature.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
menu sap.ui.unified.Menu

Menu object to be used with openContextMenu().


Methods Overview

Method Description
attachClick

Attaches event handler fnFunction to the click event of this sap.ui.vbm.Feature.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.Feature itself.

The event is raised when there is a click action on a Feature.

attachContextMenu

Attaches event handler fnFunction to the contextMenu event of this sap.ui.vbm.Feature.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.Feature itself.

The event is raised when there is a right click or a tap and hold action on a Feature.

detachClick

Detaches event handler fnFunction from the click event of this sap.ui.vbm.Feature.

The passed function and listener object must match the ones used for event registration.

detachContextMenu

Detaches event handler fnFunction from the contextMenu event of this sap.ui.vbm.Feature.

The passed function and listener object must match the ones used for event registration.

sap.ui.vbm.Feature.extend

Creates a new subclass of class sap.ui.vbm.Feature with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Element.extend.

fireClick

Fires event click to attached listeners.

fireContextMenu

Fires event contextMenu to attached listeners.

getColor

Gets current value of property color.

The color, this should be provided in the rgba(r,g,b,a) format.

getFeatureId

Gets current value of property featureId.

The Feature ID. Used to match with the feature in the GeoJSON given to the parent (FeatureCollection).

sap.ui.vbm.Feature.getMetadata

Returns a metadata object for class sap.ui.vbm.Feature.

openContextMenu

Open the context menu

openDetailWindow

Open a Detail Window for the Feature at click position

setColor

Sets a new value for property color.

The color, this should be provided in the rgba(r,g,b,a) format.

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

setFeatureId

Sets a new value for property featureId.

The Feature ID. Used to match with the feature in the GeoJSON given to the parent (FeatureCollection).

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

attachClick

Attaches event handler fnFunction to the click event of this sap.ui.vbm.Feature.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.Feature itself.

The event is raised when there is a click action on a Feature.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vbm.Feature itself

attachContextMenu

Attaches event handler fnFunction to the contextMenu event of this sap.ui.vbm.Feature.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.Feature itself.

The event is raised when there is a right click or a tap and hold action on a Feature.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vbm.Feature itself

detachClick

Detaches event handler fnFunction from the click event of this sap.ui.vbm.Feature.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachContextMenu

Detaches event handler fnFunction from the contextMenu event of this sap.ui.vbm.Feature.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.vbm.Feature.extend

Creates a new subclass of class sap.ui.vbm.Feature with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Element.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireClick

Fires event click to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireContextMenu

Fires event contextMenu to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

menu sap.ui.unified.Menu

Menu object to be used with openContextMenu().

getColor

Gets current value of property color.

The color, this should be provided in the rgba(r,g,b,a) format.

getFeatureId

Gets current value of property featureId.

The Feature ID. Used to match with the feature in the GeoJSON given to the parent (FeatureCollection).

sap.ui.vbm.Feature.getMetadata

Returns a metadata object for class sap.ui.vbm.Feature.

openContextMenu

Open the context menu

Param Type DefaultValue Description
oMenu object

the context menu to be opened

openDetailWindow

Open a Detail Window for the Feature at click position

Param Type DefaultValue Description
sCaption string

caption of detail window

sOffsetX string

position offset in x-direction from the anchor point

sOffsetY string

position offset in y-direction from the anchor point

setColor

Sets a new value for property color.

The color, this should be provided in the rgba(r,g,b,a) format.

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

Param Type DefaultValue Description
sColor sap.ui.core.CSSColor

New value for property color

setFeatureId

Sets a new value for property featureId.

The Feature ID. Used to match with the feature in the GeoJSON given to the parent (FeatureCollection).

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

Param Type DefaultValue Description
sFeatureId string

New value for property featureId