com.google.gwt.maps.client.services

Class DirectionsRendererOptions

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.google.gwt.maps.client.services.DirectionsRendererOptions

public class DirectionsRendererOptions
extends JavaScriptObject

This object defines the properties that can be set on a DirectionsRenderer object.

See DirectionsRendererOptions API Doc

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DirectionsRendererOptions() use newInstance();

Method Summary

Methods

Modifier and Type	Method and Description
DirectionsResult	getDirections() The directions to display on the map and/or in a <div> panel, retrieved as a DirectionsResult object from DirectionsService.
boolean	getDraggable() If true, allows the user to drag and modify the paths of routes rendered by this DirectionsRenderer.
boolean	getHideRouteList() This property indicates whether the renderer should provide UI to select amongst alternative routes.
InfoWindow	getInfoWindow() The InfoWindow in which to render text information when a marker is clicked.
MapWidget	getMap() Map on which to display the directions.
MapWidget	getMapWidget() Deprecated. See getMap()
MarkerOptions	getMarkerOptions() Options for the markers.
Element	getPanel() The <div> in which to display the directions steps.
PolylineOptions	getPolylineOptions() Options for the polylines.
boolean	getPreserveViewport() By default, the input map is centered and zoomed to the bounding box of this set of directions.
int	getRouteIndex() The index of the route within the DirectionsResult object.
boolean	getSuppressBicyclingLayer() Suppress the rendering of the BicyclingLayer when bicycling directions are requested.
boolean	getSuppressInfoWindows() Suppress the rendering of info windows.
boolean	getSuppressMarkers() Suppress the rendering of markers.
boolean	getSuppressPolylines() Suppress the rendering of polylines.
static DirectionsRendererOptions	newInstance() This object defines the properties that can be set on a DirectionsRenderer object.
void	setDirections(DirectionsResult directions) The directions to display on the map and/or in a <div> panel, retrieved as a DirectionsResult object from DirectionsService.
void	setDraggable(boolean draggable) If true, allows the user to drag and modify the paths of routes rendered by this DirectionsRenderer.
void	setHideRouteList(boolean hideRouteList) This property indicates whether the renderer should provide UI to select amongst alternative routes.
void	setInfoWindow(InfoWindow infoWindow) The InfoWindow in which to render text information when a marker is clicked.
void	setMap(MapWidget mapWidget) Map on which to display the directions.
void	setMarkerOptions(MarkerOptions markerOptions) Options for the markers.
void	setPanel(Element panel) The <div> in which to display the directions steps.
void	setPolylineOptions(PolylineOptions polylineOptions) Options for the polylines.
void	setPreserveViewport(boolean preserveViewport) By default, the input map is centered and zoomed to the bounding box of this set of directions.
void	setRouteIndex(int routeIndex) The index of the route within the DirectionsResult object.
void	setSuppressBicyclingLayer(boolean suppressBicyclingLayer) Suppress the rendering of the BicyclingLayer when bicycling directions are requested.
void	setSuppressInfoWindows(boolean suppressInfoWindows) Suppress the rendering of info windows.
void	setSuppressMarkers(boolean suppressMarkers) Suppress the rendering of markers.
void	setSuppressPolylines(boolean suppressPolylines) Suppress the rendering of polylines.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DirectionsRendererOptions

protected DirectionsRendererOptions()

use newInstance();

Method Detail

newInstance

public static final DirectionsRendererOptions newInstance()

This object defines the properties that can be set on a DirectionsRenderer object.

setDirections

public final void setDirections(DirectionsResult directions)

The directions to display on the map and/or in a <div> panel, retrieved as a DirectionsResult object from DirectionsService.

Parameters:

directions -

getDirections

public final DirectionsResult getDirections()

The directions to display on the map and/or in a <div> panel, retrieved as a DirectionsResult object from DirectionsService.

setDraggable

public final void setDraggable(boolean draggable)

If true, allows the user to drag and modify the paths of routes rendered by this DirectionsRenderer.

Parameters:

draggable -

getDraggable

public final boolean getDraggable()

If true, allows the user to drag and modify the paths of routes rendered by this DirectionsRenderer.

setHideRouteList

public final void setHideRouteList(boolean hideRouteList)

This property indicates whether the renderer should provide UI to select amongst alternative routes. By default, this flag is false and a user-selectable list of routes will be shown in the directions' associated panel. To hide that list, set hideRouteList to true.

Parameters:

hideRouteList -

getHideRouteList

public final boolean getHideRouteList()

This property indicates whether the renderer should provide UI to select amongst alternative routes. By default, this flag is false and a user-selectable list of routes will be shown in the directions' associated panel. To hide that list, set hideRouteList to true.

setInfoWindow

public final void setInfoWindow(InfoWindow infoWindow)

The InfoWindow in which to render text information when a marker is clicked. Existing info window content will be overwritten and its position moved. If no info window is specified, the DirectionsRenderer will create and use its own info window. This property will be ignored if suppressInfoWindows is set to true.

Parameters:

infoWindow -

getInfoWindow

public final InfoWindow getInfoWindow()

The InfoWindow in which to render text information when a marker is clicked. Existing info window content will be overwritten and its position moved. If no info window is specified, the DirectionsRenderer will create and use its own info window. This property will be ignored if suppressInfoWindows is set to true.

setMap

public final void setMap(MapWidget mapWidget)

Map on which to display the directions.

Parameters:

mapWidget -

getMap

public final MapWidget getMap()

Map on which to display the directions.

getMapWidget

@Deprecated
public final MapWidget getMapWidget()

Deprecated. See getMap()

Map on which to display the directions.

setMarkerOptions

public final void setMarkerOptions(MarkerOptions markerOptions)

Options for the markers. All markers rendered by the DirectionsRenderer will use these options.

Parameters:

markerOptions -

getMarkerOptions

public final MarkerOptions getMarkerOptions()

Options for the markers. All markers rendered by the DirectionsRenderer will use these options.

setPanel

public final void setPanel(Element panel)

The <div> in which to display the directions steps.

Parameters:

panel -

getPanel

public final Element getPanel()

The <div> in which to display the directions steps.

setPolylineOptions

public final void setPolylineOptions(PolylineOptions polylineOptions)

Options for the polylines. All polylines rendered by the DirectionsRenderer will use these options.

Parameters:

polylineOptions -

getPolylineOptions

public final PolylineOptions getPolylineOptions()

Options for the polylines. All polylines rendered by the DirectionsRenderer will use these options.

setPreserveViewport

public final void setPreserveViewport(boolean preserveViewport)

By default, the input map is centered and zoomed to the bounding box of this set of directions. If this option is set to true, the viewport is left unchanged, unless the map's center and zoom were never set.

Parameters:

preserveViewport -

getPreserveViewport

public final boolean getPreserveViewport()

By default, the input map is centered and zoomed to the bounding box of this set of directions. If this option is set to true, the viewport is left unchanged, unless the map's center and zoom were never set.

setRouteIndex

public final void setRouteIndex(int routeIndex)

The index of the route within the DirectionsResult object. The default value is 0.

Parameters:

routeIndex -

getRouteIndex

public final int getRouteIndex()

The index of the route within the DirectionsResult object. The default value is 0.

setSuppressBicyclingLayer

public final void setSuppressBicyclingLayer(boolean suppressBicyclingLayer)

Suppress the rendering of the BicyclingLayer when bicycling directions are requested.

Parameters:

suppressBicyclingLayer -

getSuppressBicyclingLayer

public final boolean getSuppressBicyclingLayer()

Suppress the rendering of the BicyclingLayer when bicycling directions are requested.

setSuppressInfoWindows

public final void setSuppressInfoWindows(boolean suppressInfoWindows)

Suppress the rendering of info windows.

Parameters:

suppressInfoWindows -

getSuppressInfoWindows

public final boolean getSuppressInfoWindows()

Suppress the rendering of info windows.

setSuppressMarkers

public final void setSuppressMarkers(boolean suppressMarkers)

Suppress the rendering of markers.

Parameters:

suppressMarkers -

getSuppressMarkers

public final boolean getSuppressMarkers()

Suppress the rendering of markers.

setSuppressPolylines

public final void setSuppressPolylines(boolean suppressPolylines)

Suppress the rendering of polylines.

Parameters:

suppressPolylines -

getSuppressPolylines

public final boolean getSuppressPolylines()

Suppress the rendering of polylines.