com.esri.arcgis.carto
Interface INorthArrow

All Superinterfaces:
IMapSurround, Serializable
All Known Implementing Classes:
MarkerNorthArrow

public interface INorthArrow
extends IMapSurround, Serializable

Provides access to members that control the north arrow.

Remarks

The INorthArrow interface provides a common interface for North arrow properties, such as size, color, and reference location.

IMarkerNorthArrow provides access to the MarkerSymbol used to draw the North Arrow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 double getAngle()
          The counter-clockwise rotation of the north arrow in degrees.
 double getCalibrationAngle()
          Calibration angle.
 IColor getColor()
          Color used to draw the north arrow.
 IPoint getReferenceLocation()
          The point on the map where north is calculated.
 double getSize()
          Size of the north arrow in points (1/72 inch).
 void setCalibrationAngle(double degrees)
          Calibration angle.
 void setColor(IColor color)
          Color used to draw the north arrow.
 void setReferenceLocationByRef(IPoint point)
          The point on the map where north is calculated.
 void setSize(double pointSize)
          Size of the north arrow in points (1/72 inch).
 
Methods inherited from interface com.esri.arcgis.carto.IMapSurround
delayEvents, draw, fitToBounds, getIcon, getMap, getName, queryBounds, refresh, setMapByRef, setName
 

Method Detail

getColor

IColor getColor()
                throws IOException,
                       AutomationException
Color used to draw the north arrow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setColor

void setColor(IColor color)
              throws IOException,
                     AutomationException
Color used to draw the north arrow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSize

double getSize()
               throws IOException,
                      AutomationException
Size of the north arrow in points (1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSize

void setSize(double pointSize)
             throws IOException,
                    AutomationException
Size of the north arrow in points (1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getAngle

double getAngle()
                throws IOException,
                       AutomationException
The counter-clockwise rotation of the north arrow in degrees. This value is calculated from the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getCalibrationAngle

double getCalibrationAngle()
                           throws IOException,
                                  AutomationException
Calibration angle. Rotation is modified by this angle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCalibrationAngle

void setCalibrationAngle(double degrees)
                         throws IOException,
                                AutomationException
Calibration angle. Rotation is modified by this angle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getReferenceLocation

IPoint getReferenceLocation()
                            throws IOException,
                                   AutomationException
The point on the map where north is calculated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setReferenceLocationByRef

void setReferenceLocationByRef(IPoint point)
                               throws IOException,
                                      AutomationException
The point on the map where north is calculated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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