com.esri.arcgis.carto
Interface IMapServerLegendGroup

All Superinterfaces:
Serializable
All Known Implementing Classes:
MapServerLegendGroup

public interface IMapServerLegendGroup
extends Serializable

Provides access to the Map Server Legend Group Interface.

Remarks

Legends are associated with renderers that belong to each layer in a map. Each layer has a separate renderer. Each renderer has one or more legend groups. Each legend group has one or more legend classes. A MapServerLegendGroup contains one or more MapServerLegendClass objects. MapServerLegendGroup objects are part of the MapServerLegendInfo object. MapServerLegendInfo objects are the result of the GetLegendInfo method on IMapServer .

When To Use

Use IMapServerLegendGroup when retrieving individual legend elements including the symbol image, labels, descriptions and headings. To export a single image of the legend use ExportLegend on IMapServerLayout .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IMapServerLegendClasses getClasses()
          A collection of legend class objects.
 String getHeading()
          The heading string.
 

Method Detail

getHeading

String getHeading()
                  throws IOException,
                         AutomationException
The heading string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getClasses

IMapServerLegendClasses getClasses()
                                   throws IOException,
                                          AutomationException
A collection of legend class objects.

Remarks

Legends are associated with renderers that belong to each layer in a map. Each layer has a separate renderer. Each renderer has one or more legend groups. Each legend group has one or more legend classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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