edu.ucdavis.cstars.client.dijits

Class OverviewMap.Parameters

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.dijits.OverviewMap.Parameters

Enclosing class:

OverviewMap

public static class OverviewMap.Parameters
extends com.google.gwt.core.client.JavaScriptObject

Method Summary

Methods

Modifier and Type	Method and Description
static OverviewMap.Parameters	create()
void	setAttachTo(java.lang.String attachTo)
void	setBaseLayer(Layer baseLayer)
void	setColor(java.lang.String color)
void	setExpandFactor(int expandFactor)
void	setHeight(int height)
void	setId(java.lang.String id)
void	setMap(MapWidget map)
void	setOpacity(float opacity)
void	setVisible(boolean visible)
void	setWidth(int width)
void	showMaximizeButton(boolean showButton)

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 OverviewMap.Parameters create()

Returns:

Parameters

setAttachTo

public final void setAttachTo(java.lang.String attachTo)

Parameters:

attachTo - - Specifies which corner of the map to attach the OverviewMap dijit. Valid values are: "top-right","bottom-right", "bottom-left" and "top-left". The default value is "top-right".

setBaseLayer

public final void setBaseLayer(Layer baseLayer)

Parameters:

baseLayer - - Specify the base layer for the overview map. Note that the specified layer must be loaded, verify this using the layer's loaded property. If a base layer is not specified the dijit will use a copy of the main map's base layer. Valid layers are ArcGISDynamicMapServiceLayer,ArcGISTiledMapServiceLayer, OpenStreetMapLayer and VETiledLayer.

setColor

public final void setColor(java.lang.String color)

Parameters:

color - - Fill color for the extent rectangle. The default value is #000000.

setExpandFactor

public final void setExpandFactor(int expandFactor)

Parameters:

expandFactor - - The ratio between the size of the overview map and the extent rectangle displayed on the overview map. The default value is 2, meaning the overview map will be at least twice the size of the extent rectangle.

setHeight

public final void setHeight(int height)

Parameters:

height - - Height of the overview map dijit in screen pixels. The default value is 1/4th the height of the map.

setId

public final void setId(java.lang.String id)

Parameters:

id - - Unique identifier for the dijit. If specified this can be used with dijit.byId to get a reference to the dijit, or with dojo.byId to get a reference to the DOM node associated with the dijit.

setMap

public final void setMap(MapWidget map)

Parameters:

map - - Reference to the map. The map parameter is required.

showMaximizeButton

public final void showMaximizeButton(boolean showButton)

Parameters:

showButton - - Defines the visibility of the maximize/restore button When true, the button is visible. The default value is false.

setOpacity

public final void setOpacity(float opacity)

Parameters:

opacity - - Opacity of the extent rectangle, defined as a number between 0 (invisible) and 1 (opaque). The default value is 0.5.

setVisible

public final void setVisible(boolean visible)

Parameters:

visible - - Specifies the initial visibility of the overview map. The default value is false.

setWidth

public final void setWidth(int width)

Parameters:

width - - Width of the overview map dijit in screen pixels. The default value is 1/4th the width of the map.