com.esri.arcgis.carto
Interface IDataGraphTLegendProperties

All Superinterfaces:

Serializable

All Known Implementing Classes:

DataGraphTLegendProperties, IDataGraphTLegendPropertiesProxy

public interface IDataGraphTLegendProperties
extends Serializable

Provides access to members that control graph legend properties.

Product Availability

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

Method Summary

int	getAlignment() Options in arranging graph legend.
int	getTextStyle() Options in representing values and labels in graph legend.
String	getTitle() Title of the legend.
boolean	isVisible() Indicates if graph legend is visible.
void	setAlignment(int pAlignment) Options in arranging graph legend.
void	setTextStyle(int style) Options in representing values and labels in graph legend.
void	setTitle(String title) Title of the legend.
void	setVisible(boolean b) Indicates if graph legend is visible.

Method Detail

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if graph legend is visible.

Product Availability

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

Returns:

The b

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(boolean b)
                throws IOException,
                       AutomationException

Indicates if graph legend is visible.

Product Availability

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

Parameters:

b - The b (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTitle

String getTitle()
                throws IOException,
                       AutomationException

Title of the legend.

Product Availability

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

Returns:

The title

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTitle

void setTitle(String title)
              throws IOException,
                     AutomationException

Title of the legend.

Product Availability

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

Parameters:

title - The title (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlignment

int getAlignment()
                 throws IOException,
                        AutomationException

Options in arranging graph legend.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriDataGraphTLegendAlignment constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlignment

void setAlignment(int pAlignment)
                  throws IOException,
                         AutomationException

Options in arranging graph legend.

Product Availability

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

Parameters:

pAlignment - A com.esri.arcgis.carto.esriDataGraphTLegendAlignment constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextStyle

int getTextStyle()
                 throws IOException,
                        AutomationException

Options in representing values and labels in graph legend.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriDataGraphTLegendTextSyle constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextStyle

void setTextStyle(int style)
                  throws IOException,
                         AutomationException

Options in representing values and labels in graph legend.

Product Availability

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

Parameters:

style - A com.esri.arcgis.carto.esriDataGraphTLegendTextSyle constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.