Circle

Расширяет GeoObject.

Круг. Представляет собой геообъект с геометрией geometry.Circle.

См.: GeoObject geometry.Circle

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

Конструктор

Создает экземпляр круга.

Параметры:

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

Тип: ICircleGeometry|Number[][]|Object

Ссылка на объект геометрии точки или массив, первый элемент которого координаты центра круга, второй - радиус в метрах, или объект с параметрами геометрии.

properties

Тип: Object|IDataManager

Данные круга. Соответствуют данным класса GeoObject. Могут задаваться как экземпляр класса, реализующего интерфейс IDataManager, либо в виде хэша. При значениях опций по умолчанию кругу трактуются следующие поля данных:
  • hintContent - содержимое всплывающей подсказки круга;
  • balloonContent - содержимое балуна круга;
  • balloonContentHeader - содержимое заголовка балуна круга;
  • balloonContentBody - содержимое основой части балуна круга;
  • balloonContentFooter - содержимое нижней части балуна круга.
Поле balloonContent является кратким обозначением для поля balloonContentBody, но при одновременном задании balloonContentBody более приоритетен. Также вы можете дополнить данные круга своими собственными полями и использовать их везде, где это возможно. Например, в макете круга или макете балуна.
options

Тип: Object

Опции круга. Используя этот параметр можно задавать как опции самого круга, так и опции его составных частей:
  • Опции балуна круга с префиксом balloon.
  • Опции всплывающей подсказки круга с префиксом hint.
  • Опции редактора геометрии круга с префиксом editor. Смотрите описание класса geometryEditor.Circle.
  • Опции геометрии могут задаваться без префикса. Смотрите описание класса IGeometry геометрии geometry.Circle.
options.circleOverlay "default#circle"

Тип: String|Function

Ключ-идентификатор из хранилища overlay.storage или класс оверлея. Функция-генератор принимает три параметра:
  • geometry: IPixelCircleGeometry - непосредственно пиксельная геометрия;
  • data: Object - данные оверлея;
  • options: Object - опции оверлея.
Функция возвращает объект vow.Promise.
options.cursor "pointer"

Тип: String

Вид курсора над кругом.

options.draggable false

Тип: Boolean

Определяет возможность перетаскивания круга.

options.fill true

Тип: Boolean

Наличие заливки фигуры.

options.fillColor "0066ff99"

Тип: String

Цвет заливки.

options.fillImageHref

Тип: String

Фоновое изображение. При включении данной опции в режиме заливки stretch значение опции fillColor игнорируется.

options.fillMethod 'stretch'

Тип: String

Тип заливки фоном. Может принимать одно из двух значений:
  • stretch - фоновое изображение растягивается по размеру оверлея.
  • tile - Фоновое изображение повторяется без изменений размера. Аналог background-repeat в css. Можно использовать для заливки фигуры неким шаблоном.
options.fillOpacity 1

Тип: Number

Прозрачность заливки.

options.hasBalloon true

Тип: Boolean

Определяет наличие поля balloon у круга.

options.hasHint true

Тип: Boolean

Определяет наличие поля hint у круга.

options.hideIconOnBalloonOpen true

Тип: Boolean

Скрывать иконку при открытии балуна.

options.interactiveZIndex false

Тип: Boolean

Включает режим автоматического изменения z-index круга в зависимости от его состояния.

options.interactivityModel "default#geoObject"

Тип: String

Модель интерактивности. Доступные ключи и их значения перечислены в описании interactivityModel.storage.

options.opacity 1

Тип: Number

Прозрачность.

options.openBalloonOnClick true

Тип: Boolean

Определяет, показывать ли балун при щелчке на круге.

options.openEmptyBalloon false

Тип: Boolean

Определяет, показывать ли пустой балун при щелчке на круге.

options.openEmptyHint false

Тип: Boolean

Определяет, показывать ли пустой хинт при наведении указателя мыши на круг.

options.openHintOnHover true

Тип: Boolean

Определяет, показывать ли хинт при наведении указателя мыши на круг.

options.outline true

Тип: Boolean

Наличие обводки круга.

options.pane "areas"

Тип: String

Ключ пейна, в который помещается оверлей круга.

options.strokeColor "0066ffff"

Тип: String|String[]

Цвет линии или обводки. Можно задать несколько значений для множественной обводки.

options.strokeOpacity 1

Тип: Number|Number[]

Прозрачность линии или обводки. Можно задать несколько значений для множественной обводки.

options.strokeStyle

Тип: String|Object|String[]|Object[]

Стиль линии или обводки. Можно задать несколько значений для множественной обводки.

options.strokeWidth 1

Тип: Number|Number[]

Толщина линии или обводки. Можно задать несколько значений для множественной обводки.

options.syncOverlayInit false

Тип: Boolean

Включает синхронное добавление оверлея на карту. По умолчанию добавление оверлея осуществляется асинхронно, что позволяет предотвратить зависания браузера при добавлении на карту большого числа геообъектов. Однако, асинхронное добавление не позволяет получать доступ к оверлею сразу после добавления круга на карту.

options.useMapMarginInDragging true

Тип: Boolean

При перетаскивании объекта к краю карты происходит автоматическое изменение центра карты. Нужно ли учитывать отступы карты при автоматическом смещении центра карты map.margin.Manager.

options.visible true

Тип: Boolean

Определяет видимость круга.

options.zIndex

Тип: Number

z-index круга в обычном состоянии. Наименее приоритетный.

options.zIndexActive

Тип: Number

z-index круга с открытым балуном. Наиболее приоритетный.

options.zIndexDrag

Тип: Number

z-index круга при перетаскивании.

options.zIndexHover

Тип: Number

z-index круга при наведении на него указателя мыши.

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

Пример:

// Создаем геодезический круг радиусом 1000 километров.
var circle = new ymaps.Circle([[50, 75], 1000000], {}, {
    geodesic: true
});
// Добавляем круг на карту.
myMap.geoObjects.add(circle);

Поля

Имя Тип Описание
balloon geoObject.Balloon

Балун геообъекта.

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

editor geometryEditor.Circle

Редактор геометрии "Круг".

events event.Manager

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

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

geometry geometry.Circle

Геометрия типа "Круг".

hint geoObject.Hint

Хинт геообъекта.

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

indices ArrayBuffer
options option.Manager

Менеджер опций геообъекта.

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

properties data.Manager

Менеджер данных геообъекта.

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

state data.Manager
Состояние геообъекта. Определяется следующими полями:
  • active: Boolean - признак того, что на геообъекте открыт балун.
  • hover: Boolean - признак того, что в данный момент на геообъект наведен указатель мыши;
  • drag: Boolean - признак того, что в данный момент геообъект перетаскивается.

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

vertices ArrayBuffer

События

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

Закрытие балуна. Экземпляр класса Event.

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

balloonopen

Открытие балуна на геообъекте. Экземпляр класса Event.

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

beforedrag
Событие, предшествующее событию drag. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • position - координаты относительно документа. Массива вида [pageX, pageY];
  • pixelOffset - массив из двух чисел, описывающий пиксельный сдвиг на данном шаге;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.
Имена методов, доступных через метод Event.callMethod:
  • setPixelOffset - метод, позволяющий скорректировать значение пиксельного сдвига, который будет фактически применен. В качестве аргумента принимает новый пиксельный сдвиг в виде массива из двух чисел.
Если у данного события вызвать метод Event.preventDefault, то последующее событие "drag" будет отменено.

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

beforedragstart
Событие, предшествующее событию dragstart. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • position - координаты относительно документа. Массива вида [pageX, pageY];
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.
Если у данного события вызвать метод Event.preventDefault, то последующее перетаскивание, как и событие "dragstart", будет отменено.

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

click

Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager.

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

contextmenu

Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager.

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

dblclick

Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager.

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

drag
Перетаскивание геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • position - координаты относительно документа. Массива вида [pageX, pageY];
  • pixelOffset - массив из двух чисел, описывающий пиксельный сдвиг на данном шаге;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

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

dragend
Завершение перетаскивания геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • position - координаты относительно документа. Массива вида [pageX, pageY];
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

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

dragstart
Начало перетаскивания геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • position - координаты относительно документа. Массива вида [pageX, pageY];
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

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

editorstatechange
Изменение состояния редактора геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • originalEvent - оригинальное событие редактора геометрии.

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

geometrychange
Изменение геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • originalEvent: IEvent - оригинальное событие геометрии.

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

hintclose

Закрытие хинта. Экземпляр класса Event.

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

hintopen

Открытие хинта на геообъекте. Экземпляр класса Event.

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

mapchange
Сменилась карта. Поля данных:
  • oldMap - старая карта;
  • newMap - новая карта.

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

mousedown

Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager.

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

mouseenter

Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager.

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

mouseleave

Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager.

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

mousemove

Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager.

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

mouseup

Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager.

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

multitouchend

Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent.

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

multitouchmove
Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
  • clientX - координата касания X относительно видимой области браузера;
  • clientY - координата касания Y относительно видимой области браузера;
  • pageX - координата касания X касания относительно начала документа;
  • pageY - координата касания Y касания относительно начала документа.

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

multitouchstart
Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
  • clientX - координата касания X относительно видимой области браузера;
  • clientY - координата касания Y относительно видимой области браузера;
  • pageX - координата касания X касания относительно начала документа;
  • pageY - координата касания Y касания относительно начала документа.

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

optionschange

Изменение в опциях объекта.

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

overlaychange
Изменение оверлея геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • overlay: IOverlay|null - ссылка на оверлей;
  • oldOverlay: IOverlay|null - предыдущий оверлей геообъекта.

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

parentchange

Сменился родительский объект.

Поля данных:

  • oldParent - старый родитель;
  • newParent - новый родитель.

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

propertieschange
Изменение данных геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • originalEvent: IEvent - оригинальное событие менеджера данных.

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

wheel

Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager.

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

Методы

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

Map

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

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

getOverlay()

vow.Promise

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

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

getOverlaySync()

IOverlay|null

Метод предоставляет синхронный доступ к оверлею.

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

getParent()

IParentOnMap|null

Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен.

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

setParent(parent)

IChildOnMap

Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта.

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

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

editor

Редактор геометрии "Круг".

geometry

{geometry.Circle} geometry

Геометрия типа "Круг".

indices

{ArrayBuffer} indices

vertices

{ArrayBuffer} vertices