jsonTypes | References | ArcGIS Maps SDK for JavaScript

Types

import type { UtilityNetworkFeatureClassUsageType, DividePolicyType, CombinePolicyType, UnitIdentifier, UnitRange } from "@arcgis/core/networks/support/jsonTypes.js";

Type definitions

UtilityNetworkFeatureClassUsageType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "esriUNFCUTDevice" | "esriUNFCUTJunction" | "esriUNFCUTLine" | "esriUNFCUTAssembly" | "esriUNFCUTSubnetLine" | "esriUNFCUTStructureJunction" | "esriUNFCUTStructureLine" | "esriUNFCUTStructureBoundary" | "esriUNFCUTJunctionObject" | "esriUNFCUTEdgeObject" | "esriUNFCUTStructureJunctionObject" | "esriUNFCUTStructureEdgeObject" | "esriUNFCUTCircuit" | "esriUNFCUTCircuitSection" | "esriUNFCUTSubcircuit"

DividePolicyType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

Type: "esriDPTUnitApportioned" | "esriDPTDefaultValue"

CombinePolicyType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

Type: "esriCPTSumValues" | "esriCPTDefaultValue"

UnitIdentifier

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.34

Uniquely identifies an element by network source ID and global ID.

sourceId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The element's network source ID.

globalId

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The element's global ID.

UnitRange

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.34

A range of unit identifiers in a container feature or object's containment hierarchy.

firstUnit

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The unit offset in the grouped object.

lastUnit

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The last unit in the unit identifier range.

isGap

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Whether the unit identifier range is a gap, i.e., is not utilized.

content

Property

Type: UnitIdentifier | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The object consuming the unit identifiers in this range.

CircuitExportResult

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.34

Results returned from the CircuitManager.export() method.

See also

circuitName

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of the exported circuit.

url

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The location of the exported circuit JSON file.

isDefaultTraceConfigurationModified

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.1

Indicates if the default trace configuration has been modified.

status

Property

Type: CircuitStatus

Since: ArcGIS Maps SDK for JavaScript 5.1

The status of the exported circuit.

success

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates if the export was successful.

error

Property

Type: CircuitExportResultError | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Optional error information if the export failed.

CircuitExportResultError

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

message

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Error message.

extendedCode

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Extended error code.

details

Property

Type: string[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Additional error details.

AssetTypeJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

AssetTypeJSON represents asset type. Attribute domains are assigned on the asset type field at the subtype level for each network class. It represents the minor classification of the utility network classes.

assetTypeCode

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique code for the asset type.

assetTypeName

Property

Type: string | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of the asset type.

isTerminalConfigurationSupported

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates if terminal configurations are supported for the asset type.

terminalConfigurationId

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The terminal configuration ID associated with the asset type, if applicable.

connectivityPolicy

Property

Type: string | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The connectivity policy applied to the asset type.

AssetGroupJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

AssetGroupJSON represents the asset group. The asset group is the subtype field and represents the major classification of utility network classes.

assetGroupCode

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique code for the asset group.

assetGroupName

Property

Type: string | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The asset group name.

assetTypes

Property

Type: AssetTypeJSON[]

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of asset types associated with the asset group.

CircuitSourceJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

layerId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The layer id of the point layer.

sourceId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The network source id of the layer.

utilityNetworkFeatureClassUsageType

Property

Type: UtilityNetworkFeatureClassUsageType

Since: ArcGIS Maps SDK for JavaScript 5.0

The usage type of the edge source.

NetworkSourceJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

JunctionSourceJSON represents the point layers that participate in the utility network service.

Supertypes: CircuitSourceJSON

assetGroups

Property

Type: AssetGroupJSON[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The asset group attribute values for the point layer.

supportedProperties

Property

Type: string[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Supported properties for the edge source.

usesGeometry

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.1

Indicates if the source uses geometry.

DomainNetworkJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.34

Describes a domain network in a utility network data element.

domainNetworkName

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of the domain network.

isStructureNetwork

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates if this domain network is a structure network.

isTelecomNetwork

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates if this domain network is a telecom domain network.

junctionSources

Property

Type: NetworkSourceJSON[]

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of network source objects that represent the sources of junction features.

edgeSources

Property

Type: NetworkSourceJSON[]

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of network source objects that represent the sources of edge features.

tiers

Property

Type: TierJSON[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of tier definitions used to organize the network into hierarchical levels. Null if no tiers are defined, e.g., a telecom domain network.

subnetworkLayerId

Property

Type: number | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The layer ID of the subnetwork layer. Null if no subnetwork layer is defined, e.g., a telecom domain network.

circuitSources

Property

Type: CircuitSourceJSON[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of circuit source objects for telecom networks.

circuitProperties

Property

Type: CircuitPropertiesJSON | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Circuit properties for telecom networks.

colorSchemes

Property

Type: ColorSchemeJSON[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of objects to describe color schemes in a telecom domain network.

dividePolicies

Property

Type: DividePolicyJSON[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of objects describing divide policies for a telecom domain network.

combinePolicies

Property

Type: CombinePolicyJSON[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of objects describing combine policies.

traceConfiguration

Property

Type: UNTraceConfiguration | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

A UNTraceConfiguration object that defines the trace configuration for the domain network. This configuration includes parameters specific to utility networks.

colorSets

Property

Type: ColorSetJSON[]

Since: ArcGIS Maps SDK for JavaScript 5.1

An array of objects representing color sets in a telecom domain network.

wavelengthSchemes

Property

Type: WavelengthSchemeJSON[]

Since: ArcGIS Maps SDK for JavaScript 5.1

An array of objects representing wavelength schemes in a telecom domain network.

WavelengthSchemeJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

id

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.1

The unique ID for the wavelength scheme.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.1

The name of the wavelength scheme.

wavelengths

Property

Type: WavelengthJSON[]

Since: ArcGIS Maps SDK for JavaScript 5.1

An array of objects representing wavelengths in the wavelength scheme.

WavelengthJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

id

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.1

The unique ID for the wavelength.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.1

The name of the wavelength.

length

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.1

The numeric value of the wavelength

CircuitPropertiesJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

type

Property

Type: "PropertySet"

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of the property set.

propertySetItems

Property

Type: (string | boolean)[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The items in the property set.

ColorSchemeJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of the color scheme.

id

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The id of the color scheme.

colorSetId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.1

The ID of the color set associated with the color scheme.

groupDelimiter

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The group delimiter.

levels

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The number of levels in the color scheme.

groups

Property

Type: ColorSchemeGroupJSON[]

Since: ArcGIS Maps SDK for JavaScript 5.1

An array of objects representing color groups in the color scheme.

ColorSetJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

id

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.1

The unique ID for the color set.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.1

The name of the color set.

colorCodes

Property

Type: ColorCodeJSON[]

Since: ArcGIS Maps SDK for JavaScript 5.1

An array of objects representing color codes in the color set.

ColorCodeJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

id

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.1

The unique ID for the color code.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.1

The name of the color code.

label

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.1

The label for the color code.

hexCodes

Property

Type: string[]

Since: ArcGIS Maps SDK for JavaScript 5.1

An array of hex codes representing the color code.

ColorSchemeGroupJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.1

The name of the color group.

level

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.1

The level of the color group.

delimiter

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.1

The delimiter for the color group.

capacity

Property

Type: number[]

Since: ArcGIS Maps SDK for JavaScript 5.1

The capacity for the color group.

colorCodeIds

Property

Type: number[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

An array of color code IDs associated with the color group.

DividePolicyJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

sourceId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.1

The source ID for the policy.

attributeName

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.1

The attribute name for the policy.

policy

Property

Type: DividePolicyType

Since: ArcGIS Maps SDK for JavaScript 5.1

The policy type.

CombinePolicyJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

sourceId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.1

The source ID for the policy.

attributeName

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.1

The attribute name for the policy.

policy

Property

Type: CombinePolicyType

Since: ArcGIS Maps SDK for JavaScript 5.1

The policy type.

TierJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of the tier.

TerminalConfigurationJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

terminalConfigurationId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The Id that uniquely identifies the terminal configuration.

NetworkDataElementJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.33

Contains the full network definition.

domainNetworks

Property

Type: DomainNetworkJSON[]

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of domain networks included in the utility network.

userIdentity

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The user identity associated with the network definition.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of the utility network.

schemaGeneration

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The schema generation version number of the utility network.

terminalConfigurations

Property

Type: TerminalConfigurationJSON[]

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of terminal configuration objects available in the network.

serviceTerritoryFeatureLayerId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The layer Id of the feature layer representing service territories within the network.

FunctionType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "add" | "subtract" | "average" | "count" | "min" | "max"

ConditionType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "networkAttribute" | "category"

OperatorType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "equal" | "notEqual" | "greaterThan" | "greaterThanEqual" | "lessThan" | "lessThanEqual" | "includesTheValues" | "doesNotIncludeTheValues" | "includesAny" | "doesNotIncludeAny"

BarrierJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Contains the Barrier information in JSON format.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of the barrier.

type

Property

Type: ConditionType

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of the barrier.

operator

Property

Type: OperatorType

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of the operator used in the barrier.

value

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The value used by the barrier when evaluating network attributes or categories.

combineUsingOr

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether this barrier is combined with other barriers using OR (true) or AND (false).

isSpecificValue

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the barrier evaluates a specific value.

ConditionJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Contains the condition information in JSON format. Conditions are used to define the criteria for barriers in a utility network trace.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of the condition.

type

Property

Type: ConditionType

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of the condition.

operator

Property

Type: OperatorType

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of the operator used in the condition.

value

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The value used by the condition when evaluating network attributes or categories.

combineUsingOr

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether this condition is combined with other conditions using OR (true) or AND (false).

isSpecificValue

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the condition evaluates a specific value.

OutputConditionJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Contains the output condition information in JSON format. Output conditions define which traced features are returned.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of the output condition.

type

Property

Type: ConditionType

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of the output condition.

operator

Property

Type: OperatorType

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of the operator used in the output condition.

value

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The value used by the output condition when evaluating network attributes or categories.

combineUsingOr

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether this output condition is combined with other conditions using OR (true) or AND (false).

isSpecificValue

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the output condition evaluates a specific value.

FunctionJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Contains the function information in JSON format.

functionName

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

An alias to describe and provide context for the function output.

functionType

Property

Type: FunctionType

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of function used for the calculation.

networkAttributeName

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The network attribute name used by the function.

conditions

Property

Type: ConditionJSON[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The set of conditions used to filter elements included in the function calculation.

FunctionBarrierJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Contains the function barrier information in JSON format.

functionType

Property

Type: FunctionType

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of function used for evaluating the barrier.

networkAttributeName

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The network attribute name used by the function barrier.

operator

Property

Type: OperatorType

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of the operator used in the function barrier.

value

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The value used to evaluate the function barrier.

AssetJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Contains asset information in JSON format.

networkSourceId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The network source ID of the asset.

assetGroupCode

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The asset group code of the asset.

assetTypeCode

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The asset type code of the asset.

NearestNeighborJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

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

count

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

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.

costNetworkAttributeName

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

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.

nearestCategories

Property

Type: string[]

Since: ArcGIS Maps SDK for JavaScript 5.0

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.

nearestAssets

Property

Type: AssetJSON[]

Since: ArcGIS Maps SDK for JavaScript 5.0

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.

PropagatorJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Propagators define how values are propagated during a trace.

networkAttributeName

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of the network attribute used to filter the propagator condition.

substitutionAttributeName

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The network attribute used for substitution.

propagatorfunctionType

Property

Type: "bitwiseAnd" | "min" | "max"

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of function used for propagation, such as bitwiseAnd, min, or max.

operator

Property

Type: OperatorType

Since: ArcGIS Maps SDK for JavaScript 5.0

The operator used for propagation (for example, equal to or less than).

value

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The specific value of the network attribute or category used for propagation.

propagatedAttributeName

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of the field used to store calculated propagated values.

ResultType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Specifies the type of results to return after running a trace.

type

Property

Type: "elements" | "aggregatedGeometry" | "paths" | "circuits"

Since: ArcGIS Maps SDK for JavaScript 5.0

Specifies the return type for the trace.

includeFlowDirections

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

Specifies whether to return flow directions for network edges. Intended for use with subnetwork based traces where flow is modeled using subnetwork controllers.

See also

NetworkElement.flowDirection

includeGeometry

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Specifies whether to return geometry values in resultTypes.

includePropagatedValues

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Specifies whether to return propagated values in resultTypes.

networkAttributeNames

Property

Type: string[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Specifies the network attribute names.

diagramTemplateName

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Specifies the name of a predefined Diagram Template.

resultTypeFields

Property

Type: Object[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Specifies the types of output fields that can be generated from geoprocessing tools.

Example

// Creates a new instance of this class and initializes it with values inputted in json format. A resultTypes object is passed into the resultTypes property.
const traceParameters = TraceParameters.fromJSON({
   traceConfigurationGlobalId: "{DF22DA8D-6EC0-408B-A8B2-E468EC7DC9BF}",
   moment: 1554214441244,
   gdbVersion: "SDE.DEFAULT",
   resultTypes: [
     {
       type: "elements",
       includeGeometry: false,
       includePropagatedValues: false,
       networkAttributeNames: [],
       diagramTemplateName: "",
       resultTypeFields: []
     },
     {
       type: "aggregatedGeometry",
       includeGeometry: false,
       includePropagatedValues: false,
       networkAttributeNames: [],
       diagramTemplateName: "",
       resultTypeFields: []
     }
   ],
   traceType: "subnetwork"
 });

ExportCircuitsResultType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Specifies the type of results to export for circuits.

type

Property

Type: "features" | "connectivity" | "associations" | "circuits"

Since: ArcGIS Maps SDK for JavaScript 5.0

The return type for the export.

includeGeometry

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Whether to include geometry values in the export.

includeDomainDescriptions

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Specifies whether domain descriptions will be included in the output file to communicate domain mapping for features and connectivity.

networkAttributeNames

Property

Type: string[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The network attributes that will be included in the result.

diagramTemplateName

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of a predefined diagram template.

resultTypeFields

Property

Type: Record<string, any>[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The feature class and field name values to include in the export.

Example

const exportCircuitProperties = {
  circuitNames: ["TESTCIRCUIT"],
  exportAcknowledgement: false,
  resultTypes: [
    {
      type: "features",
      includeGeometry: true,
      includeDomainDescriptions: true,
      networkAttributeNames: ["Asset group", "Asset type"],
      diagramTemplateName: "",
      resultTypeFields: [
        { networkSourceId: 20, fieldName: "FIRSTUNIT" },
        { networkSourceId: 20, fieldName: "LASTUNIT" },
      ],
    },
  ],
};

const exportResult = await circuitManager.export(exportCircuitProperties);

ValidationSetItemJSON

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

ValidationSetItemJSON represents the set of features and objects to validate.

sourceId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The network source id of the.

globalIds

Property

Type: string[]

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of globalId strings to validate.

Example

const validationResult = await network.submitTopologyValidationJob(
  new ValidateNetworkTopologyParameters({
    validateArea: extent,
    gdbVersion: "sde.DEFAULT",
    validationType: "rebuild",
    sessionID: "{7865BAA6-ED9C-4346-9F72-894A49E10C73}",
    validationSet: [
      {
        sourceId: 4134325151,
        globalIds: ["{7865BAA6-ED9C-4346-9F72-894A49E10C73}"]
      }
    ]
  })
);

console.log("result: ", validationResult);