ImageParameters

属性概述

属性详细信息

declaredClass Stringreadonly inherited

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

dpi Number

JobInfo.fetchResultMapImageLayer() 的每英寸点数设置。

extent Extent

要导出的地图的范围。

format String

地图图像格式。

可能值："png"|"png8"|"png24"|"png32"|"jpg"|"pdf"|"bmp"|"gif"|"svg"

示例

let imageParams = new ImageParameters();
imageParams.format = "jpg";

height Number

请求的图像高度 (以像素为单位)。

imageSpatialReference SpatialReference

导出图像的空间参考。

layerDefinitions String[]

图层定义表达式数组，可用于过滤导出的地图图像中各个图层的要素。如果使用通过 GeoScene Server 2.0 或更高版本发布的地图服务，则支持使用分号或冒号的图层定义。

示例

let layerDefs = [];
layerDefs[5] = "STATE_NAME='Kansas'";
layerDefs[4] = "STATE_NAME='Kansas' and POP2007>25000";
layerDefs[3] = "STATE_NAME='Kansas' and POP2007>25000";

let imageParams = new ImageParameters({
  layerDefinitions: layerDefs
});

layerIds Number[]

图层 ID 列表，表示要包含在导出地图中的图层。与 layerOption 结合使用可指定如何处理图层可见性。

示例

let imageParams = new ImageParameters();
imageParams.layerIds = [3,4,5];
imageParams.layerOption = "show";

layerOption String

此属性可确定如何处理 layerIds 指定的图层。

可能值："show"|"hide"|"include"|"exclude"

示例

let imageParams = new ImageParameters();
imageParams.layerOption = "show";

transparent Boolean

指示动态图像的背景是否透明。

默认值：true

width Number

请求的图像宽度 (以像素为单位)。

方法概述

方法详细说明

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() 进行删除。如果未提供键，则句柄将被添加到默认组。

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

toJSON(){Object}

将此类的实例转换为其 GeoScene portal JSON 表示。有关详细信息，请参阅指南中的使用 fromJSON() 主题。

返回

类型	描述
Object	此类实例的 GeoScene portal JSON 表示。