Specific Visual Object element for an Area. An Area is a filled polygon, which border is given as a list of geo-coordinates. Areas can have multiple disjunct parts as well as each part can have an arbitrary number of exclusions/holes.
The inner part and the edges of areas are interactive and fire events on click.
Since the actual size of an area depends on the zoom level it might be only partly visible. Thus detail windows will open at the click position.
Event Summary
edgeClick(oControlEvent)This event is raised when the edge of an Area is clicked. edgeContextMenu(oControlEvent)This event is raised when the edge of an Area is right clicked. Method Summary
sap.ui.vbm.Area.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.Area with name sClassName and enriches it with the information contained in oClassInfo. attachEdgeClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the edgeClick event of this sap.ui.vbm.Area. attachEdgeContextMenu(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the edgeContextMenu event of this sap.ui.vbm.Area. detachEdgeClick(fnFunction, oListener)Detaches event handler fnFunction from the edgeClick event of this sap.ui.vbm.Area. detachEdgeContextMenu(fnFunction, oListener)Detaches event handler fnFunction from the edgeContextMenu event of this sap.ui.vbm.Area. fireEdgeClick(mArguments?)Fires event edgeClick to attached listeners. getColor()Gets current value of property color. setBorderDash(sBorderDash)Sets a new value for property borderDash. setColor(sColor)Sets a new value for property color. setColorBorder(sColorBorder)Sets a new value for property colorBorder. setPosition(sPosition)Sets a new value for property position. attachClick,
attachContextMenu,
attachDrop,
attachHandleClick,
attachHandleContextMenu,
attachHandleMoved,
detachClick,
detachContextMenu,
detachDrop,
detachHandleClick,
detachHandleContextMenu,
detachHandleMoved,
fireClick,
fireContextMenu,
fireDrop,
fireHandleClick,
fireHandleContextMenu,
fireHandleMoved,
getChangeable,
getDragData,
getEntity,
getFxdir,
getFxsize,
getHotDeltaColor,
getHotScale,
getKey,
getLabelArrow,
getLabelBgColor,
getLabelBorderColor,
getLabelPos,
getLabelText,
getLabelType,
getSelect,
getSelectColor,
openContextMenu,
openDetailWindow,
setChangeable,
setDragData,
setEntity,
setFxdir,
setFxsize,
setHotDeltaColor,
setHotScale,
setKey,
setLabelArrow,
setLabelBgColor,
setLabelBorderColor,
setLabelPos,
setLabelText,
setLabelType,
setSelect,
setSelectColor $,
addCustomData,
addDependent,
addEventDelegate,
applyFocusInfo,
bindElement,
clone,
data,
destroy,
destroyCustomData,
destroyDependents,
destroyLayoutData,
destroyTooltip,
enhanceAccessibilityState,
exit,
findElements,
fireEvent,
focus,
getCustomData,
getDependents,
getDomRef,
getElementBinding,
getFocusDomRef,
getFocusInfo,
getInterface,
getLayoutData,
getMetadata,
getTooltip,
getTooltip_AsString,
getTooltip_Text,
indexOfCustomData,
indexOfDependent,
init,
insertCustomData,
insertDependent,
prop,
removeAllCustomData,
removeAllDependents,
removeCustomData,
removeDependent,
removeEventDelegate,
rerender,
setLayoutData,
setTooltip,
toString,
unbindElement 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 Constructor Detail
new sap.ui.vbm.Area(sId?, mSettings?)
Constructor for a new Area.
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
- Events
- edgeClick : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- edgeContextMenu : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
In addition, all settings applicable to the base type sap.ui.vbm.VoBase 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 |
Event Detail
edgeClick(oControlEvent)
This event is raised when the edge of an Area is clicked.
Parameters:
edgeContextMenu(oControlEvent)
This event is raised when the edge of an Area is right clicked.
Parameters:
Method Detail
sap.ui.vbm.Area.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vbm.Area 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.vbm.VoBase.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 |
Returns a metadata object for class sap.ui.vbm.Area.
Returns:
Attaches event handler
fnFunction to the
edgeClick event of this
sap.ui.vbm.Area.
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.Area itself.
This event is raised when the edge of an Area is clicked.
Parameters:
| {object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
| {function} | fnFunction | The function to be called when the event occurs |
| {object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.vbm.Area itself |
Returns:
Attaches event handler
fnFunction to the
edgeContextMenu event of this
sap.ui.vbm.Area.
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.Area itself.
This event is raised when the edge of an Area is right clicked.
Parameters:
| {object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
| {function} | fnFunction | The function to be called when the event occurs |
| {object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.vbm.Area itself |
Returns:
Detaches event handler
fnFunction from the
edgeClick event of this
sap.ui.vbm.Area.
The passed function and listener object must match the ones used for event registration.
Parameters:
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
Returns:
Detaches event handler
fnFunction from the
edgeContextMenu event of this
sap.ui.vbm.Area.
The passed function and listener object must match the ones used for event registration.
Parameters:
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
Returns:
Fires event edgeClick to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event edgeContextMenu to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
getBorderDash(): string
Gets current value of property
borderDash.
Defines the dashing style of the area border using an array.
Returns:
| {string} | Value of property borderDash |
getColor(): string
Gets current value of property
color.
The fill color of the Area.
Returns:
| {string} | Value of property color |
getColorBorder(): string
Gets current value of property
colorBorder.
The border color of the Area.
Returns:
| {string} | Value of property colorBorder |
getPosition(): string
Gets current value of property
position.
The position array for the Area. For single part areas the format is "lon0;lat0;0.0;...;lonN,latN,0.0". For multi part areas you need to provide an array of arrays of the above position string: "[['lon0...'],['lon0...']]" (sequence of single and double quotes is important). Single and Multi part areas must not be mixed within one Areas aggregation.
Finally each area part can have multiple exclusions/holes. In that case the position list of excluded areas has follow the list of the base shape: "['lon0...', 'exLon0...']".
Returns:
| {string} | Value of property position |
Sets a new value for property
borderDash.
Defines the dashing style of the area border using an array.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sBorderDash | New value for property borderDash |
Returns:
Sets a new value for property
color.
The fill color of the Area.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sColor | New value for property color |
Returns:
Sets a new value for property
colorBorder.
The border color of the Area.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sColorBorder | New value for property colorBorder |
Returns:
Sets a new value for property
position.
The position array for the Area. For single part areas the format is "lon0;lat0;0.0;...;lonN,latN,0.0". For multi part areas you need to provide an array of arrays of the above position string: "[['lon0...'],['lon0...']]" (sequence of single and double quotes is important). Single and Multi part areas must not be mixed within one Areas aggregation.
Finally each area part can have multiple exclusions/holes. In that case the position list of excluded areas has follow the list of the base shape: "['lon0...', 'exLon0...']".
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sPosition | New value for property position |
Returns: