com.esri.arcgis.geodatabase

Interface ILinearDispatchLayout

All Superinterfaces:

INetworkDiagramLayout, java.io.Serializable

All Known Implementing Classes:

ILinearDispatchLayoutProxy

public interface ILinearDispatchLayout
extends INetworkDiagramLayout, java.io.Serializable

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

Description: 'Provides access to members that control the Linear Dispatch 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	IID764c6911_4212_497c_81c8_31c45441078c
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
int	getJunctionsPlacement() Indicates the type of junction placement that is applied during the layout execution.
double	getLeavesShift() Indicates the maximum distance the leaf junctions is spaced from the junctions to which they connect when they are authorized to be moved during the layout execution.
double	getMaximumShift() Indicates the maximum distance the junctions with two connections is spaced from their edge extremity after the layout execution.
double	getMinimumShift() Indicates the minimum distance the junctions with two connections is spaced from their edge extremity after the layout execution.
int	getNumberOfIterations() Indicates the number of Linear Dispatch layout iterations that is executed before the final result is shown.
boolean	isAbsoluteUnit() Indicates whether the values set for the distance parameters are interpreted as absolute units.
boolean	isExpandLeaves() Indicates whether leaf junctions—that is, junctions with one connection—can be expanded during the algorithm execution.
boolean	isMoveLeaves() Indicates whether leaf junctions—that is, junctions with one connection—can be moved during the algorithm execution.
boolean	isPreservePath() Indicates whether the layout algorithm preserves the vertices along the diagram edges related to the moved diagram junctions when executing.
void	setAbsoluteUnit(boolean pVal) Indicates whether the values set for the distance parameters are interpreted as absolute units.
void	setExpandLeaves(boolean pVal) Indicates whether leaf junctions—that is, junctions with one connection—can be expanded during the algorithm execution.
void	setJunctionsPlacement(int pVal) Indicates the type of junction placement that is applied during the layout execution.
void	setLeavesShift(double pVal) Indicates the maximum distance the leaf junctions is spaced from the junctions to which they connect when they are authorized to be moved during the layout execution.
void	setMaximumShift(double pVal) Indicates the maximum distance the junctions with two connections is spaced from their edge extremity after the layout execution.
void	setMinimumShift(double pVal) Indicates the minimum distance the junctions with two connections is spaced from their edge extremity after the layout execution.
void	setMoveLeaves(boolean pVal) Indicates whether leaf junctions—that is, junctions with one connection—can be moved during the algorithm execution.
void	setNumberOfIterations(int pVal) Indicates the number of Linear Dispatch layout iterations that is executed before the final result is shown.
void	setPreservePath(boolean pVal) Indicates whether the layout algorithm preserves the vertices along the diagram edges related to the moved diagram junctions when executing.

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

getName, getPropertySet, isActive, isPreserveContainers, setIsActive, setPreserveContainers

Field Detail

IID764c6911_4212_497c_81c8_31c45441078c

static final int IID764c6911_4212_497c_81c8_31c45441078c

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

isMoveLeaves

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

Indicates whether leaf junctions—that is, junctions with one connection—can be moved during the algorithm execution.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMoveLeaves

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

Indicates whether leaf junctions—that is, junctions with one connection—can be moved during the algorithm execution.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPreservePath

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

Indicates whether the layout algorithm preserves the vertices along the diagram edges related to the moved diagram junctions when executing.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPreservePath

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

Indicates whether the layout algorithm preserves the vertices along the diagram edges related to the moved diagram junctions when executing.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isExpandLeaves

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

Indicates whether leaf junctions—that is, junctions with one connection—can be expanded during the algorithm execution.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExpandLeaves

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

Indicates whether leaf junctions—that is, junctions with one connection—can be expanded during the algorithm execution.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLeavesShift

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

Indicates the maximum distance the leaf junctions is spaced from the junctions to which they connect when they are authorized to be moved during the layout execution.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLeavesShift

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

Indicates the maximum distance the leaf junctions is spaced from the junctions to which they connect when they are authorized to be moved during the layout execution.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumShift

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

Indicates the minimum distance the junctions with two connections is spaced from their edge extremity after the layout execution. This parameter is only used when JunctionsPlacement type is esriLayoutUserDefineDistance.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumShift

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

Indicates the minimum distance the junctions with two connections is spaced from their edge extremity after the layout execution. This parameter is only used when JunctionsPlacement type is esriLayoutUserDefineDistance.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumShift

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

Indicates the maximum distance the junctions with two connections is spaced from their edge extremity after the layout execution. This parameter is only used when JunctionsPlacement type is esriLayoutIterativeDistance.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumShift

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

Indicates the maximum distance the junctions with two connections is spaced from their edge extremity after the layout execution. This parameter is only used when JunctionsPlacement type is esriLayoutIterativeDistance.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJunctionsPlacement

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

Indicates the type of junction placement that is applied during the layout execution.

Returns:

A com.esri.arcgis.geodatabase.esriLayoutJunctionsPlacement constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setJunctionsPlacement

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

Indicates the type of junction placement that is applied during the layout execution.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumberOfIterations

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

Indicates the number of Linear Dispatch layout iterations that is executed before the final result is shown. This parameter is only used when JunctionsPlacement is esriLayoutIterativeDistance.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNumberOfIterations

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

Indicates the number of Linear Dispatch layout iterations that is executed before the final result is shown. This parameter is only used when JunctionsPlacement is esriLayoutIterativeDistance.

Parameters:

pVal - The pVal (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 distance 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 distance 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.