RouteSymbols | References | ArcGIS Maps SDK for JavaScript

import RouteSymbols from "@arcgis/core/layers/support/RouteSymbols.js";

Inheritance:: RouteSymbols→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.24

RouteSymbols contains a set of symbols that will be used by RouteLayer to symbolize new stops, barriers and directions.

An instance of RouteSymbols can be retrieved from or assigned to the RouteLayer.defaultSymbols property of a RouteLayer. This property determines the symbol used when a new Stop, PointBarrier, PolylineBarrier or PolygonBarrier is added to a RouteLayer. This defaultSymbols property is also used to symbolize the results of a solved routes, specifically the network objects stored in the RouteLayer.stops, RouteLayer.pointBarriers, RouteLayer.polylineBarriers, RouteLayer.polygonBarriers, RouteLayer.directionPoints, RouteLayer.directionLines, and RouteLayer.routeInfo properties.

Whilst it is possible to assign any symbol (of appropriate dimensionality) to any property you should be cognisant of the end user's environment. For example, it is not advisable to assign a 3D symbol if it is anticipated that the route layer will be used in MapView. Similarly CIM symbols are not supported in SceneView nor the classic MapViewer.

To not show or hide a particular network feature, set the associated property to null.

See also

RouteLayer

Example

// When a route is solved, display the direction lines with a thick cyan line and hide both diection points and the
// overall route line.
const layer = new RouteLayer({
  defaultSymbols: {
   directionLines: {
     type: "simple-line",
     color: [105, 220, 255],
     width: 7,
     cap: "round",
     join: "round"
   },
   directionPoints: null,
   routeInfo: null
  }
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`RouteSymbolsProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`directionLines`	`LineSymbolUnion \| null \| undefined`
`directionPoints`	`PointSymbolUnion \| null \| undefined`
`pointBarriers`	`PointSymbolUnion \| null \| undefined`
`polygonBarriers`	`PolygonSymbolUnion \| null \| undefined`
`polylineBarriers`	`LineSymbolUnion \| null \| undefined`
`routeInfo`	`LineSymbolUnion \| null \| undefined`
`stops`	`RouteStopSymbols \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

directionLines

autocast Property

Type: LineSymbolUnion | null | undefined

The default symbol for direction lines.

Default value: { type: "simple-line", color: [0, 122, 194], width: 6 }

directionPoints

autocast Property

Type: PointSymbolUnion | null | undefined

The default symbol for direction points.

Default value: { type: "simple-marker", color: [255, 255, 255], size: 6, outline: { color: [0, 122, 194], width: 2 } }

pointBarriers

autocast Property

Type: PointSymbolUnion | null | undefined

The default symbol for point barriers.

Default value: { type: "simple-marker", style: "x", size: 10, outline: { color: [255, 0, 0], width: 3 } }

polygonBarriers

autocast Property

Type: PolygonSymbolUnion | null | undefined

The default symbol for polygon barriers.

Default value: { type: "simple-fill", color: [255, 170, 0, 0.6], outline: { width: 7.5, color: [255, 0, 0, 0.6] } }

polylineBarriers

autocast Property

Type: LineSymbolUnion | null | undefined

The default symbol for polyline Barriers.

Default value: { type: "simple-line", color: [255, 85, 0, 0.7], width: 7.5 }

routeInfo

autocast Property

Type: LineSymbolUnion | null | undefined

The default symbol for the overall route.

Default value: { type: "simple-line", color: [20, 89, 127], width: 8 }

stops

autocast Property

Type: RouteStopSymbols | null | undefined

The default symbol for stop.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.