WMTSSubLayer

类名 WMTSSubLayer

# new WMTSSubLayer(options)

IGS地图服务图层

参数:

名称	类型	默认值	描述
`options`	Object		构造参数
`description`	String	'IGS WMTS子图层'	描述信息
`imageFormat`	String	'image/png'	图像格式
`imageFormats`	Array.<String>		图像格式组
`styleId`	String		样式id
`styles`	Array.<WMTSStyle>		样式组
`tileMatrixSets`	Array.<TileMatrixSet>		要请求的图块矩阵集
`tileMatrixSetId`	String		要请求的图块矩阵集id
`extent`	Extent		图层范围
`resourceURLTemplates`	Array.<String>		资源地址模板

继承关系

Layer

成员变量

类型: Object

# readonly capabilities

图层支持能力。图层支持能力分为客户端能力和服务端能力，其中客户端能力包含cesium、leaflet、mapboxgl引擎能力。默认图层客户端能力：所有引擎支持图层加载；默认图层服务端能力为空。

Overrides:

Layer#capabilities

类型: String

# readonly copyright

Inherited From:

Layer#copyright

类型: String

# readonly description

描述信息

Overrides:

Layer#description

类型: Object

# extendProps

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

Inherited From:

Layer#extendProps

Default Value:

{}

类型: Object

# extensionOptions

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

Inherited From:

Layer#extensionOptions

Default Value:

{}

类型: Extent | null

# readonly extent

图层的范围。从元信息或数据中获取，默认为null表示取不到范围。

Inherited From:

Layer#extent

类型: String

# readonly headers

设置服务请求头

Inherited From:

Layer#headers

类型: FetchMethod

# readonly httpMethod

http请求方式

Inherited From:

Layer#httpMethod

类型: String

# readonly id

图层id

Inherited From:

Layer#id

类型: String

# imageFormat

图像格式

类型: Array.<String>

# readonly imageFormats

图像格式组

类型: Boolean

# readonly loaded

是否加载完毕

Inherited From:

Layer#loaded

Default Value:

false

类型: String

# readonly loadStatus

图层加载状态

Inherited From:

Layer#loadStatus

Default Value:

not-loaded

类型: Number

# maxScale

最大显示比例尺，图层在视图中可见的最大比例尺(最放大)。如果地图被放大到超过这个比例，图层将不可见。默认值为0，如果图层是瓦片类型，maxScale、minScale的默认值能和tileInfo上的保持一致，如果图层是动态图层，则和地图视图保持一致。maxScale应该始终小于minScale。

Inherited From:

Layer#maxScale

Default Value:

类型: Number

# minScale

最小显示比例尺，图层在视图中可见的最小比例尺(最缩小)。如果地图被缩小到超过这个比例，图层将不可见。默认值为0，如果图层是瓦片类型，maxScale、minScale的默认值能和tileInfo上的保持一致，如果图层是动态图层，则和地图视图保持一致。minScale应该始终大于maxScale。

Inherited From:

Layer#minScale

Default Value:

类型: Number

# opacity

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

Inherited From:

Layer#opacity

类型: Array.<String>

# resourceURLTemplates

资源地址模板

类型: SpatialReference

# readonly spatialReference

图层坐标系

Overrides:

Layer#spatialReference

类型: String

# styleId

样式id, 默认为样式中第一项的 ID

类型: Array.<WMTSStyle>

# readonly styles

样式组

类型: TileMatrixSet

# readonly tileMatrixSet

要请求的图块矩阵集

类型: String

# tileMatrixSetId

要请求的图块矩阵集id

类型: Array.<TileMatrixSet>

# readonly tileMatrixSets

要请求的图块矩阵集

类型: String

# title

图层名称

Inherited From:

Layer#title

类型: TokenAttachType

# tokenAttachType

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

Inherited From:

Layer#tokenAttachType

类型: String

# tokenKey

token名

Inherited From:

Layer#tokenKey

Default Value:

token

类型: String

# tokenValue

token值

Inherited From:

Layer#tokenValue

类型: LayerType

# readonly type

图层类型

Inherited From:

Layer#type

类型: Number

# visible

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

Inherited From:

Layer#visible

方法

# clone()

克隆图层对象

Overrides:

Layer#clone

返回值:

克隆后的图层对象

类型: WMTSSubLayer

# destroy()

Inherited From:

Layer#destroy

返回值:

类型: *

# fromJSON(json)

将JSON格式的子图层参数转换为JS对象

参数:

名称	类型	描述
`json`	Object	子图层的实例化JSON

# isLoaded()

判断图层是否加载成功

Inherited From:

Layer#isLoaded

返回值:

图层是否加载成功

类型: Boolean

# toJSON()

将JS对象转换为JSON格式

Overrides:

Layer#toJSON

返回值:

子图层的实例化JSON

类型: Object

事件

# 图层加载完毕事件

图层加载完毕事件

属性:

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#event:图层加载完毕事件

示例

图层加载完毕事件

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#event:图层显隐更新完毕事件

示例

图层显隐更新完毕事件

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#event:图层更新完毕事件

示例

图层更新完毕事件

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	事件接收对象
`event`	LayerViewScaleVisibleEvent			事件对象 layer.on('layerview-scale-visible', (event) => { console.log("图层比例尺显示隐藏状态更新事件:", event) })

Inherited From:

Layer#event:图层比例尺显示隐藏状态更新事件。当前仅支持非组图层以及场景子图层

示例

图层刷新完毕事件

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);
    }
  }
});

/**

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

图层透明度更新完毕事件，请注意该事件是图层更新事件(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#event:图层透明度更新完毕事件

示例

图层透明度更新完毕事件

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#event:图层销毁完毕事件

示例

图层销毁完毕事件

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

构造函数

成员变量

方法

事件

MapGIS Client for JavaScript API

# new WMTSSubLayer(options)

参数:

继承关系

成员变量

# readonly capabilities

# readonly copyright

# readonly description

# extendProps

# extensionOptions

# readonly extent

# readonly headers

# readonly httpMethod

# readonly id

# imageFormat

# readonly imageFormats

# readonly loaded

# readonly loadStatus

# maxScale

# minScale

# opacity

# resourceURLTemplates

# readonly spatialReference

# styleId

# readonly styles

# readonly tileMatrixSet

# tileMatrixSetId

# readonly tileMatrixSets

# title

# tokenAttachType

# tokenKey

# tokenValue

# readonly type

# visible

方法

# clone()

# destroy()

# fromJSON(json)

参数:

# isLoaded()

# toJSON()

事件

# 图层加载完毕事件

属性:

示例

# 图层显隐更新完毕事件

属性:

示例

图层显隐更新完毕事件

# 图层更新完毕事件

属性:

示例

# 图层比例尺显示隐藏状态更新事件。当前仅支持非组图层以及场景子图层

属性:

示例

图层刷新完毕事件

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

属性:

示例

图层透明度更新完毕事件

# 图层销毁完毕事件

属性:

示例