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
-
new RouteSymbols(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | more details The name of the class. | more details | Accessor | |
SimpleLineSymbol|LineSymbol3D|CIMSymbol | more details The default symbol for direction lines. | more details | RouteSymbols | |
SimpleMarkerSymbol|PictureMarkerSymbol|PointSymbol3D|CIMSymbol | more details The default symbol for direction points. | more details | RouteSymbols | |
SimpleMarkerSymbol|PictureMarkerSymbol|PointSymbol3D|CIMSymbol | more details The default symbol for point barriers. | more details | RouteSymbols | |
PictureFillSymbol|SimpleFillSymbol|PolygonSymbol3D|CIMSymbol | more details The default symbol for polygon barriers. | more details | RouteSymbols | |
SimpleLineSymbol|LineSymbol3D|CIMSymbol | more details The default symbol for polyline Barriers. | more details | RouteSymbols | |
SimpleLineSymbol|LineSymbol3D|CIMSymbol | more details The default symbol for the overall route. | more details | RouteSymbols | |
RouteStopSymbols | more details The default symbol for stop. | more details | RouteSymbols |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
-
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] } }
-
-
The default symbol for polyline Barriers.
- Default Value:{ type: "simple-line", color: [255, 85, 0, 0.7], width: 7.5 }
-
-
The default symbol for the overall route.
- Default Value:{ type: "simple-line", color: [20, 89, 127], width: 8 }
-
stops RouteStopSymbolsautocast
-
The default symbol for stop.
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
* | more details Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | more details | RouteSymbols | |
Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | RouteSymbols |
Method Details
-
fromJSON(json){*}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 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.
Returns:Type Description * Returns a new instance of this class.
-
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.