VJMAP logoVJMAP
CAD · WebGIS
中

Class: Polygon

Updated 2026-09-14~ 17 min read
.md
ChatGPTClaudeKimiDoubao

创建多边形.

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

+ new Polygon(options: PolygonOptions): Polygon

Parameters
Name Type
options PolygonOptions

Returns: Polygon

Overrides: OverlayLayerBase

Properties

_map

• Optional _map: Map

Inherited from: OverlayLayerBase._map

layerId

• Optional layerId: string

Inherited from: OverlayLayerBase.layerId

options

• options: PolygonOptions

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

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

getFillAntialias

▸ getFillAntialias(): PropertyValueSpecificationEx<boolean>

获取图层的“填充抗锯齿”绘制属性。

Returns: PropertyValueSpecificationEx<boolean>

getFillColor

▸ getFillColor(): DataDrivenPropertyValueSpecification<string>

获取图层的 fill-color 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

getFillOpacity

▸ getFillOpacity(): DataDrivenPropertyValueSpecification<number>

获取图层的 fill-opacity 绘制属性。

Returns: DataDrivenPropertyValueSpecification<number>

getFillOutlineColor

▸ getFillOutlineColor(): DataDrivenPropertyValueSpecification<string>

获取图层的 fill-outline-color 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

getFillPattern

▸ getFillPattern(): DataDrivenPropertyValueSpecification<string>

获取图层的fill-pattern 绘制属性。

Returns: DataDrivenPropertyValueSpecification<string>

getFillSortKey

▸ getFillSortKey(): DataDrivenPropertyValueSpecification<number>

获取图层的fill-sort-key 布局属性.

Returns: DataDrivenPropertyValueSpecification<number>

getFillTranslate

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

获取图层的 fill-translate 绘制属性。

Returns: PropertyValueSpecificationEx<[number, number]>

getFillTranslateAnchor

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

获取图层的 fill-translate-anchor 绘制属性。

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

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

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

setData

▸ setData(data: any): void

替换 GeoJSON 图层的当前数据。

Parameters
Name Type
data any

Returns: void

setFillAntialias

▸ setFillAntialias(value: PropertyValueSpecificationEx<boolean>): Polygon

为一个或多个图层设置fill-antialias 绘制属性。

Parameters
Name Type
value PropertyValueSpecificationEx<boolean>

Returns: Polygon

setFillColor

▸ setFillColor(value: DataDrivenPropertyValueSpecification<string>): Polygon

为一个或多个图层设置fill-color 绘画属性。

Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polygon

setFillOpacity

▸ setFillOpacity(value: DataDrivenPropertyValueSpecification<number>): Polygon

为一个或多个图层设置fill-opacity 绘画属性。

Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polygon

setFillOutlineColor

▸ setFillOutlineColor(value: DataDrivenPropertyValueSpecification<string>): Polygon

为一个或多个图层设置fill-outline-color 绘画属性。

Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polygon

setFillPattern

▸ setFillPattern(value: DataDrivenPropertyValueSpecification<string>): Polygon

为一个或多个图层设置fill-pattern 绘制属性。

Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polygon

setFillSortKey

▸ setFillSortKey(value: DataDrivenPropertyValueSpecification<number>): Polygon

为一层或多层设置fill-sort-key布局属性。

Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polygon

setFillTranslate

▸ setFillTranslate(value: DataDrivenPropertyValueSpecification<string>): Polygon

为一个或多个图层设置fill-translate 绘制属性。

Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polygon

setFillTranslateAnchor

▸ setFillTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): Polygon

为一个或多个图层设置fill-translate-anchor 绘制属性。

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

Returns: Polygon

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

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 / Polyline

Was this page helpful?