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

ICircleGeometryAccess

Расширяет IFreezable.

Интерфейс доступа к геометрии "Круг".

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

Конструктор

ICircleGeometryAccess()

Поля

ИмяТипОписание
events IEventManager

Менеджер событий объекта.

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

События

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

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

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

Методы

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

Boolean

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

freeze()

IFreezable

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

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

getClosest(anchorPosition)

Object

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

getCoordinates()

Number[]|null

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

getRadius()

Number

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

isFrozen()

Boolean

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

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

setCoordinates(coordinates)

ICircleGeometryAccess

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

setRadius(radius)

ICircleGeometryAccess

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

unfreeze()

IFreezable

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

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

Описание событий

change

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

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

Описание методов

contains

{Boolean} contains(position)

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

Возвращает признак принадлежности точки кругу.

Параметры:

ПараметрЗначение по умолчаниюОписание
position *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: Number[]

Координаты точки.

* Обязательный параметр/опция.

Пример:

var myCircle = new ymaps.geometry.base.Circle([0, 0], 10);
myCircle.contains([0, 10]); // => true

getClosest

{Object} getClosest(anchorPosition)

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

Возвращает объект со следующими полями:

  • position - точка на окружности, ближайшая к anchorPosition;
  • distance - расстояние от anchorPosition до position;
.

Параметры:

ПараметрЗначение по умолчаниюОписание
anchorPosition *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: Number[]

Координаты точки, для которой расчитывается ближайшая точка на окружности.

* Обязательный параметр/опция.

Пример:

var myCircle = new ymaps.geometry.base.Circle([0, 0], 10);
myCircle.getClosest([0, 15]).position; // => [0, 10]

getCoordinates

{Number[]|null} getCoordinates()

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

getRadius

{Number} getRadius()

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

setCoordinates

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

Возвращает cсылку на себя.

Параметры:

ПараметрЗначение по умолчаниюОписание
coordinates *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: Number[]|null

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

* Обязательный параметр/опция.

setRadius

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

Возвращает cсылку на себя.

Параметры:

ПараметрЗначение по умолчаниюОписание
radius *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: Number

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

* Обязательный параметр/опция.