com.esri.arcgis.carto
Interface IImageServerLayer

All Superinterfaces:

ILayer, Serializable

All Known Implementing Classes:

ImageServerLayer

public interface IImageServerLayer
extends ILayer, Serializable

Provides access to members that control an image server layer.

Description

This interface is new at ArcGIS 9.3.

Remarks

IImageServerLayer interface allows you to access properties of an ImageServerLayer created from an ImageServer. The properties include compression type and quality, serviceinfo, service URL, and so on. An ImageServerLayer is similar to a RasterLayer; you can change how the pixels render on the display by changing the renderer applied to the layer.

ImageServerLayer needs to be initialized using the Initialize method before use.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

String	getCompression() The transmission compression.
int	getCompressionQuality() The transmission compression quality.
IEnvelope	getDataFrameExtent() The extent of the dataframe that contains the layer.
Object	getDataSource() Layer’s data source object.
IRaster	getRaster() The assoicated raster.
IRasterRenderer	getRenderer() The assoicated raster renderer.
IImageServiceInfo	getServiceInfo() The image service info.
String	getServiceURL() The layer’s service URL.
IEnvelope	getVisibleExtent() The Visible extent of the layer in the data frame.
void	initialize(String serviceURL) Initializes the layer with an image service URL.
boolean	isShowResolution() Indicates if the image resolution should be displayed in TOC.
void	setCompression(String pCompression) The transmission compression.
void	setCompressionQuality(int pQuality) The transmission compression quality.
void	setRendererByRef(IRasterRenderer ppRenderer) The assoicated raster renderer.
void	setShowResolution(boolean pShowResolution) Indicates if the image resolution should be displayed in TOC.
void	setVisibleExtent(IEnvelope ppExtent) The Visible extent of the layer in the data frame.

Methods inherited from interface com.esri.arcgis.carto.ILayer

draw, getAreaOfInterest, getMaximumScale, getMinimumScale, getName, getSupportedDrawPhases, getTipText, isCached, isShowTips, isValid, isVisible, setCached, setMaximumScale, setMinimumScale, setName, setShowTips, setSpatialReferenceByRef, setVisible

Method Detail

initialize

void initialize(String serviceURL)
                throws IOException,
                       AutomationException

Initializes the layer with an image service URL.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

serviceURL - The serviceURL (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceURL

String getServiceURL()
                     throws IOException,
                            AutomationException

The layer’s service URL.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pServiceURL

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSource

Object getDataSource()
                     throws IOException,
                            AutomationException

Layer’s data source object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceInfo

IImageServiceInfo getServiceInfo()
                                 throws IOException,
                                        AutomationException

The image service info.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.carto.IImageServiceInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowResolution

boolean isShowResolution()
                         throws IOException,
                                AutomationException

Indicates if the image resolution should be displayed in TOC.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pShowResolution

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowResolution

void setShowResolution(boolean pShowResolution)
                       throws IOException,
                              AutomationException

Indicates if the image resolution should be displayed in TOC.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pShowResolution - The pShowResolution (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataFrameExtent

IEnvelope getDataFrameExtent()
                             throws IOException,
                                    AutomationException

The extent of the dataframe that contains the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisibleExtent

void setVisibleExtent(IEnvelope ppExtent)
                      throws IOException,
                             AutomationException

The Visible extent of the layer in the data frame.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVisibleExtent

IEnvelope getVisibleExtent()
                           throws IOException,
                                  AutomationException

The Visible extent of the layer in the data frame.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompression

String getCompression()
                      throws IOException,
                             AutomationException

The transmission compression.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pCompression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompression

void setCompression(String pCompression)
                    throws IOException,
                           AutomationException

The transmission compression.

Remarks

Support LZ77 and JPEG compressions. The string can be "LZ77", "JPEG", or "NONE" (no compression)

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pCompression - The pCompression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompressionQuality

int getCompressionQuality()
                          throws IOException,
                                 AutomationException

The transmission compression quality.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pQuality

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressionQuality

void setCompressionQuality(int pQuality)
                           throws IOException,
                                  AutomationException

The transmission compression quality.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pQuality - The pQuality (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRaster

IRaster getRaster()
                  throws IOException,
                         AutomationException

The assoicated raster.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.geodatabase.IRaster

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderer

IRasterRenderer getRenderer()
                            throws IOException,
                                   AutomationException

The assoicated raster renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.carto.IRasterRenderer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRendererByRef

void setRendererByRef(IRasterRenderer ppRenderer)
                      throws IOException,
                             AutomationException

The assoicated raster renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

ppRenderer - A reference to a com.esri.arcgis.carto.IRasterRenderer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.