com.esri.arcgis.schematic
Interface ISchematicLayer

All Superinterfaces:

Serializable

All Known Implementing Classes:

SchematicLayer

public interface ISchematicLayer
extends Serializable

Provides access to members that manage the schematic layer functionality.

Product Availability

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

Method Summary

ISchematicDiagram	getSchematicDiagram() Schematic diagram of the schematic layer.
IEnumSchematicFeature	getSchematicFeaturesAtPoint(IPoint point, double pointSearchDistance, boolean onlySelectable, boolean onlyVisible) Schematic features selected in the schematic layer.
IEnumSchematicFeature	getSchematicFeaturesAtPointByClass(ISchematicElementClass schematicElementClass, IPoint point, double pointSearchDistance, boolean onlySelectable, boolean onlyVisible) Schematic features of the specified type around the specified point.
IEnumSchematicFeature	getSchematicFeaturesAtPointByType(int elementType, IPoint point, double pointSearchDistance, boolean onlySelectable, boolean onlyVisible) Schematic features around the specified point.
IEnumSchematicFeature	getSchematicFeaturesInZone(IPolygon polygon, int spatialRelation, boolean onlySelectable, boolean onlyVisible) Schematic features returned by a spatial query baed on a polygon.
IEnumSchematicFeature	getSchematicFeaturesInZoneByClass(ISchematicElementClass schematicElementClass, IPolygon polygon, int spatialRelation, boolean onlySelectable, boolean onlyVisible) Schematic features of the specified class returned by a spatial query baed on a polygon.
IEnumSchematicFeature	getSchematicFeaturesInZoneByType(int elementType, IPolygon polygon, int spatialRelation, boolean onlySelectable, boolean onlyVisible) Schematic features of the specified type returned by a spatial query baed on a polygon.
ISchematicInMemoryDiagram	getSchematicInMemoryDiagram() Schematic in memory diagram of the schematic layer.
IEnumSchematicFeature	getSchematicSelectedFeatures(boolean onlyVisible) Schematic in memory diagram of the schematic layer.
boolean	isEditingSchematicDiagram() Indicates if the schematic diagram is being edited inside this layer.
void	setSchematicDiagramByRef(ISchematicDiagram diagram) Schematic diagram of the schematic layer.
void	startEditSchematicDiagram(boolean lockDiagram) Start editing the schematic diagram.
void	stopEditSchematicDiagram() Stop editing the schematic diagram.
void	updateExtent() Recalculate the extent of the schematic diagram.

Method Detail

getSchematicDiagram

ISchematicDiagram getSchematicDiagram()
                                      throws IOException,
                                             AutomationException

Schematic diagram of the schematic layer.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicDiagram

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramByRef

void setSchematicDiagramByRef(ISchematicDiagram diagram)
                              throws IOException,
                                     AutomationException

Schematic diagram of the schematic layer.

Product Availability

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

Parameters:

diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicInMemoryDiagram

ISchematicInMemoryDiagram getSchematicInMemoryDiagram()
                                                      throws IOException,
                                                             AutomationException

Schematic in memory diagram of the schematic layer.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicInMemoryDiagram

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicSelectedFeatures

IEnumSchematicFeature getSchematicSelectedFeatures(boolean onlyVisible)
                                                   throws IOException,
                                                          AutomationException

Schematic in memory diagram of the schematic layer.

Product Availability

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

Parameters:

onlyVisible - The onlyVisible (in)

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicFeature

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicFeaturesAtPoint

IEnumSchematicFeature getSchematicFeaturesAtPoint(IPoint point,
                                                  double pointSearchDistance,
                                                  boolean onlySelectable,
                                                  boolean onlyVisible)
                                                  throws IOException,
                                                         AutomationException

Schematic features selected in the schematic layer.

Product Availability

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

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

pointSearchDistance - The pointSearchDistance (in)

onlySelectable - The onlySelectable (in)

onlyVisible - The onlyVisible (in)

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicFeature

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicFeaturesAtPointByType

IEnumSchematicFeature getSchematicFeaturesAtPointByType(int elementType,
                                                        IPoint point,
                                                        double pointSearchDistance,
                                                        boolean onlySelectable,
                                                        boolean onlyVisible)
                                                        throws IOException,
                                                               AutomationException

Schematic features around the specified point.

Product Availability

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

Parameters:

elementType - A com.esri.arcgis.schematic.esriSchematicElementType constant (in)

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

pointSearchDistance - The pointSearchDistance (in)

onlySelectable - The onlySelectable (in)

onlyVisible - The onlyVisible (in)

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicFeature

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicFeaturesAtPointByClass

IEnumSchematicFeature getSchematicFeaturesAtPointByClass(ISchematicElementClass schematicElementClass,
                                                         IPoint point,
                                                         double pointSearchDistance,
                                                         boolean onlySelectable,
                                                         boolean onlyVisible)
                                                         throws IOException,
                                                                AutomationException

Schematic features of the specified type around the specified point.

Product Availability

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

Parameters:

schematicElementClass - A reference to a com.esri.arcgis.schematic.ISchematicElementClass (in)

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

pointSearchDistance - The pointSearchDistance (in)

onlySelectable - The onlySelectable (in)

onlyVisible - The onlyVisible (in)

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicFeature

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicFeaturesInZone

IEnumSchematicFeature getSchematicFeaturesInZone(IPolygon polygon,
                                                 int spatialRelation,
                                                 boolean onlySelectable,
                                                 boolean onlyVisible)
                                                 throws IOException,
                                                        AutomationException

Schematic features returned by a spatial query baed on a polygon.

Product Availability

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

Parameters:

polygon - A reference to a com.esri.arcgis.geometry.IPolygon (in)

spatialRelation - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)

onlySelectable - The onlySelectable (in)

onlyVisible - The onlyVisible (in)

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicFeature

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicFeaturesInZoneByType

IEnumSchematicFeature getSchematicFeaturesInZoneByType(int elementType,
                                                       IPolygon polygon,
                                                       int spatialRelation,
                                                       boolean onlySelectable,
                                                       boolean onlyVisible)
                                                       throws IOException,
                                                              AutomationException

Schematic features of the specified type returned by a spatial query baed on a polygon.

Product Availability

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

Parameters:

elementType - A com.esri.arcgis.schematic.esriSchematicElementType constant (in)

polygon - A reference to a com.esri.arcgis.geometry.IPolygon (in)

spatialRelation - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)

onlySelectable - The onlySelectable (in)

onlyVisible - The onlyVisible (in)

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicFeature

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicFeaturesInZoneByClass

IEnumSchematicFeature getSchematicFeaturesInZoneByClass(ISchematicElementClass schematicElementClass,
                                                        IPolygon polygon,
                                                        int spatialRelation,
                                                        boolean onlySelectable,
                                                        boolean onlyVisible)
                                                        throws IOException,
                                                               AutomationException

Schematic features of the specified class returned by a spatial query baed on a polygon.

Product Availability

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

Parameters:

schematicElementClass - A reference to a com.esri.arcgis.schematic.ISchematicElementClass (in)

polygon - A reference to a com.esri.arcgis.geometry.IPolygon (in)

spatialRelation - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)

onlySelectable - The onlySelectable (in)

onlyVisible - The onlyVisible (in)

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicFeature

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startEditSchematicDiagram

void startEditSchematicDiagram(boolean lockDiagram)
                               throws IOException,
                                      AutomationException

Start editing the schematic diagram.

Product Availability

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

Parameters:

lockDiagram - The lockDiagram (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopEditSchematicDiagram

void stopEditSchematicDiagram()
                              throws IOException,
                                     AutomationException

Stop editing the schematic diagram.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEditingSchematicDiagram

boolean isEditingSchematicDiagram()
                                  throws IOException,
                                         AutomationException

Indicates if the schematic diagram is being edited inside this layer.

Product Availability

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

Returns:

The isEditing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateExtent

void updateExtent()
                  throws IOException,
                         AutomationException

Recalculate the extent of the schematic diagram.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.