Документация
Справочник JavaScript API
2.1.64 (текущая версия)
collection
interactivityModel
Интерфейсы

geometry.base.Circle

Расширяет IBaseCircleGeometry.

Базовая геометрия "Круг".

Конструктор | Поля | События | Методы

Конструктор

geometry.base.Circle([coordinates[, radius]])

Параметры:

ПараметрЗначение по умолчаниюОписание
coordinates null

Тип: Number[]|null

Координаты центра круга.

radius 0

Тип: Number

Радиус круга.

Пример:

var myCircle = new ymaps.geometry.base.Circle([0, 0], 10);
myCircle.events.add('change', function () {
    alert('Геометрия изменилась');
});
myCircle.freeze();
myCircle.setCoordinates([10, 10]);
myCircle.setRadius(20);
// В этот момент будет сгенерировано единственное событие, и будет выведено сообщение.
myCircle.unfreeze();

Поля

ИмяТипОписание
events event.Manager

Менеджер событий геометрии.

События

ИмяОписание
change

Изменение координат. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • oldCoordinates - старые координаты центра;
  • newCoordinates - новые координаты центра;
  • oldRadius - старый радиус;
  • newRadius - новый радиус.

Унаследовано от ICircleGeometryAccess.

Методы

ИмяВозвращаетОписание
contains(position)

Boolean

Проверяет, лежит ли переданная точка внутри круга.

Унаследован от ICircleGeometryAccess.

freeze()

IFreezable

Переводит объект в "замороженный" режим.

Унаследован от IFreezable.

getBounds()

Number[][]|null

Возвращает координаты двух противоположных углов области, охватывающей геометрию. Первый элемент массива - угол с наименьшими значениями координат относительно остальных точек области; второй элемент - угол с наибольшими значениями координат.

Унаследован от IBaseGeometry.

getClosest(anchorPosition)

Object

Ищет на окружности точку, ближайшую к anchorPosition.

Унаследован от ICircleGeometryAccess.

getCoordinates()

Number[]|null

Возвращает координаты центра круга.

Унаследован от ICircleGeometryAccess.

getRadius()

Number

Возвращает радиус круга.

Унаследован от ICircleGeometryAccess.

getType()

String

Возвращает строку "Circle".

Унаследован от IBaseCircleGeometry.

isFrozen()

Boolean

Возвращает true, если объект находится в "замороженном" режиме, иначе false.

Унаследован от IFreezable.

setCoordinates(coordinates)

ICircleGeometryAccess

Задает координаты центра круга.

Унаследован от ICircleGeometryAccess.

setRadius(radius)

ICircleGeometryAccess

Задает радиус круга.

Унаследован от ICircleGeometryAccess.

unfreeze()

IFreezable

Переводит объект в активный режим.

Унаследован от IFreezable.

Описание полей

events

{event.Manager} events

Менеджер событий геометрии.