---
title: Class: SvgOverlay
source: https://vjmap.com/doc/Class_SvgOverlay.html
---

# Class: SvgOverlay

在一个地理范围内创建一个随缩放而缩放的svg的覆盖物，(注：svg覆盖物性能低，不建议大量使用，同时在级别特别大时会导致失真，在倾斜角很大时会导致不可见)

### Table of contents

#### Constructors

- [constructor](#constructor)

#### Properties

- [divOverlay](#divoverlay)
- [elements](#elements)
- [options](#options)

#### Methods

- [addElement](#addelement)
- [addElements](#addelements)
- [addTo](#addto)
- [getElements](#getelements)
- [getSvgContainer](#getsvgcontainer)
- [remove](#remove)
- [removeElements](#removeelements)
- [updateElements](#updateelements)
- [attr\_cx\_cy\_r](#attr_cx_cy_r)
- [attr\_cx\_cy\_rx\_ry](#attr_cx_cy_rx_ry)
- [attr\_fontsize](#attr_fontsize)
- [attr\_length](#attr_length)
- [attr\_path](#attr_path)
- [attr\_point](#attr_point)
- [attr\_points](#attr_points)
- [attr\_x1\_y1\_x2\_y2](#attr_x1_y1_x2_y2)
- [attr\_x\_y](#attr_x_y)
- [attr\_x\_y\_w\_h](#attr_x_y_w_h)

### Constructors

#### constructor

\+ **new SvgOverlay**(`options?`: [*SvgOverlayOptions*](#interfacesdefaultsvgoverlayoptionsmd)): [*SvgOverlay*](#classesdefaultsvgoverlaymd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `options?` | [*SvgOverlayOptions*](#interfacesdefaultsvgoverlayoptionsmd) |

**Returns:** [*SvgOverlay*](#classesdefaultsvgoverlaymd)

### Properties

#### divOverlay

• **divOverlay**: [*DivOverlay*](#classesdefaultdivoverlaymd)

___

#### elements

• **elements**: [*SvgElementOptions*](#interfacesdefaultsvgelementoptionsmd)[]

___

#### options

• **options**: [*SvgOverlayOptions*](#interfacesdefaultsvgoverlayoptionsmd)

### Methods

#### addElement

▸ **addElement**(`element`: *string* \| [*SvgElementOptions*](#interfacesdefaultsvgelementoptionsmd), `noUpdate?`: *boolean*): *void*

增加svg元素

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `element` | *string* \| [*SvgElementOptions*](#interfacesdefaultsvgelementoptionsmd) | 要增加的元素 |
| `noUpdate?` | *boolean* | 不立即更新 |

**Returns:** *void*

___

#### addElements

▸ **addElements**(`elements`: [*SvgElementOptions*](#interfacesdefaultsvgelementoptionsmd)[], `noUpdate?`: *boolean*): *void*

增加svg元素

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `elements` | [*SvgElementOptions*](#interfacesdefaultsvgelementoptionsmd)[] | 多个元素内容 |
| `noUpdate?` | *boolean* | 不立即更新 |

**Returns:** *void*

___

#### addTo

▸ **addTo**(`map`: *Map*, `insertId?`: *string* \| HTMLElement): *void*

##### Parameters

| Name | Type |
| :------ | :------ |
| `map` | *Map* |
| `insertId?` | *string* \| HTMLElement |

**Returns:** *void*

___

#### getElements

▸ **getElements**(): [*SvgElementOptions*](#interfacesdefaultsvgelementoptionsmd)[]

获取所有的元素

**Returns:** [*SvgElementOptions*](#interfacesdefaultsvgelementoptionsmd)[]

___

#### getSvgContainer

▸ **getSvgContainer**(): SVGSVGElement

获取svg获取

**Returns:** SVGSVGElement

___

#### remove

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

**Returns:** *void*

___

#### removeElements

▸ **removeElements**(`id`: *string* \| *string*[]): [*SvgElementOptions*](#interfacesdefaultsvgelementoptionsmd)[]

移动一个元素

##### Parameters

| Name | Type |
| :------ | :------ |
| `id` | *string* \| *string*[] |

**Returns:** [*SvgElementOptions*](#interfacesdefaultsvgelementoptionsmd)[]

___

#### updateElements

▸ **updateElements**(`elements`: [*SvgElementOptions*](#interfacesdefaultsvgelementoptionsmd) \| [*SvgElementOptions*](#interfacesdefaultsvgelementoptionsmd)[]): [*SvgElementOptions*](#interfacesdefaultsvgelementoptionsmd)[]

更新一个元素

##### Parameters

| Name | Type |
| :------ | :------ |
| `elements` | [*SvgElementOptions*](#interfacesdefaultsvgelementoptionsmd) \| [*SvgElementOptions*](#interfacesdefaultsvgelementoptionsmd)[] |

**Returns:** [*SvgElementOptions*](#interfacesdefaultsvgelementoptionsmd)[]

___

#### attr\_cx\_cy\_r

▸ `Static` **attr_cx_cy_r**(`cx`: *number*, `cy`: *number*, `r`: *number*): *string*

圆心半径属性字符串

##### Parameters

| Name | Type |
| :------ | :------ |
| `cx` | *number* |
| `cy` | *number* |
| `r` | *number* |

**Returns:** *string*

___

#### attr\_cx\_cy\_rx\_ry

▸ `Static` **attr_cx_cy_rx_ry**(`cx`: *number*, `cy`: *number*, `rx`: *number*, `ry`: *number*): *string*

椭圆心半径属性字符串

##### Parameters

| Name | Type |
| :------ | :------ |
| `cx` | *number* |
| `cy` | *number* |
| `rx` | *number* |
| `ry` | *number* |

**Returns:** *string*

___

#### attr\_fontsize

▸ `Static` **attr_fontsize**(`fontsize`: *number*): *string*

字体属性字符串

##### Parameters

| Name | Type |
| :------ | :------ |
| `fontsize` | *number* |

**Returns:** *string*

___

#### attr\_length

▸ `Static` **attr_length**(`len`: *number*): *string*

和长度有关属性字符串

##### Parameters

| Name | Type |
| :------ | :------ |
| `len` | *number* |

**Returns:** *string*

___

#### attr\_path

▸ `Static` **attr_path**(`points`: [*GeoPoint*](#classesdefaultgeopointmd)[]): *string*

路径序列属性字符串

##### Parameters

| Name | Type |
| :------ | :------ |
| `points` | [*GeoPoint*](#classesdefaultgeopointmd)[] |

**Returns:** *string*

___

#### attr\_point

▸ `Static` **attr_point**(`point`: [*GeoPoint*](#classesdefaultgeopointmd), `joinComma?`: *boolean*): *string*

和点坐标有关属性字符串

##### Parameters

| Name | Type |
| :------ | :------ |
| `point` | [*GeoPoint*](#classesdefaultgeopointmd) |
| `joinComma?` | *boolean* |

**Returns:** *string*

___

#### attr\_points

▸ `Static` **attr_points**(`points`: [*GeoPoint*](#classesdefaultgeopointmd)[]): *string*

坐标序列属性字符串

##### Parameters

| Name | Type |
| :------ | :------ |
| `points` | [*GeoPoint*](#classesdefaultgeopointmd)[] |

**Returns:** *string*

___

#### attr\_x1\_y1\_x2\_y2

▸ `Static` **attr_x1_y1_x2_y2**(`x1`: *number*, `y1`: *number*, `x2`: *number*, `y2`: *number*): *string*

直线坐标属性字符串

##### Parameters

| Name | Type |
| :------ | :------ |
| `x1` | *number* |
| `y1` | *number* |
| `x2` | *number* |
| `y2` | *number* |

**Returns:** *string*

___

#### attr\_x\_y

▸ `Static` **attr_x_y**(`x`: *number*, `y`: *number*): *string*

坐标属性字符串

##### Parameters

| Name | Type |
| :------ | :------ |
| `x` | *number* |
| `y` | *number* |

**Returns:** *string*

___

#### attr\_x\_y\_w\_h

▸ `Static` **attr_x_y_w_h**(`x`: *number*, `y`: *number*, `w`: *number*, `h`: *number*): *string*

坐标宽高属性字符串

##### Parameters

| Name | Type |
| :------ | :------ |
| `x` | *number* |
| `y` | *number* |
| `w` | *number* |
| `h` | *number* |

**Returns:** *string*


<a name="classessymbolmd"></a>

[vjmap](#readmemd) / [Exports](#modulesmd) / Symbol