BuildingFieldStatistics | References | ArcGIS Maps SDK for JavaScript

import BuildingFieldStatistics from "@arcgis/core/layers/support/BuildingFieldStatistics.js";

Inheritance:: BuildingFieldStatistics→Accessor

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.

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`BuildingFieldStatisticsProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`fieldName`	`string`
`label`	`string`
`max`	`number`
`min`	`number`
`modelName`	`string`
`mostFrequentValues`	`number[] \| string[]`
`subLayerIds`	`number[]`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

fieldName

Property

Type: string

Name of the field.

label

Property

Type: string

Label of the field.

max

Property

Type: number

Maximum value of the field for numeric values.

min

Property

Type: number

Minimum value of the field for numeric values.

modelName

Property

Type: string

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

mostFrequentValues

Property

Type: number[] | string[]

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

subLayerIds

Property

Type: number[]

List of sublayer ids where this field is available.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. 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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.