com.esri.arcgis.carto
Interface IRasterUniqueValueRenderer

All Superinterfaces:
Serializable
All Known Implementing Classes:
RasterUniqueValueRenderer

public interface IRasterUniqueValueRenderer
extends Serializable

Provides access to members that relate to the unique value rendering of rasters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addValue(int iHeading, int iClass, Object value)
          Adds a value to a particular class in the specified heading.
 int getClassCount(int iHeading)
          Number of classes in the specified heading.
 String getColorScheme()
          Current renderer color scheme.
 String getDefaultLabel()
          Default label for the unique value renderer.
 ISymbol getDefaultSymbol()
          Default unique value renderer.
 String getDescription(int iHeading, int iClass)
          Description for a particular class in the specified heading.
 String getField()
          Currently active renderer field.
 String getHeading(int iHeading)
          One heading in the heading list based on its index.
 int getHeadingCount()
          Number of headings used by the renderer.
 String getLabel(int iHeading, int iClass)
          Label for a particular class in the specified heading.
 ISymbol getSymbol(int iHeading, int iClass)
          Symbol for a particular class in the specified heading.
 Object getValue(int iHeading, int iClass, int iValue)
          Value of a particular class in the specified heading based on its index.
 int getValueCount(int iHeading, int iClass)
          Number of values in a particular class in the specified heading.
 boolean isUseDefaultSymbol()
          Indicates whether the default unique value renderer is currently active.
 void removeValues(int iHeading, int iClass)
          Removes a value from a particular class in the specified heading.
 void setClassCount(int iHeading, int pCount)
          Number of classes in the specified heading.
 void setColorScheme(String pName)
          Current renderer color scheme.
 void setDefaultLabel(String pLabel)
          Default label for the unique value renderer.
 void setDefaultSymbolByRef(ISymbol ppSymbol)
          Default unique value renderer.
 void setDescription(int iHeading, int iClass, String pDescription)
          Description for a particular class in the specified heading.
 void setField(String pField)
          Currently active renderer field.
 void setHeading(int iHeading, String pHeading)
          One heading in the heading list based on its index.
 void setHeadingCount(int pCount)
          Number of headings used by the renderer.
 void setLabel(int iHeading, int iClass, String pLabel)
          Label for a particular class in the specified heading.
 void setSymbol(int iHeading, int iClass, ISymbol pSymbol)
          Symbol for a particular class in the specified heading.
 void setUseDefaultSymbol(boolean pFlag)
          Indicates whether the default unique value renderer is currently active.
 

Method Detail

setUseDefaultSymbol

void setUseDefaultSymbol(boolean pFlag)
                         throws IOException,
                                AutomationException
Indicates whether the default unique value renderer is currently active.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pFlag - The pFlag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseDefaultSymbol

boolean isUseDefaultSymbol()
                           throws IOException,
                                  AutomationException
Indicates whether the default unique value renderer is currently active.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pFlag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultSymbolByRef

void setDefaultSymbolByRef(ISymbol ppSymbol)
                           throws IOException,
                                  AutomationException
Default unique value renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
ppSymbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultSymbol

ISymbol getDefaultSymbol()
                         throws IOException,
                                AutomationException
Default unique value renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.display.ISymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultLabel

void setDefaultLabel(String pLabel)
                     throws IOException,
                            AutomationException
Default label for the unique value renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pLabel - The pLabel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultLabel

String getDefaultLabel()
                       throws IOException,
                              AutomationException
Default label for the unique value renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pLabel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setField

void setField(String pField)
              throws IOException,
                     AutomationException
Currently active renderer field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pField - The pField (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getField

String getField()
                throws IOException,
                       AutomationException
Currently active renderer field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColorScheme

void setColorScheme(String pName)
                    throws IOException,
                           AutomationException
Current renderer color scheme.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pName - The pName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColorScheme

String getColorScheme()
                      throws IOException,
                             AutomationException
Current renderer color scheme.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHeadingCount

void setHeadingCount(int pCount)
                     throws IOException,
                            AutomationException
Number of headings used by the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pCount - The pCount (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeadingCount

int getHeadingCount()
                    throws IOException,
                           AutomationException
Number of headings used by the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHeading

void setHeading(int iHeading,
                String pHeading)
                throws IOException,
                       AutomationException
One heading in the heading list based on its index.

Product Availability

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

Parameters:
iHeading - The iHeading (in)
pHeading - The pHeading (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeading

String getHeading(int iHeading)
                  throws IOException,
                         AutomationException
One heading in the heading list based on its index.

Product Availability

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

Parameters:
iHeading - The iHeading (in)
Returns:
The pHeading
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClassCount

void setClassCount(int iHeading,
                   int pCount)
                   throws IOException,
                          AutomationException
Number of classes in the specified heading.

Product Availability

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

Parameters:
iHeading - The iHeading (in)
pCount - The pCount (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassCount

int getClassCount(int iHeading)
                  throws IOException,
                         AutomationException
Number of classes in the specified heading.

Product Availability

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

Parameters:
iHeading - The iHeading (in)
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbol

void setSymbol(int iHeading,
               int iClass,
               ISymbol pSymbol)
               throws IOException,
                      AutomationException
Symbol for a particular class in the specified heading.

Product Availability

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

Parameters:
iHeading - The iHeading (in)
iClass - The iClass (in)
pSymbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbol

ISymbol getSymbol(int iHeading,
                  int iClass)
                  throws IOException,
                         AutomationException
Symbol for a particular class in the specified heading.

Product Availability

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

Parameters:
iHeading - The iHeading (in)
iClass - The iClass (in)
Returns:
A reference to a com.esri.arcgis.display.ISymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabel

void setLabel(int iHeading,
              int iClass,
              String pLabel)
              throws IOException,
                     AutomationException
Label for a particular class in the specified heading.

Product Availability

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

Parameters:
iHeading - The iHeading (in)
iClass - The iClass (in)
pLabel - The pLabel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabel

String getLabel(int iHeading,
                int iClass)
                throws IOException,
                       AutomationException
Label for a particular class in the specified heading.

Product Availability

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

Parameters:
iHeading - The iHeading (in)
iClass - The iClass (in)
Returns:
The pLabel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(int iHeading,
                    int iClass,
                    String pDescription)
                    throws IOException,
                           AutomationException
Description for a particular class in the specified heading.

Product Availability

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

Parameters:
iHeading - The iHeading (in)
iClass - The iClass (in)
pDescription - The pDescription (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription(int iHeading,
                      int iClass)
                      throws IOException,
                             AutomationException
Description for a particular class in the specified heading.

Product Availability

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

Parameters:
iHeading - The iHeading (in)
iClass - The iClass (in)
Returns:
The pDescription
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addValue

void addValue(int iHeading,
              int iClass,
              Object value)
              throws IOException,
                     AutomationException
Adds a value to a particular class in the specified heading.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
iHeading - The iHeading (in)
iClass - The iClass (in)
value - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeValues

void removeValues(int iHeading,
                  int iClass)
                  throws IOException,
                         AutomationException
Removes a value from a particular class in the specified heading.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
iHeading - The iHeading (in)
iClass - The iClass (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValueCount

int getValueCount(int iHeading,
                  int iClass)
                  throws IOException,
                         AutomationException
Number of values in a particular class in the specified heading.

Product Availability

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

Parameters:
iHeading - The iHeading (in)
iClass - The iClass (in)
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValue

Object getValue(int iHeading,
                int iClass,
                int iValue)
                throws IOException,
                       AutomationException
Value of a particular class in the specified heading based on its index.

Product Availability

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

Parameters:
iHeading - The iHeading (in)
iClass - The iClass (in)
iValue - The iValue (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.