require(["esri/rest/networks/support/SynthesizeAssociationGeometriesParameters"], (SynthesizeAssociationGeometriesParameters) => { /* code goes here */ });
import SynthesizeAssociationGeometriesParameters from "@arcgis/core/rest/networks/support/SynthesizeAssociationGeometriesParameters.js";
esri/rest/networks/support/SynthesizeAssociationGeometriesParameters
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
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
The extent used to execute a spatial query to retrieve the associations. | SynthesizeAssociationGeometriesParameters | ||
The geodatabase version to execute the function against. | SynthesizeAssociationGeometriesParameters | ||
A number that indicates the maximum associations that should be synthesized after which the operation should immediately return. | SynthesizeAssociationGeometriesParameters | ||
The date/timestamp (in UTC) to execute the function. | SynthesizeAssociationGeometriesParameters | ||
SpatialReference | The spatial reference of the returned geometry. | SynthesizeAssociationGeometriesParameters | |
Indicates whether to synthesize and return structural attachment associations. | SynthesizeAssociationGeometriesParameters | ||
Indicates whether to synthesize and return connectivity associations. | SynthesizeAssociationGeometriesParameters | ||
Indicates whether to synthesize and return containment associations. | SynthesizeAssociationGeometriesParameters |
Property Details
-
extent
extent Extent
-
The extent used to execute a spatial query to retrieve the associations.
-
gdbVersion
gdbVersion String
-
The geodatabase version to execute the function against. Defaults to
SDE.DEFAULT
, if no version is provided.
-
maxGeometryCount
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 aMaxGeometryCountExceeded
totrue
in the result.
-
moment
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
-
The spatial reference of the returned geometry. If not specified, the geometry is returned in the spatial reference of the feature service.
-
returnAttachmentAssociations
returnAttachmentAssociations Boolean
-
Indicates whether to synthesize and return structural attachment associations.
- Default Value:false
-
returnConnectivityAssociations
returnConnectivityAssociations Boolean
-
Indicates whether to synthesize and return connectivity associations.
- Default Value:false
-
returnContainmentAssociations
returnContainmentAssociations 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 |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | SynthesizeAssociationGeometriesParameters | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | SynthesizeAssociationGeometriesParameters |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.