ICircleGeometry

Extends ICircleGeometryAccess, IGeometry.

Interface for the "Circle" geometry.

Constructor | Fields | Events | Methods

Constructor

ICircleGeometry()

Fields

Name Type Description
events IEventManager

Event manager.

Inherited from IEventEmitter.

options IOptionManager

Options manager.

Inherited from ICustomizable.

Events

Name Description
change
Changed coordinates. Instance of the Event class. Names of fields that are available via the Event.get method:
  • oldCoordinates - Old coordinates of the center.
  • newCoordinates - New coordinates of the center.
  • oldRadius - Old radius.
  • newRadius - New radius.

Inherited from ICircleGeometryAccess.

mapchange
Map reference changed. Instance of the Event class. Names of fields that are available via the Event.get method:
  • oldMap - Old map.
  • newMap - New map.

Inherited from IGeometry.

optionschange

Change to the object options.

Inherited from ICustomizable.

pixelgeometrychange
The pixel geometry changed. Instance of the Event class. Names of fields that are available via the Event.get method:

Inherited from IGeometry.

Methods

Name Returns Description
contains(position)

Boolean

Checks whether the passed point is located inside the circle.

Inherited from ICircleGeometryAccess.

freeze()

IFreezable

Switches the object to "frozen" mode.

Inherited from IFreezable.

getBounds()

Number[][]|null

Returns coordinates of the two opposite corners of the area that surrounds the geometry. The first item in the array is the southwest corner of the area; the second item is the northeast corner.

Inherited from IGeometry.

getClosest(anchorPosition)

Object

Searches for a point on the circle closest to the anchorPosition.

Inherited from ICircleGeometryAccess.

getCoordinates()

Number[]|null

Returns coordinates of the center of the circle.

Inherited from ICircleGeometryAccess.

getMap()

Map|null

Returns the current map.

Inherited from IGeometry.

getPixelGeometry([options])

IPixelGeometry

Returns the pixel geometry corresponding to the given geometry, its options, and the map state.

Inherited from IGeometry.

getRadius()

Number

Returns radius of the circle.

Inherited from ICircleGeometryAccess.

getType()

String

Returns the "Circle" string.

isFrozen()

Boolean

Returns true if the object is in "frozen" mode, otherwise false.

Inherited from IFreezable.

setCoordinates(coordinates)

ICircleGeometryAccess

Sets the coordinates of the center of the circle.

Inherited from ICircleGeometryAccess.

setMap(map)

Sets the map.

Inherited from IGeometry.

setRadius(radius)

ICircleGeometryAccess

Sets the radius of the circle.

Inherited from ICircleGeometryAccess.

unfreeze()

IFreezable

Switches the object to active mode.

Inherited from IFreezable.

Methods details

getType

{String} getType()

Returns the "Circle" string.