com.esri.arcgis.globecore
Interface IGlobeLegendInfos

All Superinterfaces:

Serializable

All Known Implementing Classes:

GlobeLegendInfos

public interface IGlobeLegendInfos
extends Serializable

Provides access to the Globe Server Legend collection.

Product Availability

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

Method Summary

void	add(IGlobeLegendInfo pLegendInfo) Adds a legend info.
int	getCount() The legend info count.
IGlobeLegendInfo	getElement(int index) The legend info at the specified position.
void	insert(int index, IGlobeLegendInfo pLegendInfo) Adds a legend info at the specified position.
void	remove(int index) Removes the legend info at the specified position.
void	removeAll() Removes all legend infos.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

The legend info count.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElement

IGlobeLegendInfo getElement(int index)
                            throws IOException,
                                   AutomationException

The legend info at the specified position.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeLegendInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws IOException,
                   AutomationException

Removes the legend info at the specified position.

Product Availability

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

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Removes all legend infos.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

void add(IGlobeLegendInfo pLegendInfo)
         throws IOException,
                AutomationException

Adds a legend info.

Product Availability

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

Parameters:

pLegendInfo - A reference to a com.esri.arcgis.globecore.IGlobeLegendInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IGlobeLegendInfo pLegendInfo)
            throws IOException,
                   AutomationException

Adds a legend info at the specified position.

Product Availability

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

Parameters:

index - The index (in)

pLegendInfo - A reference to a com.esri.arcgis.globecore.IGlobeLegendInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.