com.esri.arcgis.carto
Interface IScaleMarks

All Superinterfaces:
Serializable
All Known Implementing Classes:
AlternatingScaleBar, DoubleAlternatingScaleBar, HollowScaleBar, ScaleLine, SingleDivisionScaleBar, SteppedScaleLine

public interface IScaleMarks
extends Serializable

Provides access to members that control the scale bar mark properties.

Remarks

The IScaleMarks interface manages all of the properties of a scale bar that relate to the individual marks, including the division and subdivision marks heights and symbols, the marks frequency, and their position.

On the scale bar above, the tallest marks are the divisions and the smallest the subdivisions. You can control their height by setting the DivisionMarkHeight and SubdivisionMarkHeight properties.

You can also define the line symbols used for divisions and subdivisions with DivisionMarkSymbol and SubdivisionMarkSymbol. In this example the symbols where redefined as cartographic line symbols with butt ends.

The MarkPosition is an esriVertPosEnum constant that defines the position of the marks relatively to the line. On our example it is set to esriOn which results in marks centered on the line.

The MarkFrequency is an esriScaleBarFrequency constant that defines on which divisions and subdivisions the marks will be shown. Our example uses the value esriScaleBarDivisionsAndFirstSubdivisions to display the subdivisions only between the first divisions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 double getDivisionMarkHeight()
          Height of division marks in points (1/72 inch).
 ILineSymbol getDivisionMarkSymbol()
          Symbol used to draw the division marks.
 int getMarkFrequency()
          Mark frequency.
 int getMarkPosition()
          Vertical positioning of the marks relative to the bar.
 double getSubdivisionMarkHeight()
          Height of subdivision marks in points (1/72 inch).
 ILineSymbol getSubdivisionMarkSymbol()
          Symbol used to draw the subdivision marks.
 void setDivisionMarkHeight(double points)
          Height of division marks in points (1/72 inch).
 void setDivisionMarkSymbol(ILineSymbol symbol)
          Symbol used to draw the division marks.
 void setMarkFrequency(int frequency)
          Mark frequency.
 void setMarkPosition(int position)
          Vertical positioning of the marks relative to the bar.
 void setSubdivisionMarkHeight(double points)
          Height of subdivision marks in points (1/72 inch).
 void setSubdivisionMarkSymbol(ILineSymbol symbol)
          Symbol used to draw the subdivision marks.
 

Method Detail

getDivisionMarkSymbol

ILineSymbol getDivisionMarkSymbol()
                                  throws IOException,
                                         AutomationException
Symbol used to draw the division marks.

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.ILineSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDivisionMarkSymbol

void setDivisionMarkSymbol(ILineSymbol symbol)
                           throws IOException,
                                  AutomationException
Symbol used to draw the division marks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSubdivisionMarkSymbol

ILineSymbol getSubdivisionMarkSymbol()
                                     throws IOException,
                                            AutomationException
Symbol used to draw the subdivision marks.

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.ILineSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubdivisionMarkSymbol

void setSubdivisionMarkSymbol(ILineSymbol symbol)
                              throws IOException,
                                     AutomationException
Symbol used to draw the subdivision marks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDivisionMarkHeight

double getDivisionMarkHeight()
                             throws IOException,
                                    AutomationException
Height of division marks in points (1/72 inch). Use esriAutoScaleBar to automatically calculate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDivisionMarkHeight

void setDivisionMarkHeight(double points)
                           throws IOException,
                                  AutomationException
Height of division marks in points (1/72 inch). Use esriAutoScaleBar to automatically calculate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSubdivisionMarkHeight

double getSubdivisionMarkHeight()
                                throws IOException,
                                       AutomationException
Height of subdivision marks in points (1/72 inch). Use esriAutoScaleBar to automatically calculate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSubdivisionMarkHeight

void setSubdivisionMarkHeight(double points)
                              throws IOException,
                                     AutomationException
Height of subdivision marks in points (1/72 inch). Use esriAutoScaleBar to automatically calculate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMarkPosition

int getMarkPosition()
                    throws IOException,
                           AutomationException
Vertical positioning of the marks relative to the bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriVertPosEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMarkPosition

void setMarkPosition(int position)
                     throws IOException,
                            AutomationException
Vertical positioning of the marks relative to the bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
position - A com.esri.arcgis.carto.esriVertPosEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMarkFrequency

int getMarkFrequency()
                     throws IOException,
                            AutomationException
Mark frequency.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriScaleBarFrequency constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMarkFrequency

void setMarkFrequency(int frequency)
                      throws IOException,
                             AutomationException
Mark frequency.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
frequency - A com.esri.arcgis.carto.esriScaleBarFrequency constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.