ShapeAPI.createCircle

long createCircle(string ck, string fc, string x, string y, double r)

This methods creates a new circle feature of radius r, with CARIS Key and Feature Code given by ck and fc, respectively.  The circle is centered at location (x, y), which must be relative to the Exchange Coordinate System, unless the map type is NRMR (See Map Types).

The circle feature is created with the current defaults for line weight, line style, fill style, and color,as well as the current default restriction.  These defaults can be modified by the ShapeAPI methods:

• overrideDefaultLineWeight

• overrideDefaultLineStyle

• overrideDefaultFillSytle

• overrideDefaultColor

• overrideDefaultRestrictProperty

respectively, by calling one or more of them prior to createCircle.

The method returns 0 upon success, and returns error codes for the following conditions:

• The given coordinates are invalid

• Placement is restricted (the default) and the given location lies outside the map’s cover

• Placement is restricted and the map has no cover (this occurs if the map has no features)

• A CSF error occurred when trying to create the feature. (This should normally not occur, and would most likely indicate a corrupted map dataset.)