geometry.Rectangle

Расширяет IRectangleGeometry .

Геометрия "Прямоугольник".

См.: Rectangle

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

Конструктор

geometry.Rectangle([coordinates[, options]])

Параметры:

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

Тип: Number[][]|null

Массив, содержащий координаты двух противоположных углов прямоугольника.

options

Тип: Object

Опции геометрии.

options.coordRendering

Тип: String

Строковый идентификатор, определяющий алгоритм пересчета координат геометрии в пиксельные координаты. Для геометрии "Прямоугольник" может принимать одно из трех значений:
  • shortestPath - алгоритм, учитывающий зацикленность проекции по осям, и формирующий пиксельные координаты так, чтобы расстояние между противоположными углами было минимальным;
  • straightPath - алгоритм, не учитывающий зацикленность проекции;
  • boundsPath - алгоритм, трактующий координаты углов прямоугольника, как координаты соответственно нижнего и верхнего углов ограничивающей области. При расчете диагонали по зацикленным осям проекции всегда выбирается направление обхода против часовой стрелки.
options.geodesic false

Тип: Boolean

Включает отображение с использованием геодезических линий.

options.pixelRendering "jumpy"

Тип: String

Метод расчета пиксельных координат отображения в зацикленных проекциях. Опция может принимать одно из следующих значений:
  • jumpy - отображение располагается как можно ближе к центру области показа карты и может скачкообразно перемещается во время движения карты;
  • static - отображение всегда располагается в начальном мире и не перемещается при движении карты.
options.projection

Тип: IProjection

Проекция.

Пример:

// Создаем инстанцию геометрии прямоугольника (указываем координаты противоположных углов).
var rectangleGeometry = new ymaps.geometry.Rectangle([[30, 50], [31, 51]]),
// Создаем инстанцию геообъекта и передаем нашу геометрию в конструктор.
    rectangleGeoObject = new ymaps.GeoObject({ geometry: rectangleGeometry });

// Изменяем координаты через свойство geometry геообъекта.
rectangleGeoObject.geometry.setCoordinates([[10, 20], [51, 71]]);
// Или напрямую.
rectangleGeometry.setCoordinates([[10, 20], [51, 71]]);
// Также доступ к rectangleGeometry можно получить через rectangleGeoObject.geometry.

Поля

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

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

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

options IOptionManager

Менеджер опций.

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

События

Имя Описание
change
Изменение координат углов. Экземпляр класса Event . Имена полей, доступных через метод Event.get :
  • oldCoordinates - старые координаты углов;
  • newCoordinates - новые координаты углов.

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

mapchange
Сменилась карта. Экземпляр класса Event . Имена полей, доступных через метод Event.get :
  • oldMap - старая карта;
  • newMap - новая карта.

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

optionschange

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

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

pixelgeometrychange
Изменилась пиксельная геометрия. Экземпляр класса Event . Имена полей, доступных через метод Event.get :
  • pixelGeometry - новая пиксельная геометрия IPixelGeometry .

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

Методы

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

Boolean

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

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

freeze ()

IFreezable

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

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

getBounds ()

Number[][]|null

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

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

getClosest (anchorPosition)

Object

Ищет на контуре прямоугольника точку, ближайшую к anchorPosition.

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

getCoordinates ()

Number[][]

Возвращает координаты двух противоположных углов прямоугольника.

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

getMap ()

Map |null

Возвращает текущую карту.

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

getPixelGeometry ([options])

IPixelGeometry

Возвращает пиксельную геометрию, соответствующую данной геометрии, ее опциям и состоянию карты.

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

getType ()

String

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

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

isFrozen ()

Boolean

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

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

setCoordinates (coordinates)

IRectangleGeometryAccess

Задает координаты двух противоположных углов прямоугольника.

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

setMap (map)

Задает карту.

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

unfreeze ()

IFreezable

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

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