edu.ucdavis.cstars.client.layers

Class ImageServiceParameters

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.layers.ImageServiceParameters

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

Represents the image service parameter options used when calling ArcGISImageServiceLayer.exportMapImage.

Author:

lsimone, Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImageServiceParameters.Formats
static class	ImageServiceParameters.Interpolations

Method Summary

Methods

Modifier and Type	Method and Description
static ImageServiceParameters	create() Creates a new ImageServiceParameters object.
com.google.gwt.core.client.JsArrayInteger	getBandIds() Array of current band selections.
double	getCompressionQuality() Current compression quality value.
Extent	getExtent() Extent of the exported image.
ImageServiceParameters.Formats	getFormat() Map image format.
int	getHeight() Requested image height in pixels.
ImageServiceParameters.Interpolations	getInterpolation() Current interpolation method.
MosaicRule	getMosaicRule() Specifies the mosaic rule when defining how individual images should be mosaicked.
int	getNoData() The pixel value that represents no information.
RasterFunction	getRenderingRule() Specifies the rendering rule for how the requested image should be rendered.
TimeExtent	getTimeExtent() Define the time extent for the image.
int	getWidth() Requested image width in pixels.
void	setBandIds(int[] bandIds) Set the bandIds parameter.
void	setCompressionQuality(double quality)
void	setExtent(Extent extent)
void	setFormat(ImageServiceParameters.Formats format) Map image format.
void	setHeight(int height)
void	setInterpolation(ImageServiceParameters.Interpolations interpolation) Current interpolation method.
void	setMosaicRule(MosaicRule mosaicRule)
void	setNoData(int pixel)
void	setRenderingRule(RasterFunction rule)
void	setTimeExtent(TimeExtent timeExtent)
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 ImageServiceParameters create()

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

Returns:

ImageServiceParameters

setBandIds

public final void setBandIds(int[] bandIds)

Set the bandIds parameter.

Parameters:

bandIds - - Array of current band selections.

getBandIds

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

Array of current band selections.

Returns:

JsArrayInteger

setCompressionQuality

public final void setCompressionQuality(double quality)

Parameters:

quality - - Current compression quality value. The compression quality controls how much loss the image will be subjected to. Only valid with JPG image types.

getCompressionQuality

public final double getCompressionQuality()

Current compression quality value. The compression quality controls how much loss the image will be subjected to. Only valid with JPG image types.

Returns:

float

setExtent

public final void setExtent(Extent extent)

Parameters:

extent - - Extent of the exported image.

getExtent

public final Extent getExtent()

Extent of the exported image.

Returns:

Extent

setFormat

public final void setFormat(ImageServiceParameters.Formats format)

Map image format.

Known values: png8 | png24 | jpg | bmp | gif

Default value: png8

Parameters:

format -

getFormat

public final ImageServiceParameters.Formats getFormat()

Map image format.

Returns:

Formats

setHeight

public final void setHeight(int height)

Parameters:

height - - Requested image height in pixels.

getHeight

public final int getHeight()

Requested image height in pixels.

Returns:

int

setInterpolation

public final void setInterpolation(ImageServiceParameters.Interpolations interpolation)

Current interpolation method. The interpolation method affects how the raster dataset is transformed when it undergoes warping or when it changes coordinate space.

Parameters:

interpolation -

getInterpolation

public final ImageServiceParameters.Interpolations getInterpolation()

Current interpolation method. The interpolation method affects how the raster dataset is transformed when it undergoes warping or when it changes coordinate space.

Returns:

Interpolations

getMosaicRule

public final MosaicRule getMosaicRule()

Specifies the mosaic rule when defining how individual images should be mosaicked.

Returns:

MosaicRule

setMosaicRule

public final void setMosaicRule(MosaicRule mosaicRule)

Parameters:

mosaicRule - - Specifies the mosaic rule when defining how individual images should be mosaicked.

getNoData

public final int getNoData()

The pixel value that represents no information.

Returns:

int

setNoData

public final void setNoData(int pixel)

Parameters:

pixel - - The pixel value that represents no information.

getRenderingRule

public final RasterFunction getRenderingRule()

Specifies the rendering rule for how the requested image should be rendered. View the Raster Functions help topic in the REST help for more details.

Returns:

RasterFunction

setRenderingRule

public final void setRenderingRule(RasterFunction rule)

Parameters:

rule - - Specifies the rendering rule for how the requested image should be rendered. View the Raster Functions help topic in the REST help for more details.

getTimeExtent

public final TimeExtent getTimeExtent()

Define the time extent for the image.

Returns:

TimeExtent

setTimeExtent

public final void setTimeExtent(TimeExtent timeExtent)

Parameters:

timeExtent - - Define the time extent for the image.

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.