com.esri.arcgis.geodatabase

Interface IRelativeMainlineLayout

All Superinterfaces:

INetworkDiagramLayout, java.io.Serializable

All Known Implementing Classes:

IRelativeMainlineLayoutProxy

public interface IRelativeMainlineLayout
extends INetworkDiagramLayout, java.io.Serializable

COM Interface 'IRelativeMainlineLayout'. Generated 9/21/2023 10:01:48 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description: 'Provides access to members that control the Relative Mainline 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	IID3c62e3cc_255f_4820_ad3a_d121202a8d95
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
java.lang.String	getAlignmentAttributeName() Indicates the name of the network attribute that is used to align lines that are split.
java.lang.Object[]	getBranchValues() Indicates the TypeAttributeName values that identify the diagram edges that are branches.
double	getBreakPointAngle() Indicates the angle comprised between 30° and 90° that is used to position the break point on the first and last segments of the edges; that is, on the edge segments parallel to the tree direction.
double	getCompressionRatio() Percentage number that indicates the compression factor that is applied along the direction.
int	getDirection() Indicates the direction of the main line.
java.lang.Object[]	getExcludedValues() Indicates the TypeAttributeName values that identify the diagram edges that are excluded from the straight lines (crossovers or laders).
java.lang.String	getLengthAttributeName() Indicates the name of the network attribute that holds the initial length of the diagram edges.
java.lang.String	getLineAttributeName() Indicates the name of the network attribute that is used to identify the lines that comprise the straight lines.
java.lang.Object[]	getMainlineValues() Indicates the TypeAttributeName values that identify the diagram edges along the main lines.
double	getMinimalDistance() Indicates the minimal distance between two adjacent groups of neighbor diagram junctions where compression can occur.
double	getOffsetBetweenBranches() Indicates the spacing between two adjacent branches along the axis perpendicular to the direction of the lines.
java.lang.String	getTypeAttributeName() Indicates the name of the network attribute that is used to qualify the lines.
boolean	isCompressAlongDirection() Indicates whether the graph is compressed to reduce the distances between adjacent groups of neighbor diagram junctions along the direction while maintaining relative positioning between these groups.
void	setAlignmentAttributeName(java.lang.String name) Indicates the name of the network attribute that is used to align lines that are split.
void	setBranchValues(java.lang.Object[] value) Indicates the TypeAttributeName values that identify the diagram edges that are branches.
void	setBreakPointAngle(double pVal) Indicates the angle comprised between 30° and 90° that is used to position the break point on the first and last segments of the edges; that is, on the edge segments parallel to the tree direction.
void	setCompressAlongDirection(boolean pVal) Indicates whether the graph is compressed to reduce the distances between adjacent groups of neighbor diagram junctions along the direction while maintaining relative positioning between these groups.
void	setCompressionRatio(double pVal) Percentage number that indicates the compression factor that is applied along the direction.
void	setDirection(int pVal) Indicates the direction of the main line.
void	setExcludedValues(java.lang.Object[] value) Indicates the TypeAttributeName values that identify the diagram edges that are excluded from the straight lines (crossovers or laders).
void	setLengthAttributeName(java.lang.String name) Indicates the name of the network attribute that holds the initial length of the diagram edges.
void	setLineAttributeName(java.lang.String name) Indicates the name of the network attribute that is used to identify the lines that comprise the straight lines.
void	setMainlineValues(java.lang.Object[] value) Indicates the TypeAttributeName values that identify the diagram edges along the main lines.
void	setMinimalDistance(double pVal) Indicates the minimal distance between two adjacent groups of neighbor diagram junctions where compression can occur.
void	setOffsetBetweenBranches(double pVal) Indicates the spacing between two adjacent branches along the axis perpendicular to the direction of the lines.
void	setTypeAttributeName(java.lang.String name) Indicates the name of the network attribute that is used to qualify the lines.

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

getName, getPropertySet, isActive, isPreserveContainers, setIsActive, setPreserveContainers

Field Detail

IID3c62e3cc_255f_4820_ad3a_d121202a8d95

static final int IID3c62e3cc_255f_4820_ad3a_d121202a8d95

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

getDirection

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

Indicates the direction of the main line.

Returns:

A com.esri.arcgis.geodatabase.esriLayoutTreeDirection constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDirection

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

Indicates the direction of the main line.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOffsetBetweenBranches

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

Indicates the spacing between two adjacent branches along the axis perpendicular to the direction of the lines.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOffsetBetweenBranches

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

Indicates the spacing between two adjacent branches along the axis perpendicular to the direction of the lines.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBreakPointAngle

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

Indicates the angle comprised between 30° and 90° that is used to position the break point on the first and last segments of the edges; that is, on the edge segments parallel to the tree direction.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBreakPointAngle

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

Indicates the angle comprised between 30° and 90° that is used to position the break point on the first and last segments of the edges; that is, on the edge segments parallel to the tree direction.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLineAttributeName

java.lang.String getLineAttributeName()
                               throws java.io.IOException,
                                      AutomationException

Indicates the name of the network attribute that is used to identify the lines that comprise the straight lines.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLineAttributeName

void setLineAttributeName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException

Indicates the name of the network attribute that is used to identify the lines that comprise the straight lines.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTypeAttributeName

java.lang.String getTypeAttributeName()
                               throws java.io.IOException,
                                      AutomationException

Indicates the name of the network attribute that is used to qualify the lines.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTypeAttributeName

void setTypeAttributeName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException

Indicates the name of the network attribute that is used to qualify the lines.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMainlineValues

java.lang.Object[] getMainlineValues()
                              throws java.io.IOException,
                                     AutomationException

Indicates the TypeAttributeName values that identify the diagram edges along the main lines.

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMainlineValues

void setMainlineValues(java.lang.Object[] value)
                throws java.io.IOException,
                       AutomationException

Indicates the TypeAttributeName values that identify the diagram edges along the main lines.

Parameters:

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBranchValues

java.lang.Object[] getBranchValues()
                            throws java.io.IOException,
                                   AutomationException

Indicates the TypeAttributeName values that identify the diagram edges that are branches.

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBranchValues

void setBranchValues(java.lang.Object[] value)
              throws java.io.IOException,
                     AutomationException

Indicates the TypeAttributeName values that identify the diagram edges that are branches.

Parameters:

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExcludedValues

java.lang.Object[] getExcludedValues()
                              throws java.io.IOException,
                                     AutomationException

Indicates the TypeAttributeName values that identify the diagram edges that are excluded from the straight lines (crossovers or laders).

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExcludedValues

void setExcludedValues(java.lang.Object[] value)
                throws java.io.IOException,
                       AutomationException

Indicates the TypeAttributeName values that identify the diagram edges that are excluded from the straight lines (crossovers or laders).

Parameters:

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCompressAlongDirection

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

Indicates whether the graph is compressed to reduce the distances between adjacent groups of neighbor diagram junctions along the direction while maintaining relative positioning between these groups.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCompressAlongDirection

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

Indicates whether the graph is compressed to reduce the distances between adjacent groups of neighbor diagram junctions along the direction while maintaining relative positioning between these groups.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimalDistance

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

Indicates the minimal distance between two adjacent groups of neighbor diagram junctions where compression can occur.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimalDistance

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

Indicates the minimal distance between two adjacent groups of neighbor diagram junctions where compression can occur.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCompressionRatio

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

Percentage number that indicates the compression factor that is applied along the direction.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCompressionRatio

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

Percentage number that indicates the compression factor that is applied along the direction.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAlignmentAttributeName

java.lang.String getAlignmentAttributeName()
                                    throws java.io.IOException,
                                           AutomationException

Indicates the name of the network attribute that is used to align lines that are split.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAlignmentAttributeName

void setAlignmentAttributeName(java.lang.String name)
                        throws java.io.IOException,
                               AutomationException

Indicates the name of the network attribute that is used to align lines that are split.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLengthAttributeName

java.lang.String getLengthAttributeName()
                                 throws java.io.IOException,
                                        AutomationException

Indicates the name of the network attribute that holds the initial length of the diagram edges.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLengthAttributeName

void setLengthAttributeName(java.lang.String name)
                     throws java.io.IOException,
                            AutomationException

Indicates the name of the network attribute that holds the initial length of the diagram edges.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.