edu.ucdavis.cstars.client

Class MapWidget.Options

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.MapWidget.Options

Enclosing class:

MapWidget

public static class MapWidget.Options
extends com.google.gwt.core.client.JavaScriptObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapWidget.Options.SliderPosition
static class	MapWidget.Options.SliderStyle

Method Summary

Methods

Modifier and Type	Method and Description
static MapWidget.Options	create()
static MapWidget.Options	create(MapWidget.BaseMap basmap)
void	fitExtent(boolean fitExtent) When true, for maps that contain tiled map service layers, you are guaranteed to have the initial extent defined using the extent constructor option shown completely on the map.
void	setBaseMap(MapWidget.BaseMap basemap)
void	setDisplayGraphicsOnPan(boolean displayGraphics) When true, graphics are displayed during panning.
void	setExtent(Extent extent) If provided, the extent and projection of the map is set to the properties of Extent.
void	setFadeOnZoom(boolean fadeOnZoom) When true a fade effect is enabled for supported layers.
void	setForce3DTransforms(boolean force3DTransforms) When the mapNavigation mode is set to 'css-transforms', CSS3 transforms will be used for map navigation when supported by the browser.
void	setInfoWindow(InfoWindowBase infoWindow) By default the map creates and uses an out-of-the-box InfoWindow.
void	setLods(LOD[] lods) If provided, the map is initialized with the specified levels of detail.
void	setLogo(boolean logo) Display the esri logo on the map.
void	setMaxScale(double maxScale) Maximum visible scale of the map.
void	setMinScale(double minScale) Minimum visible scale of the map.
void	setNav(boolean nav) Displays pan buttons on map.
void	setNavigationMode(java.lang.String navigationMode) Specify whether or not to use CSS3 transformations when panning and zooming.
void	setResizeDelay(int resizeDelay) Specify a time period in milliseconds to ignore repeated calls to the resize method.
void	setShowAttribution(boolean attribution) Enable or disable map attribution display.
void	setSliderPosition(MapWidget.Options.SliderPosition position) Position of the slider within the map control.
void	setSliderStyle(MapWidget.Options.SliderStyle style) Defines the slider style.
void	showInfoWindowOnClick(boolean show) The default behavior is to show an InfoWindow if the Graphic has a defined InfoTemplate when the user clicks on the graphic.
void	showSlider(boolean show) Displays a slider on the map.
void	wrapAround180(boolean wrap) When true, supports continuous pan across the dateline.

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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static MapWidget.Options create()

create

public static MapWidget.Options create(MapWidget.BaseMap basmap)

setBaseMap

public final void setBaseMap(MapWidget.BaseMap basemap)

Parameters:

basemap -

setDisplayGraphicsOnPan

public final void setDisplayGraphicsOnPan(boolean displayGraphics)

When true, graphics are displayed during panning. When false, the graphics are turned off during pan movement. Setting to false may improve performance in Internet Explorer. The default is true.

Parameters:

displayGraphics -

setExtent

public final void setExtent(Extent extent)

If provided, the extent and projection of the map is set to the properties of Extent. Once the projection is set, all layers must be able to be drawn in the defined projection. The tiling scheme of an ArcGISTiledMapServiceLayer must match the projection of the map. The projection of the extent is honored as of v1.2 when used in the map constructor.

Parameters:

extent -

setFadeOnZoom

public final void setFadeOnZoom(boolean fadeOnZoom)

When true a fade effect is enabled for supported layers. Currently only tiled layers are supported. This option is not applicable if navigationMode is set to classic.

Parameters:

fadeOnZoom - - fade parameter

setForce3DTransforms

public final void setForce3DTransforms(boolean force3DTransforms)

When the mapNavigation mode is set to 'css-transforms', CSS3 transforms will be used for map navigation when supported by the browser. It is recommended that you let the map determine when to enable transformations to avoid running into a known issue with scrollbar rendering on Chrome on Windows XP

Parameters:

force3DTransforms -

fitExtent

public final void fitExtent(boolean fitExtent)

When true, for maps that contain tiled map service layers, you are guaranteed to have the initial extent defined using the extent constructor option shown completely on the map. As of v2.0

Parameters:

fitExtent -

setInfoWindow

public final void setInfoWindow(InfoWindowBase infoWindow)

By default the map creates and uses an out-of-the-box InfoWindow. If you create a custom implementation using InfoWindowBase specify it using this option.

Parameters:

infoWindow -

setLods

public final void setLods(LOD[] lods)

If provided, the map is initialized with the specified levels of detail. All ArcGISTiledMapServiceLayers added to the map must have matching resolutions in order to be displayed. (As of v1.2)

Parameters:

lods -

setLogo

public final void setLogo(boolean logo)

Display the esri logo on the map. The default value is true.

Parameters:

logo -

setMaxScale

public final void setMaxScale(double maxScale)

Maximum visible scale of the map.

Since:

3.3

setMinScale

public final void setMinScale(double minScale)

Minimum visible scale of the map.

Since:

3.3

setNav

public final void setNav(boolean nav)

Displays pan buttons on map. When false, the pan arrows never display. The default is false.

Parameters:

nav -

setNavigationMode

public final void setNavigationMode(java.lang.String navigationMode)

Specify whether or not to use CSS3 transformations when panning and zooming. Valid values are "css-transforms" or "classic". If not specified, CSS3 transforms will be used when supported by the browser. Advantages of using CSS3 transforms are a smoother, less jarring experience during map navigation and hardware acceleration in browsers that support it.

Parameters:

navigationMode - - values "css-transforms" or "classic"

setResizeDelay

public final void setResizeDelay(int resizeDelay)

Specify a time period in milliseconds to ignore repeated calls to the resize method. Default value is 300.

Parameters:

resizeDelay -

setShowAttribution

public final void setShowAttribution(boolean attribution)

Enable or disable map attribution display.

Parameters:

attribution -

showInfoWindowOnClick

public final void showInfoWindowOnClick(boolean show)

The default behavior is to show an InfoWindow if the Graphic has a defined InfoTemplate when the user clicks on the graphic. When true, this default behavior is honored. The default value is true.

Parameters:

show -

showSlider

public final void showSlider(boolean show)

Displays a slider on the map. When false, the slider never displays. Default is true.

Parameters:

show -

setSliderPosition

public final void setSliderPosition(MapWidget.Options.SliderPosition position)

Position of the slider within the map control.

Since:

3.3

setSliderStyle

public final void setSliderStyle(MapWidget.Options.SliderStyle style)

Defines the slider style.

Since:

3.3

wrapAround180

public final void wrapAround180(boolean wrap)

When true, supports continuous pan across the dateline. Wraparound is supported in the following cases: - Map spatial reference is WGS84 or Web Mercator - The tiling scheme is either the pre-9.3 ArcGIS Online (4326) tiling scheme or ArcGIS/Google Maps/ Bing tiling scheme. - Dynamic services must be version 10 or greater. The default value is false.

Parameters:

wrap -