ArcGISImageServiceLayer

java.lang.Object
- com.google.gwt.core.client.JavaScriptObject
- - edu.ucdavis.cstars.client.layers.Layer
  - - edu.ucdavis.cstars.client.layers.DynamicMapServiceLayer
    - - edu.ucdavis.cstars.client.layers.ArcGISImageServiceLayer

```
public class ArcGISImageServiceLayer
extends DynamicMapServiceLayer
```
Allows you to work with an image map service resource exposed by the ArcGIS Server REST API.

Author:

Justin Merz

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ArcGISImageServiceLayer.Options
Constructor options for the ArcGISImageServiceLayer

Nested Classes
Modifier and Type	Class and Description
`static class`	`ArcGISImageServiceLayer.Options` Constructor options for the ArcGISImageServiceLayer

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMapImageExportHandler(MapImageExportHandler handler)` Fires when the map export is completed.
`static ArcGISImageServiceLayer`	`create(java.lang.String uri)` Creates a new ArcGISImageServiceLayer object.
`static ArcGISImageServiceLayer`	`create(java.lang.String uri, ArcGISImageServiceLayer.Options options)` Creates a new ArcGISImageServiceLayer object.
`void`	`exportMapImage()` Exports a map using values as specified by ImageServiceParameters.
`void`	`exportMapImage(ImageServiceParameters params)` Exports a map using values as specified by ImageServiceParameters.
`void`	`exportMapImage(ImageServiceParameters params, MapImageExportHandler handler)` Exports a map using values as specified by ImageServiceParameters.
`void`	`exportMapImage(MapImageExportHandler handler)` Exports a map using values as specified by ImageServiceParameters.
`double`	`getBandCount()` Number of bands in ArcGISImageServiceLayer.
`com.google.gwt.core.client.JsArrayNumber`	`getBandIds()` Array of current band selections.
`com.google.gwt.core.client.JsArray<Band>`	`getBands()` The raster bands that the raster dataset is composed of and their statistics.
`double`	`getCompressionQuality()` Current compression quality value.
`java.lang.String`	`getCopyrightText()` Copyright string as defined by the image service.
`java.lang.String`	`getDescription()` Copyright string as defined by the image service.
`java.lang.String`	`getFormat()` The output image type.
`java.lang.String`	`getInterpolation()` Current interpolation method.
`int`	`getMaxImageHeight()` The maximum image height , in pixels, that the map service will export.
`int`	`getMaxImageWidth()` The maximum image width, in pixels, that the map service will export.
`int`	`getMaxRecordCount()` The maximum number of results that can be returned from query, identify and find operations.
`MosaicRule`	`getMosaicRule()` Specifies the mosaic rule when defining how individual images should be mosaicked.
`float`	`getPixelSizeX()` Size of pixel in X direction.
`float`	`getPixelSizeY()` Size of pixel in Y direction.
`java.lang.String`	`getPixelType()` The pixel type of the image service.
`RasterFunction`	`getRenderingRule()` Specifies the rendering rule for how the requested image should be rendered.
`TimeInfo`	`getTimeInfo()` Temporal information for the layer, such as time extent.
`double`	`getVersion()` The version of ArcGIS Server the image service is published to, e.g.
`boolean`	`isDisabledClientCaching()` When true, images are always requested from the server and the browser's cache is ignored.
`void`	`setBandIs(int[] bandIds)` Sets the R,G,B of the exported image to the appropriate ImageService Band ID.
`void`	`setBandIs(int[] bandIds, boolean doNotRefresh)` Sets the R,G,B of the exported image to the appropriate ImageService Band ID.
`void`	`setCompressionQuality(float quality)` Sets the compression quality of the exported image.
`void`	`setCompressionQuality(float quality, boolean doNotRefresh)` Sets the compression quality of the exported image.
`void`	`setDisableClientCaching(boolean disable)` Sets whether images are always requested from the server and the browser's cache is ignored.
`void`	`setImageFormat(java.lang.String imageFormat)` Set the image format.
`void`	`setImageFormat(java.lang.String imageFormat, boolean doNotRefresh)` Set the image format.
`void`	`setInterpolation(java.lang.String interpolation)` Sets the interpolation method.
`void`	`setInterpolation(java.lang.String interpolation, boolean doNotRefresh)` Sets the interpolation method.
`void`	`setMosaicRule(MosaicRule mosaicRule)` Sets the mosaic rule of the layer to the specified value.
`void`	`setMosaicRule(MosaicRule mosaicRule, boolean doNotRefresh)` Sets the mosaic rule of the layer to the specified value.
`void`	`setRenderingRule(RasterFunction renderingRule)` Sets the rendering rule of the layer to the given value.
`void`	`setRenderingRule(RasterFunction renderingRule, boolean doNotRefresh)` Sets the rendering rule of the layer to the given value.
`void`	`setUseMapTime(boolean update)` Determine if the layer will update its content based on the map's current time extent.

Methods inherited from class edu.ucdavis.cstars.client.layers.DynamicMapServiceLayer
getFullExtent, getImageUrl, getInitialExtent, getSpatialReference, refresh

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 ArcGISImageServiceLayer create(java.lang.String uri,
                             ArcGISImageServiceLayer.Options options)
```
    Creates a new ArcGISImageServiceLayer object. A URL is a required parameter. This layer also takes some optional parameters.
    
    Parameters:
    uri - - URL to the ArcGIS Server REST resource that represents a map service.
    options - - Optional parameters.
    
    Returns:
    ArcGISImageServiceLayer
  - create
```
public static ArcGISImageServiceLayer create(java.lang.String uri)
```
    Creates a new ArcGISImageServiceLayer object. A URL is a required parameter.
    
    Parameters:
    uri - - URL to the ArcGIS Server REST resource that represents a map service.
    
    Returns:
    ArcGISImageServiceLayer
  - getBandCount
```
public final double getBandCount()
```
    Number of bands in ArcGISImageServiceLayer.
    
    Returns:
    int
  - getBandIds
```
public final com.google.gwt.core.client.JsArrayNumber getBandIds()
```
    Array of current band selections.
    
    Returns:
    JsArrayNumber
  - getBands
```
public final com.google.gwt.core.client.JsArray<Band> getBands()
```
    The raster bands that the raster dataset is composed of and their statistics. The length of this array gives the number of bands and the array index represents the band ID.
    
    Returns:
    JsArray
  - 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
  - getCopyrightText
```
public final java.lang.String getCopyrightText()
```
    Copyright string as defined by the image service.
    
    Returns:
    String
  - getDescription
```
public final java.lang.String getDescription()
```
    Copyright string as defined by the image service.
    
    Returns:
    String
  - isDisabledClientCaching
```
public final boolean isDisabledClientCaching()
```
    When true, images are always requested from the server and the browser's cache is ignored. This should be used when the data supporting the map service changes frequently.
    
    Returns:
    boolean
  - getFormat
```
public final java.lang.String getFormat()
```
    The output image type. Known values: png8 | png24 | jpg | bmp | gif Default value: png8
    
    Returns:
    String
  - getInterpolation
```
public final java.lang.String 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:
    String
  - getMaxImageHeight
```
public final int getMaxImageHeight()
```
    The maximum image height , in pixels, that the map service will export. Requires ArcGIS Server version 10.1 or greater. (As of v2.6)
    
    Returns:
    int
  - getMaxImageWidth
```
public final int getMaxImageWidth()
```
    The maximum image width, in pixels, that the map service will export. Requires ArcGIS Server version 10.1 or greater. (As of v2.6)
    
    Returns:
    int
  - getMaxRecordCount
```
public final int getMaxRecordCount()
```
    The maximum number of results that can be returned from query, identify and find operations. Requires ArcGIS Server version 10.1 or greater. (As of v2.6)
    
    Returns:
    int
  - getMosaicRule
```
public final MosaicRule getMosaicRule()
```
    Specifies the mosaic rule when defining how individual images should be mosaicked.
    
    Returns:
    MosaicRule
  - getPixelSizeX
```
public final float getPixelSizeX()
```
    Size of pixel in X direction.
    
    Returns:
    float
  - getPixelSizeY
```
public final float getPixelSizeY()
```
    Size of pixel in Y direction.
    
    Returns:
    float
  - getPixelType
```
public final java.lang.String getPixelType()
```
    The pixel type of the image service. Pertains to the type of values stored in the raster, such as signed integer, unsigned integer, or floating point. Integers are whole numbers, whereas floating points have decimals. Known values: C64 | C128 | F32 | F64 | S8 | S16 | S32 | U1 | U2 | U4 | U8 | U16 | U32 | UNKNOWN
    
    Returns:
    String
  - 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:
    int
  - getTimeInfo
```
public final TimeInfo getTimeInfo()
```
    Temporal information for the layer, such as time extent. If this property is null or not specified, then the layer does not support time-related operations.
    
    Returns:
    TimeInfo
  - getVersion
```
public final double getVersion()
```
    The version of ArcGIS Server the image service is published to, e.g. 9.3, 9.31, 10.
    
    Returns:
    double
  - exportMapImage
```
public final void exportMapImage()
```
    Exports a map using values as specified by ImageServiceParameters. On completion, MapImage is returned.
  - exportMapImage
```
public final void exportMapImage(MapImageExportHandler handler)
```
    Exports a map using values as specified by ImageServiceParameters. On completion, MapImage is returned.
    
    Parameters:
    handler - - The function to call when the method has completed. The arguments in the function are the same as the onMapImageExport event.
  - exportMapImage
```
public final void exportMapImage(ImageServiceParameters params)
```
    Exports a map using values as specified by ImageServiceParameters. On completion, MapImage is returned.
    
    Parameters:
    params - - Input parameters assigned before exporting the map image.
  - exportMapImage
```
public final void exportMapImage(ImageServiceParameters params,
                  MapImageExportHandler handler)
```
    Exports a map using values as specified by ImageServiceParameters. On completion, MapImage is returned.
    
    Parameters:
    params - - Input parameters assigned before exporting the map image.
    handler - - The function to call when the method has completed. The arguments in the function are the same as the onMapImageExport event.
  - setBandIs
```
public final void setBandIs(int[] bandIds)
```
    Sets the R,G,B of the exported image to the appropriate ImageService Band ID. BandIds are zero based.
    
    Parameters:
    bandIds - - Array of band IDs to use in the exported image.
  - setBandIs
```
public final void setBandIs(int[] bandIds,
             boolean doNotRefresh)
```
    Sets the R,G,B of the exported image to the appropriate ImageService Band ID. BandIds are zero based.
    
    Parameters:
    bandIds - - Array of band IDs to use in the exported image.
    doNotRefresh - - Added at version 2.2 When true the layer will not refresh the map image. The default value is false.
  - setCompressionQuality
```
public final void setCompressionQuality(float quality)
```
    Sets the compression quality of the exported image. Only valid with JPG image format.
    
    Parameters:
    quality - - Sets the compression quality of the exported image. Only valid with JPG image format.
  - setCompressionQuality
```
public final void setCompressionQuality(float quality,
                         boolean doNotRefresh)
```
    Sets the compression quality of the exported image. Only valid with JPG image format.
    
    Parameters:
    quality - - Sets the compression quality of the exported image. Only valid with JPG image format.
    doNotRefresh - - Added at version 2.2 When true the layer will not refresh the map image. The default value is false.
  - setDisableClientCaching
```
public final void setDisableClientCaching(boolean disable)
```
    Sets whether images are always requested from the server and the browser's cache is ignored. This should be used when the data supporting the map service changes frequently.
    
    Parameters:
    disable - - When true, browser client side caching is disabled.
  - setImageFormat
```
public final void setImageFormat(java.lang.String imageFormat)
```
    Set the image format.
    
    Parameters:
    imageFormat - - Valid values are png | png8 | png24 | jpg | pdf | bmp | gif | svg.
  - setImageFormat
```
public final void setImageFormat(java.lang.String imageFormat,
                  boolean doNotRefresh)
```
    Set the image format.
    
    Parameters:
    imageFormat - - Valid values are png | png8 | png24 | jpg | pdf | bmp | gif | svg.
    doNotRefresh - - Added at version 2.2 When true the layer will not refresh the map image. The default value is false.
  - setInterpolation
```
public final void setInterpolation(java.lang.String interpolation)
```
    Sets the interpolation method. The interpolation method affects how the raster dataset is transformed when it undergoes warping or when it changes coordinate space.
    
    Parameters:
    interpolation - - Interpolation value defined in ImageServiceParameters Constants Table.
  - setInterpolation
```
public final void setInterpolation(java.lang.String interpolation,
                    boolean doNotRefresh)
```
    Sets the interpolation method. The interpolation method affects how the raster dataset is transformed when it undergoes warping or when it changes coordinate space.
    
    Parameters:
    interpolation - - Interpolation value defined in ImageServiceParameters Constants Table.
    doNotRefresh - - Added at version 2.2 When true the layer will not refresh the map image. The default value is false.
  - setMosaicRule
```
public final void setMosaicRule(MosaicRule mosaicRule)
```
    Sets the mosaic rule of the layer to the specified value. The mosaic rule defines how individual images should be mosaicked. Refreshes the layer to reflect the mosaic rule.
    
    Parameters:
    mosaicRule - - The mosaic rule.
  - setMosaicRule
```
public final void setMosaicRule(MosaicRule mosaicRule,
                 boolean doNotRefresh)
```
    Sets the mosaic rule of the layer to the specified value. The mosaic rule defines how individual images should be mosaicked. Refreshes the layer to reflect the mosaic rule.
    
    Parameters:
    mosaicRule - - The mosaic rule.
    doNotRefresh - - Added at version 2.2 When true the layer will not refresh the map image. The default value is false.
  - setRenderingRule
```
public final void setRenderingRule(RasterFunction renderingRule)
```
    Sets the rendering rule of the layer to the given value. Refreshes the laeyr to reflect the rendering rule.
    
    Parameters:
    renderingRule - - The new rendering rule.
  - setRenderingRule
```
public final void setRenderingRule(RasterFunction renderingRule,
                    boolean doNotRefresh)
```
    Sets the rendering rule of the layer to the given value. Refreshes the laeyr to reflect the rendering rule.
    
    Parameters:
    renderingRule - - The new rendering rule.
    doNotRefresh - - Added at version 2.2 When true the layer will not refresh the map image. The default value is false.
  - setUseMapTime
```
public final void setUseMapTime(boolean update)
```
    Determine if the layer will update its content based on the map's current time extent. Default value is true. (As of v2.2)
    
    Parameters:
    update - - When false the layer will not update its content based on the map's time extent. Default value is true.
  - addMapImageExportHandler
```
public final void addMapImageExportHandler(MapImageExportHandler handler)
```
    Fires when the map export is completed.
    
    Parameters:
    handler - - Contains the properties of a dynamically generated map image.

Class ArcGISImageServiceLayer

Nested Class Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Method Detail

create

create

getBandCount

getBandIds

getBands

getCompressionQuality

getCopyrightText

getDescription

isDisabledClientCaching

getFormat

getInterpolation

getMaxImageHeight

getMaxImageWidth

getMaxRecordCount

getMosaicRule

getPixelSizeX

getPixelSizeY

getPixelType

getRenderingRule

getTimeInfo

getVersion

exportMapImage

exportMapImage

exportMapImage

exportMapImage

setBandIs

setBandIs

setCompressionQuality

setCompressionQuality

setDisableClientCaching

setImageFormat

setImageFormat

setInterpolation

setInterpolation

setMosaicRule

setMosaicRule

setRenderingRule

setRenderingRule

setUseMapTime

addMapImageExportHandler