edu.ucdavis.cstars.client.layers

Class ImageParameters

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.layers.ImageParameters

public class ImageParameters
extends com.google.gwt.core.client.JavaScriptObject

Represents the image parameter options used when calling ArcGISDynamicMapServiceLayer.exportMapImage, Geoprocessor.getResultImage, and Geoprocessor.getResultImageLayer.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImageParameters.LayerOption

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayerTimeOptions(int index, LayerTimeOptions option)
void	clearLayerTimeOptions() Clear the layerTImeOptions array.
static ImageParameters	create() Creates a new ImageParameters object.
Extent	getBbox() Extent of map to be exported.
int	getDpi() Dots per inch setting for an ArcGISDynamicMapServiceLayer.
java.lang.String	getFormat() Map image format.
int	getHeight() Requested image height in pixels.
SpatialReference	getImageSpatialReference() Spatial reference of exported map.
com.google.gwt.core.client.JsArrayString	getLayerDefinitions() Array of layer definition expressions that allows you to filter the features of individual layers in the exported map image.
com.google.gwt.core.client.JsArrayInteger	getLayerIds() A list of layer ID's, that represent which layers to include in the exported map.
ImageParameters.LayerOption	getLayerOption() The option for displaying or hiding the layer.
com.google.gwt.core.client.JsArray<LayerTimeOptions>	getLayerTimeOptions() Array of LayerTimeOptions objects that allow you to override how a layer is exported in reference to the map's time extent.
TimeExtent	getTimeExtent() The time extent for the map image.
int	getWidth() Requested image width in pixels.
boolean	isTransparent() Whether or not background of dynamic image is transparent.
void	setBbox(Extent bbox)
void	setDpi(int dpi)
void	setFormat(java.lang.String format)
void	setHeight(int height)
void	setImageSpatialReference(SpatialReference spatialReference)
void	setLayerDefinition(int index, java.lang.String definition)
void	setLayerIds(int[] ids) Set the layerIds parameter.
void	setLayerOption(ImageParameters.LayerOption layerOption)
void	setTimeExtent(TimeExtent timeExtent)
void	setTransparent(boolean transparent)
void	setWidth(int width)

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 final ImageParameters create()

Creates a new ImageParameters object. The constructor takes no parameters.

Returns:

ImageParemeters

getBbox

public final Extent getBbox()

Extent of map to be exported.

Returns:

Extent

setBbox

public final void setBbox(Extent bbox)

Parameters:

bbox - - Extent of map to be exported.

getDpi

public final int getDpi()

Dots per inch setting for an ArcGISDynamicMapServiceLayer.

Returns:

int

setDpi

public final void setDpi(int dpi)

Parameters:

dpi - - Dots per inch setting for an ArcGISDynamicMapServiceLayer.

getFormat

public final java.lang.String getFormat()

Map image format. Known values: png | png8 | png24 | jpg | pdf | bmp | gif | svg Default value: png8

Returns:

String

setFormat

public final void setFormat(java.lang.String format)

Parameters:

format - - Map image format. Known values: png | png8 | png24 | jpg | pdf | bmp | gif | svg Default value: png8

getHeight

public final int getHeight()

Requested image height in pixels.

Returns:

- int

setHeight

public final void setHeight(int height)

Parameters:

height - - Requested image height in pixels.

getImageSpatialReference

public final SpatialReference getImageSpatialReference()

Spatial reference of exported map.

Returns:

SpatialReference

setImageSpatialReference

public final void setImageSpatialReference(SpatialReference spatialReference)

Parameters:

spatialReference - - Spatial reference of exported map.

getLayerDefinitions

public final com.google.gwt.core.client.JsArrayString getLayerDefinitions()

Array of layer definition expressions that allows you to filter the features of individual layers in the exported map image. Layer definitions with semicolons or colons are supported if using a map service published using ArcGIS Server 10.

Returns:

JsArrayString

setLayerDefinition

public final void setLayerDefinition(int index,
                      java.lang.String definition)

Parameters:

index -

definition -

getLayerIds

public final com.google.gwt.core.client.JsArrayInteger getLayerIds()

A list of layer ID's, that represent which layers to include in the exported map. Use in combination with layerOption to specify how layer visiblity is handled.

Returns:

JsArrayInteger

setLayerIds

public final void setLayerIds(int[] ids)

Set the layerIds parameter.

Parameters:

ids - - A list of layer ID's, that represent which layers to include in the exported map. Use in combination with layerOption to specify how layer visiblity is handled.

setLayerOption

public final void setLayerOption(ImageParameters.LayerOption layerOption)

Parameters:

layerOption - - The option for displaying or hiding the layer.

getLayerOption

public final ImageParameters.LayerOption getLayerOption()

The option for displaying or hiding the layer.

Returns:

LayerOption

getLayerTimeOptions

public final com.google.gwt.core.client.JsArray<LayerTimeOptions> getLayerTimeOptions()

Array of LayerTimeOptions objects that allow you to override how a layer is exported in reference to the map's time extent. There is one object per sub-layer.

Returns:

JsArray

addLayerTimeOptions

public final void addLayerTimeOptions(int index,
                       LayerTimeOptions option)

Parameters:

index -

option - - Array of LayerTimeOptions objects that allow you to override how a layer is exported in reference to the map's time extent. There is one object per sub-layer.

clearLayerTimeOptions

public final void clearLayerTimeOptions()

Clear the layerTImeOptions array.

getTimeExtent

public final TimeExtent getTimeExtent()

The time extent for the map image.

Returns:

TimeExtent

setTimeExtent

public final void setTimeExtent(TimeExtent timeExtent)

Parameters:

timeExtent - - The time extent for the map image.

isTransparent

public final boolean isTransparent()

Whether or not background of dynamic image is transparent.

Returns:

boolean

setTransparent

public final void setTransparent(boolean transparent)

Parameters:

transparent - - Whether or not background of dynamic image is transparent.

getWidth

public final int getWidth()

Requested image width in pixels.

Returns:

int

setWidth

public final void setWidth(int width)

Parameters:

width - - Requested image width in pixels.