# Class: Circle

## bemap.Circle(center, radius, options)

Base class for Circle.

## 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
Name | Type | Description
--- | --- | ---
`style` | bemap.LineStyle | Style of poyline used by the renderer.
`name` | String | Name of circle.
`properties` | Object | custom object.

Source:
  - bemap-model/bemap-circle.js, line 17

### Members

#### (protected) callback :function

##### Type:

- function

Source:
  - bemap-model/bemap-circle.js, line 81

#### (protected) coordinate :bemap.Coordinate

##### Type:

- bemap.Coordinate

Source:
  - bemap-model/bemap-circle.js, line 42

#### (protected) events :Array

##### Type:

- Array

Source:
  - bemap-model/bemap-circle.js, line 75

#### (protected) id :String

##### Type:

- String

Source:
  - bemap-model/bemap-circle.js, line 63

#### (protected) layer :Object

##### Type:

- Object

Source:
  - bemap-model/bemap-circle.js, line 36

#### (protected) map :Object

##### Type:

- Object

Source:
  - bemap-model/bemap-circle.js, line 30

#### (protected) name :String

##### Type:

- String

Source:
  - bemap-model/bemap-circle.js, line 69

#### (protected) native :Object

##### Type:

- Object

Source:
  - bemap-model/bemap-circle.js, line 24

#### (protected) properties :Object

##### Type:

- Object

Source:
  - bemap-model/bemap-circle.js, line 87

#### (protected) radius :int

##### Type:

- int

Source:
  - bemap-model/bemap-circle.js, line 48

#### (protected) style :bemap.LineStyle

##### Type:

- bemap.LineStyle

Source:
  - bemap-model/bemap-circle.js, line 56

### 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
Name | Type | Description
--- | --- | ---
`layerFilter` | bemap.Layer | set the bemap layer used as filter.

Source:
  - bemap-model/bemap-circle.js, line 232

##### Returns:

bemap.listener.

Type
  bemap.Listener

#### getCenter() → {bemap.Coordinate}

Return the coordinate. See bemap.Coordinate.

Source:
  - bemap-model/bemap-circle.js, line 159

##### Returns:

Return the coordinate. See bemap.Coordinate.

Type
  bemap.Coordinate

#### getCoordinate() → {bemap.Coordinate}

Return the coordinate. See bemap.Coordinate.

Source:
  - bemap-model/bemap-circle.js, line 171

##### Returns:

Return the coordinate. See bemap.Coordinate.

Type
  bemap.Coordinate

#### getId() → {String}

Return the id of the circle.

Source:
  - bemap-model/bemap-circle.js, line 96

##### Returns:

Return the id of the circle.

Type
  String

#### getName() → {String}

Return the name of the circle.

Source:
  - bemap-model/bemap-circle.js, line 116

##### Returns:

Return the name of the circle.

Type
  String

#### getRadius() → {int}

Return the radius of the circle.

Source:
  - bemap-model/bemap-circle.js, line 136

##### Returns:

return radius of the circle.

Type
  int

#### getStyle() → {bemap.LineStyle}

Return the style of the circle.

Source:
  - bemap-model/bemap-circle.js, line 180

##### 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:
  - bemap-model/bemap-circle.js, line 217

##### Returns:

this.

Type
  bemap.Circle

#### remove() → {bemap.Circle}

Remove the Circle from the layer.

Source:
  - bemap-model/bemap-circle.js, line 202

##### 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:
  - bemap-model/bemap-circle.js, line 189

##### 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:
  - bemap-model/bemap-circle.js, line 106

##### 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:
  - bemap-model/bemap-circle.js, line 126

##### Returns:

this

Type
  bemap.Circle

#### setRadius() → {int}

Return the radius of the circle.

Source:
  - bemap-model/bemap-circle.js, line 145

##### Returns:

return radius of the circle.

Type
  int