com.esri.arcgis.geodatabase

Interface IMainRingLayout

All Superinterfaces:

INetworkDiagramLayout, java.io.Serializable

All Known Implementing Classes:

IMainRingLayoutProxy

public interface IMainRingLayout
extends INetworkDiagramLayout, java.io.Serializable

COM Interface 'IMainRingLayout'. Generated 9/24/2024 11:01:30 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description: 'Provides access to members that control the Main Ring layout.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID8f15d4ee_202b_4b5a_b714_ed384e527ca9
static int	xxDummy Deprecated. Internal use only

Fields inherited from interface com.esri.arcgis.geodatabase.INetworkDiagramLayout

IID991f111c_8569_470f_961d_361941d63ca9

Method Summary

Modifier and Type	Method and Description
double	getBreakPointPosition() Indicates the percentage number that defines the relative position of the break point on the last segment of the diagram edges; that is, on the diagram edge segment parallel to the main line.
int	getEdgesType() Indicates if the diagram edges must display either with right angles, curved geometry, or no refinement.
double	getOffset() Indicates the distance used to separate diagram edge segments that are overlapping.
double	getRingHeight() Indicates the height of the main ring.
int	getRingType() Indicates the type of the main ring form; that is, rectangle or ellipse.
double	getRingWidth() Indicates the width of the main ring.
double	getSubTreeAlongSpacing() Indicates the spacing between the diagram junctions that display along the tree direction; that is, the spacing between a diagram junction belonging to the (n) hierarchical level and a diagram junction belonging to the (n+1) hierarchical level.
double	getSubTreePerpendicularSpacing() Indicates the spacing between the diagram junctions that display perpendicularly to the tree direction; that is, the spacing between the diagram junctions that belong to a same hierarchical level.
int	getSubtreeType() Indicates how the trees coming out of the main ring's junctions are positioned.
boolean	isAbsoluteUnit() Indicates whether the values set for the spacing parameters are interpreted as absolute units.
void	setAbsoluteUnit(boolean pVal) Indicates whether the values set for the spacing parameters are interpreted as absolute units.
void	setBreakPointPosition(double pVal) Indicates the percentage number that defines the relative position of the break point on the last segment of the diagram edges; that is, on the diagram edge segment parallel to the main line.
void	setEdgesType(int pVal) Indicates if the diagram edges must display either with right angles, curved geometry, or no refinement.
void	setOffset(double pVal) Indicates the distance used to separate diagram edge segments that are overlapping.
void	setRingHeight(double pVal) Indicates the height of the main ring.
void	setRingType(int pVal) Indicates the type of the main ring form; that is, rectangle or ellipse.
void	setRingWidth(double pVal) Indicates the width of the main ring.
void	setSubTreeAlongSpacing(double pVal) Indicates the spacing between the diagram junctions that display along the tree direction; that is, the spacing between a diagram junction belonging to the (n) hierarchical level and a diagram junction belonging to the (n+1) hierarchical level.
void	setSubTreePerpendicularSpacing(double pVal) Indicates the spacing between the diagram junctions that display perpendicularly to the tree direction; that is, the spacing between the diagram junctions that belong to a same hierarchical level.
void	setSubtreeType(int pVal) Indicates how the trees coming out of the main ring's junctions are positioned.

Methods inherited from interface com.esri.arcgis.geodatabase.INetworkDiagramLayout

getName, getPropertySet, isActive, isPreserveContainers, setIsActive, setPreserveContainers

Field Detail

IID8f15d4ee_202b_4b5a_b714_ed384e527ca9

static final int IID8f15d4ee_202b_4b5a_b714_ed384e527ca9

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getRingType

int getRingType()
         throws java.io.IOException,
                AutomationException

Indicates the type of the main ring form; that is, rectangle or ellipse.

Returns:

A com.esri.arcgis.geodatabase.esriLayoutMainRingType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRingType

void setRingType(int pVal)
          throws java.io.IOException,
                 AutomationException

Indicates the type of the main ring form; that is, rectangle or ellipse.

Parameters:

pVal - A com.esri.arcgis.geodatabase.esriLayoutMainRingType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRingHeight

double getRingHeight()
              throws java.io.IOException,
                     AutomationException

Indicates the height of the main ring.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRingHeight

void setRingHeight(double pVal)
            throws java.io.IOException,
                   AutomationException

Indicates the height of the main ring.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRingWidth

double getRingWidth()
             throws java.io.IOException,
                    AutomationException

Indicates the width of the main ring.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRingWidth

void setRingWidth(double pVal)
           throws java.io.IOException,
                  AutomationException

Indicates the width of the main ring.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubtreeType

int getSubtreeType()
            throws java.io.IOException,
                   AutomationException

Indicates how the trees coming out of the main ring's junctions are positioned.

Returns:

A com.esri.arcgis.geodatabase.esriLayoutHierarchicalType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubtreeType

void setSubtreeType(int pVal)
             throws java.io.IOException,
                    AutomationException

Indicates how the trees coming out of the main ring's junctions are positioned.

Parameters:

pVal - A com.esri.arcgis.geodatabase.esriLayoutHierarchicalType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubTreeAlongSpacing

double getSubTreeAlongSpacing()
                       throws java.io.IOException,
                              AutomationException

Indicates the spacing between the diagram junctions that display along the tree direction; that is, the spacing between a diagram junction belonging to the (n) hierarchical level and a diagram junction belonging to the (n+1) hierarchical level.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubTreeAlongSpacing

void setSubTreeAlongSpacing(double pVal)
                     throws java.io.IOException,
                            AutomationException

Indicates the spacing between the diagram junctions that display along the tree direction; that is, the spacing between a diagram junction belonging to the (n) hierarchical level and a diagram junction belonging to the (n+1) hierarchical level.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubTreePerpendicularSpacing

double getSubTreePerpendicularSpacing()
                               throws java.io.IOException,
                                      AutomationException

Indicates the spacing between the diagram junctions that display perpendicularly to the tree direction; that is, the spacing between the diagram junctions that belong to a same hierarchical level.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubTreePerpendicularSpacing

void setSubTreePerpendicularSpacing(double pVal)
                             throws java.io.IOException,
                                    AutomationException

Indicates the spacing between the diagram junctions that display perpendicularly to the tree direction; that is, the spacing between the diagram junctions that belong to a same hierarchical level.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreakPointPosition

double getBreakPointPosition()
                      throws java.io.IOException,
                             AutomationException

Indicates the percentage number that defines the relative position of the break point on the last segment of the diagram edges; that is, on the diagram edge segment parallel to the main line.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreakPointPosition

void setBreakPointPosition(double pVal)
                    throws java.io.IOException,
                           AutomationException

Indicates the percentage number that defines the relative position of the break point on the last segment of the diagram edges; that is, on the diagram edge segment parallel to the main line.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEdgesType

int getEdgesType()
          throws java.io.IOException,
                 AutomationException

Indicates if the diagram edges must display either with right angles, curved geometry, or no refinement.

Returns:

A com.esri.arcgis.geodatabase.esriLayoutEdgesType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEdgesType

void setEdgesType(int pVal)
           throws java.io.IOException,
                  AutomationException

Indicates if the diagram edges must display either with right angles, curved geometry, or no refinement.

Parameters:

pVal - A com.esri.arcgis.geodatabase.esriLayoutEdgesType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAbsoluteUnit

boolean isAbsoluteUnit()
                throws java.io.IOException,
                       AutomationException

Indicates whether the values set for the spacing parameters are interpreted as absolute units.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAbsoluteUnit

void setAbsoluteUnit(boolean pVal)
              throws java.io.IOException,
                     AutomationException

Indicates whether the values set for the spacing parameters are interpreted as absolute units.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffset

void setOffset(double pVal)
        throws java.io.IOException,
               AutomationException

Indicates the distance used to separate diagram edge segments that are overlapping. This parameter is only used when EdgesType is esriLayoutOrthogonalEdge.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffset

double getOffset()
          throws java.io.IOException,
                 AutomationException

Indicates the distance used to separate diagram edge segments that are overlapping. This parameter is only used when EdgesType is esriLayoutOrthogonalEdge.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.