Used for defining areas in an image map. At runtime, the user can trigger an action, or start a URL, from the single image areas.
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#constructor for a general description of the syntax of the settings object.
new sap.ui.commons.Area(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 |
Name | Type | Default Value | Description |
---|---|---|---|
alt | string | Alternative text that is displayed in the case the image is not available Visibility: public |
|
coords | string | Coordinates of the area Visibility: public |
|
href | sap.ui.core.URI | Hyper link that is executed when the area is clicked Visibility: public |
|
shape | string | The value is a string and can be 'rect' for rectangle, 'poly' for poligon, 'circle', or default. Visibility: public |
Method | Description |
---|---|
sap.ui.commons.Area.extend |
Creates a new subclass of class sap.ui.commons.Area with name
|
getAlt |
Gets current value of property alt. Alternative text that is displayed in the case the image is not available |
getCoords |
Gets current value of property coords. Coordinates of the area |
getHref |
Gets current value of property href. Hyper link that is executed when the area is clicked |
sap.ui.commons.Area.getMetadata |
Returns a metadata object for class sap.ui.commons.Area. |
getShape |
Gets current value of property shape. The value is a string and can be 'rect' for rectangle, 'poly' for poligon, 'circle', or default. |
setAlt |
Sets a new value for property alt. Alternative text that is displayed in the case the image is not available When called with a value of |
setCoords |
Sets a new value for property coords. Coordinates of the area When called with a value of |
setHref |
Sets a new value for property href. Hyper link that is executed when the area is clicked When called with a value of |
setShape |
Sets a new value for property shape. The value is a string and can be 'rect' for rectangle, 'poly' for poligon, 'circle', or default. When called with a value of |
Creates a new subclass of class sap.ui.commons.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.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 |
Gets current value of property alt.
Alternative text that is displayed in the case the image is not available
Gets current value of property shape.
The value is a string and can be 'rect' for rectangle, 'poly' for poligon, 'circle', or default.
Sets a new value for property alt.
Alternative text that is displayed in the case the image is not available
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sAlt | string |
New value for property |
Sets a new value for property coords.
Coordinates of the area
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sCoords | string |
New value for property |
Sets a new value for property href.
Hyper link that is executed when the area is clicked
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sHref | sap.ui.core.URI |
New value for property |
Sets a new value for property shape.
The value is a string and can be 'rect' for rectangle, 'poly' for poligon, 'circle', or default.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sShape | string |
New value for property |