com.esri.arcgis.display
Interface IDisplayTransformationScales

All Superinterfaces:

Serializable

All Known Implementing Classes:

DisplayTransformation

public interface IDisplayTransformationScales
extends Serializable

Provides access to members that control Display Transformation scales.

Product Availability

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

Method Summary

void	addUserScale(double scale) Add a new user scale.
double	calculateScale(IEnvelope extent) Calculate the scale of the specified extent.
int	getScaleSnapping() Indicates if transform snaps the fitted bounds to a standard scale.
double	getUserScale(int idx) Get the user scales.
int	getUserScaleCount() Get the number of user scales.
void	loadDefaultUserScales() Initialize user scales to defaults.
double	nextScale(double scale) Find the nearest standard scale with a value that is higher than the specified scale.
double	previousScale(double scale) Find the nearest standard scale with a value that is lower than the specified scale.
void	removeAllUserScales() Remove all the user scales.
void	removeUserScale(double scale) Remove a user scale.
void	saveDefaultUserScales() Set the current set of user scales to be the defaults.
void	setScaleSnapping(int setting) Indicates if transform snaps the fitted bounds to a standard scale.
double	snapScale(double scale) Snap the specified scale to a standard scale.
void	zoomTo(IEnvelope extent, double scale) Zoom to the specified scale.

Method Detail

getScaleSnapping

int getScaleSnapping()
                     throws IOException,
                            AutomationException

Indicates if transform snaps the fitted bounds to a standard scale.

Product Availability

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

Returns:

A com.esri.arcgis.display.esriScaleSnapping constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setScaleSnapping

void setScaleSnapping(int setting)
                      throws IOException,
                             AutomationException

Indicates if transform snaps the fitted bounds to a standard scale.

Product Availability

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

Parameters:

setting - A com.esri.arcgis.display.esriScaleSnapping constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserScaleCount

int getUserScaleCount()
                      throws IOException,
                             AutomationException

Get the number of user scales.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserScale

double getUserScale(int idx)
                    throws IOException,
                           AutomationException

Get the user scales.

Product Availability

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

Parameters:

idx - The idx (in)

Returns:

The scale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addUserScale

void addUserScale(double scale)
                  throws IOException,
                         AutomationException

Add a new user scale.

Product Availability

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

Parameters:

scale - The scale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeUserScale

void removeUserScale(double scale)
                     throws IOException,
                            AutomationException

Remove a user scale.

Product Availability

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

Parameters:

scale - The scale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllUserScales

void removeAllUserScales()
                         throws IOException,
                                AutomationException

Remove all the user scales.

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.

loadDefaultUserScales

void loadDefaultUserScales()
                           throws IOException,
                                  AutomationException

Initialize user scales to defaults.

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.

saveDefaultUserScales

void saveDefaultUserScales()
                           throws IOException,
                                  AutomationException

Set the current set of user scales to be the defaults.

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.

calculateScale

double calculateScale(IEnvelope extent)
                      throws IOException,
                             AutomationException

Calculate the scale of the specified extent.

Product Availability

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

Parameters:

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Returns:

The scale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomTo

void zoomTo(IEnvelope extent,
            double scale)
            throws IOException,
                   AutomationException

Zoom to the specified scale. Center on extent.

Product Availability

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

Parameters:

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

scale - The scale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

snapScale

double snapScale(double scale)
                 throws IOException,
                        AutomationException

Snap the specified scale to a standard scale.

Product Availability

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

Parameters:

scale - The scale (in)

Returns:

The snappedScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextScale

double nextScale(double scale)
                 throws IOException,
                        AutomationException

Find the nearest standard scale with a value that is higher than the specified scale.

Product Availability

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

Parameters:

scale - The scale (in)

Returns:

The nextScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

previousScale

double previousScale(double scale)
                     throws IOException,
                            AutomationException

Find the nearest standard scale with a value that is lower than the specified scale.

Product Availability

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

Parameters:

scale - The scale (in)

Returns:

The previousScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.