Class: Circle

default.Circle

创建圆符号图层.

Hierarchy

• OverlayLayerBase

  ↳ Circle

Table of contents

Constructors

• constructor

Properties

• _map
• layerId
• options
• sourceId

Methods

• addTo
• clickLayer
• clickPopup
• getCircleBlur
• getCircleColor
• getCircleOpacity
• getCirclePitchAlignment
• getCirclePitchScale
• getCircleRadius
• getCircleSortKey
• getCircleStrokeColor
• getCircleStrokeOpacity
• getCircleStrokeWidth
• getCircleTranslate
• getCircleTranslateAnchor
• getData
• getLayerId
• getLayerStyle
• getSourceId
• getVisibility
• hide
• hoverFeatureState
• hoverLayer
• hoverPointer
• hoverPopup
• remove
• setCircleBlur
• setCircleColor
• setCircleOpacity
• setCirclePitchAlignment
• setCirclePitchScale
• setCircleRadius
• setCircleSortKey
• setCircleStrokeColor
• setCircleStrokeOpacity
• setCircleStrokeWidth
• setCircleTranslate
• setCircleTranslateAnchor
• setData
• setFilter
• setLayerStyle
• setProperty
• setVisibility
• show
• toggle

Constructors

constructor

+ new Circle(options: CircleOptions): Circle

Parameters

Name	Type
options	CircleOptions

Returns: Circle

Overrides: OverlayLayerBase

Properties

_map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

---

layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

---

options

• options: CircleOptions

---

sourceId

• Optional sourceId: string

Inherited from: OverlayLayerBase.sourceId

Methods

addTo

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

Parameters

Name	Type
map	Map
beforeId?	string

Returns: void

Overrides: OverlayLayerBase

---

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

---

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

---

getCircleBlur

▸ getCircleBlur(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

---

getCircleColor

▸ getCircleColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

---

getCircleOpacity

▸ getCircleOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

---

getCirclePitchAlignment

▸ getCirclePitchAlignment(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

---

getCirclePitchScale

▸ getCirclePitchScale(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">

---

getCircleRadius

▸ getCircleRadius(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

---

getCircleSortKey

▸ getCircleSortKey(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

---

getCircleStrokeColor

▸ getCircleStrokeColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>

---

getCircleStrokeOpacity

▸ getCircleStrokeOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

---

getCircleStrokeWidth

▸ getCircleStrokeWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>

---

getCircleTranslate

▸ getCircleTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>

---

getCircleTranslateAnchor

▸ getCircleTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: 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

---

getLayerId

▸ getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase

---

getLayerStyle

▸ getLayerStyle(): LayerSpecification

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

Returns: LayerSpecification

Inherited from: OverlayLayerBase

---

getSourceId

▸ getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase

---

getVisibility

▸ getVisibility(): "visible" | "none"

Returns: "visible" | "none"

---

hide

▸ hide(): void

使给定的图层不可见。

Returns: void

Inherited from: OverlayLayerBase

---

hoverFeatureState

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

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

Parameters

Name	Type
enterCb?	(arg0: {}) => void
leaveCb?	(arg0: {}) => void

Returns: void

Inherited from: OverlayLayerBase

---

hoverLayer

▸ hoverLayer(cb: any): any

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

Parameters

Name	Type
cb	any

Returns: any

A function to remove the handler.

Inherited from: OverlayLayerBase

---

hoverPointer

▸ hoverPointer(): void

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

Returns: void

A function to remove the handler.

Inherited from: OverlayLayerBase

---

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

---

remove

▸ remove(): void

Returns: void

Inherited from: OverlayLayerBase

---

setCircleBlur

▸ setCircleBlur(value: DataDrivenPropertyValueSpecification<number>): Circle

Parameters

Name	Type
value	DataDrivenPropertyValueSpecification<number>

Returns: Circle

---

setCircleColor

▸ setCircleColor(value: DataDrivenPropertyValueSpecification<string>): Circle

Parameters

Name	Type
value	DataDrivenPropertyValueSpecification<string>

Returns: Circle

---

setCircleOpacity

▸ setCircleOpacity(value: DataDrivenPropertyValueSpecification<number>): Circle

Parameters

Name	Type
value	DataDrivenPropertyValueSpecification<number>

Returns: Circle

---

setCirclePitchAlignment

▸ setCirclePitchAlignment(value: PropertyValueSpecificationEx<"map" | "viewport">): Circle

Parameters

Name	Type
value	PropertyValueSpecificationEx<"map" | "viewport">

Returns: Circle

---

setCirclePitchScale

▸ setCirclePitchScale(value: PropertyValueSpecificationEx<"map" | "viewport">): Circle

Parameters

Name	Type
value	PropertyValueSpecificationEx<"map" | "viewport">

Returns: Circle

---

setCircleRadius

▸ setCircleRadius(value: DataDrivenPropertyValueSpecification<number>): Circle

Parameters

Name	Type
value	DataDrivenPropertyValueSpecification<number>

Returns: Circle

---

setCircleSortKey

▸ setCircleSortKey(value: DataDrivenPropertyValueSpecification<number>): Circle

Parameters

Name	Type
value	DataDrivenPropertyValueSpecification<number>

Returns: Circle

---

setCircleStrokeColor

▸ setCircleStrokeColor(value: DataDrivenPropertyValueSpecification<string>): Circle

Parameters

Name	Type
value	DataDrivenPropertyValueSpecification<string>

Returns: Circle

---

setCircleStrokeOpacity

▸ setCircleStrokeOpacity(value: DataDrivenPropertyValueSpecification<number>): Circle

Parameters

Name	Type
value	DataDrivenPropertyValueSpecification<number>

Returns: Circle

---

setCircleStrokeWidth

▸ setCircleStrokeWidth(value: DataDrivenPropertyValueSpecification<number>): Circle

Parameters

Name	Type
value	DataDrivenPropertyValueSpecification<number>

Returns: Circle

---

setCircleTranslate

▸ setCircleTranslate(value: PropertyValueSpecificationEx<[number, number]>): Circle

Parameters

Name	Type
value	PropertyValueSpecificationEx<[number, number]>

Returns: Circle

---

setCircleTranslateAnchor

▸ setCircleTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): Circle

Parameters

Name	Type
value	PropertyValueSpecificationEx<"map" | "viewport">

Returns: Circle

---

setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

Parameters

Name	Type
data	any

Returns: void

---

setFilter

▸ setFilter(filter: FilterSpecification): void

替换一个图层的过滤器。

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

Parameters

Name	Type	Description
filter	FilterSpecification	New filter to set.

Returns: void

Inherited from: OverlayLayerBase

---

setLayerStyle

▸ setLayerStyle(style: any): void

设置图层样式

Parameters

Name	Type
style	any

Returns: void

Inherited from: OverlayLayerBase

---

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

---

setVisibility

▸ setVisibility(value: "visible" | "none"): Circle

Parameters

Name	Type
value	"visible" | "none"

Returns: Circle

---

show

▸ show(): void

使给定的图层可见。

Returns: void

Inherited from: OverlayLayerBase

---

toggle

▸ toggle(state: boolean): boolean

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

Parameters

Name	Type	Description
state	boolean	True for visible, false for hidden.

Returns: boolean

Inherited from: OverlayLayerBase

vjmap / Exports / default / CircleEdge