Spec-Zone.ru › OpenLayers

ol/geom/Circle~Circle


import Circle from 'ol/geom/Circle.js';

Геометрия окружности.

new Circle(center, radius, layout)

geom/Circle.js, строка 15
Имя Тип Описание
center Coordinate

Центр. Для внутреннего использования также допускаются плоские координаты в сочетании с layout и без radius.

radius number | undefined

Радиус в единицах проекции.

layout GeometryLayout | undefined

Компоновка.

Генерируемые события:
  • change (BaseEvent) - Общее событие изменения. Вызывается при увеличении счётчика версий.
  • error (BaseEvent) - Общее событие ошибки. Вызывается при возникновении ошибки.
  • propertychange (ObjectEvent) - Вызывается при изменении свойства.

Наследует

  • SimpleGeometry

Методы

applyTransform(transformFn) унаследовано

geom/SimpleGeometry.js, строка 208

Применяет функцию преобразования к координатам геометрии. Геометрия изменяется на месте. Если вы не хотите изменять геометрию на месте, сначала создайте её копию с помощью clone(), а затем примените эту функцию к копии.

Имя Тип Описание
transformFn TransformFunction

Функция преобразования. Вызывается с плоским массивом координат геометрии.

changed() унаследовано

Observable.js, строка 68

Увеличивает счётчик версий и отправляет событие 'change'.

clone(){Circle}

geom/Circle.js, строка 39

Создаёт полную копию геометрии.

Возвращает:
Копия.

dispatchEvent(event){boolean | undefined} унаследовано

events/Target.js, строка 85

Отправляет событие и вызывает все обработчики, прослушивающие события этого типа. Параметр события может быть строкой или объектом со свойством type.

Имя Тип Описание
event BaseEvent | string

Объект события.

Возвращает:
false, если для объекта события был вызван preventDefault или любой из обработчиков вернул false.

get(key){*} унаследовано

Object.js, строка 136

Получает значение.

Имя Тип Описание
key string

Имя ключа.

Возвращает:
Значение.

getCenter(){Coordinate}

geom/Circle.js, строка 99

Возвращает центр окружности в виде coordinate.

Возвращает:
Центр.

getClosestPoint(point, closestPoint){Coordinate} унаследовано

geom/Geometry.js, строка 154

Возвращает ближайшую к переданной точке точку геометрии в виде coordinate.

Имя Тип Описание
point Coordinate

Точка.

closestPoint Coordinate | undefined

Ближайшая точка.

Возвращает:
Ближайшая точка.

getExtent(extent){Extent} унаследовано

geom/Geometry.js, строка 187

Получает охватывающий прямоугольник геометрии.

Имя Тип Описание
extent Extent | undefined

Охватывающий прямоугольник.

Возвращает:
extent Охватывающий прямоугольник.

getFirstCoordinate(){Coordinate} унаследовано

geom/SimpleGeometry.js, строка 69

Возвращает первую координату геометрии.

Возвращает:
Первая координата.

getKeys(){Array.<string>} унаследовано

Object.js, строка 149

Получает список имён свойств объекта.

Возвращает:
Список имён свойств.

getLastCoordinate(){Coordinate} унаследовано

geom/SimpleGeometry.js, строка 85

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

Возвращает:
Последняя точка.

getLayout(){GeometryLayout} унаследовано

geom/SimpleGeometry.js, строка 96

Возвращает layout геометрии.

Возвращает:
Раскладка.

getProperties(){NoInfer.<Properties>} унаследовано

Object.js, строка 158

Получает объект со всеми именами свойств и их значениями.

Возвращает:
Объект.

getRadius(){number}

geom/Circle.js, строка 126

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

Возвращает:
Радиус.

getRevision(){number} унаследовано

Observable.js, строка 79

Получает номер версии этого объекта. При каждом изменении объекта номер его версии увеличивается.

Возвращает:
Номер версии.

getType(){Type}

geom/Circle.js, строка 146

Получает тип этой геометрии.

Возвращает:
Тип геометрии.

intersectsCoordinate(coordinate){boolean} унаследовано

geom/Geometry.js, строка 167

Возвращает true, если эта геометрия содержит указанную координату. Если координата находится на границе геометрии, возвращает false.

Имя Тип Описание
coordinate Coordinate

Координата.

Возвращает:
Содержит ли геометрия координату.

intersectsExtent(extent){boolean}

geom/Circle.js, строка 157

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

Имя Тип Описание
extent Extent

Охватывающий прямоугольник.

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

on(type, listener){EventsKey | Array<EventsKey>} унаследовано

Observable.js, строка 152

Начинает прослушивание событий определённого типа.

Имя Тип Описание
type string | Array.<string>

Тип события или массив типов событий.

listener function

Функция-обработчик.

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

once(type, listener){EventsKey | Array<EventsKey>} унаследовано

Observable.js, строка 164

Однократно прослушивает события определённого типа.

Имя Тип Описание
type string | Array.<string>

Тип события или массив типов событий.

listener function

Функция-обработчик.

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

rotate(angle, anchor)

geom/Circle.js, строка 241

Поворачивает геометрию вокруг заданной координаты. Координаты геометрии изменяются на месте.

Имя Тип Описание
angle number

Угол поворота в радианах против часовой стрелки.

anchor Coordinate

Центр вращения.

scale(sx, sy, anchor) унаследовано

geom/SimpleGeometry.js, строка 255

Масштабирует геометрию (с необязательной точкой начала отсчёта). Координаты геометрии изменяются на месте.

Имя Тип Описание
sx number

Коэффициент масштабирования по оси x.

sy number | undefined

Коэффициент масштабирования по оси y (по умолчанию равен sx).

anchor Coordinate | undefined

Точка начала масштабирования (по умолчанию — центр охватывающего прямоугольника геометрии).

set(key, value, silent) унаследовано

Object.js, строка 218

Задаёт значение.

Имя Тип Описание
key string

Имя ключа.

value *

Значение.

silent boolean | undefined

Обновить без вызова события.

setCenter(center)

geom/Circle.js, строка 179

Задаёт центр окружности в виде coordinate.

Имя Тип Описание
center Coordinate

Центр.

setCenterAndRadius(center, radius, layout)

geom/Circle.js, строка 199

Задаёт центр окружности (в виде coordinate) и её радиус (в виде числа).

Имя Тип Описание
center Coordinate

Центр.

radius number

Радиус.

layout GeometryLayout | undefined

Раскладка.

setProperties(values, silent) унаследовано

Object.js, строка 238

Задаёт набор пар «ключ — значение». Обратите внимание: это изменяет существующие свойства и добавляет новые (но не удаляет имеющиеся свойства).

Имя Тип Описание
values Partial.<NoInfer.<Properties>>

Значения.

silent boolean | undefined

Обновить без вызова события.

setRadius(radius)

geom/Circle.js, строка 228

Задаёт радиус окружности. Радиус указывается в единицах проекции.

Имя Тип Описание
radius number

Радиус.

simplify(tolerance){Geometry} унаследовано

geom/Geometry.js, строка 233

Создаёт упрощённую версию этой геометрии. Для ломаных линий используется алгоритм Дугласа — Пекера. Для полигонов применяется упрощение на основе квантования, сохраняющее топологию.

Имя Тип Описание
tolerance number

Допуск — расстояние для упрощения.

Возвращает:
Новую упрощённую версию исходной геометрии.

transform(source, destination){Circle}

geom/Circle.js, строка 273

Преобразует каждую координату окружности из одной системы координат в другую. Геометрия изменяется на месте. Если вы не хотите изменять геометрию на месте, сначала создайте её копию с помощью clone(), а затем примените эту функцию к копии.

Внутренне окружность в настоящее время представлена двумя точками: центром окружности [cx, cy] и точкой справа от окружности [cx + r, cy]. Эта функция transform преобразует только эти две точки. Поэтому результирующая геометрия также является окружностью, но она не соответствует форме, которая получилась бы при преобразовании каждой точки исходной окружности.

Имя Тип Описание
source ProjectionLike

Текущая проекция. Может быть строковым идентификатором или объектом Projection.

destination ProjectionLike

Целевая проекция. Может быть строковым идентификатором или объектом Projection.

Возвращает:
Эта геометрия. Обратите внимание: исходная геометрия изменяется на месте.

translate(deltaX, deltaY) унаследовано

geom/SimpleGeometry.js, строка 287

Переводит геометрию. Координаты геометрии изменяются на месте. Если вместо этого нужна новая геометрия, сначала clone() эту геометрию.

Имя Тип Описание
deltaX number

Приращение по X.

deltaY number

Приращение по Y.

un(type, listener) унаследовано

Observable.js, строка 173

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

Имя Тип Описание
type string | Array.<string>

Тип события или массив типов событий.

listener function

Функция-обработчик.

unset(key, silent) унаследовано

Object.js, строка 262

Удаляет свойство.

Имя Тип Описание
key string

Имя ключа.

silent boolean | undefined

Удалить без вызова события.

© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_geom_Circle-Circle.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API