Share via

Route Class

  • Article

Route Class

Represents a calculated route. Contains the specification of the route, the route itinerary, and a binary representation that can be used to render routes on a map.

Public Class Route
    Member of [Namespace]
[C#]
public class Route : System.Object
    Member of [Namespace]

Public Properties

public propertyCalculatedRepresentation A binary object representing the calculated route (CalculatedRouteRepresentation object), which can be used to render a highlighted route on a map.
public propertyItinerary The directions, map view representations, and summary information about the calculated route (RouteItinerary object).
public propertySpecification Contains all the information necessary to calculate a route (RouteSpecification object), including route segments and data source.

Remarks

  • The Route object is returned from the RouteServiceSoap.CalculateRoute or RouteServiceSoap.CalculateSimpleRoute method.
  • The CalculatedRepresentation property is returned from the RouteServiceSoap.CalculateRoute method unless the RouteSpecification.ResultMask property has a value of Itinerary (RouteResultMask enumeration). It is not returned from the RouteServiceSoap.CalculateSimpleRoute method.
  • The Route object is used in the MapSpecification.Route property and passed to the RenderServiceSoap.GetMap method.
  • To render a map of a route, pass the CalculatedRepresentation or Specification property (or both) to the RenderServiceSoap.GetMap method. For increased performance when rendering a map of a route, pass the Itinerary and Specification properties as null.

See Also

CalculatedRouteRepresentation Class | RouteItinerary Class | RouteSpecification Class | RouteServiceSoap.CalculateRoute Method | RouteServiceSoap.CalculateSimpleRoute Method | RouteSpecification.ResultMask Property | RouteResultMask Enumeration | MapSpecification.Route Property | RenderServiceSoap.GetMap Method