require(["esri/layers/support/RouteSymbols"], (RouteSymbols) => { /* code goes here */ });
import RouteSymbols from "@arcgis/core/layers/support/RouteSymbols.js";
esri/layers/support/RouteSymbols
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
// 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
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
The name of the class. | Accessor | ||
The default symbol for direction lines. | RouteSymbols | ||
The default symbol for direction points. | RouteSymbols | ||
The default symbol for point barriers. | RouteSymbols | ||
The default symbol for polygon barriers. | RouteSymbols | ||
The default symbol for polyline Barriers. | RouteSymbols | ||
The default symbol for the overall route. | RouteSymbols | ||
The default symbol for stop. | RouteSymbols |
Property Details
-
directionLines
PropertydirectionLines SimpleLineSymbol |LineSymbol3D |CIMSymbolautocast -
The default symbol for direction lines.
- Default Value:{ type: "simple-line", color: [0, 122, 194], width: 6 }
-
directionPoints
PropertydirectionPoints SimpleMarkerSymbol |PictureMarkerSymbol |PointSymbol3D |CIMSymbolautocast -
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
PropertypointBarriers SimpleMarkerSymbol |PictureMarkerSymbol |PointSymbol3D |CIMSymbolautocast -
The default symbol for point barriers.
- Default Value:{ type: "simple-marker", style: "x", size: 10, outline: { color: [255, 0, 0], width: 3 } }
-
polygonBarriers
PropertypolygonBarriers PictureFillSymbol |SimpleFillSymbol |PolygonSymbol3D |CIMSymbolautocast -
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
PropertypolylineBarriers SimpleLineSymbol |LineSymbol3D |CIMSymbolautocast -
The default symbol for polyline Barriers.
- Default Value:{ type: "simple-line", color: [255, 85, 0, 0.7], width: 7.5 }
-
routeInfo
PropertyrouteInfo SimpleLineSymbol |LineSymbol3D |CIMSymbolautocast -
The default symbol for the overall route.
- Default Value:{ type: "simple-line", color: [20, 89, 127], width: 8 }
-
stops
Propertystops RouteStopSymbolsautocast -
The default symbol for stop.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | RouteSymbols | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | RouteSymbols |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
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
jsonparameter 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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.