com.esri.arcgis.schematic
Interface ISchematicAlgoRadialTree

All Superinterfaces:

ISchematicAlgorithm, Serializable

All Known Implementing Classes:

SchematicAlgoRadialTree

public interface ISchematicAlgoRadialTree
extends ISchematicAlgorithm, Serializable

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

Description

The Radial Tree layout arranges hierarchically all the nodes and links in the active schematic diagram and place them as a radial tree. It detects the node of the graph that it uses as the circle center to arrange the subtrees starting from this root around concentric circles, each circle corresponding to one hierarchical level. If a schematic root node is set, the Radial Tree algorithm considers this root element as the center of the concentric circles. 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	getInitialRadius() Radius of the first concentric circle which center is the Radial Tree root node.
double	getRadiusFactor() Multiplicative factor used to increase or decrease the radius of each concentric circle corresponding to a hierarchical level.
boolean	isAbsoluteParameters() Indicates if the values set for the Initial radius must be interpreted as absolute units.
void	setAbsoluteParameters(boolean pVal) Indicates if the values set for the Initial radius must be interpreted as absolute units.
void	setInitialRadius(double pVal) Radius of the first concentric circle which center is the Radial Tree root node.
void	setRadiusFactor(double pVal) Multiplicative factor used to increase or decrease the radius of each concentric circle corresponding to a hierarchical level.

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

getRadiusFactor

double getRadiusFactor()
                       throws IOException,
                              AutomationException

Multiplicative factor used to increase or decrease the radius of each concentric circle corresponding to a hierarchical level.

Description

By default, the RadiusFactor value is 1; that is, the InitialRadius also represents the distance that separates each concentric circle related to a hierarchical level. When setting a RadiusFactor lower than 1, the distance that separates the nodes belonging to the N hierarchical level and the N+1 hierarchical level progressively decreased; with factor upper than 1, the distance between the hierarchical levels increases progressively.

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:

ISchematicAlgoRadialTree.getInitialRadius()

setRadiusFactor

void setRadiusFactor(double pVal)
                     throws IOException,
                            AutomationException

Multiplicative factor used to increase or decrease the radius of each concentric circle corresponding to a 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.

getInitialRadius

double getInitialRadius()
                        throws IOException,
                               AutomationException

Radius of the first concentric circle which center is the Radial Tree root node.

Description

That is, the intial radius is the radius of the circle around which the nodes belonging to the first hierarchical level are placed.

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:

ISchematicAlgoRadialTree.getRadiusFactor()

setInitialRadius

void setInitialRadius(double pVal)
                      throws IOException,
                             AutomationException

Radius of the first concentric circle which center is the Radial Tree root node.

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 Initial radius must be interpreted as absolute units.

Description

When this property returns false, the parameters that define the radius is expressed as relative units to the average of the current symbols sizes used to represent the schematic nodes in the diagram; that is, when the InitialRadius parameter value is 2, the radius for the first concentric circle centered around the root node corresponds to the average size of two symbols placed side by side (or 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 Initial radius 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.