Types
import type { AttributeParameterValue, MessageType, OutputLine, OutputPolygon, LengthUnit } from "@arcgis/core/rest/support/types.js";Type definitions
AttributeParameterValue
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
An object describing the parameter values for the RouteParameters.attributeParameterValues property, which is used by RouteParameters, ClosestFacilityParameters and ServiceAreaParameters.
attributeName
Property
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The name of the attribute.
parameterName
Property
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The name of the parameter associated with the restriction. A restriction can have one or more parameterName properties.
MessageType
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "informative" | "process-definition" | "process-start" | "process-stop" | "warning" | "error" | "empty" | "abort"
OutputLine
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "none" | "straight" | "true-shape" | "true-shape-with-measure"
OutputPolygon
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "none" | "simplified" | "detailed"
LengthUnit
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- CoreLengthUnit | "decimal-degrees" | "points" | "unknown"
GPLinearUnit
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- LengthUnit | "international-feet" | "international-inches" | "international-miles" | "international-nautical-miles" | "international-yards"
AreaUnit
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "ares" | "hectares" | "international-acres" | "square-centimeters" | "square-decimeters" | "square-international-feet" | "square-international-inches" | "square-international-miles" | "square-international-yards" | "square-kilometers" | "square-meters" | "square-millimeters" | "square-us-feet" | "square-us-inches" | "square-us-miles" | "square-us-yards" | "unknown" | "us-acres"
GeometryOperationLengthUnit
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"
DirectionsDetail
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "complete" | "complete-no-events" | "featuresets" | "instructions-only" | "standard" | "summary-only"
UTurnRestriction
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections"
TravelDirection
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "from-facility" | "to-facility"
TraveModeType
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "automobile" | "truck" | "walk" | "other"
NetworkInput
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl
CurbApproach
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "either-side-of-vehicle" | "right-side-of-vehicle" | "left-side-of-vehicle" | "no-u-turn"
LocationType
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "stop" | "waypoint" | "break"
Status
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "ok" | "not-located" | "network-element-not-located" | "element-not-traversable" | "invalid-field-values" | "not-reached" | "time-window-violation" | "not-located-on-closest"
BarrierType
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "restriction" | "scaled-cost" | "added-cost"
DirectionPointType
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "arrive" | "bear-left" | "bear-right" | "boundary-crossing" | "central-fork" | "clockwise-roundabout" | "counter-clockwise-roundabout" | "depart" | "door" | "down-elevator" | "down-escalator" | "down-stairs" | "elevator" | "escalator" | "general-event" | "header" | "landmark" | "lane" | "left-fork" | "left-handed-u-turn" | "left-ramp" | "left-turn" | "left-turn-and-immediate-left-turn" | "left-turn-and-immediate-right-turn" | "off-ferry" | "on-ferry" | "pedestrian-ramp" | "restriction-violation" | "right-fork" | "right-handed-u-turn" | "right-ramp" | "right-turn" | "right-turn-and-immediate-left-turn" | "right-turn-and-immediate-right-turn" | "roundabout" | "scaled-cost-barrier-event" | "sharp-left" | "sharp-right" | "stairs" | "straight" | "time-zone-change" | "traffic-event" | "u-turn" | "up-elevator" | "up-escalator" | "up-stairs"
DirectionLineType
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "unknown" | "segment" | "maneuver-segment" | "restriction-violation" | "scaled-cost-barrier" | "heavy-traffic" | "slow-traffic" | "moderate-traffic"
NetworkFeature
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- DirectionLine | DirectionPoint | PointBarrier | PolygonBarrier | PolylineBarrier | RouteInfo | Stop
DirectionsStyleName
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "campus" | "desktop" | "navigation"
SpatialRelationship
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "intersects" | "contains" | "crosses" | "disjoint" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation"
GeometryType
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "point" | "polyline" | "polygon" | "envelope" | "multipoint"
DirectionsStringType
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "alt-name" | "arrive" | "branch" | "cross-street" | "cumulative-length" | "depart" | "estimated-arrival-time" | "exit" | "general" | "length" | "service-time" | "street-name" | "summary" | "time" | "time-window" | "toward" | "violation-time" | "wait-time"
NetworkAttributeAccerationUnit
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "kilometers-per-hour" | "miles-per-hour"
JobStatus
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "job-cancelled" | "job-cancelling" | "job-deleted" | "job-deleting" | "job-timed-out" | "job-executing" | "job-failed" | "job-new" | "job-submitted" | "job-succeeded" | "job-waiting"
PrintReportTemplate
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "attribute-list-letter-ansi-a-landscape" | "attribute-list-letter-ansi-a-portrait" | "attribute-list-with-group-letter-ansi-a-landscape" | "attribute-list-with-group-letter-ansi-a-portrait" | "page-per-feature-letter-ansi-a-landscape" | "page-per-feature-letter-ansi-a-portrait"
PrintLayoutTemplate
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "map-only" | "a3-landscape" | "a3-portrait" | "a4-landscape" | "a4-portrait" | "letter-ansi-a-landscape" | "letter-ansi-a-portrait" | "tabloid-ansi-b-landscape" | "tabloid-ansi-b-portrait"
PrintFileFormat
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "aix" | "eps" | "gif" | "jpg" | "pdf" | "png32" | "png8" | "svg" | "svgz" | "tiff"
ColorRampAlgorithmType
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The algorithm used to generate the colors between the fromColor and toColor. Each algorithm uses different methods for
generating the intervening colors.
| Possible Value | Description |
|---|---|
| cie-lab | Blends the from and to colors without traversing the intervening hue space. |
| lab-lch | The hue, saturation, value (hsv) algorithm is a linear traverse of colors between pairs: Color 1 H to Color 2 H, Color 1 S to Color 2 S, and Color 1 V to Color 2 V. |
| hsv | The lab-lch algorithm is very similar to the cie-lab but does not seek the shortest path between colors. |
- See also
- Type
- "cie-lab" | "lab-lch" | "hsv"
DateBinTimeUnit
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Temporal unit used to generate bins or defines and an offset. It defines a length of time such as years or months.
The unit value is defined via DateBinTimeInterval.value property.
- See also
- Type
- "years" | "quarters" | "months" | "weeks" | "days" | "hours" | "minutes" | "seconds"
DeviationUnit
Type definition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The maximum deviation unit. If the unit is not specified, units are derived from the spatial reference. Use one of the possible values listed below or any of the numeric codes for linear units.
- Type
- Exclude<LengthUnit, "us-feet"> | "decimal-degrees"