geometry.Circle
Расширяет ICircleGeometry.
Геометрия "Круг".
См.: Circle
Конструктор | Поля | События | Методы
Конструктор
geometry.Circle([coordinates[, radius[, options]]])
Параметры:
Параметр | Значение по умолчанию | Описание |
---|---|---|
coordinates | null | Тип: Number[]|null Координаты центра круга. |
radius | 0 | Тип: Number Радиус круга в метрах. |
options | — | Тип: Object Опции геометрии. |
options.geodesic | false | Тип: Boolean Включает отображение с использованием геодезических линий. |
options.pixelRendering | "jumpy" | Тип: String Метод расчета пиксельных координат отображения в зацикленных проекциях.
Опция может принимать одно из следующих значений:
|
options.projection | — | Тип: IProjection Проекция. |
Параметр | Значение по умолчанию | Описание |
---|---|---|
coordinates | null | Тип: Number[]|null Координаты центра круга. |
radius | 0 | Тип: Number Радиус круга в метрах. |
options | — | Тип: Object Опции геометрии. |
options.geodesic | false | Тип: Boolean Включает отображение с использованием геодезических линий. |
options.pixelRendering | "jumpy" | Тип: String Метод расчета пиксельных координат отображения в зацикленных проекциях.
Опция может принимать одно из следующих значений:
|
options.projection | — | Тип: IProjection Проекция. |
Пример:
// Создаем экземпляр класса геометрии круга (указываем координаты и радиус в метрах).
var circleGeometry = new ymaps.geometry.Circle([30, 50], 10),
// Создаем экземпляр класса геообъекта и передаем нашу геометрию в конструктор.
circleGeoObject = new ymaps.GeoObject({ geometry: circleGeometry });
// Изменяем радиус геометрии через свойство geometry геообъекта.
circleGeoObject.geometry.setRadius(5)
// Или напрямую.
circleGeometry.setRadius(5);
// Также доступ к circleGeometry можно получить через circleGeoObject.geometry.
Поля
Имя | Тип | Описание |
---|---|---|
events | IEventManager | Менеджер событий. Унаследовано от IEventEmitter. |
options | IOptionManager | Менеджер опций. Унаследовано от ICustomizable. |
Имя | Тип | Описание |
---|---|---|
events | IEventManager | Менеджер событий. Унаследовано от IEventEmitter. |
options | IOptionManager | Менеджер опций. Унаследовано от ICustomizable. |
События
Имя | Описание |
---|---|
change | Изменение координат.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от ICircleGeometryAccess. |
mapchange | Сменилась карта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от IGeometry. |
optionschange | Изменение в опциях объекта. Унаследовано от ICustomizable. |
pixelgeometrychange | Изменилась пиксельная геометрия.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от IGeometry. |
Имя | Описание |
---|---|
change | Изменение координат.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от ICircleGeometryAccess. |
mapchange | Сменилась карта.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от IGeometry. |
optionschange | Изменение в опциях объекта. Унаследовано от ICustomizable. |
pixelgeometrychange | Изменилась пиксельная геометрия.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
Унаследовано от IGeometry. |
Методы
Имя | Возвращает | Описание |
---|---|---|
contains(position) | Boolean | Проверяет, лежит ли переданная точка внутри круга. Унаследован от ICircleGeometryAccess. |
freeze() | Переводит объект в "замороженный" режим. Унаследован от IFreezable. | |
getBounds() | Number[][]|null | Returns координаты двух противоположных углов области, охватывающей геометрию. Первый элемент массива - юго-западный угол области; второй элемент - северо-восточный угол соответственно. Унаследован от IGeometry. |
getClosest(anchorPosition) | Object | Ищет на окружности точку, ближайшую к anchorPosition. Унаследован от ICircleGeometryAccess. |
getCoordinates() | Number[]|null | Returns координаты центра круга. Унаследован от ICircleGeometryAccess. |
getMap() | Map|null | Returns текущую карту. Унаследован от IGeometry. |
getPixelGeometry([options]) | Returns пиксельную геометрию, соответствующую данной геометрии, ее опциям и состоянию карты. Унаследован от IGeometry. | |
getRadius() | Number | Returns радиус круга. Унаследован от ICircleGeometryAccess. |
getType() | String | Returns строку "Circle". Унаследован от ICircleGeometry. |
isFrozen() | Boolean | Returns true, если объект находится в "замороженном" режиме, иначе false. Унаследован от IFreezable. |
setCoordinates(coordinates) | Задает координаты центра круга. Унаследован от ICircleGeometryAccess. | |
setMap(map) | Задает карту. Унаследован от IGeometry. | |
setRadius(radius) | Задает радиус круга. Унаследован от ICircleGeometryAccess. | |
unfreeze() | Переводит объект в активный режим. Унаследован от IFreezable. |
Имя | Возвращает | Описание |
---|---|---|
contains(position) | Boolean | Проверяет, лежит ли переданная точка внутри круга. Унаследован от ICircleGeometryAccess. |
freeze() | Переводит объект в "замороженный" режим. Унаследован от IFreezable. | |
getBounds() | Number[][]|null | Returns координаты двух противоположных углов области, охватывающей геометрию. Первый элемент массива - юго-западный угол области; второй элемент - северо-восточный угол соответственно. Унаследован от IGeometry. |
getClosest(anchorPosition) | Object | Ищет на окружности точку, ближайшую к anchorPosition. Унаследован от ICircleGeometryAccess. |
getCoordinates() | Number[]|null | Returns координаты центра круга. Унаследован от ICircleGeometryAccess. |
getMap() | Map|null | Returns текущую карту. Унаследован от IGeometry. |
getPixelGeometry([options]) | Returns пиксельную геометрию, соответствующую данной геометрии, ее опциям и состоянию карты. Унаследован от IGeometry. | |
getRadius() | Number | Returns радиус круга. Унаследован от ICircleGeometryAccess. |
getType() | String | Returns строку "Circle". Унаследован от ICircleGeometry. |
isFrozen() | Boolean | Returns true, если объект находится в "замороженном" режиме, иначе false. Унаследован от IFreezable. |
setCoordinates(coordinates) | Задает координаты центра круга. Унаследован от ICircleGeometryAccess. | |
setMap(map) | Задает карту. Унаследован от IGeometry. | |
setRadius(radius) | Задает радиус круга. Унаследован от ICircleGeometryAccess. | |
unfreeze() | Переводит объект в активный режим. Унаследован от IFreezable. |