BuildingSceneLayer

const buildingLayer = new BuildingSceneLayer({
  url: "...",
  title: "Administration Building, Redlands - Building Scene Layer"
});

属性列表

属性详细说明

activeFilterId String

起始版本: GeoScene API for JavaScript 4.22

当前活动筛选器的 ID。要激活其中一个筛选器，请将其 id 分配给此属性。

allSublayers Collection<(BuildingGroupSublayer|BuildingComponentSublayer)>readonly

建筑物子图层中所有子图层的平面集合。

示例代码:

// 查询包含门的子图层层
// 使用 modelName 来标识每一层，因为这是一个标准名称
const doorslayer = buildingSceneLayer.allSublayers.find(function(sublayer) {
  return sublayer.modelName === "Doors";
});

copyright String

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

declaredClass Stringreadonly inherited

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

elevationInfo Object

指定要素在垂直轴 （z） 上的放置方式。此属性仅在使用absolute-height 模式时影响建筑场景图层。

属性:

mode String 定义要素在垂直轴 （z） 上的放置方式。目前仅支持 absolute-height 模式。 Mode 描述 absolute-height 要素放置在海平面以上的绝对高程（z 值）处。此 z 值是通过对offset 值和点的 z 值求和来确定的。它不考虑地形的高程。这是 BuildingSceneLayer 唯一受支持的提升模式。 该值始终为 "absolute-height"。

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

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

filters Collection<BuildingFilter>autocast

起始版本: GeoScene API for JavaScript 4.22

可用于在 SceneView 中显示或隐藏特定要素的筛选器集合。当仅应显示图层中数据的子集时，使用过滤器非常有用。要激活 BuildingFilter，请将其添加到此集合中，并将其 id 分配给 activeFilterId。激活后，只有满足过滤器定义的条件的功能才会显示在 SceneView 中。

示例代码:

// 定义过滤器
const buildingFilter = new BuildingFilter({
  filterBlocks: [{
    // 使用 BldgLevel 字段进行筛选的 SQL 表达式
    filterExpression: "BldgLevel = 3"
  }]
});
// 在图层上的过滤器数组中设置过滤器
buildingLayer.filters = [buildingFilter];
// 指定应该应用哪个过滤器
buildingLayer.activeFilterId = buildingFilter.id;

fullExtent Extentautocast inherited

图层的完整范围。 默认情况下，这是全球范围的。 可以使用此属性设置视图的范围以匹配图层的范围，这样看起来要素填充了视图。 请参阅下面的示例片段。

示例代码:

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

id String inherited

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

layerId Number

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

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

如果以上两种情况下均未指定layerId，则选择服务中的第一层（layerId = 0）。

示例代码:

// 虽然这些示例使用 SceneLayer，但相同的模式可用于从 portalItem id 加载的其他图层

// 加载项目的第三层
let layer = new SceneLayer({
  portalItem: {
    id: "73df987984b24094b848d580eb83b0fb"
  },
  layerId: 2
});

// 如果不指定，则返回第一层（layerId: 0）
let layer = new SceneLayer({
  portalItem: {
    id: "73df987984b24094b848d580eb83b0fb"
  }
});

// 如果 URL 指向服务而不是层，也可以使用
let layer = new SceneLayer({
  url: "https://www.geosceneonline.cn/server/rest/services/Hosted/4%E5%85%A8%E5%B1%80%E5%9C%BA%E6%99%AF_WSL1/SceneServer",
  layerId: 0  // 请注意，url不以 /2 结尾
});

// 此代码返回与上一个片段相同的层
let layer = new SceneLayer({
  url: "https://www.geosceneonline.cn/server/rest/services/Hosted/4%E5%85%A8%E5%B1%80%E5%9C%BA%E6%99%AF_WSL1/SceneServer/layers/0",
  // 图层 ID 在 URL 中指定
});

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	对象的资源加载失败。 有关详细信息，请参阅 loadError。

可选值:"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 表示图层不可见 没有最小比例。minScale 值应始终大于 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;

outFields String[]

起始版本: GeoScene API for JavaScript 4.22

来自服务的字段名称数组，包含在所有子图层中的每个要素中。 要从所有子层中的所有字段中获取值，请使用 ["*"]。 BuildingSceneLayers 通常具有大量字段，因此获取所有值可能会导致加载时间变慢。 在  outFields中指定的字段将与所需字段一起被请求，以在所有子图层上进行 rendering 和 filtering 。

要仅在特定子图层中包括字段，请使用子图层的 outFields 属性。

默认值:null

示例:

• BuildingComponentSublayer.outFields

示例代码:

// 从所有子图层中的服务中获取指定字段
sl.outFields = ["CreatedPhase", "DemolishedPhase", "BldgLevel"];

portalItem PortalItem

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

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

示例代码:

// 虽然此示例使用 FeatureLayer，但同样的模式可用于从 portalItem id 加载的其他图层。
const lyr = new FeatureLayer({
  portalItem: {  // 自动转换为 new PortalItem()
    id: "caa9bd9da1f4487cb4989824053bb847"
  }  // 返回服务中的第一层
});

// 虽然此示例使用 FeatureLayer，但同样的模式也可用于 SceneLayers。
const lyr = new FeatureLayer({
  portalItem: {  // 自动转换为 new PortalItem()
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  // 加载给定要素服务中的第三项
  layerId: 2
});

// 此片段加载托管在 GeoScene Online 中的表。
const table = new FeatureLayer({
  portalItem: { // 自动转换为 geoscene/portal/PortalItem
    id: "123f4410054b43d7a0bacc1533ceb8dc"
  }
});

// 在将表格添加到地图之前，必须先加载它并确认它是正确的类型。
table.load().then(function() {
  if (table.isTable) {
    map.tables.add(table);
  }
});

spatialReference SpatialReferenceautocast

图层的空间参考。

sublayers Collection<(BuildingGroupSublayer|BuildingComponentSublayer)>readonly

BuildingSceneLayer 中子层的层次结构。 通常包含一个 概貌模型 BuildingComponentSublayer 和一个完整模型 BuildingGroupSublayer。 但是，某些 BuildingSceneLayers 只能包含完整模型 BuildingGroupSublayer 或直接包含学科 BuildingGroupSublayers。

summaryStatistics BuildingSummaryStatisticsreadonly

起始版本: GeoScene API for JavaScript 4.22

建筑物场景图层中所有组件图层的汇总统计数据。在访问其属性之前，必须加载此对象。

示例代码:

// 加载图层
buildingLayer.load().then(function() {
 // 在摘要统计属性上加载统计信息以便能够访问它们
 buildingLayer.summaryStatistics.load().then(function() {
   console.log(buildingLayer.summaryStatistics);
 });
});

title String

图层的标题用于在 Legend 和 LayerList 微件识别它。

按服务 URL 加载图层时，标题派生自服务名称。如果服务具有多个图层，则每个图层的标题将是服务名称和图层名称的串联。从门户项目加载图层时，将改用门户项目的标题。最后，如果图层作为 web 地图或 web 场景的一部分加载，则存储的图层标题

type Stringreadonly

对于 BuildingSceneLayer，类型始终为"building-scene"。

url String

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

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

示例代码:

// GeoScene 服务器上的场景服务图层
let sceneLayer = new SceneLayer({
  url: "https://www.geosceneonline.cn/geoscene/rest/services/Hosted/Building_Hamburg/SceneServer/layers/0"
});

// 如果 URL 指向服务而不是层，也可以使用
let layer = new SceneLayer({
  // 请注意，url不以 /0 结尾
  url: "https://www.geosceneonline.cn/geoscene/rest/services/Hosted/DevA_Trees/SceneServer",
  layerId: 0
});

version Objectreadonly

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

属性:

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

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

versionString String 场景图层的次要版本。

示例代码:

// 将版本打印到控制台 - 例如 1.4、1.5 等
console.log(layer.version.versionString);

visible Boolean inherited

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

默认值:true

示例代码:

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

方法列表

方法详细说明

cancelLoad()inherited

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

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

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

参数:

view * 父视图

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

返回值:

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

示例:

• 示例 - 自定义 WebGL 层视图

destroy()inherited

起始版本: GeoScene API for JavaScript 4.22

销毁图层和任何相关资源（包括其portalItem，如果它是图层上的属性）。该层一旦被销毁就不能再使用了。

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

示例:

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

emit(type, event){Boolean}inherited

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

参数:

type String 事件名称

event Object optional 事件负载。

返回值:

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

fetchAttributionData(){Promise<Object>}inherited

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

返回值:

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

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

返回值:

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

loadAll(){Promise<BuildingSceneLayer>}

起始版本: GeoScene API for JavaScript 4.22

加载图层及其所有子图层。

返回值:

类型	描述
Promise<BuildingSceneLayer>	在加载完所有子图层时解析。如果至少一个子图层无法加载，则拒绝。

示例:

• load

示例代码:

// 确保加载完成后打印建筑场景图层中所有组件的名称
buildingSceneLayer.loadAll()
  .then(function() {
    const allComponentNames = buildingSceneLayer.allSublayers
      .filter(function(sublayer) { return sublayer.type === "building-component"; })
      .map(function(sublayer) { return sublayer.title; })
    console.log(allComponentNames.join("\n"));
  });
  .catch(function(error) {
    console.log("Error: one or more sublayer failed to load");
  });

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

when(callback, errback){Promise}inherited

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}

事件详述

layerview-createinherited

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

属性:

view View 创建 layerView 的视图。

layerView LayerView 视图中渲染的 LayerView 。

示例:

• View.whenLayerView()

示例代码:

// 每次为此特定视图创建图层视图时，都会触发此函数。

layer.on("layerview-create", function(event){
  / 发出此事件的图层的 LayerView
  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 图层。