edu.ucdavis.cstars.client.layers

Class MapImageLayer

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.layers.Layer

edu.ucdavis.cstars.client.layers.MapImageLayer

public class MapImageLayer
extends Layer

The MapImageLayer class is used to add georeferenced images to the map. The map will place the georeferenced images at the specified geographic extent. The extent of the image should be within the map's extent. The image should also be in the same coordinate system as the map.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapImageLayer.Options

Method Summary

Methods

Modifier and Type	Method and Description
void	addMapImage(MapImage mapImage) Add an image to the map.
static boolean	assertLoaded() Check that the esri.layers.MapImageLayer has been loaded
static MapImageLayer	create() Creates a new MapImageLayer object
static MapImageLayer	create(MapImageLayer.Options options) Creates a new MapImageLayer object
com.google.gwt.core.client.JsArray<MapImage>	getImages() Get an array of MapImage objects that define the images in the MapImageLayer.
boolean	getImageVisibility(MapImage mapImage) Get the current visibility of the input MapImage.
void	removeAllImages() Remove all images from the layer.
void	removeImage(MapImage mapImage) Remove the specified image from the layer.
void	setImageVisibility(MapImage mapImage, boolean isVisible) Set the visibility for the image.

Methods inherited from class edu.ucdavis.cstars.client.layers.Layer

addErrorHandler, addLoadHandler, addOpacityChangeHandler, addUpdateEndHandler, addUpdateHandler, addUpdateStartHandler, addVisibilityChangeHandler, getCredential, getId, getOpacity, getUrl, hide, isloaded, isVisible, setOpacity, setVisibility, show

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 MapImageLayer create()

Creates a new MapImageLayer object

Returns:

MapImageLayer

create

public static MapImageLayer create(MapImageLayer.Options options)

Creates a new MapImageLayer object

Parameters:

options - - Optional parameters.

Returns:

MapImageLayer

assertLoaded

public static boolean assertLoaded()

Check that the esri.layers.MapImageLayer has been loaded

Returns:

boolean

addMapImage

public final void addMapImage(MapImage mapImage)

Add an image to the map. The Map Image extent should have the same coordinate system as the map and be within the map's extent.

Parameters:

mapImage - - A MapImage object that defines the image to add to the map.

getImages

public final com.google.gwt.core.client.JsArray<MapImage> getImages()

Get an array of MapImage objects that define the images in the MapImageLayer.

Returns:

JsArray

getImageVisibility

public final boolean getImageVisibility(MapImage mapImage)

Get the current visibility of the input MapImage.

Parameters:

mapImage - - The MapImage object.

Returns:

boolean

removeAllImages

public final void removeAllImages()

Remove all images from the layer.

removeImage

public final void removeImage(MapImage mapImage)

Remove the specified image from the layer.

Parameters:

mapImage - - The MapImage object that defines the image to remove.

setImageVisibility

public final void setImageVisibility(MapImage mapImage,
                      boolean isVisible)

Set the visibility for the image.

Parameters:

mapImage - - The mapImage object.

isVisible - - Set the visibility of the MapImage.