com.esri.arcgis.schematic
Interface ISchematicAlgoCompactTree

All Superinterfaces:

ISchematicAlgorithm, Serializable

All Known Implementing Classes:

SchematicAlgoCompactTree

public interface ISchematicAlgoCompactTree
extends ISchematicAlgorithm, Serializable

Provides access to members that control the Compact Tree schematic algorithm.

Description

The Compact Tree algorithm arranges hierarchically the schematic nodes and links in a diagram and place them as a hierarchical compact tree. If a schematic root node is set in the diagram, the compact tree starts with this root element.

Product Availability

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

Method Summary

double	getBreakPoint() Number comprised between 0 and 1 to define the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the tree direction.
int	getDirection() Compact tree structure direction.
double	getDistanceAlongTheDirection() Spacing between the nodes that display along the compact tree direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level.
double	getDistancePerpendicularToDirection() Spacing between the nodes that display perpendicularly to the compact tree direction; that is, spacing between the nodes that belong to a same hierarchical level.
boolean	isAbsoluteParameters() Indicates if the values set for the spacing parameters must be interpreted as absolute units.
boolean	isOrthogonalDisplay() Indicates if the links must display with right angles.
void	setAbsoluteParameters(boolean pVal) Indicates if the values set for the spacing parameters must be interpreted as absolute units.
void	setBreakPoint(double pVal) Number comprised between 0 and 1 to define the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the tree direction.
void	setDirection(int pVal) Compact tree structure direction.
void	setDistanceAlongTheDirection(double pVal) Spacing between the nodes that display along the compact tree direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level.
void	setDistancePerpendicularToDirection(double pVal) Spacing between the nodes that display perpendicularly to the compact tree direction; that is, spacing between the nodes that belong to a same hierarchical level.
void	setOrthogonalDisplay(boolean pVal) Indicates if the links must display with right angles.

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

getDistanceAlongTheDirection

double getDistanceAlongTheDirection()
                                    throws IOException,
                                           AutomationException

Spacing between the nodes that display along the compact tree direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level.

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.

setDistanceAlongTheDirection

void setDistanceAlongTheDirection(double pVal)
                                  throws IOException,
                                         AutomationException

Spacing between the nodes that display along the compact tree direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level.

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.

getDistancePerpendicularToDirection

double getDistancePerpendicularToDirection()
                                           throws IOException,
                                                  AutomationException

Spacing between the nodes that display perpendicularly to the compact tree direction; that is, spacing between the nodes that belong to a same hierarchical level.

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.

setDistancePerpendicularToDirection

void setDistancePerpendicularToDirection(double pVal)
                                         throws IOException,
                                                AutomationException

Spacing between the nodes that display perpendicularly to the compact tree direction; that is, spacing between the nodes that belong to a same hierarchical level.

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.

getDirection

int getDirection()
                 throws IOException,
                        AutomationException

Compact tree structure direction.

Product Availability

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

Returns:

A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirection

void setDirection(int pVal)
                  throws IOException,
                         AutomationException

Compact tree structure direction.

Product Availability

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

Parameters:

pVal - A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant (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 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 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.

getBreakPoint

double getBreakPoint()
                     throws IOException,
                            AutomationException

Number comprised between 0 and 1 to define the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the tree direction.

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 to define the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the tree direction.

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.

isOrthogonalDisplay

boolean isOrthogonalDisplay()
                            throws IOException,
                                   AutomationException

Indicates if the links must display with right angles.

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.

setOrthogonalDisplay

void setOrthogonalDisplay(boolean pVal)
                          throws IOException,
                                 AutomationException

Indicates if the links must display with right angles.

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.