---
title: Class: Circle
source: https://vjmap.com/doc/Class_Circle.html
---

# Class: Circle

[default](#modulesdefaultmd).Circle

创建圆符号图层.

### Hierarchy

- [*OverlayLayerBase*](#classesdefaultoverlaylayerbasemd)

  ↳ **Circle**

### Table of contents

#### Constructors

- [constructor](#constructor)

#### Properties

- [\_map](#_map)
- [layerId](#layerid)
- [options](#options)
- [sourceId](#sourceid)

#### Methods

- [addTo](#addto)
- [clickLayer](#clicklayer)
- [clickPopup](#clickpopup)
- [getCircleBlur](#getcircleblur)
- [getCircleColor](#getcirclecolor)
- [getCircleOpacity](#getcircleopacity)
- [getCirclePitchAlignment](#getcirclepitchalignment)
- [getCirclePitchScale](#getcirclepitchscale)
- [getCircleRadius](#getcircleradius)
- [getCircleSortKey](#getcirclesortkey)
- [getCircleStrokeColor](#getcirclestrokecolor)
- [getCircleStrokeOpacity](#getcirclestrokeopacity)
- [getCircleStrokeWidth](#getcirclestrokewidth)
- [getCircleTranslate](#getcircletranslate)
- [getCircleTranslateAnchor](#getcircletranslateanchor)
- [getData](#getdata)
- [getLayerId](#getlayerid)
- [getLayerStyle](#getlayerstyle)
- [getSourceId](#getsourceid)
- [getVisibility](#getvisibility)
- [hide](#hide)
- [hoverFeatureState](#hoverfeaturestate)
- [hoverLayer](#hoverlayer)
- [hoverPointer](#hoverpointer)
- [hoverPopup](#hoverpopup)
- [remove](#remove)
- [setCircleBlur](#setcircleblur)
- [setCircleColor](#setcirclecolor)
- [setCircleOpacity](#setcircleopacity)
- [setCirclePitchAlignment](#setcirclepitchalignment)
- [setCirclePitchScale](#setcirclepitchscale)
- [setCircleRadius](#setcircleradius)
- [setCircleSortKey](#setcirclesortkey)
- [setCircleStrokeColor](#setcirclestrokecolor)
- [setCircleStrokeOpacity](#setcirclestrokeopacity)
- [setCircleStrokeWidth](#setcirclestrokewidth)
- [setCircleTranslate](#setcircletranslate)
- [setCircleTranslateAnchor](#setcircletranslateanchor)
- [setData](#setdata)
- [setFilter](#setfilter)
- [setLayerStyle](#setlayerstyle)
- [setProperty](#setproperty)
- [setVisibility](#setvisibility)
- [show](#show)
- [toggle](#toggle)

### Constructors

#### constructor

\+ **new Circle**(`options`: [*CircleOptions*](#interfacesdefaultcircleoptionsmd)): [*Circle*](#classesdefaultcirclemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `options` | [*CircleOptions*](#interfacesdefaultcircleoptionsmd) |

**Returns:** [*Circle*](#classesdefaultcirclemd)

Overrides: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

### Properties

#### \_map

• `Optional` **\_map**: *Map*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[_map](#_map)

___

#### layerId

• `Optional` **layerId**: *string*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[layerId](#layerid)

___

#### options

• **options**: [*CircleOptions*](#interfacesdefaultcircleoptionsmd)

___

#### sourceId

• `Optional` **sourceId**: *string*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[sourceId](#sourceid)

### Methods

#### addTo

▸ **addTo**(`map`: *Map*, `beforeId?`: *string*): *void*

##### Parameters

| Name | Type |
| :------ | :------ |
| `map` | *Map* |
| `beforeId?` | *string* |

**Returns:** *void*

Overrides: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### clickLayer

▸ **clickLayer**(`cb`: *any*): *any*

每当单击这些图层中的要素时都会触发回调。

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `cb` | *any* | Callback that receives event with .features property |

**Returns:** *any*

A function that removes the handler.

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### clickPopup

▸ **clickPopup**(`htmlFunc`: (`arg0`: {}) => *void*, `popupOptions?`: PopupOptions): *any*

每当单击这些图层中的要素时都会显示一个弹出窗口。

**`example`** clickPopup(f => `<h3>${f.properties.Name}</h3> ${f.properties.Description}`, { maxWidth: 500 });

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | (`arg0`: {}) => *void* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |

**Returns:** *any*

A function that removes the handler.

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### getCircleBlur

▸ **getCircleBlur**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getCircleColor

▸ **getCircleColor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

___

#### getCircleOpacity

▸ **getCircleOpacity**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getCirclePitchAlignment

▸ **getCirclePitchAlignment**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>

___

#### getCirclePitchScale

▸ **getCirclePitchScale**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>

___

#### getCircleRadius

▸ **getCircleRadius**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getCircleSortKey

▸ **getCircleSortKey**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getCircleStrokeColor

▸ **getCircleStrokeColor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

___

#### getCircleStrokeOpacity

▸ **getCircleStrokeOpacity**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getCircleStrokeWidth

▸ **getCircleStrokeWidth**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getCircleTranslate

▸ **getCircleTranslate**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>

___

#### getCircleTranslateAnchor

▸ **getCircleTranslateAnchor**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>

___

#### getData

▸ **getData**(): *undefined* \| *Feature*<Geometry \| GeometryCollection, Properties\> \| *FeatureCollection*<Geometry \| GeometryCollection, Properties\> \| Geometry \| GeometryCollection

获取数据源的数据

**Returns:** *undefined* \| *Feature*<Geometry \| GeometryCollection, Properties\> \| *FeatureCollection*<Geometry \| GeometryCollection, Properties\> \| Geometry \| GeometryCollection

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### getLayerId

▸ **getLayerId**(): *undefined* \| *string*

获取图层ID

**Returns:** *undefined* \| *string*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### getLayerStyle

▸ **getLayerStyle**(): [*LayerSpecification*](#layerspecification)

根据样式规范，获取给定图层 ID 的图层定义。

**Returns:** [*LayerSpecification*](#layerspecification)

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### getSourceId

▸ **getSourceId**(): *undefined* \| *string*

获取数据源ID

**Returns:** *undefined* \| *string*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### getVisibility

▸ **getVisibility**(): ``"visible"`` \| ``"none"``

**Returns:** ``"visible"`` \| ``"none"``

___

#### hide

▸ **hide**(): *void*

使给定的图层不可见。

**Returns:** *void*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### hoverFeatureState

▸ **hoverFeatureState**(`enterCb?`: (`arg0`: {}) => *void*, `leaveCb?`: (`arg0`: {}) => *void*): *void*

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

##### Parameters

| Name | Type |
| :------ | :------ |
| `enterCb?` | (`arg0`: {}) => *void* |
| `leaveCb?` | (`arg0`: {}) => *void* |

**Returns:** *void*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### hoverLayer

▸ **hoverLayer**(`cb`: *any*): *any*

当鼠标悬停在这些图层中的要素上时触发回调。

##### Parameters

| Name | Type |
| :------ | :------ |
| `cb` | *any* |

**Returns:** *any*

A function to remove the handler.

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### hoverPointer

▸ **hoverPointer**(): *void*

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

**Returns:** *void*

A function to remove the handler.

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### hoverPopup

▸ **hoverPopup**(`htmlFunc`: *any*, `popupOptions?`: PopupOptions): *any*

将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。

**`example`** hoverPopup(f => `<h3>${f.properties.Name}</h3> ${f.properties.Description}`, { anchor: 'left' });

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `htmlFunc` | *any* | Function that receives feature and popup, returns HTML. |
| `popupOptions?` | PopupOptions | Options passed to `Popup()` to customise popup. |

**Returns:** *any*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### remove

▸ **remove**(): *void*

**Returns:** *void*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### setCircleBlur

▸ **setCircleBlur**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Circle*](#classesdefaultcirclemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Circle*](#classesdefaultcirclemd)

___

#### setCircleColor

▸ **setCircleColor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>): [*Circle*](#classesdefaultcirclemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\> |

**Returns:** [*Circle*](#classesdefaultcirclemd)

___

#### setCircleOpacity

▸ **setCircleOpacity**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Circle*](#classesdefaultcirclemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Circle*](#classesdefaultcirclemd)

___

#### setCirclePitchAlignment

▸ **setCirclePitchAlignment**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>): [*Circle*](#classesdefaultcirclemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\> |

**Returns:** [*Circle*](#classesdefaultcirclemd)

___

#### setCirclePitchScale

▸ **setCirclePitchScale**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>): [*Circle*](#classesdefaultcirclemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\> |

**Returns:** [*Circle*](#classesdefaultcirclemd)

___

#### setCircleRadius

▸ **setCircleRadius**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Circle*](#classesdefaultcirclemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Circle*](#classesdefaultcirclemd)

___

#### setCircleSortKey

▸ **setCircleSortKey**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Circle*](#classesdefaultcirclemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Circle*](#classesdefaultcirclemd)

___

#### setCircleStrokeColor

▸ **setCircleStrokeColor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>): [*Circle*](#classesdefaultcirclemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\> |

**Returns:** [*Circle*](#classesdefaultcirclemd)

___

#### setCircleStrokeOpacity

▸ **setCircleStrokeOpacity**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Circle*](#classesdefaultcirclemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Circle*](#classesdefaultcirclemd)

___

#### setCircleStrokeWidth

▸ **setCircleStrokeWidth**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Circle*](#classesdefaultcirclemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Circle*](#classesdefaultcirclemd)

___

#### setCircleTranslate

▸ **setCircleTranslate**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>): [*Circle*](#classesdefaultcirclemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\> |

**Returns:** [*Circle*](#classesdefaultcirclemd)

___

#### setCircleTranslateAnchor

▸ **setCircleTranslateAnchor**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>): [*Circle*](#classesdefaultcirclemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\> |

**Returns:** [*Circle*](#classesdefaultcirclemd)

___

#### setData

▸ **setData**(`data`: *any*): *void*

替换 GeoJSON 图层的当前数据。

##### Parameters

| Name | Type |
| :------ | :------ |
| `data` | *any* |

**Returns:** *void*

___

#### setFilter

▸ **setFilter**(`filter`: [*FilterSpecification*](#filterspecification)): *void*

替换一个图层的过滤器。

**`example`** setFilter(['==','level','0']]);

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `filter` | [*FilterSpecification*](#filterspecification) | New filter to set. |

**Returns:** *void*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### setLayerStyle

▸ **setLayerStyle**(`style`: *any*): *void*

设置图层样式

##### Parameters

| Name | Type |
| :------ | :------ |
| `style` | *any* |

**Returns:** *void*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### setProperty

▸ **setProperty**(`prop`: *string* \| *object*, `value?`: *any*): *void*

在一个或多个图层上设置绘制或布局属性。

**`example`** setProperty('fillOpacity', 0.5)

##### Parameters

| Name | Type |
| :------ | :------ |
| `prop` | *string* \| *object* |
| `value?` | *any* |

**Returns:** *void*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### setVisibility

▸ **setVisibility**(`value`: ``"visible"`` \| ``"none"``): [*Circle*](#classesdefaultcirclemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | ``"visible"`` \| ``"none"`` |

**Returns:** [*Circle*](#classesdefaultcirclemd)

___

#### show

▸ **show**(): *void*

使给定的图层可见。

**Returns:** *void*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### toggle

▸ **toggle**(`state`: *boolean*): *boolean*

根据参数使给定的图层隐藏或可见。

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `state` | *boolean* | True for visible, false for hidden. |

**Returns:** *boolean*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)


<a name="classesdefaultcircleedgemd"></a>

[vjmap](#readmemd) / [Exports](#modulesmd) / [default](#modulesdefaultmd) / CircleEdge