---
title: Class: GridLayer
source: https://vjmap.com/doc/Class_GridLayer.html
---

# Class: GridLayer

网络线图层

### Implements

- *CustomLayerInterface*

### Table of contents

#### Constructors

- [constructor](#constructor)

#### Properties

- [id](#id)
- [renderingMode](#renderingmode)
- [type](#type)

#### Methods

- [getWrapNum](#getwrapnum)
- [onAdd](#onadd)
- [removeFromMap](#removefrommap)
- [render](#render)
- [setExtent](#setextent)
- [setIntervals](#setintervals)
- [setMaxZoom](#setmaxzoom)
- [setMinZoom](#setminzoom)
- [setShowLabel](#setshowlabel)
- [setStrokeStyle](#setstrokestyle)
- [setVisibility](#setvisibility)
- [setXLabelStyle](#setxlabelstyle)
- [setYLabelStyle](#setylabelstyle)

### Constructors

#### constructor

\+ **new GridLayer**(`options?`: [*GridLayerOptions*](#interfacesdefaultgridlayeroptionsmd)): [*GridLayer*](#classesdefaultgridlayermd)

##### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| `options` | [*GridLayerOptions*](#interfacesdefaultgridlayeroptionsmd) | {} |

**Returns:** [*GridLayer*](#classesdefaultgridlayermd)

### Properties

#### id

• **id**: *string*

Implementation of: CustomLayerInterface.id

___

#### renderingMode

• `Optional` **renderingMode**: ``"2d"`` \| ``"3d"``

Implementation of: CustomLayerInterface.renderingMode

___

#### type

• **type**: ``"custom"``

Implementation of: CustomLayerInterface.type

### Methods

#### getWrapNum

▸ **getWrapNum**(`x`: *number*, `includeMax?`: *boolean*, `includeMin?`: *boolean*, `range?`: *number*[]): *number*

##### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| `x` | *number* | - |
| `includeMax` | *boolean* | true |
| `includeMin` | *boolean* | true |
| `range` | *number*[] | - |

**Returns:** *number*

___

#### onAdd

▸ **onAdd**(`map`: *Map*): *void*

##### Parameters

| Name | Type |
| :------ | :------ |
| `map` | *Map* |

**Returns:** *void*

Implementation of: CustomLayerInterface.onAdd

___

#### removeFromMap

▸ **removeFromMap**(): *void*

**`description`** 移除图层。

**Returns:** *void*

___

#### render

▸ **render**(`gl`: WebGLRenderingContext, `matrix`: *number*[]): *void*

##### Parameters

| Name | Type |
| :------ | :------ |
| `gl` | WebGLRenderingContext |
| `matrix` | *number*[] |

**Returns:** *void*

Implementation of: CustomLayerInterface.render

___

#### setExtent

▸ **setExtent**(`extent`: *LngLatBounds*): *void*

**`description`** 设置坐标网格渲染的边界范围。

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `extent` | *LngLatBounds* | 坐标网格渲染的边界范围。 |

**Returns:** *void*

___

#### setIntervals

▸ **setIntervals**(`interval`: *number* \| Function): *void*

**`description`** 设置经纬度的间隔（以度为单位)

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `interval` | *number* \| Function | 经纬度的间隔（以度为单位），可以是数字，也可以是函数，参数是map。 |

**Returns:** *void*

___

#### setMaxZoom

▸ **setMaxZoom**(`maxZoom`: *number*): *void*

**`description`** 该图层可见的最大视图缩放级别。

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `maxZoom` | *number* | 该图层可见的最大视图缩放级别（含）。 |

**Returns:** *void*

___

#### setMinZoom

▸ **setMinZoom**(`minZoom`: *number*): *void*

**`description`** 设置最小视图缩放级别。

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `minZoom` | *number* | 最小视图缩放级别（不包括此级别），在该级别之上，该层将可见。 |

**Returns:** *void*

___

#### setShowLabel

▸ **setShowLabel**(`showLabel`: *boolean*): *void*

**`description`** 设置显示标签。

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `showLabel` | *boolean* | 是否显示标签。 |

**Returns:** *void*

___

#### setStrokeStyle

▸ **setStrokeStyle**(`strokeStyle`: [*GridLayerStrokeStyle*](#interfacesdefaultgridlayerstrokestylemd)): *void*

**`description`** 设置经纬线样式。

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `strokeStyle` | [*GridLayerStrokeStyle*](#interfacesdefaultgridlayerstrokestylemd) | 经纬线样式。 |

**Returns:** *void*

___

#### setVisibility

▸ **setVisibility**(`visible?`: *boolean*): *void*

**`description`** 设置可见性。

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `visible?` | *boolean* | 是否可见。 |

**Returns:** *void*

___

#### setXLabelStyle

▸ **setXLabelStyle**(`labelStyle`: [*GridLayerLabelStyle*](#interfacesdefaultgridlayerlabelstylemd)): *void*

**`description`** 设置经度标签样式。

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `labelStyle` | [*GridLayerLabelStyle*](#interfacesdefaultgridlayerlabelstylemd) | 标签样式。 |

**Returns:** *void*

___

#### setYLabelStyle

▸ **setYLabelStyle**(`labelStyle`: [*GridLayerLabelStyle*](#interfacesdefaultgridlayerlabelstylemd)): *void*

**`description`** 设置纬度标签样式。

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `labelStyle` | [*GridLayerLabelStyle*](#interfacesdefaultgridlayerlabelstylemd) | 标签样式。 |

**Returns:** *void*


<a name="classeshaloringmarkermd"></a>

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