MapImageLayer

https:\/\/<hostname>/geoscene/rest/services/<service-name>/MapServer

require(["geoscene/layers/MapImageLayer"], function(MapImageLayer){
  // points to the states layer in a service storing U.S. census data
  let layer = new MapImageLayer({
    url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer"
  });
  map.add(layer);  // adds the layer to the map
});

// references an GeoScene Online item pointing to a Map Service Layer
let layer = new MapImageLayer({
  portalItem: {  // autocasts as geoscene/portal/PortalItem
    id: "686ebae3c91c4b6a86a8b4c67aee11be"
  }
});
map.add(layer);  // adds the layer to the map

let layer = new MapImageLayer({
url: "https://sampleserver.geosceneonline.cn/geoscene/rest/services/sample/MapServer",
  sublayers: [
   {
     id: 3,
     visible: false
   }, {
     id: 2,
     visible: true
   }, {
     id: 1,
     visible: true
   }, {
     id: 0,
     visible: true,
     definitionExpression: "pop2000 > 100000"
   }
 ]
});

属性概述

属性详细信息

allSublayers Collection<Sublayer>readonly

MapImageLayer 中所有 sublayers 的平面集合，包括其子图层的子图层。所有子图层都按它们在视图中的绘制顺序 (从下到上) 进行引用。

示例

// finds the census tracts sublayer from a parent sublayer of the
// MapImageLayer containing various census sublayers
let tractsId = 5;
let tracksSublayer = layer.allSublayers.find(function(sublayer){
  return sublayer.id === tracksId;
});

blendMode String

起始版本：GeoScene Maps SDK for JavaScript 4.16

混合模式用于将图层混合在一起，以便在图层中创建有趣的效果，甚至生成一个看起来像新图层的图层。与使用透明度 (透明度可能会导致顶部图层褪色) 的方法不同，混合模式通过将图层与其下方的图层进行混合来创建各种生动有趣的结果。

混合图层时，top layer 是应用了混合模式的图层。顶部图层下的所有层都是 background layers。默认的混合模式是 normal，其中顶部图层简单地显示在背景图层之上。虽然这种默认行为是完全可以接受的，但在图层上使用混合模式可为生成创意地图开辟了无限可能。

GroupLayer 中的图层混合在一起，与地图的其余部分隔离开。

在以下屏幕截图中，复古阴影浮雕图层显示在萤火虫世界影像图层上。color 混合模式应用于复古阴影浮雕，结果看起来像一个新图层。

已知限制

• 3D SceneViews 中的 blendMode 在 BaseTileLayer、ImageryTileLayer、OpenStreetMapLayer、TileLayer、VectorTileLayer、WCSLayer、WebTileLayer、WMTSLayer 和 GroupLayer 中受支持。
• Legend 不支持 blendMode。
• 请参阅打印以了解已知的打印限制。

以下因素会影响混合结果：

• 所有图层的顺序
• 图层不透明度
• 图层中要素的不透明度
• 图层的可见性
• 默认情况下，地图的最底图层绘制在透明背景上。您可以更改 MapView 的背景色。

混合模式	描述
normal	顶部图层显示在背景图层上方。在重叠部分，顶部图层数据会遮挡背景图层数据。
average	使用顶部图层和背景图层的数学平均值。average 混合模式的结果通常类似于将图层不透明度设置为 50% 的效果。

亮色混合模式：

以下混合模式会创建比所有图层更亮的结果。在亮色混合模式下，顶部图层中的纯黑色变得透明，从而使背景图层能够透出来。顶部图层的白色将保持不变。任何比纯黑色更亮的颜色都会在不同程度上使顶部图层的颜色变亮，直至纯白色。

亮色混合模式在淡化顶部图层的深色或从结果中移除黑色时非常有用。plus、lighten 和 screen 模式可用于使深色背景上褪色或深色的图层变亮。

混合模式	描述
lighten	比较顶部图层和背景图层并保留浅色。如果顶部图层中的颜色比背景图层中的重叠颜色更暗，则顶部图层中的颜色将变为透明，从而使背景图层完全显示出来。可认为是 darken 混合模式的反面。
lighter	顶部图层和背景图层的颜色乘以它们的 alpha 值 (图层不透明度和图层数据的不透明度)。再将生成的颜色相加。所有重叠的中间颜色在顶部图层变亮。图层和图层数据的不透明度将影响混合结果。
plus	顶部图层和背景图层中的颜色将相加。所有重叠的中间颜色在顶部图层变亮。此模式也称为 add 或 linear-dodge。
screen	将顶部图层和背景图层中的反转颜色相乘，然后再次反转颜色。生成的颜色将比原始颜色更亮，对比度更小。屏幕可以产生多种不同程度的亮度，具体取决于顶部图层的亮度值。可以认为是 multiply 模式的反面。
color-dodge	将背景图层中的颜色除以倒置的顶部图层。这将根据顶部图层的值使背景图层变亮。顶部图层越亮，其颜色对背景图层的影响就越大。降低顶部图层和背景图层之间的对比度，从而产生饱和的中间色调和高光。

暗色混合模式：

以下混合模式会创建比所有图层更暗的结果。在暗色混合模式下，顶部图层中的纯白色将变得透明，从而使背景图层能够显示出来。顶部图层的黑色将保持不变。任何比纯白色更深的颜色都会在不同程度上使顶部图层的颜色变暗，直至纯黑色。

multiply 混合模式通常用于突出阴影、显示对比度或突出地图的某个方面。例如，当您希望通过地形图层显示高程时，可以在显示在山体阴影上的地形图上使用 multiply 混合模式。请参阅图层混合简介示例。

multiply 和 darken 模式可用于将底图的深色标注显示在顶部图层。请参阅暗色混合示例。

color-burn 模式适用于彩色顶部图层和背景图层，因为它增加了中间色调的饱和度。它通过使顶部图层和底部图层重叠区域中的像素更接近顶部图层的颜色来增加对比度。当您想要一个对比度大于 multiply 或 darken 的效果时，请使用此混合模式。

以下屏幕截图显示了如何使用 multiply 混合模式来创建一个显示边界和高程的世界物理地图。

混合模式	描述
darken	强调重叠图层中的最暗部分。如果顶部图层中的颜色比背景图层中的重叠颜色更亮，则顶部图层中的颜色将变为透明，从而使背景图层完全显示出来。
multiply	通过将顶部图层和背景图层的颜色相乘来强调重叠图层的最暗部分。顶部图层和背景图层的中间颜色可以更均匀地混合在一起。
color-burn	强化所有图层中的暗色区域。通过将重叠区域中的颜色朝向顶部颜色着色，该模式可增加顶部图层和背景图层之间的对比度。为此，它会反转背景图层的颜色，将结果除以顶部图层的颜色，然后再反转结果。

对比度混合模式：

以下混合模式通过调亮或调暗顶部图层中较亮或较暗的区域来创建对比，通过使用变亮或变暗混合模式来创建混合。对比度混合模式将使比 50% 灰色更亮的颜色变亮 ([128,128,128])，并将比 50% 灰色更深的颜色变暗。50% 的灰色在顶部图层是透明的。根据混合在一起的顶部图层和背景图层的颜色，每种模式都可创建各种结果。overlay 混合模式根据背景图层中颜色的亮度进行计算，而所有其他对比度混合模式根据顶部图层的亮度进行计算。其中一些模式旨在模拟光线穿过顶部图层，有效地投射到其下方图层上的效果。

对比度混合模式可用于增加对比度和饱和度，以拥有更鲜艳的色彩，并为您的图层带来冲击力。例如，您可以复制一个图层并在顶部图层上设置 overlay 混合模式，以增加图层的对比度和色调。您还可以在深色影像图层上添加具有白色填充符号的多边形图层，并应用 soft-light 混合模式来增加影像图层的亮度。

以下屏幕截图显示了 overlay 混合模式在 GraphicsLayer 上的效果。左图显示了缓冲区图形图层具有 normal 混合模式的情景。如您所见，灰色的缓冲区多边形遮挡了与人口普查区域相交的部分。右图显示了将 overlay 混合模式应用于缓冲区图形图层的情景。overlay 混合模式可根据背景图层的颜色使灰色缓冲区多边形变暗或变亮，而人口普查区域图层以亮色突显出来。请在操作中查看此效果。

常规混合模式	叠加混合模式

混合模式	描述
overlay	结合使用 multiply 和 screen 模式，以使顶部图层中的颜色变暗和变亮，而背景图层始终发亮。结果是背景图层中较深的颜色值会强化顶部图层，而背景图层中较浅的颜色会清除顶部图层中的重叠区域。
soft-light	将半强度 screen 模式应用于较亮的区域，并将半强度 multiply 模式应用于顶部图层的暗色区域。您可以将 soft-light 视为 overlay 模式的更柔和版本。
hard-light	根据顶部图层的颜色，对颜色进行相乘或屏蔽。效果类似于在顶部图层上照射刺眼的聚光灯。
vivid-light	根据顶部图层中的颜色，通过增加或减少对比度来使用 color-burn 或 color-dodge 的组合。

分量混合模式：

以下混合模式使用主色分量，即色调、饱和度和亮度来混合顶部图层和背景图层。您可以在任何图层上添加具有简单渲染器的要素图层，并在此图层上设置 hue、saturation、color 或 luminosity 混合模式。使用这种技术，您可以创建一个全新的地图。

以下截图显示了地形图层与世界山体阴影图层在 luminosity 混合模式下的混合效果。结果是一个外观截然不同的地图，它保留了地形图层的亮度，同时采用了山体阴影图层的色调和饱和度。

混合模式	描述
hue	使用顶部图层的色调和背景图层的亮度和饱和度创建效果。
saturation	使用顶部图层的饱和度和背景图层的色调和亮度创建效果。背景图层中没有饱和度的 50% 灰色不会产生任何变化。
luminosity	使用顶部图层的亮度和背景图层的色调和饱和度创建效果。可认为是 color 混合模式的反面。
color	使用顶部图层的色调和饱和度以及背景图层的亮度创建效果。可认为是 luminosity 混合模式的反面。

复合混合模式：

以下混合模式可用于掩膜顶部图层、背景图层或两者的内容。

• Destination 模式用于使用背景图层的数据掩膜顶部图层的数据。
• Source 模式用于使用顶部图层的数据掩膜背景图层的数据。

destination-in 混合模式可用于通过显示底层地图或提供现象的鸟瞰图来显示聚焦区域，例如地震、动物迁徙或点源污染。查看多个混合和 groupLayer 混合示例，以查看复合混合模式的作用。

以下屏幕截图按其在视图中的绘制顺序在左侧分别显示了要素图层和影像图层。影像图层包含土地覆盖分类栅格。要素图层包含 2007 年县农作物数据。右图显示了混合图层的结果，其中在影像图层上设置了 destination-in blendMode。如您所见，效果与原始图层有很大不同。混合结果仅显示种植作物的区域 (影像图层和要素图层重叠的区域)。

混合模式	描述
destination-over	目标/背景图层可覆盖顶部图层。顶部图层绘制在目标图层下方。无论背景图层是透明的还是没有数据，您都会看到顶部图层。
destination-atop	仅当目标/背景图层与顶部图层重叠时，才会绘制目标/背景图层。顶部图层绘制在背景图层下方。无论背景图层是透明的还是没有数据，您都会看到顶部图层。
destination-in	仅当目标/背景图层与顶部图层重叠时，才会绘制目标/背景图层。其他一切都变得透明。
destination-out	目标/背景图层在不与顶部图层相重叠的位置处绘制。其他一切都变得透明。
source-atop	源/顶部图层仅在与背景图层相重叠的位置处绘制。在源图层透明或没有数据的位置处，您都会看到背景图层。
source-in	源/顶部图层仅在与背景图层相重叠的位置处绘制。其他一切都变得透明。
source-out	源/顶部图层在不与背景图层相重叠的位置处绘制。其他一切都变得透明。
xor	顶部图层和背景图层在重叠处变为透明。这两个图层在其他任何地方都是正常绘制的。

反转混合模式：

以下混合模式根据背景图层的颜色反转或抵消颜色。这些混合模式查找顶部图层和背景图层之间的差异。例如，您可以在森林覆盖的两个影像图层上使用 difference 或 exclusion 混合模式，以可视化森林覆盖从一年到另一年的变化。

invert 混合模式可用于将任何浅色底图转换为深色底图，以适应在弱光条件下工作的人。以下屏幕截图显示了如何使用简单的渲染器在要素图层上设置 invert 混合模式，从而立即将世界地形底图变为深色主题底图。

混合模式	描述
difference	从较浅颜色中减去重叠颜色中的较深颜色。减去两个具有相同值的像素时，结果为黑色。与黑色混合不会产生任何变化。与白色混合可反转颜色。此混合模式对于对齐具有相似内容的图层非常有用。
exclusion	类似于 difference 混合模式，只是生成的图像整体更亮。具有较浅颜色值的重叠区域将变亮，而较暗的重叠颜色值将变为透明。
minus	从背景图层的颜色中减去顶部图层的颜色，使混合结果更暗。对于负值，将显示黑色。
invert	在顶部图层和背景图层相重叠的任何位置处，反转背景色。反转混合模式可反转类似于照相底片的图层。
reflect	此混合模式创建的效果就像在图层中添加了闪亮物体或光线区域一样。背景图层中的黑色像素将被忽略，就好像它们是透明的一样。

可能值："average"|"color-burn"|"color-dodge"|"color"|"darken"|"destination-atop"|"destination-in"|"destination-out"|"destination-over"|"difference"|"exclusion"|"hard-light"|"hue"|"invert"|"lighten"|"lighter"|"luminosity"|"minus"|"multiply"|"normal"|"overlay"|"plus"|"reflect"|"saturation"|"screen"|"soft-light"|"source-atop"|"source-in"|"source-out"|"vivid-light"|"xor"

capabilities Objectreadonly

起始版本：GeoScene Maps SDK for JavaScript 4.8

指示图层的受支持功能。

属性

exportMap Object 表示 exportMap 操作支持的选项。如果 supportsExportMap 为 false，将为 null。 规范 supportsArcadeExpressionForLabeling Boolean 指示子图层是否支持用于标注的 Arcade 表达式。仅适用于 MapImageLayer。从版本 4.19 开始提供此功能。 supportsDynamicLayers Boolean 指示是否可以使用动态图层修改或添加子图层渲染。 supportsSublayersChanges Boolean 指示是否可以添加或移除子图层。supportsDynamicLayers 也必须为 true 才能重新排序子图层。 supportsSublayerDefinitionExpression Boolean 指示是否可以设置子图层定义表达式。 supportsSublayerVisibility Boolean 指示是否可以更改子图层的可见性。 supportsCIMSymbols Boolean 从 4.23 开始 指示 CIMSymbol 是否可以在子图层的渲染器中使用。

exportTiles Object 指示 exportTiles 操作支持的选项。如果 supportsExportTiles 为 false，将为 null。 规范 maxExportTilesCount Number 指定可以导出到缓存数据集或切片包的最大切片数。

operations Object 表示可以对服务执行的操作。 规范 supportsExportMap Boolean 指示服务是否可以生成图像。 supportsExportTiles Boolean 指示是否可以导出服务中的切片。 supportsIdentify Boolean 指示服务是否支持标识操作。 supportsQuery Boolean 指示是否可以查询子图层中的要素。 supportsTileMap Boolean 指示服务是否公开用于描述切片存在的切片地图。

copyright String

服务定义的版权文本。

customParameters Object

起始版本：GeoScene Maps SDK for JavaScript 4.18

自定义参数列表，其附加到图层获取的所有资源的 URL 中。它是一个具有键值对的对象，其中 value 是一个字符串。

示例

// send a custom parameter to your special service
let layer = new MapImageLayer({
  url: serviceUrl,
  customParameters: {
    "key": "my-special-key"
  }
});

datesInUnknownTimezone Booleanreadonly

起始版本：GeoScene Maps SDK for JavaScript 4.21

此属性由服务发布者设置，指示应在不使用本地时区的情况下考虑日期。这适用于请求和响应。

已知限制

• 此功能仅适用于使用 GeoScene Enterprise 3.0 或更高版本发布的服务。
• 标注和基于 Arcade 的 popupTemplates 不支持此属性。日期将以当地时区显示。
• 在查询、过滤器或图层中设置 timeExtent 时，必须按照 UTC 定义日期，如以下代码所示。
• 将 layer.timeInfo.fullTimeExtent 与 TimeSlider 结合使用时，必须移除本地时区偏移量。请参阅以下代码片段。

默认值：false

另请参阅

• GeoScene REST API - 3.0 中的新特性

• GeoScene Server 3.0 的新特性

• 编辑地图服务设置

示例

// Only download data for the year 2020.
// if the layer supports unknown time zone then create
// the dates in UTC
if (layer.datesInUnknownTimezone) {
  layer.timeExtent = new TimeExtent({
    start: new Date(Date.UTC(2020, 0, 1)),
    end: new Date(Date.UTC(2021, 0, 1))
  });
}
else {
  layer.timeExtent = new TimeExtent({
    start: new Date(2020, 0, 1),
    end: new Date(2021, 0, 1)
  });
}

// set up the timeslider for a service with an unknown timezone
if (layer.datesInUnknownTimezone) {
  const timeSlider = new TimeSlider({
    view: view,
    container: "timeSliderDiv",
    timeVisible: true,
  });
  view.ui.add(timeSlider, "bottom-left");

  view.whenLayerView(layer).then((layerView) => {
   // get the layer's fullTimeExtent and remove the local
   // time zone offset
    const timExtent = new TimeExtent({
      start: removeLocalOffset(layer.timeInfo.fullTimeExtent.start),
      end: removeLocalOffset(layer.timeInfo.fullTimeExtent.end)
    });

    timeSlider.fullTimeExtent = timExtent;
    timeSlider.stops = {
      interval: layer.timeInfo.interval;
    };
  });
}

// Remove the local time zone offset from dates
function removeLocalOffset(localTime) {
  return new Date(
    localTime.getUTCFullYear(),
    localTime.getUTCMonth(),
    localTime.getUTCDate(),
    localTime.getUTCHours(),
    localTime.getUTCMinutes(),
    localTime.getUTCSeconds(),
    localTime.getUTCMilliseconds()
  );
}

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

dpi Number

MapImageLayer 的每英寸输出点数 (DPI)。

默认值：96

effect Effectautocast

起始版本：GeoScene Maps SDK for JavaScript 4.18

Effect 提供了可在图层上执行的各种过滤函数，以实现类似于图像过滤工作方式的不同视觉效果。这种强大的功能允许您将 css filter-like 函数应用于图层以创建自定义视觉效果，以提高地图的制图质量。这是通过将所需效果作为字符串或对象数组应用到图层的 effect 属性以设置与比例相关的效果来完成的。

注

• 如果需要对满足或不符合指定过滤器要素应用不同的效果，可设置 featureEffect 属性。
• 如果全部应用以下四个属性，则将按以下顺序应用：featureEffect、effect、opacity 和 blendMode。

已知限制

• 3D SceneViews 中不支持该效果。
• 此效果不能应用于具有热点图渲染器的图层。
• 启用 cluster 类型为 featureReduction 的图层不支持此效果。
• 请参阅打印以了解已知的打印限制。

默认值：null

另请参阅

• featureEffect

• 关于如何设置效果的更多信息

• 图层和图层视图效果示例

示例

// the following effect will be applied to the layer at all scales
// brightness will be applied first, then hue-rotate followed by contrast
// changing order of the effects will change the final result
layer.effect = "brightness(5) hue-rotate(270deg) contrast(200%)";

// set a scale dependent bloom effect on the layer
layer.effect = [
  {
    scale: 36978595,
    value: "drop-shadow(3px, 3px, 4px)"
  },
  {
    scale: 18489297,
    value: "drop-shadow(2px, 2px, 3px)"
  },
  {
    scale: 4622324,
    value: "drop-shadow(1px, 1px, 2px)"
  }
];

fullExtent Extent

由地图服务定义的图层的完整范围。

示例

// zooms the view to the full extent of the layer
layer.when(function(){
  view.goTo(layer.fullExtent);
});

gdbVersion String

地图服务数据的地理数据库版本。

id String inherited

分配给图层的唯一 ID。如果不是开发人员设置的，它将在加载图层时自动生成。

imageFormat String

输出图像类型。

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

默认值：png24

imageMaxHeight Number

起始版本：GeoScene Maps SDK for JavaScript 4.3

表示服务导出的图片的最大高度。

默认值：2048

imageMaxWidth Number

起始版本：GeoScene Maps SDK for JavaScript 4.3

表示服务导出的图片的最大宽度。

默认值：2048

imageTransparency Boolean

表示服务导出的图片的背景是否透明。

默认值：true

legendEnabled Boolean

指示图层是否将包含在图例中。

默认值：true

listMode String inherited

指示图层在 LayerList 微件中的显示方式。下面列出了可能的值。

值	描述
show	图层在内容列表中可见。
hide	图层在内容列表中隐藏。
hide-children	如果图层是 GroupLayer、BuildingSceneLayer、KMLLayer、MapImageLayer、TileLayer 或 WMSLayer，则从内容列表中隐藏子图层。

可能值："show"|"hide"|"hide-children"

默认值："show"

loaded Booleanreadonly

指示图层的资源是否已加载。如果为 true，则可访问对象的所有属性。

默认值：false

loadError Errorreadonly inherited

如果加载时发生错误，则返回 Error 对象。

默认值：null

loadStatus Stringreadonly inherited

表示 load 操作的状态。

值	描述
not-loaded	对象的资源尚未加载。
loading	对象的资源当前正在加载。
loaded	对象的资源已加载且未出现错误。
failed	无法加载对象的资源。有关更多详情，请参阅 loadError。

可能值："not-loaded"|"loading"|"failed"|"loaded"

默认值：not-loaded

loadWarnings Object[]readonly inherited

加载时发生的警告列表。

maxScale Number

图层在视图中可见时的最大比例 (放至最大)。如果地图放大至超过此比例，则图层将不可见。值为 0 表示该图层没有最大比例。maxScale 值应始终小于 minScale 值，并且大于或等于服务规范。

默认值：0

示例

// The layer will not be visible when the view is zoomed in beyond a scale of 1:1,000
layer.maxScale = 1000;

// The layer's visibility is not restricted to a maximum scale.
layer.maxScale = 0;

minScale Number

图层在视图中可见时的最小比例 (缩至最小)。如果地图缩小到超过此比例，则图层将不可见。值为 0 表示该图层没有最小比例。minScale 值应始终大于 maxScale 值，并且小于或等于服务规范。

默认值：0

示例

// The layer will not be visible when the view is zoomed out beyond a scale of 1:3,000,000
layer.minScale = 3000000;

// The layer's visibility is not restricted to a minimum scale.
layer.minScale = 0;

opacity Number inherited

图层的不透明度。此值的范围在 1 和 0 之间，其中 0 是 100% 透明，而 1 为完全不透明。

默认值：1

示例

// Makes the layer 50% transparent
layer.opacity = 0.5;

portalItem PortalItem

从中加载图层的门户项目。这将加载图层以及保存到门户项目而不是地图服务的任何覆盖属性 (例如渲染器、定义表达式等)。

示例

let layer = new MapImageLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "caa9bd9da1f4487cb4989824053bb847"
  }
});

refreshInterval Number

起始版本：GeoScene Maps SDK for JavaScript 4.6

图层的刷新间隔，以分钟为单位。值 0 表示不刷新。

默认值：0

另请参阅

• refresh()

• refresh event

示例

// the layer will be refreshed every 6 seconds.
layer.refreshInterval = 0.1;

sourceJSON Object

起始版本：GeoScene Maps SDK for JavaScript 4.13

GeoScene REST API 公开的地图服务元数据 JSON。虽然最常用的属性直接在 MapImageLayer 类上公开，但此属性允许访问地图服务返回的所有信息。如果在使用较旧版本的 API 构建的应用程序中工作，该应用程序需要访问较新版本的地图服务属性，则此属性非常有用。

spatialReference SpatialReferencereadonly

由服务定义的图层的空间参考。

sublayers Collection<Sublayer>autocast

自动转换自 Object[]

Sublayer 对象的集合，可用于更改 MapImageLayer 的一个或多个子图层的属性。如果未指定此属性，则服务中的所有子图层都将按服务中定义的方式显示。如果将空数组传递给此属性，则服务中的任何子图层都不会显示在图层中。

所有子图层都按它们在视图中的绘制顺序 (从下到上) 进行引用。可以使用 Collection 方法添加、移除或重新排序它们。因为 Sublayer 扩展了 Accessor，因此可以监视其属性。

示例

// Only includes the first sublayer from the map service
let layer = new MapImageLayer({
  url: "https://sampleserver.geosceneonline.cn/geoscene/rest/services/sample/MapServer",
  sublayers: [{
    id: 0
  }]
});

// toggles the visibility of the first sublayer to false
layer.findSublayerById(0).visible = false;

// sublayers from the service are excluded from the layer
layer = new MapImageLayer({
  url: "https://sampleserver.geosceneonline.cn/geoscene/rest/services/sample/MapServer",
  sublayers: []
});

// Moves the cities sublayer from index 3 to index 0.
let citiesLayer = layer.sublayers.getItemAt(3);
layer.sublayers.reorder(citiesLayer, 0);

// Overrides the drawing info on the layer with a custom renderer
let citiesLayer = layer.sublayers.getItemAt(3);
citiesLayer.renderer = {
  type: "simple",  // autocasts as new SimpleRenderer()
  symbol: {
    type: "simple-marker",  // autocasts as new SimpleMarkerSymbol()
    color: "blue",
    size: 3
  }
};

timeExtent TimeExtentautocast

起始版本：GeoScene Maps SDK for JavaScript 4.14

图层的时间范围。当图层的 useViewTime 为 false 时，图层指示视图根据此时间范围显示图层中的数据。如果 useViewTime 为 true，并且设置了图层和视图时间范围，则将显示位于视图和图层时间范围的相交范围内的要素。例如，如果图层的时间范围设置为显示 1970 年至 1975 年间的要素，并且视图的时间范围设置为 1972-1980，则要素图层的有效时间为 1972-1975。

默认值：null

示例

if (!layer.useViewTime) {
  if (layer.timeExtent) {
    console.log("Current timeExtent:", layer.timeExtent.start, " - ", layer.timeExtent.end}
  } else {
    console.log("The layer will display data within the view's timeExtent.");
    console.log("Current view.timeExtent:", view.timeExtent.start, " - ", view.timeExtent.end}
  }
}

// set the timeExtent on the layer and useViewTime false
// In this case, the layer will honor its timeExtent and ignore
// the view's timeExtent
const layer = new ImageryLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ScientificData/SeaTemperature/ImageServer",
  timeExtent: {
    start: new Date(2014, 4, 18),
    end: new Date(2014, 4, 19)
  },
  useViewTime: false
});

// timeExtent is set on the layer and the view
// In this case, the layer will display features that fall
// within the intersection of view and layer time extents
// features within Jan 1, 1976 - Jan 1, 1981 will be displayed
const view = new MapView({
  timeExtent: {
    start: new Date(1976, 0, 1),
    end: new Date(2002, 0, 1)
  }
});
const layer = new FeatureLayer({
  url: myUrl,
  timeExtent: {
    start: new Date(1974, 0, 1),
    end: new Date(1981, 0, 1)
  }
});

timeInfo TimeInfoautocast

起始版本：GeoScene Maps SDK for JavaScript 4.11

TimeInfo 可提供日期字段等信息，用于存储每个要素的开始和结束时间以及图层的 fullTimeExtent。timeInfo 属性及其 startField 和 endField 属性必须在图层初始化时进行设置，如果它是为 CSVLayer、GeoJSONLayer 或从客户端要素初始化的 FeatureLayer 设置的。timeInfo 的 fullTimeExtent 是根据其 startField 和 endField 属性自动计算的。加载图层后无法更改 timeInfo 参数。

默认值：null

示例

// create geojson layer from usgs earthquakes geojson feed
const geojsonLayer = new GeoJSONLayer({
  url: "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_month.geojson",
  copyright: "USGS Earthquakes",
  fields: [
    { "name": "mag", "type": "double" },
    { "name": "place", "type": "string" },
    { "name": "time", "type": "date" }, // date field
    { "name": "depth", "type": "double" }
  ],
  // timeInfo can be used to do temporal queries
  // set the startField and endField.
  // timeExtent is automatically calculated from the
  // the start and end date fields
  // The date values must be in milliseconds number from the UNIX epoch specified in UTC.
  timeInfo: {
    startField: "time"
  }
});

timeOffset TimeIntervalautocast

起始版本：GeoScene Maps SDK for JavaScript 4.14

基于特定 TimeInterval 的时间数据的临时偏移。这允许用户叠加两个或多个具有不同时间范围的时间感知型图层中的要素。例如，如果图层具有记录了 1970 年的数据，则 2 年的偏移值会暂时将数据移动到 1972 年。然后，您可将此数据与 1972 年记录的数据相叠加。时间偏移只能用于显示目的。查询和选择不受偏移量的影响。

默认值：null

示例

// Offset a CSV Layer containing hurricanes from 2015 so that they appear in 2019 (+4 years).
let layer = new CSVLayer({
  url: `hurricanes-and-storms-2015.csv`,
  timeOffset: {
    value: 4,
    unit: "years"
  },
  timeInfo: {
    startField: "ISO_time"
  },
  renderer: {
    type: "simple",
    symbol: {
      type: "simple-marker",
      size: 6,
      color: "red",
      outline: {
        width: 0.5,
        color: "black"
      }
    }
  }
});

title String

用于在某些地方标识它的图层标题，例如在 Legend 和 LayerList 微件中。

通过服务 url 加载图层时，标题派生自服务名称。子图层的标题将与服务中子图层的名称相同。从门户项目加载图层时，将使用门户项目的标题。最后，如果图层作为 webmap 或 webscene 的一部分加载，则将使用存储在 webmap/webscene 中的图层标题。

type Stringreadonly

对于 MapImageLayer，类型总是 "map-image"。

url String

地图服务的 REST 端点的 URL。

示例

// Layer from Map Service on GeoScene Server
layer.url = "http://sampleserver6.arcgisonline.com/geoscene/rest/services/Census/MapServer";

useViewTime Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.14

确定图层是否将基于视图的 timeExtent 更新其时态数据。当为 false 时，无论视图是否发生更改，图层都将根据图层的 timeExtent 显示其时态数据。此属性为 true 时，如果设置了视图和图层时间范围，则将显示位于视图和图层时间范围交集内的要素。例如，如果图层的时间范围设置为显示 1970 年至 1975 年间的要素，并且视图的时间范围设置为 1972-1980，则要素图层的有效时间为 1972-1975。

默认值：true

示例

if (featureLayer.useViewTime) {
  console.log("Displaying data between:", view.timeExtent.start, " - ", view.timeExtent.end);
}

version Numberreadonly

在其中发布地图服务的 GeoScene Server 版本。

示例

// Prints the version number to the console, e.g. 10.2, 10.3, 10.41.
console.log(layer.version);

visible Boolean inherited

指示图层在 View 中是否可见。当为 false 时，图层仍可能添加到视图引用的 Map 实例中，但其要素将在视图中不可见。

默认值：true

示例

// The layer is no longer visible in the view
layer.visible = false;

方法概述

方法详细说明

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

cancelLoad()inherited

如果 load() 操作已在进行中，则取消它。

createExportImageParameters(extent, width, height, options){Object}

获取调用导出 REST 操作时要使用的导出图像的参数。

参数

规范

extent Extent 导出图像的范围

width Number 导出图像的宽度

height Number 导出图像的高度

options Object optional 参数选项是具有以下属性的对象。 规范 rotation Number optional 导出图像的旋转度数。从 GeoScene Server 1.3 开始可用。 pixelRatio Number optional 应用于导出图像 dpi 的像素比率。 timeExtent TimeExtent optional 要渲染内容的时刻或时间范围。

返回

类型	描述
Object	导出图像的参数。使用此对象以对地图服务调用导出 REST 操作。

createLayerView(view, options){Promise<LayerView>}inherited

将图层添加到 Map.layers 集合并且必须为其创建图层视图时，由视图调用，例如 MapView 和 SceneView。此方法在内部使用，没有直接调用它的用例。

参数

view * 父视图。

options Object optional 指定附加选项的对象。有关此对象所需的属性，请参阅下面的对象规范表。 规范 signal AbortSignal optional 中止 layerview 创建的信号。

返回

类型	描述
Promise<LayerView>	使用 LayerView 实例解析。

createServiceSublayers(){Collection<Sublayer>}

返回由服务定义的地图服务的子图层的深层克隆。对于开发人员不熟悉服务子图层，并需要“重置”图层的子图层以匹配服务定义的子图层的情况，这很有用。

返回

类型	描述
Collection<Sublayer>	由地图服务定义的子图层的集合。

示例

Layer.fromPortalItem({
  portalItem: {
    portalId: "dbb9b48477444015912061b182f196b9"
  }
}).then(function(layer){
  let serviceSublayers = layer.createServiceSublayers();
  layer.sublayers = serviceSublayers;
});

destroy()inherited

起始版本：GeoScene Maps SDK for JavaScript 4.17

销毁图层和任何相关资源 (包括其 portalItem，如果它是图层上的属性)。一旦图层被破坏，则无法再使用。

被破坏的图层将从其父对象中移除，例如 Map、WebMap、WebScene、Basemap、Ground 或 GroupLayer。

另请参阅

• Map.destroy()
• WebMap.destroy()
• WebScene.destroy()
• Basemap.destroy()
• Ground.destroy()
• PortalItem.destroy()

emit(type, event){Boolean}inherited

起始版本：GeoScene Maps SDK for JavaScript 4.5

在实例上触发事件。仅当创建此类的子类时，才应使用此方法。

参数

type String 事件的名称。

event Object optional 事件有效负载。

返回

类型	描述
Boolean	如果监听器收到通知，则为true

fetchAttributionData(){Promise<object>}inherited

在图层可用时，获取图层的自定义属性数据。

返回

类型	描述
Promise<Object>	解析为包含图层自定义属性数据的对象。

fetchImage(extent, width, height, options){Promise<HTMLImageElement>}

此方法可获取指定范围和大小的图像。

参数

规范

extent Extent 视图的范围。

width Number 视图的宽度，以像素为单位。

height Number 视图的高度，以像素为单位。

options Object optional 参数选项是具有以下属性的对象。 规范 rotation Number optional 导出图像的旋转度数。从 GeoScene Server 1.3 开始可用。 pixelRatio Number optional 以图像的物理像素为单位的分辨率与图像显示的分辨率之比。 timeExtent TimeExtent optional 要渲染内容的时刻或时间范围。 signal AbortSignal optional 中止请求的 AbortSignal。如果取消，则承诺将被拒绝，并返回一个名为 AbortError 的错误。另请参见 AbortController。

返回

类型	描述
Promise<HTMLImageElement>	返回解析为 HTMLImageElement 的承诺。

示例

// Fetch an image for the layer from the server for a given extent, height, width.
layer.when(function(){
  layer.fetchImage(view.extent, view.width, view.height).then(function(result){
    imageDiv.appendChild(result);
  });
});

findSublayerById(id){Sublayer}

返回具有给定 layerId 的子图层。

参数

id Number 子图层的 id。

返回

类型	描述
Sublayer	返回给定图层 ID 的子图层。

示例

// returns the sublayer with a layerId of 0
let sublayer0 = layer.findSublayerById(0);

hasEventListener(type){Boolean}inherited

指示实例上是否存在与提供的事件名称相匹配的事件监听器。

参数

type String 事件的名称。

返回

类型	描述
Boolean	如果类支持输入事件，则返回 true。

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

isFulfilled(){Boolean}inherited

isFulfilled() 可用于验证创建类的实例是否已完成 (已解决或已拒绝)。如果满足，则返回 true。

返回

类型	描述
Boolean	指示创建类的实例是否已完成 (已解决或已拒绝)。

isRejected(){Boolean}inherited

isRejected() 可用于验证创建类的实例是否被拒绝。如果被拒绝，则返回 true。

返回

类型	描述
Boolean	指示创建类的实例是否已被拒绝。

isResolved(){Boolean}inherited

isResolved() 可用于验证创建类的实例是否已解决。如果已解决，则返回 true。

返回

类型	描述
Boolean	指示创建类的实例是否已解决。

load(signal){Promise}inherited

加载此类引用的资源。如果视图是使用地图实例构造的，则此方法会自动为 View 及其在 Map 中引用的所有资源执行。

开发人员在访问不会在 View 中加载的资源时，必须调用此方法。

load() 方法仅在第一次调用时触发资源的加载。随后的调用将返回相同的 promise。

可以提供一个 signal 来停止对 Loadable 实例加载状态感兴趣。当信号中止时，实例不会停止其加载过程，只有 cancelLoad 可以中止它。

参数

signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise	资源已加载时解析。

loadAll(){Promise<Sublayer>}

起始版本：GeoScene Maps SDK for JavaScript 4.15

加载所有子图层。查看 loaded 或 loadStatus 属性以检查状态。

返回

类型	描述
Promise<Sublayer>	当所有可加载资源都已加载时解析。如果至少有一个可加载资源未能加载，则拒绝。

另请参阅

• load

示例

// Load all resources but ignore if one or more of them failed to load
mapImageLayer.loadAll()
  .catch(function(error) {
    // Ignore any failed resources
  })
  .then(function() {
    console.log("All loaded");
  });

on(type, listener){Object}inherited

在实例上注册事件处理程序。调用此方法将事件与监听器挂钩。

参数

type String|String[] 要侦听的事件或者事件数组。

listener Function 事件触发时要调用的函数。

返回

类型	描述
Object	返回具有 remove() 方法的事件处理程序，可调用该方法来停止侦听事件。 属性 类型 描述 remove Function 调用时，从事件中移除侦听器。

示例

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

refresh()

起始版本：GeoScene Maps SDK for JavaScript 4.6

获取图层的所有数据。

另请参阅

• refreshInterval

• refresh event

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

when(callback, errback){Promise}inherited

起始版本：GeoScene Maps SDK for JavaScript 4.6

一旦创建了类的实例，就可以使用when() 。此方法接受两个输入参数：callback 函数和 errback 函数。callback 在类的实例加载时执行。errback 在类的实例无法加载时执行。

参数

callback Function optional 当 promise 解决时调用的函数。

errback Function optional 当 promise 失败时执行的函数。

返回

类型	描述
Promise	返回 callback 结果的新承诺，可用于链接其他函数。

示例

// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

事件概述

事件详细说明

layerview-createinherited

创建图层的 LayerView 并在视图中呈现后触发。

属性

view View 在其中创建 layerView 的视图。

layerView LayerView 在表示 layer 中图层的视图中进行渲染的 LayerView。

另请参阅

• View.whenLayerView()

示例

// This function will fire each time a layer view is created for this
// particular view.
layer.on("layerview-create", function(event){
  // The LayerView for the layer that emitted this event
  event.layerView;
});

layerview-create-errorinherited

将图层添加到地图后，在创建 LayerView 期间出现错误时触发。

属性

view View 为图层创建 layerview 失败触发此事件的视图。

error Error 描述图层视图创建失败原因的错误对象。

另请参阅

• View.whenLayerView()

示例

// This function fires when an error occurs during the creation of the layer's layerview
layer.on("layerview-create-error", function(event) {
  console.error("LayerView failed to create for layer with the id: ", layer.id, " in this view: ", event.view);
});

layerview-destroyinherited

销毁图层的 LayerView 并不再在视图中呈现后触发。

属性

view View 在其中销毁 layerView 的视图。

layerView LayerView 被销毁的表示图层的 LayerView。

refresh

起始版本：GeoScene Maps SDK for JavaScript 4.21

如果图层设置了 refreshInterval 或调用了 refresh() 方法时触发。事件有效负载指示图层的数据是否已更改。

属性

dataChanged Boolean 指示图层的数据是否已更改。

另请参阅

• refreshInterval

• refresh()

示例

// listen to layer's refresh event to fetch the attachments
// for the updated features.
layer.on("refresh", function(event){
  if (event.dataChanged){
    const query = layer.createQuery();
    layer.queryObjectIds(query).then(function (objectIds) {
      let attachmentQuery = {
        objectIds: objectIds,
        definitionExpression: layer.definitionExpression,
        attachmentTypes: ["image/jpeg"]
      };
      layer.queryAttachments(attachmentQuery).then(function (attachments) {
        attachmentQuery.objectIds.forEach(function (objectId) {
          if (attachments[objectId]) {
            // process the updated attachments
            let attachment = attachments[objectId];
          }
        });
      })
      .catch(function (error) {
        console.log("attachment query error", error);
      });
    });
  }
});