@arcgis/core

import type Collection from "../../core/Collection.js"; import type SpatialReference from "../../geometry/SpatialReference.js"; import type PointBarrier from "./PointBarrier.js"; import type PolygonBarrier from "./PolygonBarrier.js"; import type PolylineBarrier from "./PolylineBarrier.js"; import type TravelMode from "./TravelMode.js"; import type { ClonableMixin } from "../../core/Clonable.js"; import type { JSONSupport } from "../../core/JSONSupport.js"; import type { AttributeParameterValue, DirectionsDetail, DirectionsStyleName, LengthUnit, NetworkDate, NetworkInput, OutputLine, TimeOfDay, TravelDirection, UTurnRestriction } from "./types.js"; import type { SpatialReferenceProperties } from "../../geometry/SpatialReference.js"; import type { TravelModeProperties } from "./TravelMode.js"; export interface ClosestFacilityParametersProperties extends Partial<Pick<ClosestFacilityParameters, "accumulateAttributes" | "apiKey" | "attributeParameterValues" | "defaultCutoff" | "defaultTargetFacilityCount" | "directionsLanguage" | "directionsLengthUnits" | "directionsOutputType" | "directionsStyleName" | "directionsTimeAttribute" | "facilities" | "geometryPrecision" | "geometryPrecisionM" | "geometryPrecisionZ" | "ignoreInvalidLocations" | "impedanceAttribute" | "incidents" | "outputGeometryPrecision" | "outputGeometryPrecisionUnits" | "outputLines" | "overrides" | "pointBarriers" | "polygonBarriers" | "polylineBarriers" | "preserveObjectID" | "restrictionAttributes" | "restrictUTurns" | "returnDirections" | "returnFacilities" | "returnIncidents" | "returnPointBarriers" | "returnPolygonBarriers" | "returnPolylineBarriers" | "returnRoutes" | "returnTraversedEdges" | "returnTraversedJunctions" | "returnTraversedTurns" | "returnZ" | "timeOfDay" | "timeOfDayIsUTC" | "timeOfDayUsage" | "travelDirection" | "useHierarchy">> { /** * Use this property to specify the spatial reference of the geometries, such as line or point features, returned by * a solve operation. * * @see [outSR](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#outsr) */ outSpatialReference?: SpatialReferenceProperties | null; /** * A travel mode represents a means of transportation, such as driving or walking. Travel modes define the physical * characteristics of a vehicle or pedestrian. * * Use [fetchServiceDescription()](https://developers.arcgis.com/javascript/latest/references/core/rest/networkService/#fetchServiceDescription) to * obtain a list of predefined travel modes and the default travel mode that is used if one is not specified in a * routing reqest. * * @see [Introduction to travel modes](https://enterprise.arcgis.com/en/portal/latest/administer/windows/travel-modes.htm) * @see [Default travel modes](https://enterprise.arcgis.com/en/portal/latest/administer/windows/travel-modes.htm#GUID-96DF7F50-E0B2-4BF3-8271-EB515D3F0107) * @see [travelMode](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#travelmode) */ travelMode?: TravelModeProperties | null; } /** * ClosestFacilityParameters provides the input parameters for a [closestFacility](https://developers.arcgis.com/javascript/latest/references/core/rest/closestFacility/) request. * * @since 4.20 * @see [closestFacility](https://developers.arcgis.com/javascript/latest/references/core/rest/closestFacility/) * @see [ClosestFacilitySolveResult](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilitySolveResult/) * @see [Closest Facility service with synchronous execution](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services.htm) */ export default class ClosestFacilityParameters extends ClosestFacilityParametersSuperclass { constructor(properties?: ClosestFacilityParametersProperties); /** * Use this property to specify whether the operation should accumulate values other than the value specified for * [impedanceAttribute](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#impedanceAttribute). For example, if your impedanceAttribute is set to `travel-time`, the total * travel time for the route will be calculated by the operation. However, if you also want to calculate the total * distance of the route in miles, you can specify `Miles` as the value for the accumulateAttributes property. * * Known Value | * ------------| * kilometers | * miles | * meters | * minutes | * time-at-1kph * travel-time | * truck-minutes | * truck-travel-time | * walk-time | * * @see [Network attributes](https://pro.arcgis.com/en/pro-app/latest/help/analysis/networks/what-are-network-attributes-.htm). * @see [accumulateAttributeNames](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#accumulateattributenames) */ accessor accumulateAttributes: string[] | null | undefined; /** * An authorization string used to access a resource or service. * [API keys](https://developers.arcgis.com/documentation/security-and-authentication/api-key-authentication/) are generated and managed in the * portal. An API key is tied explicitly to an ArcGIS account; it is also used to * monitor service usage. * Setting a fine-grained API key on a specific class overrides the [global API key](https://developers.arcgis.com/javascript/latest/references/core/config/#Config-apiKey). * * @since 4.21 * @see [API keys](https://developers.arcgis.com/documentation/security-and-authentication/api-key-authentication/) * @see [Display a map tutorial - get an API key](https://developers.arcgis.com/javascript/latest/display-a-map/#get-an-access-token) * @see [token](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#token) * @example * const start = new Graphic({ * geometry: { * type: "point", * x: -13656212.041436872, * y: 5703897.952531632, * spatialReference * } * }); * * const stores = [ * [-122.67484, 45.52087], * [-122.68365, 45.52327], * [-122.66406, 45.52378] * ]; * * const storeGraphics = stores.map( * (store) => * new Graphic({ * geometry: { * type: "point", * longitude: store[0], * latitude: store[1], * spatialReference * } * }) * ); * * const closestFacilityParameters = new ClosestFacilityParameters({ * apiKey: "YOUR_API_KEY", * incidents: new FeatureSet({ * features: [start] * }), * facilities: new FeatureSet({ * features: storeGraphics * }), * defaultTargetFacilityCount: 2 * }); * * const results = await solve(url, closestFacilityParameters); */ accessor apiKey: string | null | undefined; /** * Use this property to specify additional values required by an attribute or restriction, such as to specify * whether the restriction prohibits, avoids, or prefers travel on restricted roads. If the restriction is meant to * avoid or prefer roads, you can further specify the degree to which they are avoided or preferred using this * property. For example, you can choose to never use toll roads, avoid them as much as possible, or prefer them. * * @see [attributeParameterValues](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#attributeparametervalues) */ accessor attributeParameterValues: AttributeParameterValue[] | null | undefined; /** * The travel time or travel distance value at which to stop searching for facilities for a given incident. For * example, while finding the closest hospitals from the site of an accident, a cutoff value of 15 minutes means that * the tool will search for the closest hospital within 15 minutes from the incident. If the closest hospital is 17 * minutes away, no routes will be returned in the output routes. A cutoff value is especially useful when searching * for multiple facilities. * * The unit for this parameter is based on the unit of the impedance attribute specified using the * [impedanceAttribute](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#impedanceAttribute) parameter or the * [TravelMode.impedanceAttributeName](https://developers.arcgis.com/javascript/latest/references/core/rest/support/TravelMode/#impedanceAttributeName) of the * [travel mode](https://developers.arcgis.com/javascript/latest/references/core/rest/support/TravelMode/) if travel mode is specified . If the * impedanceAttributeName parameter is TravelTime, the defaultCutoff is specified in minutes. Otherwise, the value is * specified in miles or kilometers based on whether the impedanceAttributeName is set to Miles or Kilometers, * respectively. * * @see [defaultCutoff](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#defaultcutoff) */ accessor defaultCutoff: number | null | undefined; /** * The number of closest facilities to find per incident. This is useful in situations in which multiple fire engines * may be required from different fire stations, such as a fire. You can specify, for example, to find the three * nearest fire stations to a fire. * * The value for this parameter can be overridden on a per incident basis by specifying a value for the * TargetFacilityCount attribute when specifying the incidents parameter. * * @see [defaultTargetFacilityCount](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#defaulttargetfacilitycount) */ accessor defaultTargetFacilityCount: number | null | undefined; /** * The language that will be used when generating travel directions. This parameter applies only when the * [returnDirections](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#returnDirections) parameter is set to `true`. The service supports generating directions in * the following languages: `ar`, `bg`, `bs`, `ca`, `cs`, `da`, `de`, `el`, `en`, `es`, `et`, `fi`, `fr`, `he`, `hr`, * `hu`, `id`, `it`, `ja`, `ko`, `lt`, `lv`, `nb`, `nl`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `sk`, `sl`, `sr`, `sv`, * `th`, `tr`, `uk`, `vi`, `zh-CN`, `zh-HK` and `zh-TW`. * * @see [directionsLanguage](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#directionslanguage) */ accessor directionsLanguage: string | null | undefined; /** * Specify the units for displaying travel distance in the driving directions. This parameter applies only when the * [returnDirections](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#returnDirections) parameter is set to `true`. * * @see [directionsLengthUnits](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#directionslengthunits) */ directionsLengthUnits?: LengthUnit | null; /** * Define the content and verbosity of the driving directions. This parameter applies only when the * [returnDirections](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#returnDirections) parameter is set to `true`. * * @see [directionsOutputType](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#directionsoutputtype) */ directionsOutputType?: DirectionsDetail | null; /** * Specify the name of the formatting style for the directions. * * @see [directionsStyleName](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#directionsstylename) */ directionsStyleName?: DirectionsStyleName | null; /** * Set the time-based impedance attribute to display the duration of a maneuver, such as "Go northwest on Alvorado * St. for 5 minutes." The units for all the time attributes is minutes. * * Known Value | * ------------| * minutes | * time-at-1-kph | * travel-time | * truck-minutes | * truck-travel-time | * walk-time * * @see [directionsTimeAttributeName](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#directionstimeattributename) */ directionsTimeAttribute?: string | null; /** * One or more locations that are searched for when finding the closest location. * * @see [facilities](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#facilities) * @example * const closestFacilityParameters = new ClosestFacilityParameters({ * facilities: new FeatureSet({ * features: [ * new Graphic({ * geometry: new Point({ x: -122.4079, 37.78356 }), * attributes: { * "Name": "Fire Station 34", * "Attr_TravelTime": 4 * } * }), * new Graphic({ * geometry: new Point({ x: -122.404, 37.782 }), * attributes: { * "Name": "Fire Station 29", * "Attr_TravelTime": 5 * } * }) * ] * }) * }); */ accessor facilities: NetworkInput | null | undefined; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * This applies to x- and y-values only (not m- or z-values). * * @since 4.25 * @see [geometryPrecision](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#geometryprecision) */ accessor geometryPrecision: number | null | undefined; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * This applies to m-value only (not x-,y- or z-values). * * @since 4.25 * @see [geometryPrecisionM](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#geometryprecisionm) */ accessor geometryPrecisionM: number | null | undefined; /** * Use this property to specify the number of decimal places in the response geometries returned by a solve operation. * This applies to z-value only (not x-,y- or m-values). * * @since 4.25 * @see [geometryPrecisionZ](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#geometryprecisionz) */ accessor geometryPrecisionZ: number | null | undefined; /** * Specify whether invalid input locations should be ignored when finding the best solution. An input point is deemed * invalid by the operation if it is not within the maximum snap tolerance of any traversable street. When `true` * invalid points are ignored. When `false` any invalid point in your request will cause the operation to return a failure. * * @since 4.25 * @see [ignoreInvalidLocations](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#ignoreinvalidlocations) */ accessor ignoreInvalidLocations: boolean | null | undefined; /** * Specifies the impedance. * * Impedance is a value that quantifies travel along the transportation network. Travel distance is an example of * impedance; it quantifies the length of walkways and road segments. Similarly, drive time—the typical time it takes * to drive a car along a road segment—is an example of impedance. This property will be ignored if * [travelMode](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#travelMode) is set. * * Known Value | * ------------| * kilometers | * miles | * meters | * minutes | * time-at-1kph * travel-time | * truck-minutes | * truck-travel-time | * walk-time | * * @see [Network attributes](https://pro.arcgis.com/en/pro-app/latest/help/analysis/networks/what-are-network-attributes-.htm). * @see [impedanceAttributeName](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#impedanceattributename) */ impedanceAttribute?: string | null; /** * One or more locations from which the service searches for the nearby locations * * @see [incidents](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#incidents) * @example * const closestFacilityParameters = new ClosestFacilityParameters({ * incidents: new FeatureSet({ * features: [ * new Graphic({ * geometry: new Point({ x: -122.4079, 37.78356 }), * attributes: { * "Name": "Fire Incident 1", * "Attr_TravelTime": 4 * } * }), * new Graphic({ * geometry: new Point({ x: -122.404, 37.782 }), * attributes: { * "Name": "Crime Incident 45", * "Attr_TravelTime": 5 * } * }) * ] * }) * }); */ accessor incidents: NetworkInput | null | undefined; /** * Use this property to specify by how much you want to simplify the route geometry returned by the operation. * Simplification maintains critical points on a route, such as turns at intersections, to define the essential shape * of the route and removes other points. The value of this property, regardless of whether you rely on the default * or explicitly set a value, is overridden when you pass in [travelMode](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#travelMode). * * The units are specified with the [outputGeometryPrecisionUnits](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#outputGeometryPrecisionUnits) parameter. * * @see [outputGeometryPrecision](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#outputgeometryprecision) */ accessor outputGeometryPrecision: number | null | undefined; /** * Use this property to specify the units for the value specified for the * [outputGeometryPrecision](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#outputGeometryPrecision) parameter. The value of this parameter, regardless of whether * you rely on the default or explicitly set a value, is overridden when you pass in [travelMode](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#travelMode). * * @see [outputGeometryPrecisionUnits](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#outputgeometryprecisionunits) */ outputGeometryPrecisionUnits?: LengthUnit | null; /** * Use this property to specify the type of route features that are output by the operation. This parameter is * applicable only if the [returnRoutes](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#returnRoutes) parameter is set to `true`. * * Possible Value | Description * ------------------------|------------------------ * none | Do not return any shapes for the routes. * straight | Return a straight line between the stops. * true-shape | Return the exact shape of the resulting route that is based on the underlying streets. * true-shape-with-measure | Return the exact shape of the resulting route that is based on the underlying streets and include route measurements that keep track of the cumulative travel time or travel distance along the route relative to the first stop. * * @see [outputLines](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#outputlines) */ outputLines?: OutputLine | null; /** * Use this property to specify the spatial reference of the geometries, such as line or point features, returned by * a solve operation. * * @see [outSR](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#outsr) */ get outSpatialReference(): SpatialReference | null | undefined; set outSpatialReference(value: SpatialReferenceProperties | null | undefined); /** * Specify additional settings that can influence the behavior of the solver when finding solutions for the network * analysis problems. * * @since 4.25 * @see [overrides](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#overrides) */ accessor overrides: Record<string, number | boolean | string> | null | undefined; /** * Use this property to specify one or more points that will act as temporary restrictions or represent additional * time or distance that may be required to travel on the underlying streets. For example, a point barrier can be * used to represent a fallen tree along a street or a time delay spent at a railroad crossing. * * @see [barriers](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#barriers) */ accessor pointBarriers: (NetworkInput | Collection<PointBarrier>) | null | undefined; /** * Use this property to specify polygons that either completely restrict travel or proportionately scale the time or * distance required to travel on the streets intersected by the polygons. * * @see [polygonBarriers](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#polygonbarriers) */ accessor polygonBarriers: (NetworkInput | Collection<PolygonBarrier>) | null | undefined; /** * Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets. For * example, a parade or protest that blocks traffic across several street segments can be modeled with a line * barrier. * * @see [polylineBarriers](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#polylinebarriers) */ accessor polylineBarriers: (NetworkInput | Collection<PolylineBarrier>) | null | undefined; /** * Use this property to specify if the Object IDs specified for input locations such as stops or barriers should be * preserved when the input locations are returned as output. * * @since 4.25 * @see [preserveObjectID](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#preserveobjectid) */ accessor preserveObjectID: boolean | null | undefined; /** * Use this property to specify which restrictions should be honored by the operation. A restriction represents a * driving preference or requirement. This value is ignored if [travelMode](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#travelMode) is specified. * * Known Value | * ------------| * any-hazmat-prohibited | * avoid-carpool-roads | * avoid-express-lanes | * avoid-ferries | * avoid-gates | * avoid-limited-access-roads | * avoid-private-roads | * avoid-roads-unsuitable-for-pedestrians | * avoid-stairways | * avoid-toll-roads | * avoid-toll-roads-for-trucks | * avoid-truck-restricted-roads | * avoid-unpaved-roads | * axle-count-restriction | * driving-a-bus | * driving-a-taxi | * driving-a-truck | * driving-an-automobile | * driving-an-emergency-vehicle | * height-restriction | * kingpin-to-rear-axle-length-restriction | * length-restriction | * preferred-for-pedestrians | * riding-a-motorcycle | * roads-under-construction-prohibited | * semi-or-tractor-with-one-or-more-trailers-prohibited | * single-axle-vehicles-prohibited | * tandem-axle-vehicles-prohibited | * through-traffic-prohibited | * truck-with-trailers-restriction | * use-preferred-hazmat-routes | * use-preferred-truck-routes | * walking | * weight-restriction | * * @see [restrictionAttributeNames](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#restrictionattributenames) */ accessor restrictionAttributes: string[] | null | undefined; /** * Specifies how U-Turns should be handled. * * Possible Value | Description * -------------------------------|------------------------------- * allow-backtrack | U-turns are permitted everywhere. Allowing U-turns implies that the vehicle can turn around at a junction and double back on the same street. * at-dead-ends-only | U-turns are prohibited at all junctions and intersections and are permitted only at dead ends. * no-backtrack | U-turns are prohibited at all junctions, intersections, and dead-ends. * at-dead-ends-and-intersections | U-turns are prohibited at junctions where exactly two adjacent streets meet. * * @see [restrictUTurns](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#restrictuturns) */ restrictUTurns?: UTurnRestriction | null; /** * Specify whether the operation should generate driving directions for each route. If `true` directions are configured * based on the values for the [directionsLanguage](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#directionsLanguage), * [directionsOutputType](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#directionsOutputType), [directionsStyleName](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#directionsStyleName), and * [directionsLengthUnits](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#directionsLengthUnits) properties. * * @default false * @see [returnDirections](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#returndirections) */ accessor returnDirections: boolean | null | undefined; /** * Determines if facilities will be returned by the service. * * @default false * @see [returnFacilities](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#returnfacilities) */ accessor returnFacilities: boolean | null | undefined; /** * Determines if incidents will be returned by the service. * * @default false * @see [returnIncidents](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#returnincidents) */ accessor returnIncidents: boolean | null | undefined; /** * Specify whether [point barriers](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#pointBarriers) will be returned by the routing operation. * * @default false * @see [returnBarriers](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#returnbarriers) */ accessor returnPointBarriers: boolean | null | undefined; /** * Specify whether [polygon barriers](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#polygonBarriers) will be returned by the routing operation. * * @default false * @see [returnPolygonBarriers](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#returnpolygonbarriers) */ accessor returnPolygonBarriers: boolean | null | undefined; /** * Specify whether [polyline barriers](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#polylineBarriers) will be returned by the routing operation. * * @default false * @see [returnPolylineBarriers](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#returnpolylinebarriers) */ accessor returnPolylineBarriers: boolean | null | undefined; /** * Use this property to specify if the operation should return routes. If `true`, the shape of the routes depends on * the value for the [outputLines](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#outputLines) property. * * @default true * @see [returnCFRoutes](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#returncfroutes) */ accessor returnRoutes: boolean | null | undefined; /** * Specify whether traversed edges will be returned by the operation. * * @since 4.25 * @see [returnTraversedEdges](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#returntraversededges) */ accessor returnTraversedEdges: boolean | null | undefined; /** * Specify whether traversed junctions will be returned by the operation. * * @since 4.25 * @see [returnTraversedJunctions](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#returntraversedjunctions) */ accessor returnTraversedJunctions: boolean | null | undefined; /** * Specify whether traversed turns will be returned by the operation. * * @since 4.25 * @see [returnTraversedTurns](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#returntraversedturns) */ accessor returnTraversedTurns: boolean | null | undefined; /** * Include z values for the returned geometries if supported by the underlying network. * * @since 4.25 * @see [returnZ](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#returnz) */ accessor returnZ: boolean | null | undefined; /** * Specify the time and date to depart from or arrive at incidents or facilities. You can also specify a value of * "now", to set the depart or arrive time to current time. * * @see [timeOfDay](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#timeofday) */ accessor timeOfDay: NetworkDate | null | undefined; /** * Specify the time zone or zones of the [timeOfDay](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#timeOfDay) property. * * @since 4.25 * @see [timeOfDayIsUTC](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#timeofdayisutc) */ accessor timeOfDayIsUTC: boolean | null | undefined; /** * The [timeOfDay](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#timeOfDay) parameter value represents the arrival or departure time for the routes. * * @see [timeOfDayUsage](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#timeofdayusage) */ timeOfDayUsage?: TimeOfDay | null; /** * Specifies how the travel direction for the closest facility search will be measured. * * Possible Value | Description * ---------------|------------ * from-facility | Direction of travel is from facilities to incidents. * to-facility | Direction of travel is from incidents to facilities. * * @see [travelDirection](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#traveldirection) */ travelDirection?: TravelDirection | null; /** * A travel mode represents a means of transportation, such as driving or walking. Travel modes define the physical * characteristics of a vehicle or pedestrian. * * Use [fetchServiceDescription()](https://developers.arcgis.com/javascript/latest/references/core/rest/networkService/#fetchServiceDescription) to * obtain a list of predefined travel modes and the default travel mode that is used if one is not specified in a * routing reqest. * * @see [Introduction to travel modes](https://enterprise.arcgis.com/en/portal/latest/administer/windows/travel-modes.htm) * @see [Default travel modes](https://enterprise.arcgis.com/en/portal/latest/administer/windows/travel-modes.htm#GUID-96DF7F50-E0B2-4BF3-8271-EB515D3F0107) * @see [travelMode](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#travelmode) */ get travelMode(): TravelMode | null | undefined; set travelMode(value: TravelModeProperties | null | undefined); /** * Specify whether hierarchy should be used when finding the shortest paths. This value is ignored if a * [travelMode](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ClosestFacilityParameters/#travelMode) is specified. * * @default false * @see [useHierarchy](https://developers.arcgis.com/rest/services-reference/enterprise/closest-facility-sync-services/#usehierarchy) */ accessor useHierarchy: boolean | null | undefined; } declare const ClosestFacilityParametersSuperclass: typeof JSONSupport & typeof ClonableMixin