Common Cesium-Plugin MapboxGL-Plugin Leaflet-Plugin OpenLayers-Plugin Video-Plugin
API文档
类名 OGCLayer

# new OGCLayer(options)

OGS图层基类

参数:

名称 类型 默认值 描述
options Object

构造参数
minScale Number 0

最小显示比例尺，图层在视图中可见的最小比例尺。
maxScale Number 0

最大显示比例尺，图层在视图中可见的最大比例尺。
tokenKey String 'token'

token名
tokenValue String

token值
version String ''

服务版本
customParameters Object {}

自定义服务参数
customLayerParameters Object {}

自定义图层参数

继承关系

成员变量

String

版权所有

Inherited From:
Object

# customParameters

自定义查询参数customParameters

String

# readonly description

图层描述

Inherited From:
Object

# extendProps

当前图层对象上不支持的属性，二次开发用户希望挂在图层对像上的属性可以存储到该属性中

Inherited From:
Default Value:
  • {}
Object

# extensionOptions

初始化图层的额外参数，可以通过该参数传入引擎原生的构造参数

Inherited From:
Default Value:
  • {}
Extent

# readonly extent

图层范围，从服务元信息中获取

Inherited From:
String

# headers

设置服务请求头

Inherited From:
FetchMethod

# httpMethod

http请求方式

Inherited From:
String

# readonly id

图层id

Inherited From:
Number

# index

图层顺序

Inherited From:
Boolean

# readonly loaded

是否加载完毕

Inherited From:
Default Value:
  • false
String

# readonly loadStatus

图层加载状态

Inherited From:
Default Value:
  • not-loaded
Number

# maxScale

最大显示比例尺，图层在视图中可见的最大比例尺(最放大)。如果地图被放大到超过这个比例，图层将不可见。默认值为0，0表示图层没有最大比例尺、可见性不受最大比例尺限制。maxScale应该始终小于minScale。

Inherited From:
Default Value:
  • 0
Number

# minScale

最小显示比例尺，图层在视图中可见的最小比例尺(最缩小)。如果地图被缩小到超过这个比例，图层将不可见。默认值为0，0表示图层没有最小比例尺、可见性不受最小比例尺限制。minScale应该始终大于maxScale。

Inherited From:
Default Value:
  • 0
Number

# opacity

图层透明度，0到1之间的值，0为完全透明，1为不透明，会触发图层更新完毕事件。IGSSceneLayer图层类型为地形时，不支持该属性。

Inherited From:
SpatialReference

# spatialReference

图层坐标系对象

Inherited From:
String

# title

图层名称

Inherited From:
String

# tokenAttachType

token附加类型。默认psot请求优先附加到body，get请求优先附加到url末尾

Inherited From:
String

# tokenKey

token名

Inherited From:
Default Value:
  • token
String

# tokenValue

token值

Inherited From:
String

# readonly type

图层类型

Inherited From:
String

# version

ogc版本号

Number

# visible

图层显示或隐藏，true则显示，false则隐藏，会触发图层更新完毕事件

Inherited From:

方法

# clone()

克隆方法

Inherited From:

图层

Layer

# destroy()

Inherited From:
*

# isLoaded()

判断图层是否加载成功

Inherited From:

图层是否加载成功

Boolean

# refresh()

刷新图层

Inherited From:

# toJSON()

转换为json对象

Overrides:

json对象

Object

事件

# 图层刷新完毕事件

图层刷新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

属性:
Name Type Attributes Default Description
event Object

事件对象
type String <optional>
 'layerview-update'

图层更新完毕事件
message String <optional>
 null

更新描述
updateContent Array.<UpdateContent> <optional>
 null

更新详情对象
layer Layer <optional>
 null

地图图层对象
layerView MapView <optional>
 null

图层的视图对象
sourceTarget Layer <optional>
 null

事件发起对象
target Map <optional>
 null

事件接收对象
Inherited From:
示例

图层刷新完毕事件

Layer.on('layerview-update', function (event) {
  // 获取更新事件对象
  console.log("更新完毕:", event)
  // 获取更新详情数组
  const updateContent = event.updateContent
  // 循环数组，根据事件名进行后续操作
  for (let i = 0; i < updateContent.length; i++) {
    // 图层刷新完毕事件
    if(updateContent[i].name === 'refresh'){
      console.log("图层刷新完毕事件:", event);
    }
  }
});

# 图层加载完毕事件

图层加载完毕事件

属性:
Name Type Attributes Default Description
event Object

事件对象
type String <optional>
 'layerview-created'

图层加载完毕事件
message String <optional>
 null

更新描述
UpdateContent Array.<UpdateContent> <optional>
 null

更新详情对象
layer Layer <optional>
 null

地图图层对象
layerView MapView <optional>
 null

图层的视图对象
sourceTarget Layer <optional>
 null

事件发起对象
target Map <optional>
 null

事件接收对象
Inherited From:
示例

图层加载完毕事件

Layer.on('layerview-created', function (result) {
  console.log("加载完毕:", result.layer)
});

# 图层显隐更新完毕事件

图层显隐更新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

属性:
Name Type Attributes Default Description
event Object

事件对象
type String <optional>
 'layerview-update'

图层更新完毕事件
message String <optional>
 null

更新描述
updateContent Array.<UpdateContent> <optional>
 null

更新详情对象
layer Layer <optional>
 null

地图图层对象
layerView MapView <optional>
 null

图层的视图对象
sourceTarget Layer <optional>
 null

事件发起对象
target Map <optional>
 null

事件接收对象
Inherited From:
示例

图层显隐更新完毕事件

Layer.on('layerview-update', function (event) {
  // 获取更新事件对象
  console.log("更新完毕:", event)
  // 获取更新详情数组
  const updateContent = event.updateContent
  // 循环数组，根据事件名进行后续操作
  for (let i = 0; i < updateContent.length; i++) {
    // 图层显隐事件
    if(updateContent[i].name === 'visible'){
      console.log("图层显隐更新事件:", event);
    }
  }
});

# 图层更新完毕事件

图层更新完毕事件

属性:
Name Type Attributes Default Description
event Object

事件对象
type String <optional>
 'layerview-update'

图层更新完毕事件
message String <optional>
 null

更新描述
updateContent Array.<UpdateContent> <optional>
 null

更新详情对象
layer Layer <optional>
 null

地图图层对象
layerView MapView <optional>
 null

图层的视图对象
sourceTarget Layer <optional>
 null

事件发起对象
target Map <optional>
 null

事件接收对象
Inherited From:
示例

图层更新完毕事件

Layer.on('layerview-update', function (result) {
  console.log("更新完毕:", result.layer)
});

# 图层透明度更新完毕事件

图层透明度更新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

属性:
Name Type Attributes Default Description
event Object

事件对象
type String <optional>
 'layerview-update'

图层更新完毕事件
message String <optional>
 null

更新描述
updateContent Array.<UpdateContent> <optional>
 null

更新详情对象
layer Layer <optional>
 null

地图图层对象
layerView MapView <optional>
 null

图层的视图对象
sourceTarget Layer <optional>
 null

事件发起对象
target Map <optional>
 null

事件接收对象
Inherited From:
示例

图层透明度更新完毕事件

Layer.on('layerview-update', function (event) {
  // 获取更新事件对象
  console.log("更新完毕:", event)
  // 获取更新详情数组
  const updateContent = event.updateContent
  // 循环数组，根据事件名进行后续操作
  for (let i = 0; i < updateContent.length; i++) {
    // 图层透明度更新事件
    if(updateContent[i].name === 'opacity'){
      console.log("图层透明度更新事件:", event);
    }
  }
});

# 图层销毁完毕事件

图层销毁完毕事件

属性:
Name Type Attributes Default Description
event Object

事件对象
type String <optional>
 'layerview-remove'

图层销毁完毕事件
message String <optional>
 null

更新描述
updateContent Array.<UpdateContent> <optional>
 null

更新详情对象
layer Layer <optional>
 null

要销毁的地图图层对象
layerView MapView <optional>
 null

图层的视图对象
sourceTarget Layer <optional>
 null

事件发起对象
target Map <optional>
 null

事件接收对象
Inherited From:
示例

图层销毁完毕事件

Layer.on('layerview-remove', function (result) {
  console.log("销毁完毕:", result.layer)
});

# 图层顺序更新完毕事件

图层顺序更新完毕事件，请注意该事件是图层更新事件(layerview-update)的子事件

属性:
Name Type Attributes Default Description
event Object

事件对象
type String <optional>
 'layerview-update'

图层更新完毕事件
message String <optional>
 null

更新描述
updateContent Array.<UpdateContent> <optional>
 null

更新详情对象
layer Layer <optional>
 null

地图图层对象
layerView MapView <optional>
 null

图层的视图对象
sourceTarget Layer <optional>
 null

事件发起对象
target Map <optional>
 null

事件接收对象
Inherited From:
示例

图层顺序更新完毕事件

Layer.on('layerview-update', function (event) {
  // 获取更新事件对象
  console.log("更新完毕:", event)
  // 获取更新详情数组
  const updateContent = event.updateContent
  // 循环数组，根据事件名进行后续操作
  for (let i = 0; i < updateContent.length; i++) {
    // 图层顺序更新完毕事件
    if(updateContent[i].name === 'index'){
      console.log("图层顺序更新完毕事件:", event);
    }
  }
});
构造函数
成员变量
方法
事件