SynthesizeAssociationGeometriesParameters

AMD: require(["esri/rest/networks/support/SynthesizeAssociationGeometriesParameters"], (SynthesizeAssociationGeometriesParameters) => { /* code goes here */ });
ESM: import SynthesizeAssociationGeometriesParameters from "@arcgis/core/rest/networks/support/SynthesizeAssociationGeometriesParameters";
Class: esri/rest/networks/support/SynthesizeAssociationGeometriesParameters
Inheritance: SynthesizeAssociationGeometriesParameters Accessor
Since: ArcGIS API 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:

Constructors

new SynthesizeAssociationGeometriesParameters(properties)
Parameter:
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Extentmore details

The extent used to execute a spatial query to retrieve the associations.

more detailsSynthesizeAssociationGeometriesParameters
Stringmore details

The geodatabase version to execute the function against.

more detailsSynthesizeAssociationGeometriesParameters
Numbermore details

A number that indicates the maximum associations that should be synthesized after which the operation should immediately return.

more detailsSynthesizeAssociationGeometriesParameters
datemore details

The date/timestamp (in UTC) to execute the function.

more detailsSynthesizeAssociationGeometriesParameters
SpatialReferencemore details

The spatial reference that should be used to project the synthesized geometries.

more detailsSynthesizeAssociationGeometriesParameters
Booleanmore details

Indicates whether to synthesize and return structual attachment associations.

more detailsSynthesizeAssociationGeometriesParameters
Booleanmore details

Indicates whether to synthesize and return connectivity associations.

more detailsSynthesizeAssociationGeometriesParameters
Booleanmore details

Indicates whether to synthesize and return containment associations.

more detailsSynthesizeAssociationGeometriesParameters

Property Details

declaredClass Stringreadonly inherited

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

extent Extent

The extent used to execute a spatial query to retrieve the associations.

gdbVersion String

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

maxGeometryCount Number

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 date

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:
outSpatialReference SpatialReference

The spatial reference that should be used to project the synthesized geometries.

returnAttachmentAssociations Boolean

Indicates whether to synthesize and return structual attachment associations.

Default Value:false
returnConnectivityAssociations Boolean

Indicates whether to synthesize and return connectivity associations.

Default Value:false
returnContainerAssociations 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

Method Overview

Name Return Type Summary Class
*more details

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

more detailsSynthesizeAssociationGeometriesParameters
Objectmore details

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

more detailsSynthesizeAssociationGeometriesParameters

Method Details

fromJSON(json){*}static

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.

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:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

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

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.