UtilityNetworkAssociationType | API Reference | ArcGIS Maps SDK for JavaScript 4.32

The UtilityNetworkAssociationType class defines one utility network association type used in a PopupTemplate or a FormTemplate.

See also

Constructors

UtilityNetworkAssociationType Constructor new UtilityNetworkAssociationType(properties)

Parameter

properties Object

optional

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

Property Overview

Type	Summary	Class
Number	This property is used to filter the associations by asset group.	UtilityNetworkAssociationType
Number	This property is used to filter the associations by asset type.	UtilityNetworkAssociationType
Number	This property is used to filter the associations by network sourceId.	UtilityNetworkAssociationType
String	The description for the type of association in the list of association types on the popup or form.	UtilityNetworkAssociationType
String	The title for the type of association in the list of association types on the popup or form.	UtilityNetworkAssociationType
String	The type of association.	UtilityNetworkAssociationType

Property Details

associatedAssetGroup Property associatedAssetGroup Number

This property is used to filter the associations by asset group. In order for this filter to work a value must be assigned to associatedNetworkSourceId.

associatedAssetType Property associatedAssetType Number

This property is used to filter the associations by asset type. In order for this filter to work a value must be assigned to associatedAssetGroup and associatedNetworkSourceId.

associatedNetworkSourceId Property associatedNetworkSourceId Number

This property is used to filter the associations by network sourceId.

description Property description String

The description for the type of association in the list of association types on the popup or form.

title Property title String

The title for the type of association in the list of association types on the popup or form. Users are able to change the display titles of the association type header in their list of association types. For example, the header Contents could be changed to Cont. or the header Connectivity could be changed to MyConnectivity.

type Property type String

The type of association.

Possible Values:"attachment" |"connectivity" |"container" |"content" |"structure"

Method Overview

Return Type	Summary	Class
this	Creates a deep clone of this object.	UtilityNetworkAssociationType
*\|null\|undefined	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	UtilityNetworkAssociationType
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	UtilityNetworkAssociationType

Method Details

clone Method clone(){this}

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns

Type	Description
this	A deep clone of the class instance that invoked this method.

fromJSON Method fromJSON(json){* |null |undefined}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
* \| null \| undefined	Returns a new instance of this class.

toJSON Method 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.