BaseTileLayer

let MyCustomTileLayer = BaseTileLayer.createSubclass({
    // 自定义切片图层的属性
    properties: {
      urlTemplate: null,
    },

   // 覆盖 getTileUrl()
   // 为给定的级别、行和列生成切片 url
   getTileUrl: function (level, row, col) {
     return this.urlTemplate.replace("{z}", level).replace("{x}", col).replace("{y}", row);
   }
});

// 覆盖 fetchTile() 方法来处理从服务器返回的数据。
 fetchTile: function (level, row, col, options) {
   // 调用 getTileUrl 方法为给定级别、行和列的图像构造 Url
   let url = this.getTileUrl(level, row, col);

   // 根据 getTileUrl() 方法返回的 url 请求切片。
   // 信号options确保过时的请求被中止。
   return geosceneRequest(url, {
     responseType: "image",
     signal: options && options.signal
   })
   .then(function (response) {
     // 当 geosceneRequest 解析成功时，处理返回的图片
     let image = response.data;
     let width = this.tileInfo.size[0];
     let height = this.tileInfo.size[0];

     // 创建一个带有填充矩形的画布
     let canvas = document.createElement("canvas");
     let context = canvas.getContext("2d");
     canvas.width = width;
     canvas.height = height;

     // 将图层提供的颜色应用于填充矩形
     if (this.tint) {
       context.fillStyle = this.tint.toCss();
       context.fillRect(0, 0, width, height);
       // 将多重混合模式应用于画布的填充颜色和从服务器返回的切片以使切片变暗
       context.globalCompositeOperation = "multiply";
     }
     context.drawImage(image, 0, 0, width, height);
     return canvas;
   }.bind(this));
}

// 覆盖加载方法
load: function () {
 // multiply 属性是 GeoScene 缓存地图服务的数组
 this.multiply.forEach(function (layer) {
   // 循环遍历每个切片图层并在每个图层上调用加载方法
   let promise = layer.load();

   // 将每个 load() 方法的 promise 添加到 addResolvingPromise()
   // 自定义 tile 层将在每个 promise 被解析时加载
   this.addResolvingPromise(promise);
 }, this);
}

属性列表

属性详细说明

blendMode String

起始版本: GeoScene API for JavaScript 4.22

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

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

群组图层中的图层将与地图的其余部分隔离地混合在一起。

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

已知限制

• 混合模式在 3D场景视图 中不受支持。
• 图例中不支持混合模式。
• 有关已知的打印限制，请参阅打印。

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

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

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

淡化混合模式：

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

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

混合模式	描述
lighten	比较顶层和背景层并保留较浅的颜色。 如果顶层中的颜色比背景层中的重叠颜色更暗，则顶层中的颜色将变为透明，从而使背景层完全显示出来。 可以认为是darken混合模式的反面。
lighter	顶层和背景层的颜色乘以它们的 alphas（层 opacity 和层的 数据不透明度 。然后将生成的颜色相加。所有重叠的中间颜色在顶层变亮。图层和图层数据的不透明度会影响混合结果。
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 混合模式根据背景图层的颜色使灰色缓冲多边形变暗或变亮当人口普查区域层发光时。

Normal blend mode	Overlay blend mode

混合模式	描述
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 混合模式可用于显示重点区域，例如地震、动物迁徙或点源污染，通过显示底层地图，提供现象的鸟瞰图.

以下屏幕截图按照它们在视图中的绘制顺序分别在左侧显示了要素和图像图层。包含土地覆盖分类栅格的影像图层。要素图层包含 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"

默认值:normal

示例:

• 图层混合示例
  

declaredClass Stringreadonly inherited

起始版本: GeoScene API for JavaScript 4.22

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

effect Effectautocast

起始版本: GeoScene API for JavaScript 4.22

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

提示

• 如果需要应用满足或未通过指定过滤器的不同效果，请设置featureEffect属性。
• 如果应用了以下所有四个属性，则将按以下顺序应用它们：featureEffect ，效果，不透明度和混合模式。
  

已知限制

• 3D SceneViews中不支持该效果。
• 该效果无法应用于具有热图渲染器的图层。
• 启用了  cluster 类型的 featureReduction 的图层不支持该效果。
• 有关已知的打印限制，请参阅打印。

默认值:null

示例:

• featureEffect

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

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

示例代码:

// 以下效果将应用于所有比例的图层
// 亮度将首先应用，然后色调旋转，然后是对比度改变效果的顺序将改变最终结果
layer.effect = "brightness(5) hue-rotate(270deg) contrast(200%)";

// 在图层上设置与比例有关的绽放效果
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 Extentautocast inherited

图层的全图范围。默认情况下，这是全球性的。此属性可用于将视图的范围设置为与图层的范围匹配，以便其要素显示为填充视图。请参阅下面的示例代码段。

示例代码:

// 图层加载后，将视图的范围设置为图层的全范围
layer.when(function(){
  view.extent = layer.fullExtent;
});

id String inherited

分配给图层的唯一 ID。 如果没有开发者设置，则在图层加载时自动生成。

listMode String inherited

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

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

可选值:"show"|"hide"|"hide-children"

默认值:show

loaded Booleanreadonly inherited

指示层的资源是否已加载。当 true时，可以访问对象的所有属性。

默认值:false

loadError Errorreadonly inherited

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

默认值:null

loadStatus Stringreadonly inherited

表示加载操作的状态。

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

可选值:"not-loaded"|"loading"|"failed"|"loaded"

默认值:not-loaded

loadWarnings Object[]readonly inherited

加载时发生的警告列表。

maxScale Number

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

默认值:0

示例代码:

// 当视图放大到超过 1:1,000 的比例时，图层将不可见
layer.maxScale = 1000;

// 图层的可见性不限于最大比例。
layer.maxScale = 0;

minScale Number

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

默认值:0

示例代码:

// 当视图缩小到超过 1:3,000,000 的比例时，图层将不可见。
layer.minScale = 3000000;

// 图层的可见性不限于最小比例。
layer.minScale = 0;

opacity Number inherited

图层的不透明度。 该值的范围可以在 1 和 0 之间，其中 0 表示 100% 透明，1 表示完全不透明。

默认值:1

示例代码:

// 使图层 50% 透明
layer.opacity = 0.5;

refreshInterval Number

起始版本: GeoScene API for JavaScript 4.22

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

默认值:0

示例:

• refresh()

• refresh 事件

示例代码:

// 该图层将每 6 秒刷新一次。
layer.refreshInterval = 0.1;

spatialReference SpatialReferenceautocast

图层的空间参考。

默认值:SpatialReference.WebMercator

tileInfo TileInfoautocast

图层的切片方案信息。

title String inherited

图层的标题，用于在图层列表微件等位置对其进行标识。

如果从门户项目加载图层，则将使用门户项目的标题。如果图层作为 web 地图或 web 场景的一部分加载，则将使用存储在 webmap/web 场景中的图层标题。

type Stringreadonly

对于BaseTileLayer，类型为 base-tile.

可选值:"base-tile"|"bing-maps"

visible Boolean inherited

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

默认值:true

示例代码:

// 该图层在视图中不可见
layer.visible = false;

方法列表

方法详细说明

addResolvingPromise(promiseToLoad){Promise}

向图层的可加载链添加承诺。这通常用于 load() 方法中，以确保在此图层解析和加载之前加载图层运行所需的所有可加载资源。

参数:

promiseToLoad Promise 一个必须为要解析的图层解析并且改变 loading 状态 到 loaded 的 promise。

返回值:

类型	描述
Promise	promise

示例:

• 示例 - 自定义混合图层
  

示例代码:

// The requiredLayer 必须在 MyCustomTileLayer 解析并移至“已加载”状态之前 load()。
let MyCustomTileLayer = BaseTileLayer.createSubclass({
  load: function() {
    let promise = this.requiredLayer.load();
    this.addResolvingPromise(promise);
  }
});

cancelLoad()inherited

取消 load() 操作（如果该操作已在进行中）。

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

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

参数:

view * 父视图。

options Object 可选 指定其他选项的对象。有关此对象的必需属性，请参阅下面的对象规范表。 规范: signal AbortSignal 可选 中止图层视图创建的信号。

返回值:

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

示例:

• 示例 - 自定义 WebGL 图层视图
  

destroy()inherited

起始版本: GeoScene API for JavaScript 4.22

销毁图层和任何关联的资源（包括其门户项，如果它是图层上的属性）。该图层一旦被销毁，便无法再使用。

被销毁的图层将从其父对象（如地图、 Web 地图、 WebScene、底图、地面或群组图层） 中移除。

示例:

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

emit(type, event){Boolean}inherited

起始版本: GeoScene API for JavaScript 4.22

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

参数:

type String 事件名称

event Object 可选 事件有效加载。

返回值:

类型	描述
Boolean	true 如果收到通知

fetchAttributionData(){Promise<Object>}inherited

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

返回值:

类型	描述
Promise<Object>	在图层可用时获取图层的自定义归因数据。

fetchTile(level, row, col, options){Promise<(HTMLImageElement|HTMLCanvasElement)>}

此方法为视图中存在的给定级别、行和列提取切片。如果从服务器返回的数据或图像需要先进行处理，则在显示之前需要重写此方法。

参数:

level Number 要获取的切片的详细级别。此值由 LayerView  提供。

row Number 切片提取的行 （y） 位置。此值由 LayerView 提供。

col Number 要获取的切片的列 （x） 位置。此值由 LayerView 提供。

options Object 可选 切片请求的可选设置。这些选项具有以下属性。 规范: signal AbortSignal 可选 中止请求的 AbortSignal 。 覆盖 fetchTile 时，应处理signal ，例如通过将其传递给 request 或中止挂起的操作。 对 fetchTile 的中止调用应该以 Error实例拒绝其返回的 Promise。

返回值:

类型	描述
Promise<(HTMLImageElement|HTMLCanvasElement)>	返回解析为 HTMLImageElement 或 HTMLCanvasElement 的 promise。

示例:

• 示例 - 自定义混合图层
  

• 示例 - 自定义 LERC 图层
  

示例代码:

// 在显示之前处理从服务器返回的图像。
fetchTile: function (level, row, col, options) {
  // 调用 getTileUrl 方法为给定级别、行和列构造图像的 URL
  let url = this.getTileUrl(level, row, col);

  // 根据生成的 url 请求切片。
  // 信号选项确保过时的请求被中止。
  return geosceneRequest(url, {
    responseType: "image",
    signal: options && options.signal
  })
  .then(function (response) {
    // 从响应中获取图像
    let image = response.data;
    let width = this.tileInfo.size[0];
    let height = this.tileInfo.size[0];

    let canvas = document.createElement("canvas");
    canvas.width = width;
    canvas.height = height;
    let context = canvas.getContext("2d");

    // tint 是该层的自定义属性
    // 将应用程序提供的 tint 颜色应用到画布上
    if (this.tint) {
      context.fillStyle = this.tint.toCss();
      context.fillRect(0, 0, width, height);

      // 顶层的像素与底层的相应像素相乘。 结果是一张更暗的照片。
      context.globalCompositeOperation = "multiply";
    }
    context.drawImage(image, 0, 0, width, height);
    return canvas;
  }.bind(this));
}

getTileBounds(level, row, column, out){Number[]}

将切片的边界作为四个数字的数组返回，这些数字可轻松转换为Extent对象。下表描述了数组中每个项的值：

索引	值
0	最小 x 值
1	最小 y 值
2	最大 x 值
3	最大 y 值

参数:

level Number 切片的详细级别 （LOD）。

row Number 切片在数据集中的行 （y） 位置。

column Number 切片列 （x） 在数据集中的位置。

out Number[] 可选 用于存储切片边界或范围的数组。

返回值:

类型	描述
Number[]	返回表示切片边界或范围的数组。

getTileUrl(level, row, col){String}

此方法返回给定级别、行和列的图像的 URL。重写此方法以基于用户交互构造图像的 URL。

参数:

level Number 详细程度。此值由 LayerView 提供。

row Number 切片行。此值由 LayerView 提供。

col Number 切片列。此值由 LayerView 提供。

返回值:

类型	描述
String	返回切片图像的 URL。

示例代码:

// 为给定的级别、行和列生成切片 url
getTileUrl: function (level, row, col) {
  // urlTemplate 是自定义层的属性。
  // value 由应用程序提供
  return this.urlTemplate.replace("{z}", level).replace("{x}", col).replace("{y}", row);
},

hasEventListener(type){Boolean}inherited

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

参数:

type String 事件名称

返回值:

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

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 可选 可用于中止异步任务的信号对象。 当发出中止信号时，返回的 Promise 将被一个名为  AbortError  的 Error 拒绝。 另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回值:

类型	描述
Promise	资源 loaded 时解析。

on(type, listener){Object}inherited

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

参数:

type String|String[] 要监听的event 或者事件数组

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

返回值:

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

示例代码:

view.on("click", function(event){
  // event是事件触发后返回的事件句柄。
  console.log(event.mapPoint);
});

refresh()

起始版本: GeoScene API for JavaScript 4.22

提取图层的所有数据。

示例:

• refreshInterval

• refresh 事件

when(callback, errback){Promise}inherited

起始版本: GeoScene API for JavaScript 4.22

when() 创建类的实例后，会被执行一次。该方法接受两个参数： callback 函数和 errback 函数。 callback 在类的实例加载时执行。 如果类的实例无法加载，则执行 errback。

参数:

callback Function optional 当 Promise 成功时，该函数将被调用。

errback Function optional 当 Promise 失败时，该函数将被调用。

返回值:

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

示例代码:

// 尽管此示例使用 MapView，但任何作为 Promise 的类实例都可以以相同的方式使用 when()
let view = new MapView();
view.when(function(){
  // 当 Promise resolved 时，函数将被执行
}, function(error){
  // 当 Promise 通过 rejected 抛错时，这个函数将被执行
});

事件概述

{view: View,layerView: LayerView}

{view: View,error: Error}

{view: View,layerView: LayerView}

{dataChanged: Boolean}

Event Details

layerview-createinherited

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

属性：

view View 创建 layerView 的视图。

layerView LayerView 在视图中渲染的 LayerView 图层

示例:

• View.whenLayerView()

示例代码:

// 每次为此特定视图创建图层视图时，都会触发此函数。
layer.on("layerview-create", function(event){
  // 每次为此特定视图创建图层视图时，都会触发此函数。
  event.layerView;
});

layerview-create-errorinherited

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

属性:

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

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

示例:

• View.whenLayerView()

示例代码:

// 在创建图层的图层视图期间发生错误时会触发此函数
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 API for JavaScript 4.22

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

Property:

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

示例:

• refreshInterval

• refresh()

示例代码:

// 侦听图层的刷新事件以获取更新要素的附件。
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]) {
            // 处理更新的附件
            let attachment = attachments[objectId];
          }
        });
      })
      .catch(function (error) {
        console.log("attachment query error", error);
      });
    });
  }
});