com.esri.arcgis.schematic
Interface ISchematicAlgoSmartTree

All Superinterfaces:

ISchematicAlgorithm, Serializable

All Known Implementing Classes:

SchematicAlgoSmartTree

public interface ISchematicAlgoSmartTree
extends ISchematicAlgorithm, Serializable

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

Description

The Smart Tree layout arranges hierarchically all the nodes and links in the active schematic diagram and place them as a smart tree. If a schematic root node is set, the smart tree starts with the root element.

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:

ISchematicAlgoCompactTree

Method Summary

double	getBreakPoint() Number comprised between 0 and 1 that defines 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() Smart tree structure direction.
double	getDistanceAlongTheDirection() Spacing between the nodes that display along the smart 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 smart tree direction and that belong to the same subtree level; that is, spacing between the nodes that belong to the same hierarchical level in the same subtree.
double	getSubtreeSeparation() Spacing between two neighbor subtrees; that is, spacing between the nodes that display perpendicularly to the smart tree direction and that belong to two different subtrees.
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 that defines 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) Smart tree structure direction.
void	setDistanceAlongTheDirection(double pVal) Spacing between the nodes that display along the smart 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 smart tree direction and that belong to the same subtree level; that is, spacing between the nodes that belong to the same hierarchical level in the same subtree.
void	setOrthogonalDisplay(boolean pVal) Indicates if the links must display with right angles.
void	setSubtreeSeparation(double pVal) Spacing between two neighbor subtrees; that is, spacing between the nodes that display perpendicularly to the smart tree direction and that belong to two different subtrees.

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 smart 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.

See Also:

ISchematicAlgoSmartTree.getSubtreeSeparation(), ISchematicAlgoSmartTree.getDistancePerpendicularToDirection()

setDistanceAlongTheDirection

void setDistanceAlongTheDirection(double pVal)
                                  throws IOException,
                                         AutomationException

Spacing between the nodes that display along the smart 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 smart tree direction and that belong to the same subtree level; that is, spacing between the nodes that belong to the same hierarchical level in the same subtree.

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:

ISchematicAlgoSmartTree.getSubtreeSeparation(), ISchematicAlgoSmartTree.getDistanceAlongTheDirection()

setDistancePerpendicularToDirection

void setDistancePerpendicularToDirection(double pVal)
                                         throws IOException,
                                                AutomationException

Spacing between the nodes that display perpendicularly to the smart tree direction and that belong to the same subtree level; that is, spacing between the nodes that belong to the same hierarchical level in the same subtree.

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.

getSubtreeSeparation

double getSubtreeSeparation()
                            throws IOException,
                                   AutomationException

Spacing between two neighbor subtrees; that is, spacing between the nodes that display perpendicularly to the smart tree direction and that belong to two different subtrees.

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:

ISchematicAlgoSmartTree.getDistancePerpendicularToDirection()

setSubtreeSeparation

void setSubtreeSeparation(double pVal)
                          throws IOException,
                                 AutomationException

Spacing between two neighbor subtrees; that is, spacing between the nodes that display perpendicularly to the smart tree direction and that belong to two different subtrees.

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

Smart 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

Smart 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.

getBreakPoint

double getBreakPoint()
                     throws IOException,
                            AutomationException

Number comprised between 0 and 1 that defines 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.

Description

With a BreakPoint property value of 0, this segment length is the longest and it displays with a right angle. With a BreakPoint property value of 1, this segment doesn’t exist; each link directly connects its two extremity nodes without intermediate point.

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:

ISchematicAlgoSmartTree.isOrthogonalDisplay()

setBreakPoint

void setBreakPoint(double pVal)
                   throws IOException,
                          AutomationException

Number comprised between 0 and 1 that defines 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.

See Also:

ISchematicAlgoSmartTree.getBreakPoint()

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.

isAbsoluteParameters

boolean isAbsoluteParameters()
                             throws IOException,
                                    AutomationException

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

Description

When the AbsoluteParameters is false, the distance parameters are interpreted as relative units to the average of the current symbols sizes used to represent the schematic nodes in the diagram; that is, for instance, when the DistanceAlongTheDirection property value is 2, the distance that separates two nodes belonging to the (n) and the (n+1) hierarchical levels corresponds to the average size of two symbols placed side by side

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.