com.esri.arcgis.schematic
Interface ISchematicAlgoOrthogonal

All Superinterfaces:

ISchematicAlgorithm, Serializable

All Known Implementing Classes:

SchematicAlgoOrthogonal

public interface ISchematicAlgoOrthogonal
extends ISchematicAlgorithm, Serializable

Provides access to members that control the Orthogonal schematic algorithm.

Description

The Orthogonal algorithm arranges the schematic nodes and links in a schematic diagram orthogonally. It works from a root node that is placed on the bottom, the other schematic nodes and links being placed orthogonally starting from this root.

Product Availability

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

Method Summary

double	getAngle() Counterclockwise rotation angle from the vertical axis that determines the direction for the orthogonal layout.
double	getBreakPoint() Number comprised between 0 and 1 that allows computing the distance between the extremity node of the links and the break points that will be inserted on the links that are overlapping.
double	getDistanceBetweenLinks() Number comprised between 0 and 1 used to compute the distance between the links or the link segments that are overlapping so that they are separated.
double	getHorizontalStep() Spacing between the nodes aligned on the same horizontal axis.
double	getVerticalStep() Spacing between the nodes aligned on the same vertical axis.
boolean	isAbsoluteParameters() Indicates if the values set for the spacing and step parameters must be interpreted as absolute units.
void	setAbsoluteParameters(boolean pVal) Indicates if the values set for the spacing and step parameters must be interpreted as absolute units.
void	setAngle(double pVal) Counterclockwise rotation angle from the vertical axis that determines the direction for the orthogonal layout.
void	setBreakPoint(double pVal) Number comprised between 0 and 1 that allows computing the distance between the extremity node of the links and the break points that will be inserted on the links that are overlapping.
void	setDistanceBetweenLinks(double pVal) Number comprised between 0 and 1 used to compute the distance between the links or the link segments that are overlapping so that they are separated.
void	setHorizontalStep(double pVal) Spacing between the nodes aligned on the same horizontal axis.
void	setVerticalStep(double pVal) Spacing between the nodes aligned on the same vertical axis.

Methods inherited from interface com.esri.arcgis.schematic.ISchematicAlgorithm

execute, getAlgorithmCLSID, getLabel, getPropertySet, getSchematicDiagramClassName, isAvailable, isEnabled, isOverridable, isUseEndNode, isUseRootNode, setAvailable, setLabel, setOverridable, setPropertySet, setSchematicDiagramClassNameByRef

Method Detail

getHorizontalStep

double getHorizontalStep()
                         throws IOException,
                                AutomationException

Spacing between the nodes aligned on the same horizontal axis.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontalStep

void setHorizontalStep(double pVal)
                       throws IOException,
                              AutomationException

Spacing between the nodes aligned on the same horizontal axis.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerticalStep

double getVerticalStep()
                       throws IOException,
                              AutomationException

Spacing between the nodes aligned on the same vertical axis.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalStep

void setVerticalStep(double pVal)
                     throws IOException,
                            AutomationException

Spacing between the nodes aligned on the same vertical axis.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistanceBetweenLinks

double getDistanceBetweenLinks()
                               throws IOException,
                                      AutomationException

Number comprised between 0 and 1 used to compute the distance between the links or the link segments that are overlapping so that they are separated.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDistanceBetweenLinks

void setDistanceBetweenLinks(double pVal)
                             throws IOException,
                                    AutomationException

Number comprised between 0 and 1 used to compute the distance between the links or the link segments that are overlapping so that they are separated.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreakPoint

double getBreakPoint()
                     throws IOException,
                            AutomationException

Number comprised between 0 and 1 that allows computing the distance between the extremity node of the links and the break points that will be inserted on the links that are overlapping.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreakPoint

void setBreakPoint(double pVal)
                   throws IOException,
                          AutomationException

Number comprised between 0 and 1 that allows computing the distance between the extremity node of the links and the break points that will be inserted on the links that are overlapping.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAngle

double getAngle()
                throws IOException,
                       AutomationException

Counterclockwise rotation angle from the vertical axis that determines the direction for the orthogonal layout.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAngle

void setAngle(double pVal)
              throws IOException,
                     AutomationException

Counterclockwise rotation angle from the vertical axis that determines the direction for the orthogonal layout.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAbsoluteParameters

boolean isAbsoluteParameters()
                             throws IOException,
                                    AutomationException

Indicates if the values set for the spacing and step parameters must be interpreted as absolute units.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAbsoluteParameters

void setAbsoluteParameters(boolean pVal)
                           throws IOException,
                                  AutomationException

Indicates if the values set for the spacing and step parameters must be interpreted as absolute units.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.