MGMap.digitizeCircle   Go to object model Go to parent topic Go to previous topic Go to next topic

Syntax

ActiveX Control: boolean digitizeCircle(String units)

Plug-In/Java Edition: boolean digitizeCircle(String units, MGDigitizeCircleObserver observer)

Description

Enables the user to define a circle on the map by clicking and dragging the mouse.

It fires the onDigitizedCircle event upon completion. The digitizeCircle method does not perform any functions other than sending the circle coordinates to onDigitizedCircle.

For Autodesk MapGuide Viewer Plug-In, the observer parameter specifies the object that either handles the event or forwards it back to JavaScript.

Note that this method does not work during a busy state. For additional information about the busy state, refer to "Handling Busy State and Map Refresh" chapter in the Autodesk MapGuide Developer's Guide.

Parameters

units - Units to specify radius in, one of the following codes: M (meters), KM (kilometers), FT (feet), MI (miles), "", or null. "" and null apply to the Autodesk MapGuide Viewer Plug-In and Java Edition only. They use the current default units.

observer - A Java object that implements MGDigitizeCircleObserver (Plug-In and Java Edition only).

Returns

boolean - Returns True if successful; otherwise, returns False.

Error Codes

-1 (busy)

-3 (illegal argument)

See Also

digitizePoint, digitizePolygonEx, digitizePolylineEx