Interface IMapServerLegendClass

Namespace
ESRI.ArcGIS.Carto
Assembly
ESRI.Server.Carto.dll

Provides access to the Map Server Legend Class Interface.

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("0AB95E54-7EBF-4DE8-81EB-F383F21CC9B0")]
public interface IMapServerLegendClass

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. MapServerLegendClass objects are part of a MapServerLegendGroup object. MapServerLegendGroup objects are part of a MapServerLegendInfo object. MapServerLegendInfo objects are the result of the GetLegendInfo  method on IMapServer .

Properties

Description

The description string.

string Description { get; }

Property Value

string

Label

The label string.

string Label { get; }

Property Value

string

SymbolImage

The symbol image.

IImageResult SymbolImage { get; }

Property Value

IImageResult

Remarks

Use SymbolImage to retrieve the legend symbol image of a particular legend class. The SymbolImage is an ImageResult object. Properties of an ImageResult object include: Height, Width, URL and MimeData. The symbol image size is in pixels while a MapServer legend patch is measured in points.

TransparentColor

The transparent color used for the symbol image.

IColorDescription TransparentColor { get; }

Property Value

IColorDescription

Remarks

Transparency is only supported for image types that support transparency such as .png or .gif.