Google Maps Interface

Property

Description

directionsAvoidHighways

When set to non-zero, major highways are avoided where possible when the route is calculated. Boolean value. (Default: Off or 0)

directionsAvoidTolls

When set to non-zero, toll roads are avoided where possible when the route is calculated. Boolean value. (Default: Off or 0)

directionsDestination$

Contains the address of the destination used in the last directions request. Set to null if the last request used latitude/longitude values to specify the location of the destination.

directionsDestinationLatitude

Contains the latitude of the destination used in the last directions request. Set to 0 if the last request used an address to set the location of the destination.

directionsDestinationLongitude

Contains the longitude of the destination used in the last directions request. Set to 0 if the last request used an address to set the location of the destination.

directionsDraggable

When set to non-zero, the user will be able to dynamically modify directions by clicking and dragging the paths on the map. Boolean value. (Default: Off or 0)

directionsHideRouteList

When set to non-zero, the route list in the directions pane that is displayed when alternate routes are calculated is suppressed, i.e. when the directionsProvideRouteAlternatives property is turned On. Boolean value. (Default: Off or 0)

directionsOptimizeWaypoints

When this property is set to non-zero and all waypoints are classified as stopovers, the waypoint sequence is overridden and the optimum route through the waypoints is determined. Boolean value. (Default: Off or 0)

directionsOrigin$

Contains the address of the origin used in the last directions request. Set to null if the last request used latitude/longitude values to specify the location of the origin.

directionsOriginLatitude

Contains the latitude of the origin used in the last directions request. Set to 0 if the last request used an address to set the location of the origin.

directionsOriginLongitude

Contains the longitude of the origin used in the last directions request. Set to 0 if the last request used an address to set the location of the origin.

directionsPanePercent

Percent (0 - 100) of the designated horizontal map area to be used to display directions. If set to 0, then a default value of 30 will be used.

Note:
This property must be set in the map definition and cannot be changed subsequently.

directionsPreserveViewport

When set to non-zero, the current map viewport is maintained when directions are displayed rather the viewport being adjusted to center and display the entire route. Boolean value. (Default: Off or 0)

directionsProvideRouteAlternatives

When set to non-zero, alternate routes may be calculated. Setting this property may slow down response time, and multiple routes are not guaranteed.

directionsRegion$

Region code. Used for biasing results to a particular region.

directionsRouteColor$

directionsRouteColour$

Color of the route displayed on the map. Can be a standard PxPlus color (e.g. Light red, Dark blue, etc.) or an RGB value (e.g. RGB:192 0 255).

directionsRouteOpacity

Opacity of route displayed on the map, between 0.0 and 1.0.

directionsRoutePixels

Width of the route displayed on the map in pixels. Range is 0 to 10.

directionsSuppressBicyclingLayer

When set to non-zero, the rendering of the Bicycling layer is suppressed when bicycling directions are requested. Boolean value. (Default: Off or 0)

directionsSuppressInfoWindows

When set to non-zero, the rendering of Info windows is suppressed. Boolean value. (Default: Off or 0)

directionsSuppressMarkers

When set to non-zero, the display of markers on the route is suppressed. Boolean value. (Default: Off or 0)

directionsSuppressPolylines

When set to non-zero, the line that marks the route is not displayed. Boolean value. (Default: Off or 0)

directionsTravelMode$

Type of transportation mode. Options are driving, walking and bicycling. If not specified, default is driving.

directionsUnitSystem$

Unit system to be used in the directions result. Options are default (or null), metric and imperial.

By default, the unit system of the origin's country or region is used; therefore, a route from Toronto, Canada to Buffalo, NY would use metric units, while a route from Buffalo to Toronto would use imperial units. Specifically setting the unit system to metric or imperial will override this behavior.

routeCount

The number of routes calculated in the directions result. Normally, this is 1 unless the directionsProvideRouteAlternatives property is turned On.

showDirectionsPane

Used to enable the directions service and indicate the placement of the directions. Values are:

Note:
This property must be set in the map definition and cannot be changed subsequently.

waypointCount

Number of waypoints that have been added to the directions request. The maximum number of waypoints may vary. The standard number is 8 while the maximum for Google Maps API Premier developers is 23.

Method

Description

addWaypoint(sequence, address,[stopover])

addWaypoint(sequence, lat, lng,[stopover])

Adds a waypoint on the route to be requested. Waypoints are additional locations through which the calculated route must pass. The location may be specified as an address or using latitude/longitude settings.

By default, waypoints are stopover points, which divide the route into legs. You can specify that a waypoint is not a stopover by setting the optional stopover flag to 0, in which case its location is marked on the route with a dot and it does not divide the route into legs.

A sequence number must be specified when adding waypoints, where the route would follow the order of the sequence numbers. Gaps in sequence numbers are allowed. A sequence number of 0 can be used to assign the waypoint to the first available sequence number. Sequence number order can be overridden if all waypoints are stopover points and the directionsOptimizeWaypoints property is turned On, in which case the order of the sequence numbers is ignored and an optimal route through the waypoints determined.

There is no maximum to the number of waypoints you may add using this method; however, the Google Maps API limits the maximum number of waypoints for a standard user to 8, and 23 for Google Maps API Premier customers. If you add more than the allowed number of waypoints, then the directions request will fail when the getDirections$() method is invoked, i.e. the directions will not be displayed on the map, and the return status of the getDirections$() method will contain the value "MAX_WAYPOINTS_EXCEEDED".

Returns the sequence number.

clearDirections( )

Clears the directions display from the map and directions pane. Does not affect any directions-related properties or defined waypoints.

clearWaypoints( )

Clears all waypoints that have been defined.

getDirections$( )

Based upon the specified origin and destination, as well as pre-defined waypoints and directions-related properties, this method calculates and draws the route, markers, etc. on the map and displays directions in the directions pane. If the origin and destination are omitted, then the origin and destination of the last directions request are used.

Returns one of the following statuses:

getDirectionsCalculatedWaypointOrder([route,] originalPosition)

Given a waypoint's original position in the waypoint order, this method returns the position in the waypoint order after the route is calculated. Waypoint order may be altered due to route optimization. See directionsOptimizeWaypoints property.

getDirectionsHTML$( )

Returns the current HTML contents of the directions pane.

getDirectionsLegCount([route])

Returns the number of legs in a route. The number of legs is dependent on the number of waypoints and whether a waypoint has been classified as a stopover. A route with no stopovers has 1 leg; a route with one stopover has 2 legs, etc.

If the directionsProvideRouteAlternatives property has been turned On, you can specify a route number where the primary route number is 1.

getDirectionsLegDistance([route,] leg)

Returns the distance of the specified leg number in meters, regardless of the directionsUnitSystem$ setting.

getDirectionsLegDuration([route,] leg)

Returns the duration of the specified leg number in seconds.

getDirectionsLegStartLatitude([route,] leg)

Returns the latitude of the starting location of the specified leg. Default route is the primary route 1.

getDirectionsLegStartLongitude([route,] leg)

Returns the longitude of the starting location of the specified leg. Default route is the primary route 1.

getDirectionsLegEndLatitude([route,] leg)

Returns the latitude of the ending location of the specified leg. Default route is the primary route 1.

getDirectionsLegEndLongitude([route,] leg)

Returns the longitude of the ending location of the specified leg. Default route is the primary route 1.

getDirectionsOriginalWaypointOrder([route,] calculatedPosition)

Given a waypoint's position in the waypoint order after a route has been calculated, this method returns the original position in the waypoint order before the route was calculated. Waypoint order may be altered due to route optimization. See directionsOptimizeWaypoints property.

getDirectionsRouteDistance([route])

Returns the total route distance in meters, regardless of the directionsUnitSystem$ setting.

If the directionsProvideRouteAlternatives property has been turned On, then you can specify a route number for the distance of alternate routes. The primary route number is 1.

getDirectionsRouteDuration([route])

Returns the total route duration in seconds.

If the directionsProvideRouteAlternatives property has been turned On, then you can specify a route number for the duration of alternate routes. The primary route number is 1.

getDirectionsText$( )

getDirectionsText$(route)

getDirectionsText$(route, leg)

Returns directions for the route in plain text format.

If the directionsProvideRouteAlternatives property has been turned On, then you can specify a route number for alternate routes. The primary route number is 1.

If route and leg numbers are specified, the text for just that leg is returned.

getWaypointAddress$(sequence)

Returns the address of the waypoint with the specified sequence if that waypoint was added using an address. The address is null if the waypoint was added using a latitude/longitude location.

getWaypointLatitude(sequence)

Returns the latitude of the waypoint with the specified sequence if that waypoint was added using a latitude/longitude location. The latitude is 0 if the waypoint was added using an address as its location.

getWaypointLongitude(sequence)

Returns the longitude of the waypoint with the specified sequence if that waypoint was added using a latitude/longitude location. The longitude is 0 if the waypoint was added using an address as its location.

getWaypointStopover(sequence)

Returns the value of the stopover flag for the waypoint with the specified sequence.

removeWaypoint(sequence)

Removes the waypoint with the specified sequence number. If the removal of a waypoint results in a gap in the sequence, then that sequence number is skipped when directions are requested.

setDirectionsAvoidHighways(flag)

Sets the option to avoid major highways where possible when the route is calculated. Flag is Boolean.

setDirectionsAvoidTolls(flag)

Sets the option to avoid toll roads where possible when the route is calculated. Flag is Boolean.

setDirectionsDraggable(flag)

Sets the option to allow the user to dynamically modify directions by clicking and dragging the paths on the map. Flag is Boolean.

setDirectionsHideRouteList(flag)

Sets the option to suppress the route list in the directions pane that is displayed when alternate routes are calculated; i.e. when the directionsProvideRouteAlternatives property is turned On. Flag is Boolean.

setDirectionsOptimizeWaypoints(flag)

Sets the option to override the waypoint sequence and determine the optimum route through the waypoints. Flag is Boolean.

setDirectionsPreserveViewport(flag)

Sets the option to maintain the current map viewport when directions are displayed, rather than adjusting the viewport to center and display the entire route. Flag is Boolean.

setDirectionsProvideRouteAlternatives(flag)

Sets the option to calculate alternate routes. Setting this property may slow down response time, and multiple routes are not guaranteed. Flag is Boolean.

setDirectionsRegion(code$)

Sets the region code that is used for biasing results to a particular region.

setDirectionsRouteColor(color$)

setDirectionsRouteColour(colour$)

Sets the color of the route displayed on the map. Color$ can be a standard PxPlus color (e.g. Light Red, Dark Blue, etc.) or an RGB value (e.g. RGB: 192 0,255).

When setting the route color, standard route width (pixels) and opacity are reset; therefore, you may want to set these as well.

setDirectionsRouteOpacity(opacity)

Sets the opacity of route displayed on the map. Valid opacity values are between 0.0 and 1.0.

setDirectionsRoutePixels(pixels)

Sets the width of the route displayed on the map in pixels. Range is 1 to 10.

setDirectionsSuppressBicyclingLayer(flag)

Sets the option to suppress the rendering of the bicycling layer when bicycling directions are requested. Flag is Boolean.

setDirectionsSuppressInfoWindows(flag)

Sets the option to suppress the rendering of info windows. Flag is Boolean.

setDirectionsSuppressMarkers(flag)

Sets the option to suppress the placement of markers when a route is displayed. Flag is Boolean.

setDirectionsSuppressPolylines(flag)

Sets the option to suppress the line that marks the route. Flag is Boolean.

setDirectionsTravelMode(mode$)

Sets the type of transportation mode. Options are driving, walking and bicycling. If not set, default is driving.

setDirectionsUnitSystem(unit$)

Sets the unit system to be used in the directions result. Options are default (or null), metric and imperial.

By default, the unit system of the origin's country or region is used; therefore, a route from Toronto, Canada to Buffalo, NY would use metric units, while a route from Buffalo to Toronto would use imperial units. Specifically setting the unit system to metric or imperial will override this behavior.