com.esri.arcgis.trackinganalyst
Interface IUniqueValueTextRenderer

All Superinterfaces:

Serializable

All Known Implementing Classes:

UniqueValueTextRenderer

public interface IUniqueValueTextRenderer
extends Serializable

Provides access to methods and properties that support using text for symbolizing temporal events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Method Summary

void	addReferenceValue(String value, String refValue) Adds a value to the renderer to be grouped with the refValue, which has already ben added to the renderer.
void	addValue(String value, String heading, ISymbol symbol) Adds a value and correstonding symbol to the list.
String	getColorScheme() Color scheme (user interface property only).
String	getDefaultLabel() Label used for unspecified values.
ISymbol	getDefaultSymbol() Symbol used to draw any unspecified values (may be NULL).
String	getDescription(String value) Description for the specified label.
String	getField(int index) Field at the specified index that is used to categorize features.
int	getFieldCount() Number of fields used by the renderer (0-3).
String	getFieldDelimiter() Delimiter used to separate field values.
String	getHeading(String value) Heading that contains the specified value.
String	getLabel(String value) Label for the specified value.
String	getLookupStyleset() Style used for matching (user interface property only).
String	getReferenceValue(String value) Reference value for the specified value.
ISymbol	getSymbol(String value) Symbol associated with the specified value.
String	getValue(int index) Value at the specified index.
int	getValueCount() Number of unique values used to categorieze the data.
boolean	isUseDefaultSymbol() Indicates if DefaultSymbol is used for drawing unspecified values.
void	removeAllValues() Removes all values from teh renderer.
void	removeValue(String value) Removes a value from the renderer.
void	setColorScheme(String name) Color scheme (user interface property only).
void	setDefaultLabel(String pLabel) Label used for unspecified values.
void	setDefaultSymbol(ISymbol pVal) Symbol used to draw any unspecified values (may be NULL).
void	setDescription(String value, String pVal) Description for the specified label.
void	setField(int index, String pVal) Field at the specified index that is used to categorize features.
void	setFieldCount(int pVal) Number of fields used by the renderer (0-3).
void	setFieldDelimiter(String pVal) Delimiter used to separate field values.
void	setFieldType(int index, boolean rhs2) Indicates if the field at eth specified index is a string.
void	setHeading(String value, String pVal) Heading that contains the specified value.
void	setLabel(String value, String pVal) Label for the specified value.
void	setLookupStyleset(String pVal) Style used for matching (user interface property only).
void	setSymbol(String value, ISymbol pVal) Symbol associated with the specified value.
void	setUseDefaultSymbol(boolean pVal) Indicates if DefaultSymbol is used for drawing unspecified values.
void	setValue(int index, String pVal) Value at the specified index.

Method Detail

addReferenceValue

void addReferenceValue(String value,
                       String refValue)
                       throws IOException,
                              AutomationException

Adds a value to the renderer to be grouped with the refValue, which has already ben added to the renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

value - The value (in)

refValue - The refValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addValue

void addValue(String value,
              String heading,
              ISymbol symbol)
              throws IOException,
                     AutomationException

Adds a value and correstonding symbol to the list.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

value - The value (in)

heading - The heading (in)

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

getColorScheme

String getColorScheme()
                      throws IOException,
                             AutomationException

Color scheme (user interface property only).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorScheme

void setColorScheme(String name)
                    throws IOException,
                           AutomationException

Color scheme (user interface property only).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultLabel

String getDefaultLabel()
                       throws IOException,
                              AutomationException

Label used for unspecified values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pLabel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultLabel

void setDefaultLabel(String pLabel)
                     throws IOException,
                            AutomationException

Label used for unspecified values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pLabel - The pLabel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultSymbol

ISymbol getDefaultSymbol()
                         throws IOException,
                                AutomationException

Symbol used to draw any unspecified values (may be NULL).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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.

setDefaultSymbol

void setDefaultSymbol(ISymbol pVal)
                      throws IOException,
                             AutomationException

Symbol used to draw any unspecified values (may be NULL).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

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

getDescription

String getDescription(String value)
                      throws IOException,
                             AutomationException

Description for the specified label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

value - The value (in)

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String value,
                    String pVal)
                    throws IOException,
                           AutomationException

Description for the specified label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

value - The value (in)

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getField

String getField(int index)
                throws IOException,
                       AutomationException

Field at the specified index that is used to categorize features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

index - The index (in)

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setField

void setField(int index,
              String pVal)
              throws IOException,
                     AutomationException

Field at the specified index that is used to categorize features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

index - The index (in)

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldCount

int getFieldCount()
                  throws IOException,
                         AutomationException

Number of fields used by the renderer (0-3).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldCount

void setFieldCount(int pVal)
                   throws IOException,
                          AutomationException

Number of fields used by the renderer (0-3).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldDelimiter

String getFieldDelimiter()
                         throws IOException,
                                AutomationException

Delimiter used to separate field values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldDelimiter

void setFieldDelimiter(String pVal)
                       throws IOException,
                              AutomationException

Delimiter used to separate field values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldType

void setFieldType(int index,
                  boolean rhs2)
                  throws IOException,
                         AutomationException

Indicates if the field at eth specified index is a string.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

index - The index (in)

rhs2 - The rhs2 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeading

String getHeading(String value)
                  throws IOException,
                         AutomationException

Heading that contains the specified value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

value - The value (in)

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeading

void setHeading(String value,
                String pVal)
                throws IOException,
                       AutomationException

Heading that contains the specified value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

value - The value (in)

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

String getLabel(String value)
                throws IOException,
                       AutomationException

Label for the specified value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

value - The value (in)

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

void setLabel(String value,
              String pVal)
              throws IOException,
                     AutomationException

Label for the specified value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

value - The value (in)

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLookupStyleset

String getLookupStyleset()
                         throws IOException,
                                AutomationException

Style used for matching (user interface property only).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLookupStyleset

void setLookupStyleset(String pVal)
                       throws IOException,
                              AutomationException

Style used for matching (user interface property only).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceValue

String getReferenceValue(String value)
                         throws IOException,
                                AutomationException

Reference value for the specified value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

value - The value (in)

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllValues

void removeAllValues()
                     throws IOException,
                            AutomationException

Removes all values from teh renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeValue

void removeValue(String value)
                 throws IOException,
                        AutomationException

Removes a value from the renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

ISymbol getSymbol(String value)
                  throws IOException,
                         AutomationException

Symbol associated with the specified value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

value - The value (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.

setSymbol

void setSymbol(String value,
               ISymbol pVal)
               throws IOException,
                      AutomationException

Symbol associated with the specified value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

value - The value (in)

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

isUseDefaultSymbol

boolean isUseDefaultSymbol()
                           throws IOException,
                                  AutomationException

Indicates if DefaultSymbol is used for drawing unspecified values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseDefaultSymbol

void setUseDefaultSymbol(boolean pVal)
                         throws IOException,
                                AutomationException

Indicates if DefaultSymbol is used for drawing unspecified values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

String getValue(int index)
                throws IOException,
                       AutomationException

Value at the specified index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

index - The index (in)

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

void setValue(int index,
              String pVal)
              throws IOException,
                     AutomationException

Value at the specified index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

index - The index (in)

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValueCount

int getValueCount()
                  throws IOException,
                         AutomationException

Number of unique values used to categorieze the data.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.