RouteSymbols | API Reference | ArcGIS Maps SDK for JavaScript 4.32

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 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 stops, pointBarriers, polylineBarriers, polygonBarriers, directionPoints, directionLines, and 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

RouteSymbols Constructor new RouteSymbols(properties)

Parameter

properties Object

optional

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

Property Overview

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

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
SimpleLineSymbol\|LineSymbol3D\|CIMSymbol\|null\|undefined	The default symbol for direction lines.	RouteSymbols
SimpleMarkerSymbol\|PictureMarkerSymbol\|PointSymbol3D\|CIMSymbol\|null\|undefined	The default symbol for direction points.	RouteSymbols
SimpleMarkerSymbol\|PictureMarkerSymbol\|PointSymbol3D\|CIMSymbol\|null\|undefined	The default symbol for point barriers.	RouteSymbols
PictureFillSymbol\|SimpleFillSymbol\|PolygonSymbol3D\|CIMSymbol\|null\|undefined	The default symbol for polygon barriers.	RouteSymbols
SimpleLineSymbol\|LineSymbol3D\|CIMSymbol\|null\|undefined	The default symbol for polyline Barriers.	RouteSymbols
SimpleLineSymbol\|LineSymbol3D\|CIMSymbol\|null\|undefined	The default symbol for the overall route.	RouteSymbols
RouteStopSymbols\|null\|undefined	The default symbol for stop.	RouteSymbols

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

directionLines Property directionLines SimpleLineSymbol |LineSymbol3D |CIMSymbol |null |undefinedautocast

The default symbol for direction lines.

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

The default symbol for direction points.

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

The default symbol for point barriers.

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

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 Property polylineBarriers SimpleLineSymbol |LineSymbol3D |CIMSymbol |null |undefinedautocast

The default symbol for polyline Barriers.

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

routeInfo Property routeInfo SimpleLineSymbol |LineSymbol3D |CIMSymbol |null |undefinedautocast

The default symbol for the overall route.

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

stops Property stops RouteStopSymbols |null |undefinedautocast

The default symbol for stop.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
*\|null\|undefined	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	RouteSymbols
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	RouteSymbols

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

fromJSON Method fromJSON(json){* |null |undefined}static

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.

Parameter

json Object

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

Type	Description
* \| null \| undefined	Returns a new instance of this class.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON Method toJSON(){Object}

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

Returns

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.