Skip To Content

Nearest Neighbor Properties

Summary

The properties below are returned by the nearestNeighbor object when using Describe on a utility network.

Learn more about filtering what is traced

Properties

PropertyExplanationData Type
costNetworkAttributeName
(Read Only)

If the filter nearest function is being used, this is the name of the network attribute that is being used to calculate the cost. If the filter nearest function is not being used, this property returns an empty string.

String
count
(Read Only)

If the filter nearest function is being used, this is the value of the number of features to be returned. If the filter nearest function is not being used, this property returns a -1 value.

Integer
nearestAssets
(Read Only)

The nearestAssets object. If the filter nearest function is being used, these are the asset groups and asset types that will be returned. If the filter nearest function is not being used, this property returns an empty list.

Object
nearestCategories
(Read Only)

If the filter nearest function is being used, these are the names of the categories that will be returned. If the filter nearest function is not being used, this property returns an empty list.

String
In this topic