com.esri.arcgis.arcweb
Interface IArcWebRouteDisplayOptions

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArcWebRouteDisplayOptions

public interface IArcWebRouteDisplayOptions
extends Serializable

Provides access to members that control the way a route is displayed on a map.

Product Availability

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

Method Summary

IColor	getColor() The color of the route line (default is Red).
int	getThickness() The thickness of the route line in pixels 1-20 (default is 7).
double	getTransparency() The transparency of the route line 0.1-1.0 (default is 0.5 and less then 0.1 is reset to 0.5).
void	setColorByRef(IColor color) The color of the route line (default is Red).
void	setThickness(int thickness) The thickness of the route line in pixels 1-20 (default is 7).
void	setTransparency(double transpanency) The transparency of the route line 0.1-1.0 (default is 0.5 and less then 0.1 is reset to 0.5).

Method Detail

getColor

IColor getColor()
                throws IOException,
                       AutomationException

The color of the route line (default is Red).

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorByRef

void setColorByRef(IColor color)
                   throws IOException,
                          AutomationException

The color of the route line (default is Red).

Product Availability

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

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThickness

int getThickness()
                 throws IOException,
                        AutomationException

The thickness of the route line in pixels 1-20 (default is 7).

Product Availability

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

Returns:

The thickness

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setThickness

void setThickness(int thickness)
                  throws IOException,
                         AutomationException

The thickness of the route line in pixels 1-20 (default is 7).

Product Availability

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

Parameters:

thickness - The thickness (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparency

double getTransparency()
                       throws IOException,
                              AutomationException

The transparency of the route line 0.1-1.0 (default is 0.5 and less then 0.1 is reset to 0.5).

Product Availability

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

Returns:

The transpanency

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparency

void setTransparency(double transpanency)
                     throws IOException,
                            AutomationException

The transparency of the route line 0.1-1.0 (default is 0.5 and less then 0.1 is reset to 0.5).

Product Availability

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

Parameters:

transpanency - The transpanency (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.