com.esri.arcgis.carto
Interface IFeatureExtent

All Superinterfaces:
Serializable
All Known Implementing Classes:
FeatureExtent

public interface IFeatureExtent
extends Serializable

Provides access to the Feature Extent Map Area Interface.

Remarks

To use a FeatureExtent, the properties MapName, LayerID and FeatureIDs need to be set. You are likely to get unexpected results if these properties are not set. The ExpandRatio and DefaultScale properties are optional. If the ExpandRatio is not set some of the selected features will be located at the very edge of the map image. The DefaultScale value only affects conditions where a single point feature is selected. This will be the map scale in which the map will zoom to when a single point is selected.

When To Use

Use IFeatureExtent to zoom to selected features of a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 double getDefaultScale()
          Scale at which the extent of a single point is drawn.
 double getExpandRatio()
          Ratio used to expand the extent.
 IFIDSet getFeatureIDs()
          The set of feature IDs.
 int getLayerID()
          The ID of the layer.
 String getMapName()
          Name of the map (data frame).
 void setDefaultScale(double mapScale)
          Scale at which the extent of a single point is drawn.
 void setExpandRatio(double ratio)
          Ratio used to expand the extent.
 void setFeatureIDs(IFIDSet featureIDs)
          The set of feature IDs.
 void setLayerID(int layerID)
          The ID of the layer.
 void setMapName(String name)
          Name of the map (data frame).
 

Method Detail

getMapName

String getMapName()
                  throws IOException,
                         AutomationException
Name of the map (data frame).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapName

void setMapName(String name)
                throws IOException,
                       AutomationException
Name of the map (data frame).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerID

int getLayerID()
               throws IOException,
                      AutomationException
The ID of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The layerID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerID

void setLayerID(int layerID)
                throws IOException,
                       AutomationException
The ID of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
layerID - The layerID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureIDs

IFIDSet getFeatureIDs()
                      throws IOException,
                             AutomationException
The set of feature IDs.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.IFIDSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureIDs

void setFeatureIDs(IFIDSet featureIDs)
                   throws IOException,
                          AutomationException
The set of feature IDs.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
featureIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExpandRatio

double getExpandRatio()
                      throws IOException,
                             AutomationException
Ratio used to expand the extent.

Remarks

Use ExpandRatio to add a "buffer" around the requested geographic extent. For example, an ExpandRatio value of 1.5 will expand the map extent by 1.5 times.ExpandRatio should be used to ensure that the set of features can be viewed easily. Otherwise, some features may be at the very edge of the displayed map extent. If the ExpandRatio is not set (the default value is 1) some of the selected features will be located at the very edge of the map image. A number greater than 1 will "zoom out", providing a spatial buffer around the selected features. A number less than 1 will "zoom in".

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The ratio
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExpandRatio

void setExpandRatio(double ratio)
                    throws IOException,
                           AutomationException
Ratio used to expand the extent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
ratio - The ratio (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultScale

double getDefaultScale()
                       throws IOException,
                              AutomationException
Scale at which the extent of a single point is drawn.

Remarks

Use DefaultScale to control the map scale when zooming to a single point feature. The DefaultScale value only affects conditions where a single point feature is selected. This value will be ignored when selecting multiple points or when selecting other feature types. If this value is not set and FeatureIDs is comprised of a single point feature, the new spatial extent may be too large.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The mapScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultScale

void setDefaultScale(double mapScale)
                     throws IOException,
                            AutomationException
Scale at which the extent of a single point is drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
mapScale - The mapScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.