ICircleGeometryAccess
Расширяет IFreezable.
Интерфейс доступа к геометрии "Круг".
Конструктор | Поля | События | Методы
Конструктор
ICircleGeometryAccess()Поля
| Имя | Тип | Описание |
|---|---|---|
| events | IEventManager | Менеджер событий объекта. Унаследовано от IFreezable. |
| Имя | Тип | Описание |
|---|---|---|
| events | IEventManager | Менеджер событий объекта. Унаследовано от IFreezable. |
События
Методы
| Имя | Возвращает | Описание |
|---|---|---|
| contains(position) | Boolean | Проверяет, лежит ли переданная точка внутри круга. |
| freeze() | Переводит объект в "замороженный" режим. Унаследован от IFreezable. | |
| getClosest(anchorPosition) | Object | Ищет на окружности точку, ближайшую к anchorPosition. |
| getCoordinates() | Number[]|null | Returns координаты центра круга. |
| getRadius() | Number | Returns радиус круга. |
| isFrozen() | Boolean | Returns true, если объект находится в "замороженном" режиме, иначе false. Унаследован от IFreezable. |
| setCoordinates(coordinates) | Задает координаты центра круга. | |
| setRadius(radius) | Задает радиус круга. | |
| unfreeze() | Переводит объект в активный режим. Унаследован от IFreezable. |
| Имя | Возвращает | Описание |
|---|---|---|
| contains(position) | Boolean | Проверяет, лежит ли переданная точка внутри круга. |
| freeze() | Переводит объект в "замороженный" режим. Унаследован от IFreezable. | |
| getClosest(anchorPosition) | Object | Ищет на окружности точку, ближайшую к anchorPosition. |
| getCoordinates() | Number[]|null | Returns координаты центра круга. |
| getRadius() | Number | Returns радиус круга. |
| isFrozen() | Boolean | Returns true, если объект находится в "замороженном" режиме, иначе false. Унаследован от IFreezable. |
| setCoordinates(coordinates) | Задает координаты центра круга. | |
| setRadius(radius) | Задает радиус круга. | |
| unfreeze() | Переводит объект в активный режим. Унаследован от IFreezable. |
Описание событий
change
- oldCoordinates - старые координаты центра;
- newCoordinates - новые координаты центра;
- oldRadius - старый радиус;
- newRadius - новый радиус.
Описание методов
contains
{Boolean} contains(position)Проверяет, лежит ли переданная точка внутри круга.
Returns признак принадлежности точки кругу.
Параметры:
* Обязательный параметр/опция.
Пример:
var myCircle = new ymaps.geometry.base.Circle([0, 0], 10);
myCircle.contains([0, 10]); // => truegetClosest
{Object} getClosest(anchorPosition)Ищет на окружности точку, ближайшую к anchorPosition.
- position - точка на окружности, ближайшая к anchorPosition;
- distance - расстояние от anchorPosition до position;
Параметры:
| Параметр | Значение по умолчанию | Описание |
|---|---|---|
| anchorPosition * | — | Тип: Number[] Координаты точки, для которой расчитывается ближайшая точка на окружности. |
| Параметр | Значение по умолчанию | Описание |
|---|---|---|
| anchorPosition * | — | Тип: Number[] Координаты точки, для которой расчитывается ближайшая точка на окружности. |
* Обязательный параметр/опция.
Пример:
var myCircle = new ymaps.geometry.base.Circle([0, 0], 10);
myCircle.getClosest([0, 15]).position; // => [0, 10]getCoordinates
{Number[]|null} getCoordinates()Returns координаты центра круга.
getRadius
{Number} getRadius()Returns радиус круга.
setCoordinates
{ICircleGeometryAccess} setCoordinates(coordinates)Задает координаты центра круга.
Returns ссылку на себя.
Параметры:
| Параметр | Значение по умолчанию | Описание |
|---|---|---|
| coordinates * | — | Тип: Number[]|null Координаты центра круга. |
| Параметр | Значение по умолчанию | Описание |
|---|---|---|
| coordinates * | — | Тип: Number[]|null Координаты центра круга. |
* Обязательный параметр/опция.
setRadius
{ICircleGeometryAccess} setRadius(radius)Задает радиус круга.
Returns ссылку на себя.
Параметры:
* Обязательный параметр/опция.