PointCloudLayer

let pointCloudLayer = new PointCloudLayer({
  url: "https://tiles.arcgis.com/tiles/V6ZHFr6zdgNZuVG0/arcgis/rest/services/BARNEGAT_BAY_LiDAR_UTM/SceneServer"
});

属性概述

属性详细信息

apiKey String

起始版本：GeoScene Maps SDK for JavaScript 4.20

用于访问资源或服务的授权字符串。API 秘钥可在 GeoScene Developer 仪表盘中生成和管理。API 密钥显式绑定到 GeoScene 帐户；它还用于监视服务的使用情况。在特定类上设置细粒度 API 秘钥将覆盖全局 API 秘钥。

示例

// set the api key to access a protected service
const layer = new FeatureLayer({
  url: serviceUrl,
  apiKey: "YOUR_API_KEY"
});

copyright String

场景服务定义的版权文本。

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

elevationInfo Object

起始版本：GeoScene Maps SDK for JavaScript 4.4

指定点在垂直轴 (z) 上的放置方式。此属性仅在使用 absolute-height 模式时影响 PointCloudLayers。

属性

mode String 定义点在垂直轴 (z) 上的放置方式。目前仅支持 absolute-height 模式。 模式 描述 absolute-height 点放置在海平面以上的绝对高程 (z 值) 处。此 z 值是通过将 offset 值和点的 z 值相加来确定的。它没有考虑地形的高度。这是 PointCloudLayer 唯一支持的高程模式。

offset Number optional 默认值：0 高程偏移，将其添加到每个点的垂直位置。

unit String optional 默认值：meters offset 值的单位。 可能值："feet"|"meters"|"kilometers"|"miles"|"us-feet"|"yards"

fields Field[]

图层中可访问的字段数组。下表更详细地描述了 PointCloudLayers 的最常见字段：

名称	说明
ELEVATION	有关详细信息，请查看 LAS 规范。
INTENSITY	有关详细信息，请查看 LAS 规范。
CLASS_CODE	使用 PointCloudLayer.queryCachedStatistics 获取带有类标注的列表。
RGB	单个 RGB 通道 (uint8) 被打包为单个 uint32 值中。请参阅解码示例。
RETURNS	位 0-5 表示一个或多个返回数。请参阅解码示例。
FLAGS	有关详细信息，请查看 LAS 规范。

示例

// decode the rgb value with Arcade:
var rgb = $feature.RGB;
var red = Floor(rgb/65536,0);
var green = Floor((rgb-(red*65536))/256,0);
var blue = rgb-(red*65536)-(green*256);
return "rgb(" + red + "," + green + "," + blue + ")";

// decode the returns value with Arcade:
var returnnumber = $feature.RETURNS % 16;
var numberofreturns = Floor($feature.RETURNS / 16)
return returnnumber + " / " + numberofreturns;

fieldsIndex FieldsIndexreadonly

起始版本：GeoScene Maps SDK for JavaScript 4.13

便捷属性，可用于按字段名称对字段进行不区分大小写的查找。它还可以提供图层中日期字段的列表。

示例

// lookup a field by name. name is case-insensitive
const field = layer.fieldsIndex.get("SoMeFiEld");

if (field) {
  console.log(field.name); // SomeField
}

filters Array<(PointCloudValueFilter|PointCloudReturnFilter)>

起始版本：GeoScene Maps SDK for JavaScript 4.10

用于过滤点的 pointCloudFilters 数组。只有满足所有过滤器的点才会显示在视图中。可以设置两种类型的过滤器：PointCloudValueFilter 根据分类值过滤点，PointCloudReturnFilter 根据返回值过滤点。

示例

// filter out points that don't belong to ground or building
const pcLayer = new PointCloudLayer({
  ...,
  filters: [{
    type: "value",
    field: "CLASS_CODE",
    mode: "include",
    // values include ground(2) and building(6)
    values: [2, 6]
  }]
});

fullExtent Extentautocast inherited

图层的完整范围。默认情况下，这是全球范围的。可使用此属性设置视图的范围以匹配图层的范围，以便其要素出现在视图中。请参阅以下示例片段。

示例

// Once the layer loads, set the view's extent to the layer's fullextent
layer.when(function(){
  view.extent = layer.fullExtent;
});

id String inherited

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

layerId Number

场景服务图层的图层 ID 或图层索引。在从包含多个图层的服务加载具有 portalItem 属性的单个图层时，这特别有用。您可以在以下两种情况之一中指定此值：

• 通过 portalItem 属性加载图层时。
• 将图层 url 直接指向场景服务时。

如果上述任一场景中均未指定 layerId，则选择服务中的第一个图层 (layerId = 0)。

示例

// while these examples use a SceneLayer, the same pattern can be
// used for other layers that may be loaded from portalItem ids

// loads the third layer in the given Portal Item
let layer = new SceneLayer({
  portalItem: {
    id: "73df987984b24094b848d580eb83b0fb"
  },
  layerId: 2
});

// If not specified, the first layer (layerId: 0) will be returned
let layer = new SceneLayer({
  portalItem: {
    id: "73df987984b24094b848d580eb83b0fb"
  }
});

// Can also be used if URL points to service and not layer
let layer = new SceneLayer({
  url: "https://scenesampleserverdev.arcgis.com/geoscene/rest/services/Hosted/DevA_Trees/SceneServer",
  layerId: 0  // Notice that the url doesn't end with /2
});

// This code returns the same layer as the previous snippet
let layer = new SceneLayer({
  url: "https://scenesampleserverdev.arcgis.com/geoscene/rest/services/Hosted/DevA_Trees/SceneServer/layers/0",
  // The layer id is specified in the URL
});

legendEnabled Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.5

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

默认值：true

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

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

outFields String[]

要包含在每个要素中的字段名称数组。要从图层的所有字段中获取值，请使用 ["*"]。outFields 中指定的字段将与 rendering 和 filtering 所需的字段一起被请求。必填字段和 outFields 用于填充 PointCloudLayerView.availableFields。

默认值：null

另请参阅

• PointCloudLayerView.availableFields
• fieldUtils

示例

// Includes all fields from the service in the layer
pcl.outFields = ["*"];

// Get the specified fields from the service in the layer
// These fields will be added to FeatureLayerView.availableFields
// along with rendering and labeling fields. Use these fields
// for client-side filtering and querying.
pcl.outFields = ["ELEVATION", "RGB", "CLASS_CODE];

popupEnabled Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.13

指示单击图层中的点时是否显示弹出窗口。该图层需要具有一个 popupTemplate，以定义应在弹出窗口中显示哪些信息。或者，如果 Popup.defaultPopupTemplateEnabled 设置为 true 时，则可自动使用默认弹出模板。

默认值：true

另请参阅

• createPopupTemplate

• View

popupTemplate PopupTemplateautocast

起始版本：GeoScene Maps SDK for JavaScript 4.13

图层的弹出模板。在图层上设置时，popupTemplate 允许用户在使用文本和/或图表选择要素时访问属性并在视图的弹出窗口中显示其值。有关最常见的属性信息，请参阅 PointCloudLayer.fields。有关 PopupTemplate 如何与 FeatureLayer 交互的例子，请参阅 PopupTemplate sample。在此图层类型上设置 PopupTemplate 的方式与 FeatureLayer 相同。

当 Popup.defaultPopupTemplateEnabled 设置为 true 时，如果未定义 popupTemplate，则自动使用默认弹出模板。

另请参阅

• createPopupTemplate

• View

portalItem PortalItem

从中加载图层的门户项目。如果门户项目引用要素服务或场景服务，则可以使用 layerId 属性指定要加载的单个图层。

从版本 4.17 开始，可以从 GeoScene Online 和 GeoScene Enterprise 中托管的要素服务项目加载表。这仅适用于要素图层，如果 FeatureLayer.isTable 返回 true，将成功加载。

示例

// While this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids.
const layer = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "caa9bd9da1f4487cb4989824053bb847"
  }  // the first layer in the service is returned
});

// Set hostname when using an on-premise portal (default is GeoScene Online)
// geosceneConfig.portalUrl = "http://myHostName.geoscene.cn/geoscene";

// While this example uses FeatureLayer, this same pattern can be
// used for SceneLayers.
const layer = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  // loads the third item in the given feature service
  layerId: 2
});

// Initialize GeoJSONLayer by referencing a portalItem id pointing to geojson file.
const layer = new GeoJSONLayer({
  portalItem: new PortalItem({
    id: "81e769cd7031482797e1b0768f23c7e1",
    // optionally define the portal, of the item.
    // if not specified, the default portal defined is used.
    // see https://doc.geoscene.cn/javascript/4.25/api-reference/geoscene-config.html#portalUrl
    portal: new Portal({
      url: "https://www.geosceneonline.cn/geoscene"
    })
  }
});

// This snippet loads a table hosted in GeoScene Online.
const table = new FeatureLayer({
  portalItem: { // autocasts as geoscene/portal/PortalItem
    id: "123f4410054b43d7a0bacc1533ceb8dc"
  }
});

// Before adding the table to the map, it must first be loaded and confirm it is the right type.
table.load().then(function() {
  if (table.isTable) {
    map.tables.add(table);
  }
});

renderer PointCloudRendererautocast

分配给图层的渲染器。渲染器定义如何可视化图层中的每个点。

示例

// all points in the layer will be colorized with the RGB attribute
layer.renderer = {
  type: "point-cloud-rgb",  // autocasts as new PointCloudRGBRenderer()
  field: "RGB"
};

spatialReference SpatialReferenceautocast

图层的空间参考。

title String

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

通过服务 url 加载图层时，标题派生自服务名称。如果服务具有多个图层，则每个图层的标题将是服务名称和图层名称的串联。从门户项目加载图层时，将使用门户项目的标题。最后，如果图层作为 webmap 或 webscene 的一部分加载，则将使用存储在 webmap/webscene 中的图层标题。

type Stringreadonly

对于 PointCloudLayer，类型总是 "point-cloud"。

url String

图层或场景服务的 REST 端点的 URL。URL 可以指向 GeoScene Enterprise 或 GeoScene Online 上的资源。

当 url 直接指向服务而不是特定图层时，可以使用 layerId 属性指定该图层。如果未指定 layerId，则它将默认为服务中的第一个图层。

示例

// Layer from Scene Service on GeoScene Server
let sceneLayer = new SceneLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/Paris_3D_Local_WSL2/SceneServer/layers/0"
});

// Can also be used if URL points to service and not layer
let layer = new SceneLayer({
  // Notice that the url doesn't end with /0
  url: "https://scenesampleserverdev.arcgis.com/geoscene/rest/services/Hosted/DevA_Trees/SceneServer",
  layerId: 0
});

version Objectreadonly

用于此服务的场景服务规范的版本。

属性

major Number 场景图层的主要版本。

minor Number 场景图层的次要版本。

versionString String 场景图层的完整版本字符串。

另请参阅

• https://github.com/Esri/i3s-spec

示例

// Prints the version to the console - e.g. 1.4, 1.5, etc.
console.log(layer.version.versionString);

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() 操作已在进行中，则取消它。

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

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

参数

view * 父视图。

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

返回

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

createPopupTemplate(options){PopupTemplate}

起始版本：GeoScene Maps SDK for JavaScript 4.13

为图层创建一个默认弹出模板，使用图层的所有字段进行填充。字段 CLASS_CODE 使用类别名称进行解码。字段 RGB 使用十进制代码描述 rgb。字段 RETURNS 使用总数中的返回数 (1/3) 进行解码，其显示 3 个中的 1 个。

参数

options CreatePopupTemplateOptions optional 用于创建弹出模板的选项。

返回

类型	描述
PopupTemplate	弹出模板，如果图层没有任何字段，则为 null。

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>	解析为包含图层自定义属性数据的对象。

getFieldDomain(fieldName){Domain}

起始版本：GeoScene Maps SDK for JavaScript 4.13

返回与给定字段名称相关联的 Domain。域可以是 CodedValueDomain 或 RangeDomain。

参数

fieldName String 字段名称。

返回

类型	描述
Domain	与给定要素的给定字段名称相关联的 Domain 对象。

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	资源已加载时解析。

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

queryCachedStatistics(fieldName, options){Object}

起始版本：GeoScene Maps SDK for JavaScript 4.13

从服务中查询给定字段的缓存统计信息。查看 I3S PointCloud 规范中的响应详细信息

参数

fieldName String 要查询其统计信息的字段的名称。

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

返回

类型	描述
Object	统计信息文档。

示例

layer.queryCachedStatistics("ELEVATION")
 .then(function(statistics) {
   console.log(statistics);
});

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。