ArcGISDynamicMapServiceLayer

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.ArcGISDynamicMapServiceLayer

```
public class ArcGISDynamicMapServiceLayer
extends DynamicMapServiceLayer
```
Allows you to work with a dynamic map service resource exposed by the ArcGIS Server REST API. A dynamic map service generates images on the fly. For cached map services, @see edu.ucdavis.cstars.client.layers.ArcGISTiledMapServiceLayer. If the first layer added to the map is an ArcGISDynamicMapServiceLayer, the map will take on the projection of this layer.

Author:

Justin Merz

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ArcGISDynamicMapServiceLayer.ImageFormat`
`static class`	`ArcGISDynamicMapServiceLayer.LayerDefinitions` Example: `layerDefinitions.setLayerDefinition(0, "POPULATION > 5000000"); layerDefinitions.setLayerDefinition(0, "AREA > 100000"); dynamicMapServiceLayer.setLayerDefinitions(layerDefinitions);` Note that the array indices 0 and 5 are valid layer IDs, and POPULATION and AREA are valid attribute fields associated with the respective layers.
`static class`	`ArcGISDynamicMapServiceLayer.Options` Layer Options

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addGDBChangeHandler(GdbVersionChangeHandler handler)` Set gdb version change handler.
`void`	`addMapImageExportHandler(MapImageExportHandler handler)` Fires when the map export is completed.
`static ArcGISDynamicMapServiceLayer`	`create(java.lang.String uri)` Creates a new ArcGISDynamicMapServiceLayer object.
`static ArcGISDynamicMapServiceLayer`	`create(java.lang.String uri, ArcGISDynamicMapServiceLayer.Options options)` Creates a new ArcGISDynamicMapServiceLayer object.
`com.google.gwt.core.client.JsArray<DynamicLayerInfo>`	`createDynamicLayerInfosFromLayerInfos()` Create an array of DynamicLayerInfos based on the current set of LayerInfo.
`void`	`exportMapImage()` Exports a map using values as specified by ImageParameters.
`void`	`exportMapImage(ImageParameters params)` Exports a map using values as specified by ImageParameters.
`void`	`exportMapImage(ImageParameters params, MapImageExportHandler handler)` Exports a map using values as specified by ImageParameters.
`java.lang.String`	`getCapabilities()` Capabilities of the map service, possible values are Map, Query and Data.
`java.lang.String`	`getCopyright()` Copyright string as defined by the map service.
`java.lang.String`	`getDescription()` Map description as defined by the map service.
`int`	`getDpi()` The output dpi of the dynamic map service layer.
`ArcGISDynamicMapServiceLayer.ImageFormat`	`getImageFormat()` The output image type.
`com.google.gwt.core.client.JsArrayString`	`getLayerDefinitions()` Sets the layer definitions used to filter the features of individual layers in the map service.
`com.google.gwt.core.client.JsArray<LayerDrawingOptions>`	`getLayerDrawingOptions()` Array of LayerDrawingOptions used to override the way layers are drawn.
`com.google.gwt.core.client.JsArray<LayerInfo>`	`getLayerInfos()` Returns the available layers in service and their default visibility.
`int`	`getMaxImageHeight()` The maximum image height , 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.
`int`	`getMinImageHeight()` The maximum image width, in pixels, that the map service will export.
`TimeInfo`	`getTimeInfo()` Temporal information for the layer, such as time extent.
`com.google.gwt.core.client.JsArray<LayerTimeOptions>`	`getTimeLayerOptions()` Returns the current layer time options if applicable.
`java.lang.String`	`getUnits()` Default units of the layer as defined by the service.
`float`	`getVersion()` The version of ArcGIS Server where the map service is published.
`com.google.gwt.core.client.JsArrayInteger`	`getVisibleLayers()` Gets the visible layers of the exported map.
`boolean`	`imageTransparency()` Whether or not background of dynamic image is transparent.
`boolean`	`isDisabledClientCaching()` When true, images are always requested from the server and the browser's cache is ignored.
`void`	`setDefaultLayerDefinitions()` Resets all layer definitions to those defined in the service.
`void`	`setDefaultLayerDefinitions(boolean doNotRefresh)` Resets all layer definitions to those defined in the service.
`void`	`setDefaultVisibleLayers()` Clears the visible layers as defined in setVisibleLayers, and resets to the default layers of the map service.
`void`	`setDefaultVisibleLayers(boolean doNotRefresh)` Clears the visible layers as defined in setVisibleLayers, and resets to the default layers of the map service.
`void`	`setDisableClientCaching(boolean disable)` Sets whether images are always requested from the server and the browser's cache is ignored.
`void`	`setDPI(int dpi)` Sets the dpi of the exported map.
`void`	`setDPI(int dpi, boolean doNotRefresh)` Sets the dpi of the exported map.
`void`	`setDynamicLayerInfos(DynamicLayerInfo[] dynamicLayerInfos)` Specify an array of DynamicLayerInfos used to change the layer ordering or to redefine the map.
`void`	`setDynamicLayerInfos(DynamicLayerInfo[] dynamicLayerInfos, boolean doNotRefresh)` Specify an array of DynamicLayerInfos used to change the layer ordering or to redefine the map.
`void`	`setGDBVersion(java.lang.String gdbVersion)` Set the version for the ArcGIS DynamicMapServiceLayer.
`void`	`setGDBVersion(java.lang.String gdbVersion, boolean doNotRefresh)` Set the version for the ArcGIS DynamicMapServiceLayer.
`void`	`setImageFormat(ArcGISDynamicMapServiceLayer.ImageFormat imageFormat)` Sets the image format of the exported map.
`void`	`setImageFormat(ArcGISDynamicMapServiceLayer.ImageFormat imageFormat, boolean doNotRefresh)` Sets the image format of the exported map.
`void`	`setImageTransparency(boolean transparent)` Sets the background of a dynamic image to transparent.
`void`	`setImageTransparency(boolean transparent, boolean doNotRefresh)` Sets the background of a dynamic image to transparent.
`void`	`setLayerDefinitions(ArcGISDynamicMapServiceLayer.LayerDefinitions layerDefinitions)` Sets the layer definitions used to filter the features of individual layers in the map service.
`void`	`setLayerDefinitions(ArcGISDynamicMapServiceLayer.LayerDefinitions layerDefinitions, boolean doNotRefresh)` Sets the layer definitions used to filter the features of individual layers in the map service.
`void`	`setLayerDrawingOptions(LayerDrawingOptions[] layerDrawingOptions)` Specify an array of LayerDrawingOptions that override the way the layers are drawn.
`void`	`setLayerDrawingOptions(LayerDrawingOptions[] layerDrawingOptions, boolean doNotRefresh)` Specify an array of LayerDrawingOptions that override the way the layers are drawn.
`void`	`setLayerTimeOptions(LayerTimeOptions[] options)` Sets the time-related options for the layer.
`void`	`setLayerTimeOptions(LayerTimeOptions[] options, boolean doNotRefresh)` Sets the time-related options for the layer.
`void`	`setUseMapTime(boolean update)` Determine if the layer will update its content based on the map's current time extent.
`void`	`setVisibleLayers(int[] ids)` Sets the visible layers of the exported map.
`void`	`setVisibleLayers(int[] ids, boolean doNotRefresh)` Sets the visible layers of the exported map.
`boolean`	`useMapImage()` Deprecated.

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 final ArcGISDynamicMapServiceLayer create(java.lang.String uri)
```
    Creates a new ArcGISDynamicMapServiceLayer object. A URL is a required parameter.
    
    Parameters:
    uri - - URL to the ArcGIS Server REST resource that represents a map service.
    
    Returns:
    ArcGISDynamicMapServiceLayer
  - create
```
public static final ArcGISDynamicMapServiceLayer create(java.lang.String uri,
                                  ArcGISDynamicMapServiceLayer.Options options)
```
    Creates a new ArcGISDynamicMapServiceLayer 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:
    ArcGISDynamicMapServiceLayer
  - getCapabilities
```
public final java.lang.String getCapabilities()
```
    Capabilities of the map service, possible values are Map, Query and Data. Only available if the map service is published using ArcGIS Server version 10 or greater.
    
    Returns:
    String
  - getCopyright
```
public final java.lang.String getCopyright()
```
    Copyright string as defined by the map service.
    
    Returns:
    String
  - getDescription
```
public final java.lang.String getDescription()
```
    Map description as defined by the map 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
  - getDpi
```
public final int getDpi()
```
    The output dpi of the dynamic map service layer.
    
    Returns:
    int
  - getImageFormat
```
public final ArcGISDynamicMapServiceLayer.ImageFormat getImageFormat()
```
    The output image type. As of ArcGIS Server 9.3.1, the list of supported image formats is included in the description of Map Services in Services Directory under "Supported Image Format Types". In addition, as of ArcGIS Server 9.3.1, optimized map services can produce true PNG32 images.
    
    Returns:
    ImageFormat
  - imageTransparency
```
public final boolean imageTransparency()
```
    Whether or not background of dynamic image is transparent.
    
    Returns:
    boolean
  - getLayerDefinitions
```
public final com.google.gwt.core.client.JsArrayString getLayerDefinitions()
```
    Sets the layer definitions used to filter the features of individual layers in the map service. Layer definitions with semicolons or colons are supported at version 2.0 if using a map service published using ArcGIS Server 10.0
    
    Returns:
    JsArrayString
  - getLayerDrawingOptions
```
public final com.google.gwt.core.client.JsArray<LayerDrawingOptions> getLayerDrawingOptions()
```
    Array of LayerDrawingOptions used to override the way layers are drawn.
    
    Returns:
    JsArray
  - getLayerInfos
```
public final com.google.gwt.core.client.JsArray<LayerInfo> getLayerInfos()
```
    Returns the available layers in service and their default visibility.
    
    Returns:
    JsArray
  - getTimeLayerOptions
```
public final com.google.gwt.core.client.JsArray<LayerTimeOptions> getTimeLayerOptions()
```
    Returns the current layer time options if applicable. Use the setLayerTimeOptions method to modify the time options. (As of v2.0)
    
    Returns:
    JsArray
  - 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.
    
    Returns:
    int
  - getMinImageHeight
```
public final int getMinImageHeight()
```
    The maximum image width, in pixels, that the map service will export. Requires ArcGIS Server version 10.1 or greater.
    
    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.
    
    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
  - getUnits
```
public final java.lang.String getUnits()
```
    Default units of the layer as defined by the service. If the layer is the base map, the map is in these units.
    
    Returns:
    String
  - useMapImage
```
public final boolean useMapImage()
```
    Deprecated.
    
    When true, the image is saved to the server, and a JSON formatted response is sent to the client with the URL location of the image. A second call is automatically made to the server to retrieve the image. This value is set in the constructor using useMapImage. Deprecated at v2.0. Prior to v2.0 this option was used when some export map requests exceeded the limit of 2000 characters and it configured the map to use the proxy all the time. This is not the optimal behavior so at v2.0 the switch to use the proxy will automatically happen for long requests.
    
    Returns:
    boolean
  - getVersion
```
public final float getVersion()
```
    The version of ArcGIS Server where the map service is published.
    
    Returns:
    float
  - getVisibleLayers
```
public final com.google.gwt.core.client.JsArrayInteger getVisibleLayers()
```
    Gets the visible layers of the exported map.
    
    Returns:
    JsArrayInteger
  - createDynamicLayerInfosFromLayerInfos
```
public final com.google.gwt.core.client.JsArray<DynamicLayerInfo> createDynamicLayerInfosFromLayerInfos()
```
    Create an array of DynamicLayerInfos based on the current set of LayerInfo. (As of v2.7)
    
    Returns:
    JsArray
  - exportMapImage
```
public final void exportMapImage()
```
    Exports a map using values as specified by ImageParameters. On completion, MapImage is returned.
  - exportMapImage
```
public final void exportMapImage(ImageParameters params)
```
    Exports a map using values as specified by ImageParameters. On completion, MapImage is returned.
    
    Parameters:
    params - - Input parameters assigned before exporting the map image.
  - exportMapImage
```
public final void exportMapImage(ImageParameters params,
                  MapImageExportHandler handler)
```
    Exports a map using values as specified by ImageParameters. 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.
  - setDefaultLayerDefinitions
```
public final void setDefaultLayerDefinitions()
```
    Resets all layer definitions to those defined in the service.
  - setDefaultLayerDefinitions
```
public final void setDefaultLayerDefinitions(boolean doNotRefresh)
```
    Resets all layer definitions to those defined in the service.
    
    Parameters:
    doNotRefresh - - Added at version 2.2 When true the layer will not refresh the map image. The default value is false.
  - setDefaultVisibleLayers
```
public final void setDefaultVisibleLayers()
```
    Clears the visible layers as defined in setVisibleLayers, and resets to the default layers of the map service.
  - setDefaultVisibleLayers
```
public final void setDefaultVisibleLayers(boolean doNotRefresh)
```
    Clears the visible layers as defined in setVisibleLayers, and resets to the default layers of the map service.
    
    Parameters:
    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, client side caching is disabled.
  - setDPI
```
public final void setDPI(int dpi)
```
    Sets the dpi of the exported map. The default value is 96.
    
    Parameters:
    dpi - - DPI value.
  - setDPI
```
public final void setDPI(int dpi,
          boolean doNotRefresh)
```
    Sets the dpi of the exported map. The default value is 96.
    
    Parameters:
    dpi - - DPI value.
    doNotRefresh - - Added at version 2.2 When true the layer will not refresh the map image. The default value is false.
  - setDynamicLayerInfos
```
public final void setDynamicLayerInfos(DynamicLayerInfo[] dynamicLayerInfos)
```
    Specify an array of DynamicLayerInfos used to change the layer ordering or to redefine the map. (As of v2.7)
    
    Parameters:
    dynamicLayerInfos - - An array of dynamic layer infos.
  - setDynamicLayerInfos
```
public final void setDynamicLayerInfos(DynamicLayerInfo[] dynamicLayerInfos,
                        boolean doNotRefresh)
```
    Specify an array of DynamicLayerInfos used to change the layer ordering or to redefine the map. (As of v2.7)
    
    Parameters:
    dynamicLayerInfos - - An array of dynamic layer infos.
    doNotRefresh - - When true the layer will not refresh the map image. The default value is false.
  - setGDBVersion
```
public final void setGDBVersion(java.lang.String gdbVersion)
```
    Set the version for the ArcGIS DynamicMapServiceLayer. Requires an ArcGIS Server service 10.1 or greater (As of v2.7)
    
    Parameters:
    gdbVersion - - The name of the version to display.
  - setGDBVersion
```
public final void setGDBVersion(java.lang.String gdbVersion,
                 boolean doNotRefresh)
```
    Set the version for the ArcGIS DynamicMapServiceLayer. Requires an ArcGIS Server service 10.1 or greater (As of v2.7)
    
    Parameters:
    gdbVersion - - The name of the version to display.
    doNotRefresh - - When true the layer will not refresh the map image. The default value is false.
  - setImageFormat
```
public final void setImageFormat(ArcGISDynamicMapServiceLayer.ImageFormat imageFormat)
```
    Sets the image format of the exported map.
    
    Parameters:
    imageFormat -
  - setImageFormat
```
public final void setImageFormat(ArcGISDynamicMapServiceLayer.ImageFormat imageFormat,
                  boolean doNotRefresh)
```
    Sets the image format of the exported map.
    
    Parameters:
    imageFormat -
    doNotRefresh - - Added at version 2.2 When true the layer will not refresh the map image. The default value is false.
  - setImageTransparency
```
public final void setImageTransparency(boolean transparent)
```
    Sets the background of a dynamic image to transparent.
    
    Parameters:
    transparent - - The default is "true".
  - setImageTransparency
```
public final void setImageTransparency(boolean transparent,
                        boolean doNotRefresh)
```
    Sets the background of a dynamic image to transparent.
    
    Parameters:
    transparent - - The default is "true".
    doNotRefresh - - Added at version 2.2 When true the layer will not refresh the map image. The default value is false.
  - setLayerDefinitions
```
public final void setLayerDefinitions(ArcGISDynamicMapServiceLayer.LayerDefinitions layerDefinitions)
```
    Sets the layer definitions used to filter the features of individual layers in the map service. If the layer definition expression is longer than approximately 2000 characters you will need to set up a proxy page. Prior to v2.0, you also need to set useMapImage to true. Layer definitions with semicolons or colons are supported if using a map service published using ArcGIS Server 10.
    
    Parameters:
    layerDefinitions - - An array containing each layer's definition.
  - setLayerDefinitions
```
public final void setLayerDefinitions(ArcGISDynamicMapServiceLayer.LayerDefinitions layerDefinitions,
                       boolean doNotRefresh)
```
    Sets the layer definitions used to filter the features of individual layers in the map service. If the layer definition expression is longer than approximately 2000 characters you will need to set up a proxy page. Prior to v2.0, you also need to set useMapImage to true. Layer definitions with semicolons or colons are supported if using a map service published using ArcGIS Server 10.
    
    Parameters:
    layerDefinitions - - An array containing each layer's definition.
    doNotRefresh - - Added at version 2.2 When true the layer will not refresh the map image. The default value is false.
  - setLayerDrawingOptions
```
public final void setLayerDrawingOptions(LayerDrawingOptions[] layerDrawingOptions)
```
    Specify an array of LayerDrawingOptions that override the way the layers are drawn.
    
    Parameters:
    layerDrawingOptions - - An array of layer drawing options.
  - setLayerDrawingOptions
```
public final void setLayerDrawingOptions(LayerDrawingOptions[] layerDrawingOptions,
                          boolean doNotRefresh)
```
    Specify an array of LayerDrawingOptions that override the way the layers are drawn.
    
    Parameters:
    layerDrawingOptions - - An array of layer drawing options.
    doNotRefresh - - When true the layer will not refresh the map image. The default value is false.
  - setLayerTimeOptions
```
public final void setLayerTimeOptions(LayerTimeOptions[] options)
```
    Sets the time-related options for the layer. (As of v2.0)
    
    Parameters:
    options - - 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.
  - setLayerTimeOptions
```
public final void setLayerTimeOptions(LayerTimeOptions[] options,
                       boolean doNotRefresh)
```
    Sets the time-related options for the layer. (As of v2.0)
    
    Parameters:
    options - - 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.
    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.
  - setVisibleLayers
```
public final void setVisibleLayers(int[] ids)
```
    Sets the visible layers of the exported map. By default, the visible layers are as defined by the default visibility in LayerInfo.
    
    Parameters:
    ids - - Array of layer IDs.
  - setVisibleLayers
```
public final void setVisibleLayers(int[] ids,
                    boolean doNotRefresh)
```
    Sets the visible layers of the exported map. By default, the visible layers are as defined by the default visibility in LayerInfo.
    
    Parameters:
    ids - - Array of layer IDs.
    doNotRefresh - - Added at version 2.2 When true the layer will not refresh the map image. The default value is false.
  - addGDBChangeHandler
```
public final void addGDBChangeHandler(GdbVersionChangeHandler handler)
```
    Set gdb version change handler.
    
    Parameters:
    handler - - Fired when the geodatabase version is switched.
  - 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 ArcGISDynamicMapServiceLayer

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

getCapabilities

getCopyright

getDescription

isDisabledClientCaching

getDpi

getImageFormat

imageTransparency

getLayerDefinitions

getLayerDrawingOptions

getLayerInfos

getTimeLayerOptions

getMaxImageHeight

getMinImageHeight

getMaxRecordCount

getTimeInfo

getUnits

useMapImage

getVersion

getVisibleLayers

createDynamicLayerInfosFromLayerInfos

exportMapImage

exportMapImage

exportMapImage

setDefaultLayerDefinitions

setDefaultLayerDefinitions

setDefaultVisibleLayers

setDefaultVisibleLayers

setDisableClientCaching

setDPI

setDPI

setDynamicLayerInfos

setDynamicLayerInfos

setGDBVersion

setGDBVersion

setImageFormat

setImageFormat

setImageTransparency

setImageTransparency

setLayerDefinitions

setLayerDefinitions

setLayerDrawingOptions

setLayerDrawingOptions

setLayerTimeOptions

setLayerTimeOptions

setUseMapTime

setVisibleLayers

setVisibleLayers

addGDBChangeHandler

addMapImageExportHandler