Pitney Bowes MapXtreme - Manual (Page 369)

Chapter 20: Routing
Advanced Route Options
MapXtreme v7.1 376 Developer Guide
• Focus - Specifies the focus of the route. A focused route is a subset of the whole route that
concentrates on either the beginning or end of the route. A route focused at the start will route
the user from their origin to (and including) the first major highway. A route focused at the end will
route the user from the last major highway in the route (including that highway) to the
destination. If there are no major highways in the route, the focused route will be the same as an
unfocused route. NONE signifies directions for the whole route will be returned, START signifies
that the start of the route will be returned, or END signifies that the end of the route will be
returned. The default is NONE.
• ShowDistance - Indicates whether or not to return the distance of a direction in the driving
directions. The default is true.
• ShowPrimaryNameOnly - Specifies whether or not to show only the primary street names. It is
often the case that a street contains multiple names. This is used to indicate whether all names
for the street should be shown in the directions or only the primary name. If set to true, only the
primary name of the street will be used in the directions. If set to false, the primary name and all
alternate names will be used. The default is false.
• ShowTime - Indicates whether or not to return the time it takes to follow a direction in the driving
directions. The default is true.
• Style - Specifies the type of directions to return. The client can return two types of directions,
normal and terse. Normal is the standard driving direction instructions. For example “Turn left on
Yonge Blvd and travel Southeast (1 s)”. Terse directions are shorter directions that are more
suitable for wireless devices. For example “L on Yonge Blvd”. This can be set to NORMAL or
TERSE. The default setting is NORMAL.
Setting the Direction Language
You can manipulate the output language of your route instructions by changing the UserLocale
property. The route client uses ISO standard locale code <language>_<country> (for example,
French is fr_FR, German is de_DE). Currently the route client supports EN, FR, DA, DE, FI, NL, NO,
ES, PT, IT, SV. English (en_US) is the default language.
Route Geometry
The ability to create a route geometry is a vital capability in creating maps and analysis of a route.
The route geometry is the visual representation of the route. By default the route geometry is not
returned. However, you can return the route geometry in the response by setting the
ReturnGeometry property to true.
Avoiding Points, Features, and Segments
You can avoid or exclude types of roads, points, or route segments. Before determining a route, you
may already know of a road or location that you would like to avoid based on traffic information,
accidents, holidays, rush hour, or any other known factor.
There are three types of avoids or excludes: points, features, and segments: