---
title: Class: SkyLayer
source: https://vjmap.com/doc/Class_SkyLayer.html
---

# Class: SkyLayer

创建天空图层.

### Hierarchy

- [*OverlayLayerBase*](#classesdefaultoverlaylayerbasemd)

  ↳ **SkyLayer**

### Table of contents

#### Constructors

- [constructor](#constructor)

#### Properties

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

#### Methods

- [addTo](#addto)
- [clickLayer](#clicklayer)
- [clickPopup](#clickpopup)
- [getData](#getdata)
- [getLayerId](#getlayerid)
- [getLayerStyle](#getlayerstyle)
- [getSkyAtmosphereColor](#getskyatmospherecolor)
- [getSkyAtmosphereHaloColor](#getskyatmospherehalocolor)
- [getSkyAtmosphereSun](#getskyatmospheresun)
- [getSkyAtmosphereSunIntensity](#getskyatmospheresunintensity)
- [getSkyGradient](#getskygradient)
- [getSkyGradientCenter](#getskygradientcenter)
- [getSkyGradientRadius](#getskygradientradius)
- [getSkyOpacity](#getskyopacity)
- [getSkyType](#getskytype)
- [getSourceId](#getsourceid)
- [hide](#hide)
- [hoverFeatureState](#hoverfeaturestate)
- [hoverLayer](#hoverlayer)
- [hoverPointer](#hoverpointer)
- [hoverPopup](#hoverpopup)
- [remove](#remove)
- [setFilter](#setfilter)
- [setLayerStyle](#setlayerstyle)
- [setProperty](#setproperty)
- [setSkyAtmosphereColor](#setskyatmospherecolor)
- [setSkyAtmosphereHaloColor](#setskyatmospherehalocolor)
- [setSkyAtmosphereSun](#setskyatmospheresun)
- [setSkyAtmosphereSunIntensity](#setskyatmospheresunintensity)
- [setSkyGradient](#setskygradient)
- [setSkyGradientCenter](#setskygradientcenter)
- [setSkyGradientRadius](#setskygradientradius)
- [setSkyOpacity](#setskyopacity)
- [setSkyType](#setskytype)
- [show](#show)
- [toggle](#toggle)

### Constructors

#### constructor

\+ **new SkyLayer**(`options`: [*SkyLayerOptions*](#interfacesdefaultskylayeroptionsmd)): [*SkyLayer*](#classesdefaultskylayermd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `options` | [*SkyLayerOptions*](#interfacesdefaultskylayeroptionsmd) |

**Returns:** [*SkyLayer*](#classesdefaultskylayermd)

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**: [*SkyLayerOptions*](#interfacesdefaultskylayeroptionsmd)

___

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

___

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

___

#### getSkyAtmosphereColor

▸ **getSkyAtmosphereColor**(): *string*

**Returns:** *string*

___

#### getSkyAtmosphereHaloColor

▸ **getSkyAtmosphereHaloColor**(): *string*

**Returns:** *string*

___

#### getSkyAtmosphereSun

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

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

___

#### getSkyAtmosphereSunIntensity

▸ **getSkyAtmosphereSunIntensity**(): *number*

**Returns:** *number*

___

#### getSkyGradient

▸ **getSkyGradient**(): [*ExpressionSpecificationEx*](#expressionspecificationex)

**Returns:** [*ExpressionSpecificationEx*](#expressionspecificationex)

___

#### getSkyGradientCenter

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

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

___

#### getSkyGradientRadius

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

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

___

#### getSkyOpacity

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

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

___

#### getSkyType

▸ **getSkyType**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"gradient"`` \| ``"atmosphere"``\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"gradient"`` \| ``"atmosphere"``\>

___

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

___

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

___

#### setSkyAtmosphereColor

▸ **setSkyAtmosphereColor**(`value`: *string*): [*SkyLayer*](#classesdefaultskylayermd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | *string* |

**Returns:** [*SkyLayer*](#classesdefaultskylayermd)

___

#### setSkyAtmosphereHaloColor

▸ **setSkyAtmosphereHaloColor**(`value`: *string*): [*SkyLayer*](#classesdefaultskylayermd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | *string* |

**Returns:** [*SkyLayer*](#classesdefaultskylayermd)

___

#### setSkyAtmosphereSun

▸ **setSkyAtmosphereSun**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>): [*SkyLayer*](#classesdefaultskylayermd)

##### Parameters

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

**Returns:** [*SkyLayer*](#classesdefaultskylayermd)

___

#### setSkyAtmosphereSunIntensity

▸ **setSkyAtmosphereSunIntensity**(`value`: *number*): [*SkyLayer*](#classesdefaultskylayermd)

##### Parameters

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

**Returns:** [*SkyLayer*](#classesdefaultskylayermd)

___

#### setSkyGradient

▸ **setSkyGradient**(`value`: [*ExpressionSpecificationEx*](#expressionspecificationex)): [*SkyLayer*](#classesdefaultskylayermd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*ExpressionSpecificationEx*](#expressionspecificationex) |

**Returns:** [*SkyLayer*](#classesdefaultskylayermd)

___

#### setSkyGradientCenter

▸ **setSkyGradientCenter**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>): [*SkyLayer*](#classesdefaultskylayermd)

##### Parameters

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

**Returns:** [*SkyLayer*](#classesdefaultskylayermd)

___

#### setSkyGradientRadius

▸ **setSkyGradientRadius**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>): [*SkyLayer*](#classesdefaultskylayermd)

##### Parameters

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

**Returns:** [*SkyLayer*](#classesdefaultskylayermd)

___

#### setSkyOpacity

▸ **setSkyOpacity**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>): [*SkyLayer*](#classesdefaultskylayermd)

##### Parameters

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

**Returns:** [*SkyLayer*](#classesdefaultskylayermd)

___

#### setSkyType

▸ **setSkyType**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"gradient"`` \| ``"atmosphere"``\>): [*SkyLayer*](#classesdefaultskylayermd)

##### Parameters

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

**Returns:** [*SkyLayer*](#classesdefaultskylayermd)

___

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

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