BiImageMapArea
This class represents a particular area on an image map.
This class supports the following events:-
mousemove
mousedown
mouseover
mouseout
click
contextmenu
This class extends BiEventTarget and therefore all methods and fields available for BiEventTarget are also available for BiImageMapArea .
Constructor
new BiImageMapArea ( oShapes )
Parameters
| Name | Type | Optional | Default | Descripton |
oShapes | | The shapes defining the area |
Properties
| Name | Type | get | set | Descripton |
cursor | String |  | | The cursor to show when the mouse hovers over this area |
Methods
| Name | Description |
addShape | Adds a shape describing this area. |
contains | This method returns a Boolean indicating if the point(x,y) is contained within this area.If true, it means that (x,y) is within this area. Otherwise, (x,y) is outside the bounds of this area. |
removeShape | Removes a shape describing this area. An error will be thrown if oShape is not found in this area. |
Events
None.
Static Methods
None.
Static Fields
None.
Remarks
None.
Method Details
addShape
Adds a shape describing this area.
Syntax
object.addShape ( oShape ) Parameters
| Name | Type | Optional | Default | Descripton |
oShape | | The shape object to add |
Return Type
void
contains
This method returns a Boolean indicating if the point(x,y) is contained within this area.
If true, it means that (x,y) is within this area. Otherwise, (x,y) is outside the bounds of this area.
Syntax
object.contains ( x,y ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The x value of the coordinate. | ||
y | Number | The y value of the the coordinate. |
Return Type
Boolean
removeShape
Removes a shape describing this area. An error will be thrown if oShape is not found in this area.
Syntax
object.removeShape ( oShape ) Parameters
| Name | Type | Optional | Default | Descripton |
oShape | | The shape object to remove |
Return Type
void