---
title: Class: BackgroundLayer
source: https://vjmap.com/doc/Class_BackgroundLayer.html
---

# Class: BackgroundLayer

[default](#modulesdefaultmd).BackgroundLayer

创建一个背景图层.

### Hierarchy

- [*OverlayLayerBase*](#classesdefaultoverlaylayerbasemd)

  ↳ **BackgroundLayer**

### Table of contents

#### Constructors

- [constructor](#constructor)

#### Properties

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

#### Methods

- [addTo](#addto)
- [clickLayer](#clicklayer)
- [clickPopup](#clickpopup)
- [getBackgroundColor](#getbackgroundcolor)
- [getBackgroundOpacity](#getbackgroundopacity)
- [getBackgroundPattern](#getbackgroundpattern)
- [getData](#getdata)
- [getLayerId](#getlayerid)
- [getLayerStyle](#getlayerstyle)
- [getSourceId](#getsourceid)
- [hide](#hide)
- [hoverFeatureState](#hoverfeaturestate)
- [hoverLayer](#hoverlayer)
- [hoverPointer](#hoverpointer)
- [hoverPopup](#hoverpopup)
- [remove](#remove)
- [setBackgroundColor](#setbackgroundcolor)
- [setBackgroundOpacity](#setbackgroundopacity)
- [setBackgroundPattern](#setbackgroundpattern)
- [setFilter](#setfilter)
- [setLayerStyle](#setlayerstyle)
- [setProperty](#setproperty)
- [show](#show)
- [toggle](#toggle)

### Constructors

#### constructor

\+ **new BackgroundLayer**(`options`: [*BackgroundLayerOptions*](#interfacesdefaultbackgroundlayeroptionsmd)): [*BackgroundLayer*](#classesdefaultbackgroundlayermd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `options` | [*BackgroundLayerOptions*](#interfacesdefaultbackgroundlayeroptionsmd) |

**Returns:** [*BackgroundLayer*](#classesdefaultbackgroundlayermd)

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**: [*BackgroundLayerOptions*](#interfacesdefaultbackgroundlayeroptionsmd)

___

#### 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)

___

#### getBackgroundColor

▸ **getBackgroundColor**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<string\>

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

___

#### getBackgroundOpacity

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

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

___

#### getBackgroundPattern

▸ **getBackgroundPattern**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<string\>

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

___

#### 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)

___

#### 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)

___

#### setBackgroundColor

▸ **setBackgroundColor**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<string\>): [*BackgroundLayer*](#classesdefaultbackgroundlayermd)

##### Parameters

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

**Returns:** [*BackgroundLayer*](#classesdefaultbackgroundlayermd)

___

#### setBackgroundOpacity

▸ **setBackgroundOpacity**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>): [*BackgroundLayer*](#classesdefaultbackgroundlayermd)

##### Parameters

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

**Returns:** [*BackgroundLayer*](#classesdefaultbackgroundlayermd)

___

#### setBackgroundPattern

▸ **setBackgroundPattern**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<string\>): [*BackgroundLayer*](#classesdefaultbackgroundlayermd)

##### Parameters

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

**Returns:** [*BackgroundLayer*](#classesdefaultbackgroundlayermd)

___

#### 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)

___

#### 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="classesdefaultbreathingaperturemarkermd"></a>

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