Provides access to members that control legend information provided by a renderer.
Product Availability
Description
Implemented by layers and renderers to manage legend information. Layers typically delegate the implementation of this interface to the renderer. Legend information appears in the ArcMap table of contents as well as in ArcMap legends.
Members
| Description | ||
|---|---|---|
 |
LegendGroup | Legend group at the specified index. |
|
LegendGroupCount | Number of legend groups contained by the object. |
|
LegendItem | Optional. Defines legend formatting for layer rendered with this object. |
 |
SymbolsAreGraduated | Indicates if symbols are graduated. |
CoClasses that implement ILegendInfo
| CoClasses and Classes | Description |
|---|---|
| ASPointRenderer (esriSurveyPkgs) | ASPointRenderer Class |
| BiUniqueValueRenderer | A bivariate renderer that combines a unique values renderer with a class breaks renderer (either graduated colors or graduated symbol type symbology). |
| CadFeatureLayer | ESRI CAD Feature Layer class. |
| ChartRenderer | A chart renderer used to draw pie, bar, and stacked bar chart symbols. |
| ClassBreaksRenderer | A renderer that can be used to draw graduated color (choropleth) and graduated symbol maps. |
| COGOMeasurementRenderer (esriSurveyPkgs) | COGOMeasurementRenderer Class |
| CoTrackSymbologyRenderer (esriTrackingAnalyst) | Symbolizes temporal based features and tracks in order to identify temporal feature characteristics in relation to the temporal reference. |
| DotDensityRenderer | A dot density renderer. |
| DummyGraduatedMarkerLayer | A dummy layer used to display legend items in the style gallery (Singleton). |
| DummyLayer | A dummy layer used to display legend items in the style gallery (Singleton). |
| FeatureLayer | A collection of features and their visual representation. |
| FeatureVertexRenderer (esriSurveyExt) | FeatureVertexRenderer Class |
| GdbRasterCatalogLayer | Geodabase RasterCatalog source and display options. |
| MoleEventRenderer (esriMOLE) | Controls event rendering for the MOLE renderer. |
| NAStopRenderer (esriNetworkAnalyst) | |
| ProportionalSymbolRenderer | A proportional symbol renderer, used to draw symbols of varying size for each feature, sized in proportion to a field value. |
| RasterCatalogLayer | Raster catalog source and display options. |
| RasterClassifyColorRampRenderer | A renderer with a color ramp for rasters with classified values. |
| RasterColormapRenderer | A raster colormap renderer. |
| RasterLayer | Raster layer source and display options. |
| RasterRGBRenderer | A true-color RGB renderer. |
| RasterStretchColorRampRenderer | A renderer with a color ramp for rasters with continuous values. |
| RasterUniqueValueRenderer | A renderer for rasters with unique values. |
| ScaleDependentRenderer | A scale dependent renderer that is composed of multiple renderers, each operating within a particular scale range. |
| SchematicLayer (esriSchematic) | Schematic layer object. |
| SimpleRenderer | A simple renderer where the same symbol is drawn for each feature. |
| TemporalFeatureLayer (esriTrackingAnalyst) | Defines the coclass IDL parameters and attributes of the TemporalFeatureLayer COM object. |
| TinAspectRenderer | TIN aspect renderer component. |
| TinBreaklineRenderer | TIN breakline renderer component. |
| TinEdgeRenderer | TIN edge renderer component. |
| TinElevationRenderer | TIN elevation renderer component. |
| TinFaceRenderer | TIN face renderer component. |
| TinFaceValueRenderer | TIN face value renderer component. |
| TinLayer | The TIN Layer class. |
| TinNodeElevationRenderer | TIN node elevation renderer component. |
| TinNodeRenderer | TIN node renderer component. |
| TinNodeValueRenderer | TIN node value renderer component. |
| TinSlopeRenderer | TIN slope renderer component. |
| TopologyLayer | A collection of properties for a topology layer. |
| TPSMeasurementRenderer (esriSurveyPkgs) | TPSMeasurementRenderer Class |
| UniqueValueRenderer | A unique values renderer where symbols are assigned to features based on an unique attribute values. |
Remarks
This interface provides access to a layer or renderer's legend information and symbols. Use this interface to access the information about a layer or renderer that appears in the table of contents and also in legends.
All ESRI renderers have at least one LegendGroup which in turn has at least one LegendClass. Though renderers typically store all of the symbols they use to draw features in their LegendClass objects, it is best to access these symbols via the specific renderer interface for the renderer object you are using. For example, when rendering features, for a ClassBreaksRenderer use IClassBreaksRenderer::Symbol, or for a ProportionalSymbolRenderer use IProportionalSymbolRenderer::MinSymbol and IProportionalSymbolRenderer::BackgroundSymbol.
Some renderers, for example SimpleRenderer, ClassBreaksRenderer, and UniqueValueRenderer, update the legend groups and legend classes automatically when you set the renderer symbols. However, other renderers require you to call a method on a renderer specific interface to update the legend after making a symbol change. For the ProportionalSymbolRenderer, ChartRenderer, DotDensityRenderer, and BiUniqueValueRenderer you must do this. For example, call IProportionalSymbolRenderer:CreateLegendSymbols to update the legend for a layer symbolized with a ProportionalSymbolRenderer.
Send feedback on this page