com.esri.arcgis.carto
Interface IACValueMapRenderer

All Superinterfaces:
Serializable
All Known Implementing Classes:
ACValueMapLabelRenderer, ACValueMapRenderer

public interface IACValueMapRenderer
extends Serializable

Provides access to members that control ArcIMS value map renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void add(IACSymbol symbol, int range, String value, String label, String lower, String upper)
          Adds a value and corresponding symbol to the list.
 void clear()
          Clears all values.
 int getCount()
          Number of unique values used to categorize the data.
 String getLabel(int index)
          Label for the specified value.
 String getLookupField()
          Field name that is used to categorize features.
 String getLower(int index)
          The lower value of the range.
 int getRangeType(int index)
          The type of categorization for the values within the specified field.
 IACSymbol getSymbol(int index)
          Symbol associated with the specified value.
 String getUpper(int index)
          The upper value of the range.
 String getValue(int index)
          The unique value for the specified field.
 void remove(int index)
          Removes a value.
 void setLabel(int index, String label)
          Label for the specified value.
 void setLookupField(String lookupField)
          Field name that is used to categorize features.
 void setLower(int index, String value)
          The lower value of the range.
 void setRangeType(int index, int range)
          The type of categorization for the values within the specified field.
 void setSymbol(int index, IACSymbol symbol)
          Symbol associated with the specified value.
 void setUpper(int index, String value)
          The upper value of the range.
 void setValue(int index, String value)
          The unique value for the specified field.
 

Method Detail

getLookupField

String getLookupField()
                      throws IOException,
                             AutomationException
Field name that is used to categorize features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setLookupField

void setLookupField(String lookupField)
                    throws IOException,
                           AutomationException
Field name that is used to categorize features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getCount

int getCount()
             throws IOException,
                    AutomationException
Number of unique values used to categorize the data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSymbol

IACSymbol getSymbol(int index)
                    throws IOException,
                           AutomationException
Symbol associated with the specified value.

Product Availability

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

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

setSymbol

void setSymbol(int index,
               IACSymbol symbol)
               throws IOException,
                      AutomationException
Symbol associated with the specified value.

Product Availability

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

Parameters:
index - The index (in)
symbol - A reference to a com.esri.arcgis.carto.IACSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRangeType

int getRangeType(int index)
                 throws IOException,
                        AutomationException
The type of categorization for the values within the specified field.

Product Availability

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

Parameters:
index - The index (in)
Returns:
A com.esri.arcgis.carto.acRangeType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRangeType

void setRangeType(int index,
                  int range)
                  throws IOException,
                         AutomationException
The type of categorization for the values within the specified field.

Product Availability

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

Parameters:
index - The index (in)
range - A com.esri.arcgis.carto.acRangeType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValue

String getValue(int index)
                throws IOException,
                       AutomationException
The unique value for the specified field.

Product Availability

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

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

setValue

void setValue(int index,
              String value)
              throws IOException,
                     AutomationException
The unique value for the specified field.

Product Availability

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

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

getLabel

String getLabel(int index)
                throws IOException,
                       AutomationException
Label for the specified value.

Product Availability

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

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

setLabel

void setLabel(int index,
              String label)
              throws IOException,
                     AutomationException
Label for the specified value.

Product Availability

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

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

getUpper

String getUpper(int index)
                throws IOException,
                       AutomationException
The upper value of the range.

Product Availability

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

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

setUpper

void setUpper(int index,
              String value)
              throws IOException,
                     AutomationException
The upper value of the range.

Product Availability

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

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

getLower

String getLower(int index)
                throws IOException,
                       AutomationException
The lower value of the range.

Product Availability

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

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

setLower

void setLower(int index,
              String value)
              throws IOException,
                     AutomationException
The lower value of the range.

Product Availability

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

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

add

void add(IACSymbol symbol,
         int range,
         String value,
         String label,
         String lower,
         String upper)
         throws IOException,
                AutomationException
Adds a value and corresponding symbol to the list.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
symbol - A reference to a com.esri.arcgis.carto.IACSymbol (in)
range - A com.esri.arcgis.carto.acRangeType constant (in)
value - The value (in)
label - The label (in)
lower - The lower (in)
upper - The upper (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

void clear()
           throws IOException,
                  AutomationException
Clears all values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

remove

void remove(int index)
            throws IOException,
                   AutomationException
Removes a value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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