com.esri.arcgis.carto
Class RasterStretchColorRampRenderer

java.lang.Object
  extended by com.esri.arcgis.carto.RasterStretchColorRampRenderer
All Implemented Interfaces:
IColorChannelMapping, IDisplayTableExchange, IGlobeRasterStretch, IHillShadeInfo, IIdentify, ILegendInfo, IRasterDisplayProps, IRasterRenderer, IRasterRenderer2, IRasterRendererClassInfo, IRasterRendererColorRamp, IRasterRendererInfo, IRasterStretch, IRasterStretch2, IRasterStretch3, IRasterStretchColorRampRenderer, IRasterStretchMinMax, IDisplayAdmin, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class RasterStretchColorRampRenderer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterStretchColorRampRenderer, IGlobeRasterStretch, IRasterStretch, IRasterStretch2, IRasterStretch3, IRasterStretchMinMax, IRasterRenderer, IRasterRenderer2, IRasterRendererInfo, IRasterRendererColorRamp, IRasterDisplayProps, IIdentify, ILegendInfo, IDisplayAdmin, IPersistStream, IRasterRendererClassInfo, IColorChannelMapping, IHillShadeInfo, IXMLSerialize, IDisplayTableExchange, Externalizable

A renderer with a color ramp for rasters with continuous values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
RasterStretchColorRampRenderer()
          Constructs a RasterStretchColorRampRenderer using ArcGIS Engine.
RasterStretchColorRampRenderer(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterStretchColorRampRenderer theRasterStretchColorRampRenderer = (RasterStretchColorRampRenderer) obj;
 
Method Summary
 void adaptRaster(IRaster pRaster)
          Adapts to the new raster.
 boolean canRender(IRaster raster)
          Indicates if the raster can be rendered.
 void copy(IRasterRenderer pSource)
          Selects a raster as the current copy object.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 void draw(IRaster raster, int drawPhase, IDisplay pDisplay, ITrackCancel pTrackCancel)
          Draws the raster on the display.
 boolean equals(Object o)
          Compare this object with another
 IColor getBackgroundColor()
          Background display color.
 Object getBackgroundValue()
          The list of background value(s).
 double getBackgroundValues()
          Indicates whether an array of background values is being used.
 int getBandIndex()
          Index of the band to be rendered.
 Object getBandIndices()
          The band indices being used in the mapping.
 int getBrightnessValue()
          Brightness value for a raster.
 int getClassCount()
          Number of classes in the renderer.
 void getClassID(GUID[] pClassID)
          getClassID
 String getClassificationField()
          Classification field name or an empty string if a table doesn't exist.
static String getClsid()
          getClsid.
 IColorRamp getColorRamp()
          Color ramp.
 String getColorScheme()
          ColorScheme name.
 int getContrastValue()
          Contrast value for a raster.
 double getCustomStretchMax()
          The custom maximum value for stretch renderer type "Minimum-Maximum".
 double getCustomStretchMin()
          The custom minimum value for stretch renderer type "Minimum-Maximum".
 String getDescription()
          The description of the raster renderer.
 int getDisplayResolutionFactor()
          Display resolution factor.
 ITable getDisplayTable()
          The renderer display table.
 Object getGammaValue()
          The list of Gamma value(s).
 String getLabelHigh()
          Label for highest value.
 String getLabelLow()
          Label for lowest value.
 String getLabelMedium()
          Label for medium value.
 ILegendGroup getLegendGroup(int index)
          Legend group at the specified index.
 int getLegendGroupCount()
          Number of legend groups contained by the object.
 ILegendItem getLegendItem()
          Optional.
 String getName()
          The name of the raster renderer.
 IColor getNoDataColor()
          Nodata color for a raster.
 String getNormalizationField()
          Normalization field name or an empty string if none.
 IRaster getRaster()
          Raster to be rendered.
 int getResamplingType()
          Resampling method for displaying a raster.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 IArray getSpecificationHistogram()
          The statistics for histogram specification stretch.
 double getStandardDeviationsParam()
          Standard deviation parameter for the stretch renderer.
 double getStretchMax()
          The maximum value used for stretching cell values.
 double getStretchMin()
          The minimum value used for stretching cell values.
 IArray getStretchStats()
          The global raster stretch statistics.
 int getStretchStatsType()
          The current stretch statistics type.
 int getStretchType()
          Current stretch type.
 int getTransparencyValue()
          Transparency value for a raster.
 double getZScale()
          The Z factor multipled to z valuesg.
 int hashCode()
          the hashcode for this object
 IArray identify(IGeometry pGeom)
          Identifies objects at the specified location.
 IColorRamp IRasterRendererColorRamp_getColorRamp()
          The color ramp of the color map.
 boolean isBackground()
          Indicates if a background value is being used.
 void isDirty()
          isDirty
 boolean isGlobeLayerRenderer()
          Indicates whether it is a ArcGlobe layer renderer.
 boolean isInvert()
          Indicates if the stretch is inverted.
 boolean isNumericClasses()
          Indicates if the classification field is numeric.
 boolean isSymbolsAreGraduated()
          Indicates if symbols are graduated.
 boolean isUpdated()
          Indicates whether the renderer requires updating.
 boolean isUseCustomStretchMinMax()
          Indicates whether to use the custom minimum/maximum values for stretch renderer type "Minimum-Maximum".
 boolean isUseDefaultMapping()
          Indicates whether the default mapping is being used.
 boolean isUseGamma()
          Indicates if Gamma stretch should be applied.
 boolean isUseHillShade()
          Indicates whether the hill shading is being used.
 boolean isUsesFilter()
          Indicates if the current object draws using a filter.
 void load(IStream pstm)
          load
 void queryNumberClass(int classIndex, double[] minValue, double[] maxValue, int[] outValue)
          Information for a number class by index.
 void queryStringClass(int classIndex, String[] inValue, int[] outValue)
          Information for a string class by index.
 void readExternal(ObjectInput in)
           
 void recreateRaster(IRasterDataset pDataset, IRaster pRaster)
          Recreates a raster, if necessary, from a given RasterDataset.
 void resetLabels()
          Makes default labels.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setBackground(boolean b)
          Indicates if a background value is being used.
 void setBackgroundColorByRef(IColor ppColor)
          Background display color.
 void setBackgroundValue(Object background)
          The list of background value(s).
 void setBackgroundValues(double[] pBkg)
          Indicates whether an array of background values is being used.
 void setBandIndex(int bandIndex)
          Index of the band to be rendered.
 void setBandIndices(Object vIndex)
          The band indices being used in the mapping.
 void setBrightnessValue(int pValue)
          Brightness value for a raster.
 void setColorRamp(IColorRamp ppColorRamp)
          Color ramp.
 void setColorScheme(String colorScheme)
          ColorScheme name.
 void setContrastValue(int iValue)
          Contrast value for a raster.
 void setCustomStretchMax(double param)
          The custom maximum value for stretch renderer type "Minimum-Maximum".
 void setCustomStretchMin(double param)
          The custom minimum value for stretch renderer type "Minimum-Maximum".
 void setDisplayResolutionFactor(int pnFactor)
          Display resolution factor.
 void setDisplayTableByRef(ITable ppTable)
          The renderer display table.
 void setGammaValue(Object pGamma)
          The list of Gamma value(s).
 void setInvert(boolean pInvert)
          Indicates if the stretch is inverted.
 void setIsGlobeLayerRenderer(boolean flag)
          Indicates whether it is a ArcGlobe layer renderer.
 void setLabelHigh(String label)
          Label for highest value.
 void setLabelLow(String label)
          Label for lowest value.
 void setLabelMedium(String label)
          Label for medium value.
 void setNoDataColorByRef(IColor ppColor)
          Nodata color for a raster.
 void setRasterByRef(IRaster raster)
          Raster to be rendered.
 void setResamplingType(int pResamplingType)
          Resampling method for displaying a raster.
 void setSpecificationHistogramByRef(IArray pRGBStats)
          The statistics for histogram specification stretch.
 void setStandardDeviationsParam(double param)
          Standard deviation parameter for the stretch renderer.
 void setStretchStatsByRef(IArray ppRGBStats)
          The global raster stretch statistics.
 void setStretchStatsType(int stats)
          The current stretch statistics type.
 void setStretchType(int en_stretch)
          Current stretch type.
 void setSymbolsAreGraduated(boolean symbolsAreGraduated)
          Indicates if symbols are graduated.
 void setTransparencyValue(int pValue)
          Transparency value for a raster.
 void setUseCustomStretchMinMax(boolean pUse)
          Indicates whether to use the custom minimum/maximum values for stretch renderer type "Minimum-Maximum".
 void setUseDefaultMapping(boolean bIsDefault)
          Indicates whether the default mapping is being used.
 void setUseGamma(boolean pUseGamma)
          Indicates if Gamma stretch should be applied.
 void setUseHillShade(boolean bUse)
          Indicates whether the hill shading is being used.
 void setZScale(double pZScale)
          The Z factor multipled to z valuesg.
 void update()
          Updates the renderer for any changes that have been made.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

RasterStretchColorRampRenderer

public RasterStretchColorRampRenderer()
                               throws IOException,
                                      UnknownHostException
Constructs a RasterStretchColorRampRenderer using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

RasterStretchColorRampRenderer

public RasterStretchColorRampRenderer(Object obj)
                               throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterStretchColorRampRenderer theRasterStretchColorRampRenderer = (RasterStretchColorRampRenderer) obj;

Construct a RasterStretchColorRampRenderer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterStretchColorRampRenderer.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

setBandIndex

public void setBandIndex(int bandIndex)
                  throws IOException,
                         AutomationException
Index of the band to be rendered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBandIndex in interface IRasterStretchColorRampRenderer
Parameters:
bandIndex - The bandIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBandIndex

public int getBandIndex()
                 throws IOException,
                        AutomationException
Index of the band to be rendered.

Remarks

The BandIndex property specifies the band in the raster dataset to be drawn. For single-band data, this should be 0, but with multiband data any band may be selected.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBandIndex in interface IRasterStretchColorRampRenderer
Returns:
The bandIndex
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColorScheme

public String getColorScheme()
                      throws IOException,
                             AutomationException
ColorScheme name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getColorScheme in interface IRasterRendererColorRamp
Specified by:
getColorScheme in interface IRasterStretchColorRampRenderer
Returns:
The colorScheme
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColorScheme

public void setColorScheme(String colorScheme)
                    throws IOException,
                           AutomationException
ColorScheme name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setColorScheme in interface IRasterRendererColorRamp
Specified by:
setColorScheme in interface IRasterStretchColorRampRenderer
Parameters:
colorScheme - The colorScheme (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColorRamp

public IColorRamp getColorRamp()
                        throws IOException,
                               AutomationException
Color ramp.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getColorRamp in interface IRasterStretchColorRampRenderer
Returns:
A reference to a com.esri.arcgis.display.IColorRamp
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColorRamp

public void setColorRamp(IColorRamp ppColorRamp)
                  throws IOException,
                         AutomationException
Color ramp.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setColorRamp in interface IRasterRendererColorRamp
Specified by:
setColorRamp in interface IRasterStretchColorRampRenderer
Parameters:
ppColorRamp - A reference to a com.esri.arcgis.display.IColorRamp (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelLow

public String getLabelLow()
                   throws IOException,
                          AutomationException
Label for lowest value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLabelLow in interface IRasterStretchColorRampRenderer
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelLow

public void setLabelLow(String label)
                 throws IOException,
                        AutomationException
Label for lowest value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLabelLow in interface IRasterStretchColorRampRenderer
Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelMedium

public String getLabelMedium()
                      throws IOException,
                             AutomationException
Label for medium value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLabelMedium in interface IRasterStretchColorRampRenderer
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelMedium

public void setLabelMedium(String label)
                    throws IOException,
                           AutomationException
Label for medium value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLabelMedium in interface IRasterStretchColorRampRenderer
Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelHigh

public String getLabelHigh()
                    throws IOException,
                           AutomationException
Label for highest value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLabelHigh in interface IRasterStretchColorRampRenderer
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelHigh

public void setLabelHigh(String label)
                  throws IOException,
                         AutomationException
Label for highest value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLabelHigh in interface IRasterStretchColorRampRenderer
Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetLabels

public void resetLabels()
                 throws IOException,
                        AutomationException
Makes default labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
resetLabels in interface IRasterStretchColorRampRenderer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isGlobeLayerRenderer

public boolean isGlobeLayerRenderer()
                             throws IOException,
                                    AutomationException
Indicates whether it is a ArcGlobe layer renderer.

Product Availability

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

Specified by:
isGlobeLayerRenderer in interface IGlobeRasterStretch
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsGlobeLayerRenderer

public void setIsGlobeLayerRenderer(boolean flag)
                             throws IOException,
                                    AutomationException
Indicates whether it is a ArcGlobe layer renderer.

Product Availability

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

Specified by:
setIsGlobeLayerRenderer in interface IGlobeRasterStretch
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStretchType

public void setStretchType(int en_stretch)
                    throws IOException,
                           AutomationException
Current stretch type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setStretchType in interface IRasterStretch
Specified by:
setStretchType in interface IRasterStretch2
Parameters:
en_stretch - A com.esri.arcgis.carto.esriRasterStretchTypesEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStretchType

public int getStretchType()
                   throws IOException,
                          AutomationException
Current stretch type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getStretchType in interface IRasterStretch
Specified by:
getStretchType in interface IRasterStretch2
Returns:
A com.esri.arcgis.carto.esriRasterStretchTypesEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStandardDeviationsParam

public void setStandardDeviationsParam(double param)
                                throws IOException,
                                       AutomationException
Standard deviation parameter for the stretch renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setStandardDeviationsParam in interface IRasterStretch
Specified by:
setStandardDeviationsParam in interface IRasterStretch2
Parameters:
param - The param (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStandardDeviationsParam

public double getStandardDeviationsParam()
                                  throws IOException,
                                         AutomationException
Standard deviation parameter for the stretch renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getStandardDeviationsParam in interface IRasterStretch
Specified by:
getStandardDeviationsParam in interface IRasterStretch2
Returns:
The param
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInvert

public void setInvert(boolean pInvert)
               throws IOException,
                      AutomationException
Indicates if the stretch is inverted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setInvert in interface IRasterStretch
Specified by:
setInvert in interface IRasterStretch2
Parameters:
pInvert - The pInvert (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInvert

public boolean isInvert()
                 throws IOException,
                        AutomationException
Indicates if the stretch is inverted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isInvert in interface IRasterStretch
Specified by:
isInvert in interface IRasterStretch2
Returns:
The pInvert
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackground

public void setBackground(boolean b)
                   throws IOException,
                          AutomationException
Indicates if a background value is being used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBackground in interface IRasterStretch
Specified by:
setBackground in interface IRasterStretch2
Parameters:
b - The b (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBackground

public boolean isBackground()
                     throws IOException,
                            AutomationException
Indicates if a background value is being used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isBackground in interface IRasterStretch
Specified by:
isBackground in interface IRasterStretch2
Returns:
The b
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundValues

public double getBackgroundValues()
                           throws IOException,
                                  AutomationException
Indicates whether an array of background values is being used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBackgroundValues in interface IRasterStretch
Returns:
The pBkg
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundValues

public void setBackgroundValues(double[] pBkg)
                         throws IOException,
                                AutomationException
Indicates whether an array of background values is being used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

To set a list of background values, use IRasterStretch2::setBackgroundValue() instead.

Specified by:
setBackgroundValues in interface IRasterStretch
Parameters:
pBkg - The pBkg (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException
Background display color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBackgroundColor in interface IRasterStretch
Specified by:
getBackgroundColor in interface IRasterStretch2
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundColorByRef

public void setBackgroundColorByRef(IColor ppColor)
                             throws IOException,
                                    AutomationException
Background display color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBackgroundColorByRef in interface IRasterStretch
Specified by:
setBackgroundColorByRef in interface IRasterStretch2
Parameters:
ppColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundValue

public Object getBackgroundValue()
                          throws IOException,
                                 AutomationException
The list of background value(s).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBackgroundValue in interface IRasterStretch2
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundValue

public void setBackgroundValue(Object background)
                        throws IOException,
                               AutomationException
The list of background value(s).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

For example :-

IRasterStretch2 rasterStretch2 = ...;
double[] values = new double[1];
values[0] = 1;
rasterStretch.setBackgroundValue(values);

Specified by:
setBackgroundValue in interface IRasterStretch2
Parameters:
background - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStretchStatsType

public void setStretchStatsType(int stats)
                         throws IOException,
                                AutomationException
The current stretch statistics type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setStretchStatsType in interface IRasterStretch2
Parameters:
stats - A com.esri.arcgis.carto.esriRasterStretchStatsTypeEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStretchStatsType

public int getStretchStatsType()
                        throws IOException,
                               AutomationException
The current stretch statistics type.

Remarks

The StretchStatsType property specifies the stretch statistics type. The option esriRasterStretchStats_AreaOfView uses statistics dynamically calculated from the current display area, whereby the option esriRasterStretchStats_Dataset uses statistics from the raster dataset, and the option esriRasterStretchStats_GlobalStats uses user-defined statistics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getStretchStatsType in interface IRasterStretch2
Returns:
A com.esri.arcgis.carto.esriRasterStretchStatsTypeEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStretchStatsByRef

public void setStretchStatsByRef(IArray ppRGBStats)
                          throws IOException,
                                 AutomationException
The global raster stretch statistics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setStretchStatsByRef in interface IRasterStretch2
Parameters:
ppRGBStats - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStretchStats

public IArray getStretchStats()
                       throws IOException,
                              AutomationException
The global raster stretch statistics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getStretchStats in interface IRasterStretch2
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpecificationHistogramByRef

public void setSpecificationHistogramByRef(IArray pRGBStats)
                                    throws IOException,
                                           AutomationException
The statistics for histogram specification stretch.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSpecificationHistogramByRef in interface IRasterStretch2
Parameters:
pRGBStats - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpecificationHistogram

public IArray getSpecificationHistogram()
                                 throws IOException,
                                        AutomationException
The statistics for histogram specification stretch.

Remarks

The SpecificationHistogram property specifies histograms. You must set the stretch type (IRasterStretch::StretchType) to be esri_HistogramSpecification in order for the specified histograms to be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSpecificationHistogram in interface IRasterStretch2
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseGamma

public void setUseGamma(boolean pUseGamma)
                 throws IOException,
                        AutomationException
Indicates if Gamma stretch should be applied.

Product Availability

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

Specified by:
setUseGamma in interface IRasterStretch3
Parameters:
pUseGamma - The pUseGamma (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseGamma

public boolean isUseGamma()
                   throws IOException,
                          AutomationException
Indicates if Gamma stretch should be applied.

Product Availability

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

Specified by:
isUseGamma in interface IRasterStretch3
Returns:
The pUseGamma
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGammaValue

public void setGammaValue(Object pGamma)
                   throws IOException,
                          AutomationException
The list of Gamma value(s).

Product Availability

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

Specified by:
setGammaValue in interface IRasterStretch3
Parameters:
pGamma - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGammaValue

public Object getGammaValue()
                     throws IOException,
                            AutomationException
The list of Gamma value(s).

Product Availability

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

Specified by:
getGammaValue in interface IRasterStretch3
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStretchMin

public double getStretchMin()
                     throws IOException,
                            AutomationException
The minimum value used for stretching cell values.

Remarks

The StretchMax and StretchMin properties return the existing minimum and maximum values from the raster band.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getStretchMin in interface IRasterStretchMinMax
Returns:
The param
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStretchMax

public double getStretchMax()
                     throws IOException,
                            AutomationException
The maximum value used for stretching cell values.

Remarks

The StretchMax and StretchMin properties return the existing minimum and maximum values from the raster band.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getStretchMax in interface IRasterStretchMinMax
Returns:
The param
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomStretchMin

public void setCustomStretchMin(double param)
                         throws IOException,
                                AutomationException
The custom minimum value for stretch renderer type "Minimum-Maximum".

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCustomStretchMin in interface IRasterStretchMinMax
Parameters:
param - The param (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomStretchMin

public double getCustomStretchMin()
                           throws IOException,
                                  AutomationException
The custom minimum value for stretch renderer type "Minimum-Maximum".

Remarks

The CustomStretchMax and CustomStretchMin properties specify custom minimum and maximum values to be used.

The property IRasterStretchType::StretchType must be set to be esriRasterStretch_MinimumMaximum before using the custom minimum and maximum values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCustomStretchMin in interface IRasterStretchMinMax
Returns:
The param
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomStretchMax

public void setCustomStretchMax(double param)
                         throws IOException,
                                AutomationException
The custom maximum value for stretch renderer type "Minimum-Maximum".

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCustomStretchMax in interface IRasterStretchMinMax
Parameters:
param - The param (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomStretchMax

public double getCustomStretchMax()
                           throws IOException,
                                  AutomationException
The custom maximum value for stretch renderer type "Minimum-Maximum".

Remarks

The CustomStretchMax and CustomStretchMin properties specify custom minimum and maximum values to be used.

The property IRasterStretchType::StretchType must be set to be esriRasterStretch_MinimumMaximum before using the custom minimum and maximum values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCustomStretchMax in interface IRasterStretchMinMax
Returns:
The param
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseCustomStretchMinMax

public void setUseCustomStretchMinMax(boolean pUse)
                               throws IOException,
                                      AutomationException
Indicates whether to use the custom minimum/maximum values for stretch renderer type "Minimum-Maximum".

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setUseCustomStretchMinMax in interface IRasterStretchMinMax
Parameters:
pUse - The pUse (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseCustomStretchMinMax

public boolean isUseCustomStretchMinMax()
                                 throws IOException,
                                        AutomationException
Indicates whether to use the custom minimum/maximum values for stretch renderer type "Minimum-Maximum".

Remarks

The UseCustomStretchMinMax property must be true in order to use the minimum and maximum values you have specified; setting this property to be false the minimum and maximum values in the raster band or raster dataset will be used in rendering.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isUseCustomStretchMinMax in interface IRasterStretchMinMax
Returns:
The pUse
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canRender

public boolean canRender(IRaster raster)
                  throws IOException,
                         AutomationException
Indicates if the raster can be rendered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
canRender in interface IRasterRenderer
Parameters:
raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Returns:
The pCanRender
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterByRef

public void setRasterByRef(IRaster raster)
                    throws IOException,
                           AutomationException
Raster to be rendered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRasterByRef in interface IRasterRenderer
Parameters:
raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRaster

public IRaster getRaster()
                  throws IOException,
                         AutomationException
Raster to be rendered.

Description

The Raster property controls the raster being displayed by the renderer. Because the renderers depend on dataset statistics, after changing the raster to be displayed, the update method must be called before performing using the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRaster in interface IRasterRenderer
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.

draw

public void draw(IRaster raster,
                 int drawPhase,
                 IDisplay pDisplay,
                 ITrackCancel pTrackCancel)
          throws IOException,
                 AutomationException
Draws the raster on the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
draw in interface IRasterRenderer
Parameters:
raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)
pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUpdated

public boolean isUpdated()
                  throws IOException,
                         AutomationException
Indicates whether the renderer requires updating.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isUpdated in interface IRasterRenderer
Returns:
The pUpdated
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

public void update()
            throws IOException,
                   AutomationException
Updates the renderer for any changes that have been made.

Remarks

The Update method should also be called after making changes to the renderer but before assigning the renderer to a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
update in interface IRasterRenderer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

copy

public void copy(IRasterRenderer pSource)
          throws IOException,
                 AutomationException
Selects a raster as the current copy object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
copy in interface IRasterRenderer
Parameters:
pSource - 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.

getResamplingType

public int getResamplingType()
                      throws IOException,
                             AutomationException
Resampling method for displaying a raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getResamplingType in interface IRasterRenderer
Returns:
A com.esri.arcgis.geodatabase.rstResamplingTypes constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setResamplingType

public void setResamplingType(int pResamplingType)
                       throws IOException,
                              AutomationException
Resampling method for displaying a raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setResamplingType in interface IRasterRenderer
Parameters:
pResamplingType - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayResolutionFactor

public void setDisplayResolutionFactor(int pnFactor)
                                throws IOException,
                                       AutomationException
Display resolution factor. Factor value is expressed as a percentage between 0 and 100.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDisplayResolutionFactor in interface IRasterRenderer
Parameters:
pnFactor - The pnFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayResolutionFactor

public int getDisplayResolutionFactor()
                               throws IOException,
                                      AutomationException
Display resolution factor. Factor value is expressed as a percentage between 0 and 100.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDisplayResolutionFactor in interface IRasterRenderer
Returns:
The pnFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

recreateRaster

public void recreateRaster(IRasterDataset pDataset,
                           IRaster pRaster)
                    throws IOException,
                           AutomationException
Recreates a raster, if necessary, from a given RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
recreateRaster in interface IRasterRenderer2
Parameters:
pDataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)
pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

adaptRaster

public void adaptRaster(IRaster pRaster)
                 throws IOException,
                        AutomationException
Adapts to the new raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
adaptRaster in interface IRasterRenderer2
Parameters:
pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the raster renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IRasterRendererInfo
Returns:
The pName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException
The description of the raster renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDescription in interface IRasterRendererInfo
Returns:
The pDescription
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

IRasterRendererColorRamp_getColorRamp

public IColorRamp IRasterRendererColorRamp_getColorRamp()
                                                 throws IOException,
                                                        AutomationException
The color ramp of the color map.

Product Availability

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

Specified by:
IRasterRendererColorRamp_getColorRamp in interface IRasterRendererColorRamp
Returns:
A reference to a com.esri.arcgis.display.IColorRamp
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setContrastValue

public void setContrastValue(int iValue)
                      throws IOException,
                             AutomationException
Contrast value for a raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setContrastValue in interface IRasterDisplayProps
Parameters:
iValue - The iValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContrastValue

public int getContrastValue()
                     throws IOException,
                            AutomationException
Contrast value for a raster.

Remarks

The IRasterDisplayProps interface controls display properties common to all raster renderers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getContrastValue in interface IRasterDisplayProps
Returns:
The iValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBrightnessValue

public void setBrightnessValue(int pValue)
                        throws IOException,
                               AutomationException
Brightness value for a raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBrightnessValue in interface IRasterDisplayProps
Parameters:
pValue - The pValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBrightnessValue

public int getBrightnessValue()
                       throws IOException,
                              AutomationException
Brightness value for a raster.

Remarks

The BrightnessValue property ranges from -100 to 100, representing a percentage of increase or decrease in the property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBrightnessValue in interface IRasterDisplayProps
Returns:
The pValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTransparencyValue

public void setTransparencyValue(int pValue)
                          throws IOException,
                                 AutomationException
Transparency value for a raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTransparencyValue in interface IRasterDisplayProps
Parameters:
pValue - The pValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTransparencyValue

public int getTransparencyValue()
                         throws IOException,
                                AutomationException
Transparency value for a raster.

Remarks

The TransparencyValue value ranges from 0 to 100, with 0 representing opaque and 100 representing fully transparent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTransparencyValue in interface IRasterDisplayProps
Returns:
The pValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNoDataColor

public IColor getNoDataColor()
                      throws IOException,
                             AutomationException
Nodata color for a raster.

Remarks

The NoDataColor property controls how NoData cells in your raster are displayed. By default, NoData cells appear transparent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNoDataColor in interface IRasterDisplayProps
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNoDataColorByRef

public void setNoDataColorByRef(IColor ppColor)
                         throws IOException,
                                AutomationException
Nodata color for a raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setNoDataColorByRef in interface IRasterDisplayProps
Parameters:
ppColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom)
                throws IOException,
                       AutomationException
Identifies objects at the specified location.

Remarks

When the IIdentify interface is on a map layer, the Identify method returns an array of FeatureIdentifyObject objects.

On a FeatureIdentifyObject, you can do a QI to the IIdentifyObj interface to get more information about the identified feature. The IIdentifyObj interface returns the window handle, layer, and name of the feature; it has methods to flash the feature in the display and to display a context menu at the Identify location.

This method performs an identify operation with the provided geometry. When identifying layers, typically a small envelope is passed in rather than a point to account for differences in the precision of the display and the feature geometry.


Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
identify in interface IIdentify
Parameters:
pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

public int getLegendGroupCount()
                        throws IOException,
                               AutomationException
Number of legend groups contained by the object.

Remarks

The number of legend groups is determined by the implementation of the renderer, consequently this property is read only. For example, SimpleRenderer has one group, while a BiUniqueValueRenderer has any number of groups.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLegendGroupCount in interface ILegendInfo
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws IOException,
                                   AutomationException
Legend group at the specified index.

Product Availability

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

Specified by:
getLegendGroup in interface ILegendInfo
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.carto.ILegendGroup
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws IOException,
                                 AutomationException
Optional. Defines legend formatting for layer rendered with this object.

Remarks

Layer or renderer legend information is further formatted for display in ArcMap legends. A renderer can override this formatting by returning a LegendItem for this property. ESRI renderers typically do not return anything for this property. With this configuration, legend formatting becomes a user or developer choice on the legend object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLegendItem in interface ILegendInfo
Returns:
A reference to a com.esri.arcgis.carto.ILegendItem
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws IOException,
                                     AutomationException
Indicates if symbols are graduated.

Description

Indicates whether the symbols used for a layer or renderer's legend vary by size.

Remarks

For example the proportional symbol renderer returns True for this property.

You can use this property to distinguish between a layer symbolized with graduated color or graduated symbol type layer symbology. Both of these symbolizations use a ClassBreaksRenderer, but only a graduated symbol symbolization will return True for this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSymbolsAreGraduated in interface ILegendInfo
Returns:
The symbolsAreGraduated
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws IOException,
                                   AutomationException
Indicates if symbols are graduated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSymbolsAreGraduated in interface ILegendInfo
Parameters:
symbolsAreGraduated - The symbolsAreGraduated (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUsesFilter

public boolean isUsesFilter()
                     throws IOException,
                            AutomationException
Indicates if the current object draws using a filter.

Remarks

The UsesFilter property returns true when the object in question will draw with a filter. Drawing with a filter means means that an object that would normally draw as vector graphics will instead draw as raster. The UsesFilter property is particularly useful for detecting vector map layers that will be rasterized at time of print or export.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isUsesFilter in interface IDisplayAdmin
Returns:
The usesFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassificationField

public String getClassificationField()
                              throws IOException,
                                     AutomationException
Classification field name or an empty string if a table doesn't exist.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassificationField in interface IRasterRendererClassInfo
Returns:
The classFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNormalizationField

public String getNormalizationField()
                             throws IOException,
                                    AutomationException
Normalization field name or an empty string if none.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNormalizationField in interface IRasterRendererClassInfo
Returns:
The normFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isNumericClasses

public boolean isNumericClasses()
                         throws IOException,
                                AutomationException
Indicates if the classification field is numeric.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isNumericClasses in interface IRasterRendererClassInfo
Returns:
The bNumeric
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassCount

public int getClassCount()
                  throws IOException,
                         AutomationException
Number of classes in the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassCount in interface IRasterRendererClassInfo
Returns:
The classCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryNumberClass

public void queryNumberClass(int classIndex,
                             double[] minValue,
                             double[] maxValue,
                             int[] outValue)
                      throws IOException,
                             AutomationException
Information for a number class by index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryNumberClass in interface IRasterRendererClassInfo
Parameters:
classIndex - The classIndex (in)
minValue - The minValue (out: use single element array)
maxValue - The maxValue (out: use single element array)
outValue - The outValue (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryStringClass

public void queryStringClass(int classIndex,
                             String[] inValue,
                             int[] outValue)
                      throws IOException,
                             AutomationException
Information for a string class by index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryStringClass in interface IRasterRendererClassInfo
Parameters:
classIndex - The classIndex (in)
inValue - The inValue (out: use single element array)
outValue - The outValue (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseDefaultMapping

public boolean isUseDefaultMapping()
                            throws IOException,
                                   AutomationException
Indicates whether the default mapping is being used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isUseDefaultMapping in interface IColorChannelMapping
Returns:
The bIsDefault
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseDefaultMapping

public void setUseDefaultMapping(boolean bIsDefault)
                          throws IOException,
                                 AutomationException
Indicates whether the default mapping is being used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setUseDefaultMapping in interface IColorChannelMapping
Parameters:
bIsDefault - The bIsDefault (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBandIndices

public Object getBandIndices()
                      throws IOException,
                             AutomationException
The band indices being used in the mapping.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBandIndices in interface IColorChannelMapping
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBandIndices

public void setBandIndices(Object vIndex)
                    throws IOException,
                           AutomationException
The band indices being used in the mapping.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBandIndices in interface IColorChannelMapping
Parameters:
vIndex - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseHillShade

public boolean isUseHillShade()
                       throws IOException,
                              AutomationException
Indicates whether the hill shading is being used.

Product Availability

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

Specified by:
isUseHillShade in interface IHillShadeInfo
Returns:
The bUse
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseHillShade

public void setUseHillShade(boolean bUse)
                     throws IOException,
                            AutomationException
Indicates whether the hill shading is being used.

Product Availability

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

Specified by:
setUseHillShade in interface IHillShadeInfo
Parameters:
bUse - The bUse (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getZScale

public double getZScale()
                 throws IOException,
                        AutomationException
The Z factor multipled to z valuesg.

Product Availability

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

Specified by:
getZScale in interface IHillShadeInfo
Returns:
The pZScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setZScale

public void setZScale(double pZScale)
               throws IOException,
                      AutomationException
The Z factor multipled to z valuesg.

Product Availability

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

Specified by:
setZScale in interface IHillShadeInfo
Parameters:
pZScale - The pZScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayTableByRef

public void setDisplayTableByRef(ITable ppTable)
                          throws IOException,
                                 AutomationException
The renderer display table.

Product Availability

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

Specified by:
setDisplayTableByRef in interface IDisplayTableExchange
Parameters:
ppTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayTable

public ITable getDisplayTable()
                       throws IOException,
                              AutomationException
The renderer display table.

Product Availability

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

Specified by:
getDisplayTable in interface IDisplayTableExchange
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException