com.esri.arcgis.carto
Interface IMapServerLegendPatch

All Superinterfaces:
Serializable
All Known Implementing Classes:
MapServerLegendPatch

public interface IMapServerLegendPatch
extends Serializable

Provides access to the Map Server Legend Patch Interface.

Remarks

A legend patch is a rectangular image with an individual polygon, line or point symbol associated with a particular legend class. Use PatchHeight and PatchWidth to change the size of the legend patch. Use AreaPatch or LinePatch to change the shape of the symbol. If the goal is only to change the size of the patch and to retain the default shape, AreaPatch and LinePatch do not have to be set.

When To Use

A MapServerLegendPatch object is a parameter of the GetLegendInfo method on IMapServer. Use IMapServerLegendPatch to customize the size of the legend patch and the shape of the symbol displayed on the patch. 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
 IAreaPatch getAreaPatch()
          The area patch.
 ILinePatch getLinePatch()
          The line patch.
 double getPatchHeight()
          The patch height (in points).
 double getPatchResolution()
          The patch resolution (dots per inch).
 double getPatchWidth()
          The patch width (in points).
 void setAreaPatch(IAreaPatch patch)
          The area patch.
 void setLinePatch(ILinePatch patch)
          The line patch.
 void setPatchHeight(double heightPts)
          The patch height (in points).
 void setPatchResolution(double dpi)
          The patch resolution (dots per inch).
 void setPatchWidth(double widthPts)
          The patch width (in points).
 

Method Detail

getPatchWidth

double getPatchWidth()
                     throws IOException,
                            AutomationException
The patch width (in points).

Remarks

Changing the size of the legend patch will not change the size of the symbol. It only changes the size of the patch surrounding the symbol. The size of the symbol is determined by the properties of the symbol itself. The symbol will increase in size if AreaPatch or LinePatch are used. A size should be specified. Entering 0 may lead to unexpected results.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPatchWidth

void setPatchWidth(double widthPts)
                   throws IOException,
                          AutomationException
The patch width (in points).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
widthPts - The widthPts (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPatchHeight

double getPatchHeight()
                      throws IOException,
                             AutomationException
The patch height (in points).

Remarks

Changing the size of the legend patch will not change the size of the symbol. It only changes the size of the patch surrounding the symbol. The size of the symbol is determined by the properties of the symbol itself. The symbol will increase in size if AreaPatch or LinePatch are used. A size should be specified. Entering 0 may lead to unexpected results.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPatchHeight

void setPatchHeight(double heightPts)
                    throws IOException,
                           AutomationException
The patch height (in points).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
heightPts - The heightPts (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPatchResolution

double getPatchResolution()
                          throws IOException,
                                 AutomationException
The patch resolution (dots per inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPatchResolution

void setPatchResolution(double dpi)
                        throws IOException,
                               AutomationException
The patch resolution (dots per inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
dpi - The dpi (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLinePatch

ILinePatch getLinePatch()
                        throws IOException,
                               AutomationException
The line patch.

Remarks

Assign a custom line shape to the symbol such as a zigzag line.

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.ILinePatch
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLinePatch

void setLinePatch(ILinePatch patch)
                  throws IOException,
                         AutomationException
The line patch.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
patch - A reference to a com.esri.arcgis.carto.ILinePatch (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAreaPatch

IAreaPatch getAreaPatch()
                        throws IOException,
                               AutomationException
The area patch.

Remarks

Assign a custom shape to the symbol such as a triangle or rounded polygon.

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.IAreaPatch
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAreaPatch

void setAreaPatch(IAreaPatch patch)
                  throws IOException,
                         AutomationException
The area patch.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
patch - A reference to a com.esri.arcgis.carto.IAreaPatch (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.