Graticule~Graticule

import Graticule from 'ol/layer/Graticule.js';

Слой, отображающий сетку системы координат (в настоящее время поддерживается только EPSG:4326). Обратите внимание: проекция представления должна задавать и extent, и worldExtent.

new Graticule(options) layer/Graticule.js, строка 187

Имя	Тип	Описание
`className`	string (по умолчанию 'ol-layer')	Имя CSS-класса, назначаемого элементу слоя.
`opacity`	number (по умолчанию 1)	Непрозрачность (0, 1).
`visible`	boolean (по умолчанию true)	Видимость.
`extent`	Extent \| undefined	Границы области отрисовки слоя. За пределами этой области слой отображаться не будет.
`zIndex`	number \| undefined	Z-индекс для отрисовки слоя. Во время отрисовки слои упорядочиваются сначала по Z-индексу, а затем по позиции. Если `undefined`, для слоёв, добавленных в коллекцию `layers` карты, предполагается значение `zIndex`, а если использовался метод `setMap()` слоя — `Infinity`.
`minResolution`	number \| undefined	Минимальное разрешение (включительно), при котором слой будет видим.
`maxResolution`	number \| undefined	Максимальное разрешение (не включительно), ниже которого слой будет видим.
`minZoom`	number \| undefined	Минимальный уровень масштаба представления (не включительно), выше которого слой будет видим.
`maxZoom`	number \| undefined	Максимальный уровень масштаба представления (включительно), при котором слой будет видим.
`maxLines`	number (по умолчанию 100)	Максимальное количество меридианов и параллелей от центра карты. Значение по умолчанию 100 означает, что будет отображаться не более 200 меридианов и 200 параллелей. Значение по умолчанию подходит для конформных проекций, таких как сферическая проекция Меркатора. При увеличении значения будет отрисовываться больше линий, а производительность отрисовки снизится.
`strokeStyle`	Stroke \| undefined	Стиль обводки для отрисовки координатной сетки. Если он не задан, будет использоваться следующая обводка: new Stroke({ color: 'rgba(0, 0, 0, 0.2)' // a not fully opaque black });
`targetSize`	number (по умолчанию 100)	Целевой размер ячеек координатной сетки в пикселях.
`showLabels`	boolean (по умолчанию false)	Отображать подпись с соответствующей широтой/долготой для каждой линии координатной сетки.
`lonLabelFormatter`	function \| undefined	Функция форматирования подписей долгот. Эта функция вызывается с долготой в качестве аргумента и должна возвращать отформатированную строку, представляющую долготу. По умолчанию подписи форматируются в градусах, минутах, секундах и полушарии.
`latLabelFormatter`	function \| undefined	Функция форматирования подписей широт. Эта функция вызывается с широтой в качестве аргумента и должна возвращать отформатированную строку, представляющую широту. По умолчанию подписи форматируются в градусах, минутах, секундах и полушарии.
`lonLabelPosition`	number (по умолчанию 0)	Положение подписи долготы в долях (0..1) от extent представления. 0 означает нижнюю границу области просмотра, 1 — верхнюю.
`latLabelPosition`	number (по умолчанию 1)	Положение подписи широты в долях (0..1) от extent представления. 0 означает левую границу области просмотра, 1 — правую.
`lonLabelStyle`	Text \| undefined	Стиль текста подписи долготы. Если он не задан, будет использоваться следующий стиль: new Text({ font: '12px Calibri,sans-serif', textBaseline: 'bottom', fill: new Fill({ color: 'rgba(0,0,0,1)' }), stroke: new Stroke({ color: 'rgba(255,255,255,1)', width: 3 }) }); Обратите внимание: конфигурация `textBaseline` по умолчанию не будет хорошо работать с конфигурациями `lonLabelPosition`, которые размещают подписи близко к верхней границе области просмотра.
`latLabelStyle`	Text \| undefined	Стиль текста подписи широты. Если он не задан, будет использоваться следующий стиль: new Text({ font: '12px Calibri,sans-serif', textAlign: 'end', fill: new Fill({ color: 'rgba(0,0,0,1)' }), stroke: Stroke({ color: 'rgba(255,255,255,1)', width: 3 }) }); Обратите внимание: конфигурация `textAlign` по умолчанию не будет хорошо работать с конфигурациями `latLabelPosition`, которые размещают подписи близко к левой границе области просмотра.
`intervals`	Array.<number> (по умолчанию [90, 45, 30, 20, 10, 5, 2, 1, 30/60, 20/60, 10/60, 5/60, 2/60, 1/60, 30/3600, 20/3600, 10/3600, 5/3600, 2/3600, 1/3600])	Интервалы координатной сетки в градусах. Пример ограничения интервалов сетки значениями 30 и 10 градусов: [30, 10]
`wrapX`	boolean (по умолчанию true)	Повторять ли координатную сетку по горизонтали.
`background`	BackgroundColor \| undefined	Цвет фона слоя. Если не задан, фон отображаться не будет.
`properties`	Object.<string, *> \| undefined	Произвольные наблюдаемые свойства. Доступ к ним можно получить с помощью `#get()` и `#set()`.

События:

change (BaseEvent) — общее событие изменения. Вызывается при увеличении счётчика ревизий.
change:extent (ObjectEvent)
change:maxResolution (ObjectEvent)
change:maxZoom (ObjectEvent)
change:minResolution (ObjectEvent)
change:minZoom (ObjectEvent)
change:opacity (ObjectEvent)
change:source (ObjectEvent)
change:visible (ObjectEvent)
change:zIndex (ObjectEvent)
error (BaseEvent) — общее событие ошибки. Вызывается при возникновении ошибки.
postrender (RenderEvent) — вызывается после отрисовки слоя.
prerender (RenderEvent) — вызывается перед отрисовкой слоя.
propertychange (ObjectEvent) — вызывается при изменении свойства.
sourceready (BaseEvent)

Наследует

VectorLayer

Наблюдаемые свойства

Имя	Тип	Можно задать	Тип ObjectEvent	Описание
`extent`	Extent \| undefined	да	`change:extent`	Extent слоя.
`maxResolution`	number	да	`change:maxresolution`	Максимальное разрешение слоя.
`maxZoom`	number	да	`change:maxzoom`	Максимальный уровень масштаба слоя.
`minResolution`	number	да	`change:minresolution`	Минимальное разрешение слоя.
`minZoom`	number	да	`change:minzoom`	Минимальный уровень масштаба слоя.
`opacity`	number	да	`change:opacity`	Непрозрачность слоя.
`source`	SourceType \| null	да	`change:source`	Источник слоя (или `null`, если ещё не задан).
`visible`	boolean	да	`change:visible`	Значение свойства `visible` слоя.
`zIndex`	number \| undefined	да	`change:zindex`	Z-индекс слоя.

Методы

changed() унаследовано Observable.js, строка 68

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

dispatchEvent(event){boolean | undefined} унаследовано events/Target.js, строка 85

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

Имя	Тип	Описание
`event`	BaseEvent \| строка	Объект события.

Возвращает:

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

get(key){*} унаследовано Object.js, строка 136

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

Имя	Тип	Описание
`key`	строка	Имя ключа.

Возвращает:

Значение.

getAttributions(view){Array.<string>} унаследовано layer/Layer.js, строка 349

Получает атрибуцию источника этого слоя для указанного представления.

Имя	Тип	Описание
`view`	View \| ViewStateLayerStateExtent \| undefined	Представление или `FrameState`. Требуется только в том случае, если слой не добавлен на карту.

Возвращает:

Атрибуцию этого слоя для указанного представления.

getExtent(){Extent | undefined} унаследовано layer/Base.js, строка 210

Возвращает extent слоя или undefined, если слой виден независимо от области охвата.

Возвращает:

Область охвата слоя.

getFeatures(pixel){Promise<Array<FeatureLike>>} унаследовано layer/BaseVector.js, строка 175

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

Алгоритм обнаружения пересечений, используемый этим методом, оптимизирован для производительности, но менее точен, чем алгоритм метода map.getFeaturesAtPixel(). Текст не учитывается, а значки представлены только ограничивающим прямоугольником, а не точным изображением.

Имя	Тип	Описание
`pixel`	Pixel	Пиксель.

Возвращает:

Промис, который разрешается массивом объектов.

getKeys(){Array.<string>} унаследовано Object.js, строка 149

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

Возвращает:

Список имён свойств.

getMaxResolution(){number} унаследовано layer/Base.js, строка 223

Возвращает максимальное разрешение слоя. Возвращает Infinity, если для слоя не задано максимальное разрешение.

Возвращает:

Максимальное разрешение слоя.

getMaxZoom(){number} унаследовано layer/Base.js, строка 256

Возвращает максимальный уровень масштабирования слоя. Возвращает Infinity, если для слоя не задан максимальный уровень масштабирования.

Возвращает:

Максимальный уровень масштабирования слоя.

getMeridians(){Array<LineString>} layer/Graticule.js, строка 1108

Получает список меридианов. Меридианы — это линии одинаковой долготы.

Возвращает:

Меридианы.

getMinResolution(){number} унаследовано layer/Base.js, строка 234

Возвращает минимальное разрешение слоя. Возвращает 0, если для слоя не задано минимальное разрешение.

Возвращает:

Минимальное разрешение слоя.

getMinZoom(){number} унаследовано layer/Base.js, строка 245

Возвращает минимальный уровень масштабирования слоя. Возвращает -Infinity, если для слоя не задан минимальный уровень масштабирования.

Возвращает:

Минимальный уровень масштабирования слоя.

getOpacity(){number} унаследовано layer/Base.js, строка 266

Возвращает непрозрачность слоя (от 0 до 1).

Возвращает:

Непрозрачность слоя.

getParallels(){Array<LineString>} layer/Graticule.js, строка 1177

Получает список параллелей. Параллели — это линии одинаковой широты.

Возвращает:

Параллели.

getProperties(){NoInfer.<Properties>} унаследовано Object.js, строка 158

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

Возвращает:

Объект.

getRevision(){number} унаследовано Observable.js, строка 79

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

Возвращает:

Ревизия.

getSource(){SourceType | null} унаследовано layer/Layer.js, строка 214

Получает источник слоя.

Возвращает:

Источник слоя (или null, если он ещё не задан).

getStyle(){StyleLike | FlatStyleLike | null | undefined} унаследовано layer/BaseVector.js, строка 201

Получает стиль объектов. Возвращает значение, переданное параметру style при создании или методу setStyle.

Возвращает:

Стиль слоя.

getStyleFunction(){StyleFunction | undefined} унаследовано layer/BaseVector.js, строка 210

Получает функцию стиля.

Возвращает:

Функция стиля слоя.

getVisible(){boolean} унаследовано layer/Base.js, строка 285

Возвращает значение свойства visible этого слоя. Чтобы узнать, виден ли слой на карте, используйте вместо этого isVisible().

Возвращает:

Значение свойства visible слоя.

getZIndex(){number | undefined} унаследовано layer/Base.js, строка 296

Возвращает Z-индекс слоя, используемый для упорядочивания слоёв перед отрисовкой. Возвращает undefined, если слой не управляется.

Возвращает:

Z-индекс слоя.

isVisible(view){boolean} унаследовано layer/Layer.js, строка 305

Слой виден в представлении карты, то есть находится в пределах минимального/максимального разрешения или уровня масштабирования и области охвата, не отключён visible: false и не находится внутри группы слоёв, для которой задано visible: false.

Имя	Тип	Описание
`view`	View \| ViewStateLayerStateExtent \| undefined	Представление или `FrameState`. Требуется только в том случае, если слой не добавлен на карту.

Возвращает:

Видимость слоя в представлении карты.

on(type, listener){EventsKey | Array<EventsKey>} унаследовано Observable.js, строка 152

Ожидает событие указанного типа.

Имя	Тип	Описание
`type`	строка \| Array.<string>	Тип события или массив типов событий.
`listener`	функция	Функция-обработчик.

Возвращает:

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

once(type, listener){EventsKey | Array<EventsKey>} унаследовано Observable.js, строка 164

Ожидает однократное возникновение события указанного типа.

Имя	Тип	Описание
`type`	строка \| Array.<string>	Тип события или массив типов событий.
`listener`	функция	Функция-обработчик.

Возвращает:

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

set(key, value, silent) унаследовано Object.js, строка 218

Устанавливает значение.

Имя	Тип	Описание
`key`	строка	Имя ключа.
`value`	*	Значение.
`silent`	логическое значение \| undefined	Обновить без отправки события.

setDeclutter(declutter) унаследовано layer/BaseVector.js, строка 285

Имя	Тип	Описание
`declutter`	логическое значение \| строка \| число	Предотвращать наложение изображений и текста.

setExtent(extent) унаследовано layer/Base.js, строка 316

Задаёт область охвата, в пределах которой слой виден. Если undefined, слой будет виден при любой области охвата.

Имя	Тип	Описание
`extent`	Extent \| undefined	Область охвата слоя.

setMap(map) унаследовано layer/Layer.js, строка 444

Задаёт слой для отрисовки поверх других слоёв на карте. Карта не будет управлять этим слоем в своей коллекции слоёв. Это удобно для временных слоёв. Чтобы удалить неуправляемый слой с карты, используйте #setMap(null).

Чтобы добавить слой на карту и передать управление им карте, используйте вместо этого addLayer.

Имя	Тип	Описание
`map`	Map \| null	Карта.

setMaxResolution(maxResolution) унаследовано layer/Base.js, строка 326

Задаёт максимальное разрешение, при котором слой виден.

Имя	Тип	Описание
`maxResolution`	число	Максимальное разрешение слоя.

setMaxZoom(maxZoom) унаследовано layer/Base.js, строка 348

Задаёт максимальный уровень масштабирования (не включая его), при котором слой виден. Обратите внимание, что уровни масштабирования для видимости слоя основаны на уровне масштабирования представления, который может отличаться от уровня масштабирования источника тайлов.

Имя	Тип	Описание
`maxZoom`	число	Максимальный уровень масштабирования слоя.

setMinResolution(minResolution) унаследовано layer/Base.js, строка 336

Задаёт минимальное разрешение, при котором слой виден.

Имя	Тип	Описание
`minResolution`	число	Минимальное разрешение слоя.

setMinZoom(minZoom) унаследовано layer/Base.js, строка 360

Задаёт минимальный уровень масштабирования (включая его), при котором слой виден. Обратите внимание, что уровни масштабирования для видимости слоя основаны на уровне масштабирования представления, который может отличаться от уровня масштабирования источника тайлов.

Имя	Тип	Описание
`minZoom`	число	Минимальный уровень масштабирования слоя.

setOpacity(opacity) унаследовано layer/Base.js, строка 370

Задаёт непрозрачность слоя; допустимые значения — от 0 до 1.

Имя	Тип	Описание
`opacity`	number	Непрозрачность слоя.

setProperties(values, silent) унаследовано Object.js, строка 238

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

Имя	Тип	Описание
`values`	Partial.<NoInfer.<Properties>>	Значения.
`silent`	boolean \| undefined	Обновить без вызова события.

setSource(source) унаследовано layer/Layer.js, строка 492

Задаёт источник слоя.

Имя	Тип	Описание
`source`	SourceType \| null	Источник слоя.

setStyle(style) унаследовано layer/BaseVector.js, строка 273

Задаёт стиль для объектов. Это может быть один объект стиля, массив стилей или функция, принимающая объект и разрешение и возвращающая массив стилей. Если указано значение null, у слоя нет стиля (стиль null), поэтому в слое будут отображаться только объекты с собственными стилями. Вызовите setStyle() без аргументов, чтобы восстановить стиль по умолчанию. Сведения о стиле по умолчанию см. в разделе the ol/style/Style module.

Если у слоя статический стиль, можно использовать литералы объектов flat style вместо конструкторов Style и символизаторов (Fill, Stroke и т. д.):

vectorLayer.setStyle({
  "fill-color": "yellow",
  "stroke-color": "black",
  "stroke-width": 4
})

Имя	Тип	Описание
`style`	StyleLike \| FlatStyleLike \| null \| undefined	Стиль слоя.

setVisible(visible) унаследовано layer/Base.js, строка 381

Задаёт видимость слоя (true или false).

Имя	Тип	Описание
`visible`	boolean	Видимость слоя.

setZIndex(zindex) унаследовано layer/Base.js, строка 392

Задаёт Z-индекс слоя, используемый для упорядочивания слоёв перед отрисовкой. По умолчанию Z-индекс равен 0.

Имя	Тип	Описание
`zindex`	number	Z-индекс слоя.

un(type, listener) унаследовано Observable.js, строка 173

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

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция-обработчик.

unset(key, silent) унаследовано Object.js, строка 262

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

Имя	Тип	Описание
`key`	string	Имя ключа.
`silent`	boolean \| undefined	Удалить без вызова события.