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 layout arranges orthogonally the nodes and links in the active schematic diagram.

If a schematic root is set for the active diagram, the Orthogonal algorithm computes the layout according to this root node: the root node is placed on the bottom, and all the others nodes and links are placed orthogonally starting from this node. If a selected set has been defined in the active schematic diagram, the algorithm only applies to the selected schematic elements.

Product Availability

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

See Also:

ISchematicAlgoSquareLinks

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.

Description

This property value determines the minimum X distance between two nodes that are horizontally aligned. All nodes aligned on the same horizontal axis will be exactly spaced by this distance or by a multiple of this distance.

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.

See Also:

ISchematicAlgoOrthogonal.getVerticalStep()

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.

Description

This property value determines the minimum Y distance between two nodes that are vertically aligned. All nodes aligned on the same vertical axis will be exactly spaced by this distance or by a multiple of this distance.

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.

See Also:

ISchematicAlgoOrthogonal.getHorizontalStep()

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.

Description

For horizontal links that are overlapping, this value is combined with the VerticalStep property value. When the VerticalStep value is 6 and the DistanceBetweenLinks property value is 0.5, the vertical spacing that will separate overlapping links will be 6 x 0.5; that is, 3. For vertical links that are overlapping, this value is combined with the HorizontalStep property value. When the HorizontalStep property value is 6 and the DistanceBetweenLinks property value is 0.5, the horizontal spacing that will separate overlapping links will be 6 x 0.5; that is, 3.

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.

Description

For horizontal links that are overlapping, this value is combined with the HorizontalStep property value to compute the inserted break point X coordinate. When the HorizontalStep property value is 3 and the BreakPoint distance is 0.5, the horizontal spacing between the extremity node and the break point that will be inserted in order to separate the overlapping links will be 3 x 0.5; that is 1.5. For vertical links that are overlapping, this value is combined with the VerticalStep property value to compute the inserted break point Y coordinate. When the VerticalStep property value is 3 and the BreakPoint distance is 0.5, the vertical spacing between the extremity node and the break point that will be inserted in order to separate the overlapping links will be 3 x 0.5; that is 1.5.

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.

Description

By default, when no Angle value is specified, the Orthogonal layout arranges the schematic elements orthogonally positioning the root node at the bottom and the leave nodes at the top.

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.

Description

When this property returns false, the parameters that define the distances are expressed as relative units to the average of the current symbols sizes used to represent the schematic nodes in the diagram; for instance, when the HorizontalStep property value is 2, the distance that separates two nodes that are horizontally aligned corresponds to the average size of two symbols placed side by side (or to a multiple of this average size).

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.