Skip To ContentArcGIS for DevelopersSign In Dashboard

BuildingSummaryStatistics

Class: esri/layers/support/BuildingSummaryStatistics
Inheritance: BuildingSummaryStatistics Accessor
Since: ArcGIS API for JavaScript 4.15

Contains statistics about the fields in all sublayers of a BuildingSceneLayer. The statistics contain the most frequent values in that layer, minimum and maximum values in case they are numeric and the sublayers where the field is available.

This class can't be instantiated, use it as part of the BuildingSceneLayer.summaryStatistics property:

// load the layer
buildingLayer.load().then(function() {
 // load the statistics on the summaryStatistics property
 // to be able to acccess them
 buildingLayer.summaryStatistics.load().then(function() {
   console.log(buildingLayer.summaryStatistics);
 });
});
See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
BuildingFieldStatistics[]

An array of statistics on all fields in all sublayers.

more details
more detailsBuildingSummaryStatistics
Error

The Error object returned if an error occurred while loading.

more details
more detailsBuildingSummaryStatistics
String

Represents the status of a load operation.

more details
more detailsBuildingSummaryStatistics
Object[]

A list of warnings which occurred while loading.

more details
more detailsBuildingSummaryStatistics

Property Details

declaredClass Stringreadonly inherited

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

An array of statistics on all fields in all sublayers.

loadError Errorreadonly

The Error object returned if an error occurred while loading.

Default Value:null
loadStatus Stringreadonly

Represents the status of a load operation.

ValueDescription
not-loadedThe object's resources have not loaded.
loadingThe object's resources are currently loading.
loadedThe object's resources have loaded without errors.
failedThe object's resources failed to load. See loadError for more details.

Possible Values:"not-loaded"|"loading"|"failed"|"loaded"

Default Value:not-loaded
loadWarnings Object[]readonly

A list of warnings which occurred while loading.

Method Overview

NameReturn TypeSummaryClass

Cancels a load() operation if it is already in progress.

more details
more detailsBuildingSummaryStatistics
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsBuildingSummaryStatistics
Boolean

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

more details
more detailsBuildingSummaryStatistics
Boolean

isRejected() may be used to verify if creating an instance of the class is rejected.

more details
more detailsBuildingSummaryStatistics
Boolean

isResolved() may be used to verify if creating an instance of the class is resolved.

more details
more detailsBuildingSummaryStatistics
Promise

Loads the resources referenced by this class.

more details
more detailsBuildingSummaryStatistics
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
more detailsBuildingSummaryStatistics
Promise

when() may be leveraged once an instance of the class is created.

more details
more detailsBuildingSummaryStatistics

Method Details

cancelLoad()

Cancels a load() operation if it is already in progress.

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
TypeDescription
*Returns a new instance of this class.
isFulfilled(){Boolean}

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:
TypeDescription
BooleanIndicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected(){Boolean}

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

Returns:
TypeDescription
BooleanIndicates whether creating an instance of the class has been rejected.
isResolved(){Boolean}

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

Returns:
TypeDescription
BooleanIndicates whether creating an instance of the class has been resolved.
load(signal){Promise}

Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.

This method must be called by the developer when accessing a resource that will not be loaded in a View.

The load() method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.

It's possible to provide a signal to stop being interested into a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.

Parameter:
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:
TypeDescription
PromiseResolves when the resources have loaded.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.
when(callback, errback){Promise}

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:
TypeDescription
PromiseReturns 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
var 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
});

Type Definitions

BuildingFieldStatistics Object

Summary statistics for a field in a BuildingSceneLayer. The statistics contain the most frequent values in that layer, minimum and maximum values in case they are numeric and the sublayers where the field is available.

Properties:
fieldName String

Name of the field.

modelName String

Model Name of the field. This can be used to identify certain special fields, like floor number, or phase id.

label String

Label of the field.

min Number

Minimum value of the field for numeric values.

max Number

Maximum value of the field for numeric values.

mostFrequentValues String[]|Number[]

List of the most frequent values of the field. This is not guaranteed to be a complete list of all values.

subLayerIds Number[]

List of sublayer ids where this field is available.

API Reference search results

NameTypeModule
Loading...