UtilityNetworkHandle
UtilityNetworkHandle =
object
Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:2272
Methods
Section titled “Methods”associations()
Section titled “associations()”associations(
tableName,whereClause):Promise<UtilityAssociationSummary>
Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:2313
Returns the associations of a feature queried from tableName.
Parameters
Section titled “Parameters”tableName
Section titled “tableName”string
whereClause
Section titled “whereClause”string
Returns
Section titled “Returns”Promise<UtilityAssociationSummary>
describeNetwork()
Section titled “describeNetwork()”describeNetwork():
object
Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:2274
Returns metadata about the loaded network (its network-source names).
Returns
Section titled “Returns”object
networkSources
Section titled “networkSources”networkSources:
string[]
getState()
Section titled “getState()”getState():
Promise<UtilityNetworkState>
Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:2283
Returns the network’s topology state — dirty areas, errors, and whether topology is enabled.
Returns
Section titled “Returns”Promise<UtilityNetworkState>
getTerminalConfigurations()
Section titled “getTerminalConfigurations()”getTerminalConfigurations():
UtilityTerminalConfiguration[]
Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:2281
Returns the terminal configurations defined in the network. Use this to discover the available terminals on multi-terminal devices (e.g. transformers) before starting a directional trace that must specify a terminal. Synchronous — no network round-trip; reads from the already-loaded network definition.
Returns
Section titled “Returns”UtilityTerminalConfiguration[]
queryNamedTraceConfigurations()
Section titled “queryNamedTraceConfigurations()”queryNamedTraceConfigurations():
Promise<UtilityNamedTraceConfiguration[]>
Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:2305
Lists the network’s predefined named trace configurations.
Returns
Section titled “Returns”Promise<UtilityNamedTraceConfiguration[]>
trace()
Section titled “trace()”trace(
traceType,startingLocations):Promise<UtilityTraceResult>
Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:2291
Runs a trace of traceType from the given starting locations (explicit element descriptors).
Parameters
Section titled “Parameters”traceType
Section titled “traceType”startingLocations
Section titled “startingLocations”Returns
Section titled “Returns”Promise<UtilityTraceResult>
traceFromQuery()
Section titled “traceFromQuery()”traceFromQuery(
tableName,whereClause,traceType):Promise<UtilityTraceResult>
Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:2299
Queries a starting feature from the layer tableName (matching whereClause), traces from it,
and selects the result features on the map. Convenient for an interactive “trace from here” flow.
Parameters
Section titled “Parameters”tableName
Section titled “tableName”string
whereClause
Section titled “whereClause”string
traceType
Section titled “traceType”Returns
Section titled “Returns”Promise<UtilityTraceResult>
traceWithConfiguration()
Section titled “traceWithConfiguration()”traceWithConfiguration(
configGlobalId,tableName,whereClause):Promise<UtilityTraceResult>
Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:2307
Traces using a named configuration (by globalId), from a feature queried from tableName.
Parameters
Section titled “Parameters”configGlobalId
Section titled “configGlobalId”string
tableName
Section titled “tableName”string
whereClause
Section titled “whereClause”string
Returns
Section titled “Returns”Promise<UtilityTraceResult>
validateNetworkTopology()
Section titled “validateNetworkTopology()”validateNetworkTopology(
extent):JobRef<{validated:boolean; }>
Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:2289
Validates the network topology over extent (an envelope geometry). Returns a JobRef —
call .result() to run it (and track onProgress), or .cancel(). After it completes, read
getState() to see whether errors or dirty areas remain.
Parameters
Section titled “Parameters”extent
Section titled “extent”Returns
Section titled “Returns”JobRef<{ validated: boolean; }>