BuildingSceneLayerView

// query all the loaded features
view.whenLayerView(buildingSceneLayer).then(function(buildingSceneLayerView) {
   buildingSceneLayerView.sublayerViews.forEach(function(sublayerView) {
       const query = sublayerView.createQuery();
       sublayerView.queryFeatures(query).then(function(result) {
         console.log(result.features);
       });
   });
});

// on user click, select the first feature in the BuildingSceneLayer
let highlight = null;

view.on("click", function (event) {
  view.hitTest(event.screenPoint, {include: buildingSceneLayer}).then((hitTestResult) => {
    if (highlight) {
      highlight.remove();
      highlight = null;
    }
    if (hitTestResult.results.length) {
      highlight = bslv.highlight(hitTestResult.results[0].graphic);
    }
  });
});

Property Overview

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

layer BuildingSceneLayerreadonly

The layer being viewed.

spatialReferenceSupported Booleanreadonly inherited

Since: ArcGIS API for JavaScript 4.23

Indicates if the spatialReference of the MapView is supported by the layer view. When false layer view will be suspended.

See also:

• suspended

sublayerViews Collection<BuildingComponentSublayerView>readonly

Collection of sublayer views for all the component sublayers of the BuildingSceneLayer.

Example:

view.whenLayerView(buildingSceneLayer).then(function(buildingSceneLayerView) {
   console.log(buildingSceneLayerView.sublayerViews);
});

suspended Booleanreadonly inherited

Value is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).

See also:

• spatialReferenceSupported

updating Booleanreadonly inherited

Value is true when the layer is updating; for example, if it is in the process of fetching data.

Default Value:false

visible Boolean inherited

When true, the layer is visible in the view. Value of this property is inherited from the layer.visible unless the developer overrides it. The layerView.visible will take precedence over layer.visible if both properties are set.

Default Value:true

Method Overview

Method Details

highlight(target){Handle}

Highlights the given feature(s).

Parameter:

target Graphic|Graphic[] optional The feature(s) to highlight. The graphics that are passed to this function must originate from one of the component sublayers of the BuildigSceneLayer.

Returns:

Type	Description
Handle	Returns a highlight handler with a remove() method that can be called to remove the highlight.

Example:

// on user click, select the first feature in the BuildingSceneLayer
let highlight = null;

view.on("click", function (event) {
  view.hitTest(event.screenPoint, {include: buildingSceneLayer}).then((hitTestResult) => {
    if (highlight) {
      highlight.remove();
      highlight = null;
    }
    if (hitTestResult.results.length) {
      highlight = bslv.highlight(hitTestResult.results[0].graphic);
    }
  });
});

isFulfilled(){Boolean}inherited

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved(){Boolean}inherited

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

own(handleOrHandles)inherited

Since: ArcGIS API for JavaScript 4.24

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
});

handle.remove();

// Assign a handle using own()
this.own(reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
  }));

Parameter:

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

when(callback, errback){Promise}inherited

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:

callback Function optional The function to call when the promise resolves.

errback Function optional The function to execute when the promise fails.

Returns:

Type	Description
Promise	Returns a new promise for the result of callback that may be used to chain additional functions.

Example:

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