SynthesizeAssociationGeometriesParameters | References

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

const SynthesizeAssociationGeometriesParameters = await $arcgis.import("@arcgis/core/rest/networks/support/SynthesizeAssociationGeometriesParameters.js");

Inheritance: SynthesizeAssociationGeometriesParameters→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.20

This class describes the parameters required to execute the synthesizeAssociationGeometries function which synthesizes and returns the associations geometries in a given extent.

See also

synthesizeAssociationGeometries

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	SynthesizeAssociationGeometriesParametersProperties

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
extent	Extent \| null \| undefined
gdbVersion	string \| null \| undefined
maxGeometryCount	number \| null \| undefined
moment	Date \| null \| undefined
outSpatialReference	SpatialReference \| null \| undefined
returnAttachmentAssociations	boolean
returnConnectivityAssociations	boolean
returnContainmentAssociations	boolean

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

extent

autocast Property

Type: Extent | null | undefined

The extent within which to synthesize association geometries.

gdbVersion

Property

Type: string | null | undefined

The geodatabase version to execute the function against. Defaults to SDE.DEFAULT, if no version is provided.

maxGeometryCount

Property

Type: number | null | undefined

A number that indicates the maximum associations that should be synthesized after which the operation should immediately return. Useful to avoid slowing down the operation in case many associations need to be rendered. When this count is exceeded, synthesizeAssociationGeometries will set a MaxGeometryCountExceeded to true in the result.

moment

autocast Property

Type: Date | null | undefined

The date/timestamp (in UTC) to execute the function. This could be used to run the function in a moment in the past or in long transaction mode (undo/redo). Applicable to branch versioned datasets only.

See also

Learn more about branch versioning.

outSpatialReference

autocast Property

Type: SpatialReference | null | undefined

The spatial reference of the returned geometry. If not specified, the geometry is returned in the spatial reference of the feature service.

returnAttachmentAssociations

Property

Type: boolean

If true, attachment associations will be included in the results.

Default value: false

returnConnectivityAssociations

Property

Type: boolean

If true, connectivity associations will be included in the results.

Default value: false

returnContainmentAssociations

Property

Type: boolean

Indicates whether to synthesize and return containment associations. Containment associations can be created between polygons, as a result the centroid of that polygon is used as anchor to synthesize the association geometry.

Default value: false

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.