WMSSublayer

属性概述

属性详细信息

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

类的名称。声明的类名称格式化为 geoscene.folder.className。

description String

WMS 子图层的说明。这默认为 WMS GetCapabilities 请求中 Abstract 属性的值。

dimensions Array<(TimeDimension|ElevationDimension|GenericDimension)>readonly

起始版本：GeoScene Maps SDK for JavaScript 4.20

子图层的时间、高程和其他维度的数组。来自 TimeDimension 的信息可用于更新 View.timeExtent、WMSLayer.timeExtent 或配置 TimeSlider 微件。

WMSLayer 或 WMSSublayer 只能有一个时间维度。以下示例显示了如何查找基础图层的时间维度 (如果有)。

const layer = new WMSLayer({
  url: "https://public-wms.met.no/verportal/verportal.map?request=GetCapabilities&service=WMS&version=1.3.0"
});
await layer.load();
const precipitation = layer.allSublayers.find((sl) => sl.name === "precipitation_3h_global");
layer.sublayers = [precipitation];
const timeDimension = precipitation.dimensions.find((dimension) => dimension.name === "time");

数据可以存在于特定时间或时间范围内。我们可以从 TimeDimension 的 extent 属性中以离散日期数组或 TimeDimensionInterval 的形式访问此信息。例如，继续上一个示例，使用 TimeDimension 的范围配置 TimeSlider。

const dates = timeDimension.extent; // This time dimension is expressed as an array of dates.
const start = dates[0]; // Get the first and earliest date
const end = dates[dates.length -1]; // Get last date
const timeSlider = new TimeSlider({
  container: "timeSliderDiv",
  view: view,
  mode: "instant",
  timeVisible: true,
  loop: true,
  fullTimeExtent: { // The TimeSlider UI will span all dates
    start,
    end
  },
  stops: {
    dates // The TimeSlider thumb will snap exactly to each valid date
  }
})

fullExtent Extent

图层的完整范围。

id Number

WMS 子图层的 id。

layer WMSLayer

子图层所属的 WMSLayer。

legendEnabled Boolean

指示图层是否将包含在图例中。当为 false 时，图层将从图例中排除。

默认值：true

legendUrl String

指向图层图例图像的字符串 url。

maxScale Number

起始版本：GeoScene Maps SDK for JavaScript 4.14

图层在视图中可见时的最大比例 (放至最大)。如果地图放大至超过此比例，则图层将不可见。值为零表示该图层没有最大比例。

默认值：0

minScale Number

起始版本：GeoScene Maps SDK for JavaScript 4.14

图层在视图中可见时的最小比例 (缩至最小)。如果地图缩小到超过此比例，则图层将不可见。值为零表示该图层没有最小比例。

默认值：0

name String

WMS 子图层名称。这默认为 WMS GetCapabilities 请求中的 Name 属性的值。

parent WMSSublayer|WMSLayer

起始版本：GeoScene Maps SDK for JavaScript 4.17

返回对父 WMS 子图层或图层的引用。

示例

// Display the title and description for the WMS sublayer named "RADAR_1KM_RDBR".
const wmsLayer = new WMSLayer({
  url: "https://geo.weather.gc.ca/geomet"
});
wmsLayer.load().then(() => {
  const subLayer = layer.findSublayerByName("RADAR_1KM_RDBR");
  let parent = wmsSubLayer.parent;
  while(parent) {
    parent.visible = true;
    parent = parent.parent;
  }
});

popupEnabled Boolean

指示单击图层中的要素时是否显示弹出窗口。

默认值：false

queryable Boolean

指示是否可以查询图层，例如，服务支持使用 text/html 或 text/plain 格式的 GetFeatureInfo。

默认值：false

spatialReferences Number[]

从 GetCapabilities 请求中的第一个图层的 CRS 元素派生的 spatialReferences (WKID) 列表。

sublayers Collection<WMSSublayer>

WMSSublayer 的集合。

title String

用于在某些地方标识它的 WMS 子图层标题，例如 LayerList 和 Legend 微件。这默认为 WMS GetCapabilities 请求中的 Title 属性的值。

visible Boolean

指示图层在视图中是否可见。

方法概述

方法详细说明

addHandles(handleOrHandles, groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时，将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

参数

handleOrHandles WatchHandle|WatchHandle[] 对象销毁后，标记为要移除的句柄。

groupKey * optional 标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键，则句柄将被添加到默认组。

clone(){WMSSublayer}

创建 WMS 子图层的深度克隆。

返回

类型	描述
WMSSublayer	调用此方法的 WMS 子图层实例的深度克隆。

hasHandles(groupKey){Boolean}inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组，则返回 true。

参数

groupKey * optional 组键。

返回

类型	描述
Boolean	如果存在指定的句柄组，则返回 true。

示例

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles(groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数

groupKey * optional 要移除的组键或组键的数组或集合。

示例

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

类型定义

ElevationDimension Object

高程维度信息。

属性

name String 维度轴的名称。 值通常是 "elevation"。

GenericDimension Object

通用维度信息。

属性

name String 维度轴的名称。

TimeDimension Object

时间维度信息。例如，可以发布 WMS 服务以显示每小时的天气信息。TimeDimension 可用于更新 View.timeExtent、WMSLayer.timeExtent 或配置 TimeSlider 微件。

属性

name String 维度轴的名称。 值通常是 "time"。

units String 维度轴的单位。 值通常是 "ISO8601"。

extent Date[]|TimeDimensionInterval[] 时间维度的可用值。

default Date[]|TimeDimensionInterval[] 时间维度的默认值。如果请求不包含时间维度的值，则将使用默认值。

multipleValues Boolean 指示是否可以请求维度的多个值。

nearestValue Boolean 指示是否将返回维度的最近值以响应对邻近值的请求。

TimeDimensionInterval Object

时间维度间隔。

属性

min Date 间隔开始。

max Date 间隔结束。

resolution Object 由以下属性定义的间隔持续时间。 规范 years Number 年数。 months Number 月数。 days Number 天数。 hours Number 小时数。 minutes Number 分钟数。 seconds Number 秒数。