com.esri.arcgis.carto
Interface INetworkTrafficRenderer

All Superinterfaces:
Serializable
All Known Implementing Classes:
NetworkTrafficRenderer

public interface INetworkTrafficRenderer
extends Serializable

Provides access to members that control drawing traffic along a network dataset.

Product Availability

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


Method Summary
 IColor deriveLineCasingsColor(IColor interiorColor)
          The exterior line casing color dervived from the interior color.
 double getExteriorLineWidthIncrement()
          The additional width of the exterior line symbol above the width of the interior line symbol.
 IDoubleArray getInteriorLineWidthsByHierarchyLevelIndex()
          The interior line widths by hierarchy level index.
 IColor getLineCasingsColor()
          The line casings color.
 IDoubleArray getScaleFilters()
          The maximum scale ratios for drawing hierarchy value 1 and also each hierarchy level max value.
 boolean isDrawLineWidthByHierarchyLevelIndex()
          Indicates whether to get interior line width by hierarchy level or instead use the interior line width of the legend symbols.
 boolean isShowLiveTrafficOnly()
          Indicates whether to only show live traffic or otherwise show all traffic.
 boolean isUseDerivedLineCasingsColor()
          Indicates whether to derive the line casings colors from the interior color of the legend line symbols or otherwise use the line casings color.
 boolean isUseLineCasings()
          Indicates whether to use line casings.
 boolean isUseScaleFilters()
          Indicates whether to use scale ratio filters by hierarchy level.
 void setDrawLineWidthByHierarchyLevelIndex(boolean useHierarchy)
          Indicates whether to get interior line width by hierarchy level or instead use the interior line width of the legend symbols.
 void setInteriorLineWidthsByHierarchyLevelIndex(IDoubleArray widths)
          The interior line widths by hierarchy level index.
 void setLineCasingsColor(IColor exteriorColor)
          The line casings color.
 void setScaleFilters(IDoubleArray scaleRatios)
          The maximum scale ratios for drawing hierarchy value 1 and also each hierarchy level max value.
 void setShowLiveTrafficOnly(boolean liveTrafficOnly)
          Indicates whether to only show live traffic or otherwise show all traffic.
 void setUseDerivedLineCasingsColor(boolean useDerivedLineCasingsColor)
          Indicates whether to derive the line casings colors from the interior color of the legend line symbols or otherwise use the line casings color.
 void setUseLineCasings(boolean useLineCasings)
          Indicates whether to use line casings.
 void setUseScaleFilters(boolean useScaleFilters)
          Indicates whether to use scale ratio filters by hierarchy level.
 

Method Detail

isShowLiveTrafficOnly

boolean isShowLiveTrafficOnly()
                              throws IOException,
                                     AutomationException
Indicates whether to only show live traffic or otherwise show all traffic.

Product Availability

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

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

setShowLiveTrafficOnly

void setShowLiveTrafficOnly(boolean liveTrafficOnly)
                            throws IOException,
                                   AutomationException
Indicates whether to only show live traffic or otherwise show all traffic.

Product Availability

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

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

isUseScaleFilters

boolean isUseScaleFilters()
                          throws IOException,
                                 AutomationException
Indicates whether to use scale ratio filters by hierarchy level.

Product Availability

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

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

setUseScaleFilters

void setUseScaleFilters(boolean useScaleFilters)
                        throws IOException,
                               AutomationException
Indicates whether to use scale ratio filters by hierarchy level.

Product Availability

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

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

getScaleFilters

IDoubleArray getScaleFilters()
                             throws IOException,
                                    AutomationException
The maximum scale ratios for drawing hierarchy value 1 and also each hierarchy level max value.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.system.IDoubleArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScaleFilters

void setScaleFilters(IDoubleArray scaleRatios)
                     throws IOException,
                            AutomationException
The maximum scale ratios for drawing hierarchy value 1 and also each hierarchy level max value.

Product Availability

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

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

isDrawLineWidthByHierarchyLevelIndex

boolean isDrawLineWidthByHierarchyLevelIndex()
                                             throws IOException,
                                                    AutomationException
Indicates whether to get interior line width by hierarchy level or instead use the interior line width of the legend symbols.

Product Availability

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

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

setDrawLineWidthByHierarchyLevelIndex

void setDrawLineWidthByHierarchyLevelIndex(boolean useHierarchy)
                                           throws IOException,
                                                  AutomationException
Indicates whether to get interior line width by hierarchy level or instead use the interior line width of the legend symbols.

Product Availability

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

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

getInteriorLineWidthsByHierarchyLevelIndex

IDoubleArray getInteriorLineWidthsByHierarchyLevelIndex()
                                                        throws IOException,
                                                               AutomationException
The interior line widths by hierarchy level index.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.system.IDoubleArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInteriorLineWidthsByHierarchyLevelIndex

void setInteriorLineWidthsByHierarchyLevelIndex(IDoubleArray widths)
                                                throws IOException,
                                                       AutomationException
The interior line widths by hierarchy level index.

Product Availability

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

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

getExteriorLineWidthIncrement

double getExteriorLineWidthIncrement()
                                     throws IOException,
                                            AutomationException
The additional width of the exterior line symbol above the width of the interior line symbol.

Product Availability

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

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

isUseLineCasings

boolean isUseLineCasings()
                         throws IOException,
                                AutomationException
Indicates whether to use line casings.

Product Availability

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

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

setUseLineCasings

void setUseLineCasings(boolean useLineCasings)
                       throws IOException,
                              AutomationException
Indicates whether to use line casings.

Product Availability

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

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

isUseDerivedLineCasingsColor

boolean isUseDerivedLineCasingsColor()
                                     throws IOException,
                                            AutomationException
Indicates whether to derive the line casings colors from the interior color of the legend line symbols or otherwise use the line casings color.

Product Availability

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

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

setUseDerivedLineCasingsColor

void setUseDerivedLineCasingsColor(boolean useDerivedLineCasingsColor)
                                   throws IOException,
                                          AutomationException
Indicates whether to derive the line casings colors from the interior color of the legend line symbols or otherwise use the line casings color.

Product Availability

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

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

deriveLineCasingsColor

IColor deriveLineCasingsColor(IColor interiorColor)
                              throws IOException,
                                     AutomationException
The exterior line casing color dervived from the interior color.

Product Availability

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

Parameters:
interiorColor - A reference to a com.esri.arcgis.display.IColor (in)
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.

getLineCasingsColor

IColor getLineCasingsColor()
                           throws IOException,
                                  AutomationException
The line casings color.

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.

setLineCasingsColor

void setLineCasingsColor(IColor exteriorColor)
                         throws IOException,
                                AutomationException
The line casings color.

Product Availability

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

Parameters:
exteriorColor - 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.