com.esri.arcgis.schematic
Interface ISchematicAlgoGrid

All Superinterfaces:
ISchematicAlgorithm, Serializable
All Known Implementing Classes:
SchematicAlgoGrid

public interface ISchematicAlgoGrid
extends ISchematicAlgorithm, Serializable

Provides access to members that control the Grid schematic algorithm.

Description

The Grid algorithm lays out the schematic nodes in a diagram relative to a magnetic grid. The nodes are moved based on their current positions so that only one node holds a grid cell

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 double getHorizontalStep()
          Horizontal step for the grid; that is the wide of each grid cell.
 double getOriginX()
          Horizontal coordinate for the origin of the grid.
 double getOriginY()
          Vertical coordinate for the origin of the grid.
 double getVerticalStep()
          Vertical step for the grid; that is the wide of each grid cell.
 boolean isAbsoluteParameters()
          Indicates if the values set for the step parameters must be interpreted as absolute units.
 void setAbsoluteParameters(boolean pVal)
          Indicates if the values set for the step parameters must be interpreted as absolute units.
 void setHorizontalStep(double pVal)
          Horizontal step for the grid; that is the wide of each grid cell.
 void setOriginX(double pVal)
          Horizontal coordinate for the origin of the grid.
 void setOriginY(double pVal)
          Vertical coordinate for the origin of the grid.
 void setVerticalStep(double pVal)
          Vertical step for the grid; that is the wide of each grid cell.
 
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

getOriginX

double getOriginX()
                  throws IOException,
                         AutomationException
Horizontal coordinate for the origin of the grid.

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.

setOriginX

void setOriginX(double pVal)
                throws IOException,
                       AutomationException
Horizontal coordinate for the origin of the grid.

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.

getOriginY

double getOriginY()
                  throws IOException,
                         AutomationException
Vertical coordinate for the origin of the grid.

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.

setOriginY

void setOriginY(double pVal)
                throws IOException,
                       AutomationException
Vertical coordinate for the origin of the grid.

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.

getHorizontalStep

double getHorizontalStep()
                         throws IOException,
                                AutomationException
Horizontal step for the grid; that is the wide of each grid cell.

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.

setHorizontalStep

void setHorizontalStep(double pVal)
                       throws IOException,
                              AutomationException
Horizontal step for the grid; that is the wide of each grid cell.

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.

getVerticalStep

double getVerticalStep()
                       throws IOException,
                              AutomationException
Vertical step for the grid; that is the wide of each grid cell.

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.

setVerticalStep

void setVerticalStep(double pVal)
                     throws IOException,
                            AutomationException
Vertical step for the grid; that is the wide of each grid cell.

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 step parameters must be interpreted as absolute units.

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