Constructor
new Circle(center, radius, options)
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
center |
bemap.Coordinate | Array of bemap.Coordinate. | ||||||||||||
radius |
int | Radius of circle. | ||||||||||||
options |
Object | See below the available values.
Properties
|
- Source:
Members
(protected) callback :function
Type:
- function
- Source:
(protected) coordinate :bemap.Coordinate
Type:
- Source:
(protected) events :Array
Type:
- Array
- Source:
(protected) id :String
Type:
- String
- Source:
(protected) layer :Object
Type:
- Object
- Source:
(protected) map :Object
Type:
- Object
- Source:
(protected) name :String
Type:
- String
- Source:
(protected) native :Object
Type:
- Object
- Source:
(protected) properties :Object
Type:
- Object
- Source:
(protected) radius :int
Type:
- int
- Source:
(protected) style :bemap.LineStyle
Type:
- Source:
Methods
(protected) draggable(callback, options) → {bemap.Listener}
Define the draggable capability for bemap.Circle.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
callback |
function | Function will be called when the specified eventType is occur. | ||||||
options |
object | Options.
Properties
|
- Source:
Returns:
bemap.listener.
- Type
- bemap.Listener
getCenter() → {bemap.Coordinate}
Return the coordinate. See bemap.Coordinate.
- Source:
Returns:
Return the coordinate. See bemap.Coordinate.
- Type
- bemap.Coordinate
getCoordinate() → {bemap.Coordinate}
Return the coordinate. See bemap.Coordinate.
- Source:
Returns:
Return the coordinate. See bemap.Coordinate.
- Type
- bemap.Coordinate
getId() → {String}
Return the id of the circle.
- Source:
Returns:
Return the id of the circle.
- Type
- String
getName() → {String}
Return the name of the circle.
- Source:
Returns:
Return the name of the circle.
- Type
- String
getRadius() → {int}
Return the radius of the circle.
- Source:
Returns:
return radius of the circle.
- Type
- int
getStyle() → {bemap.LineStyle}
Return the style of the circle.
- Source:
Returns:
Return the style of the circle.
- Type
- bemap.LineStyle
on(eventType, callback, options) → {bemap.Circle}
Set the listner when an specified eventType occur on bemap.Circle.
Parameters:
| Name | Type | Description |
|---|---|---|
eventType |
bemap.Map.EventType | Event type. |
callback |
function | Function will be called when the specified eventType is occur. |
options |
object | options. |
- Source:
Returns:
this.
- Type
- bemap.Circle
remove() → {bemap.Circle}
Remove the Circle from the layer.
- Source:
Returns:
this
- Type
- bemap.Circle
setCenter(center) → {bemap.Marker}
Set the center of the circle.
Parameters:
| Name | Type | Description |
|---|---|---|
center |
bemap.Coordinate | the new coordinates to set. |
- Source:
Returns:
this
- Type
- bemap.Marker
setId(id) → {bemap.Circle}
Define the id of circle
Parameters:
| Name | Type | Description |
|---|---|---|
id |
String | the new id to set. |
- Source:
Returns:
this
- Type
- bemap.Circle
setName(name) → {bemap.Circle}
Define the name of circle
Parameters:
| Name | Type | Description |
|---|---|---|
name |
String | the new name to set. |
- Source:
Returns:
this
- Type
- bemap.Circle
setRadius() → {int}
Return the radius of the circle.
- Source:
Returns:
return radius of the circle.
- Type
- int