ImageParameters

AMD: require(["geoscene/layers/support/ImageParameters"], (ImageParameters) => { /* code goes here */ });
ESM: import ImageParameters from "@geoscene/core/layers/support/ImageParameters";
类: geoscene/layers/support/ImageParameters
继承于:ImageParameters Accessor
起始版本:GeoScene Maps SDK for JavaScript 4.0
已弃用从 4.24 版开始。请改为使用 ImageParameters

表示调用 JobInfo.fetchResultImage()JobInfo.fetchResultMapImageLayer() 时使用的影像参数选项。

另请参阅

构造函数

new ImageParameters(properties)
参数
properties Object
optional

有关可能传递给构造函数的所有属性的列表,请参见属性

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
String

类的名称。

更多详情
Accessor
Number

MapImageLayer 的每英寸点数设置。

更多详情
ImageParameters
Extent

要导出的地图的范围。

更多详情
ImageParameters
String

地图图像格式。

更多详情
ImageParameters
Number

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

更多详情
ImageParameters
SpatialReference

导出地图的空间参考。

更多详情
ImageParameters
String[]

图层定义表达式数组,可用于过滤导出的地图图像中各个图层的要素。

更多详情
ImageParameters
Number[]

图层 ID 列表,表示要包含在导出地图中的图层。

更多详情
ImageParameters
String

用于显示或隐藏图层的选项。

更多详情
ImageParameters
Boolean

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

更多详情
ImageParameters
Number

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

更多详情
ImageParameters

属性详细信息

declaredClass Stringreadonly inherited
起始版本:GeoScene Maps SDK for JavaScript 4.7

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

dpi Number

MapImageLayer 的每英寸点数设置。

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

用于显示或隐藏图层的选项。

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

示例
let imageParams = new ImageParameters();
imageParams.layerOption = "show";
transparent Boolean

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

默认值:true
width Number

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

方法概述

显示继承的方法 隐藏继承的方法
名称 返回值类值 描述

添加一个或多个与对象的生命周期相关联的句柄。

更多详情
Accessor
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

将此类的实例转换为其 GeoScene portal JSON 表示。

更多详情
ImageParameters

方法详细说明

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 表示。

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。请参阅浏览器弃用帖子以获取更多信息