AggregatedGeometry | References | ArcGIS Maps SDK for JavaScript

import AggregatedGeometry from "@arcgis/core/rest/networks/support/AggregatedGeometry.js";

Inheritance:: AggregatedGeometry→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.20

A class that defines an aggregation of geometries. Returned by the trace function when aggregate trace result is specified. The aggregated geometries will only include geometries that belong to features with assetgroups and assettypes specified in the trace output.

See also

trace

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`AggregatedGeometryProperties`

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
`line` readonly	`Polyline \| null \| undefined`
`multipoint` readonly	`Multipoint \| null \| undefined`
`polygon` readonly	`Polygon \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

line

readonly Property

Type: Polyline | null | undefined

A Polyline geometry representing a union of all polyline features encountered during the trace and specified by the output. The aggregated geometries will only include geometries that belong to features with assetgroups/assettypes specified in the trace output.

multipoint

readonly Property

Type: Multipoint | null | undefined

A multi-point geometry representing a union of all point features encountered during the trace and specified by the output The aggregated geometries will only include geometries that belong to features with assetgroups/assettypes specified in the trace output.

polygon

readonly Property

Type: Polygon | null | undefined

A Polygon geometry representing a union of all polygon features encountered during the trace and specified by the output. Note that polygon features are normally not part of the connectivity topology, but can be returned as a result of including containment associations. Example is structure boundry. The aggregated geometries will only include geometries that belong to features with assetgroups/assettypes specified in the trace output.

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.