com.esri.arcgis.carto
Interface ISimpleRenderer

All Superinterfaces:

Serializable

All Known Implementing Classes:

SimpleRenderer

public interface ISimpleRenderer
extends Serializable

Provides access to members that control a renderer which draws the same symbol for each feature.

Product Availability

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

Method Summary

String	getDescription() Renderer description.
String	getLabel() Renderer label.
ISymbol	getSymbol() Symbol used to draw each feature.
void	setDescription(String text) Renderer description.
void	setLabel(String label) Renderer label.
void	setSymbolByRef(ISymbol symbol) Symbol used to draw each feature.

Method Detail

getSymbol

ISymbol getSymbol()
                  throws IOException,
                         AutomationException

Symbol used to draw each feature.

Description

Symbol is the symbol that all features will be drawn with.

Remarks

This property provides access to the symbol used to draw all features in a layer.

The symbol type matches the geometry of the layer being rendered, so marker symbols are used to draw point layers, line symbols are used to draw line features, and fill symbols are used to draw polygon features.

Marker symbols can be rotated on a feature by feature basis via IRotationRenderer. Fill symbols can be made partially transparent, again on a feature by feature basis, via ITransparencyRenderer. The amount of rotation or transparency is specified by attribute values associated with each feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

void setSymbolByRef(ISymbol symbol)
                    throws IOException,
                           AutomationException

Symbol used to draw each feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

String getLabel()
                throws IOException,
                       AutomationException

Renderer label.

Description

For a layer symbolized with a renderer that supports ISimpleRenderer, the descriptive text string that is displayed in the table of contents and may also appear in the legend.

Remarks

This property describes the meaning of the symbol. For example, a black, circular marker symbol might represents "Cities".

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

void setLabel(String label)
              throws IOException,
                     AutomationException

Renderer label.

Description

Label is the label that will be displayed in the TOC and LegendItems with the symbol for a layer rendered using an ISimpleRenderer .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

Renderer description.

Description

For a layer symbolized with a renderer that supports ISimpleRenderer, the descriptive text string that does not appear in the table of contents but may appear in the legend.

Remarks

This property provides further explanatory text about the symbolization.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String text)
                    throws IOException,
                           AutomationException

Renderer description.

Description

Description is the text that will be displayed in the LegendItem with the symbol for a layer rendered using an ISimpleRenderer .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

text - The text (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.