com.esri.arcgis.display
Interface ISymbolArray

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BarChartSymbol, DotDensityFillSymbol, ISymbolArrayProxy, PieChartSymbol, StackedChartSymbol

public interface ISymbolArray

extends java.io.Serializable

Provides access to members that work with an array of symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

You can use this interface to work with the properties of a data driven symbol that is comprised of other symbols. Chart symbols are an example of a data driven symbol, as are dot density fill symbols. These symbols are designed only to be used by a ChartRenderer and a DotDensityRenderer respectively.

ISymbolArray is a generic interface that provides access to members that manage the individual symbols that make up the data driven symbols mentioned above. For example, for a PieChartSymbol, Symbol(i) provides access to the fill symbol for the ith pie slice. When rendered, this slice is mapped to a particular field in the data whose value for a particular feature determines the size of the pie slice. For a dot density renderer, Symbol(i) represents the marker symbol used to represent the density of values in the ith field added to the DotDensityRenderer.

You can use MoveSymbol to change the order of the individual symbols that make up a chart symbol or dot density fill symbol. For example, changing the order of symbols for a BarChartSymbol changes the order that bars/columns will appear on the map.

Method Summary

void	addSymbol(ISymbol symbol) Adds a symbol to the array.
void	clearSymbols() Removes all symbols from the array.
void	deleteSymbol(ISymbol symbol) Delete the given symbol.
ISymbol	getSymbol(int index) The symbol at the index position.
int	getSymbolCount() The number of symbols.
void	moveSymbol(ISymbol symbol, int toIndex) Moves the given symbol to new index position.
void	setSymbolByRef(int index, ISymbol symbol) The symbol at the index position.

Method Detail

getSymbolCount

public int getSymbolCount()
                   throws java.io.IOException,
                          AutomationException

The number of symbols.

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

public ISymbol getSymbol(int index)
                  throws java.io.IOException,
                         AutomationException

The symbol at the index position.

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

public void setSymbolByRef(int index,
                           ISymbol symbol)
                    throws java.io.IOException,
                           AutomationException

The symbol at the index position.

Parameters:

index - The index (in)

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addSymbol

public void addSymbol(ISymbol symbol)
               throws java.io.IOException,
                      AutomationException

Adds a symbol to the array.

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteSymbol

public void deleteSymbol(ISymbol symbol)
                  throws java.io.IOException,
                         AutomationException

Delete the given symbol.

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveSymbol

public void moveSymbol(ISymbol symbol,
                       int toIndex)
                throws java.io.IOException,
                       AutomationException

Moves the given symbol to new index position.

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

toIndex - The toIndex (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearSymbols

public void clearSymbols()
                  throws java.io.IOException,
                         AutomationException

Removes all symbols from the array.

Supported Platforms

Windows, Solaris, Linux

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.