Spec-Zone.ru › OpenLayers

ol/layer/Graticule~Graticule


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

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

new Graticule(options)

layer/Graticule.js, строка 185
Имя Тип Описание
className string (по умолчанию 'ol-layer')

Имя класса CSS, устанавливаемого для элемента слоя.
opacity number (по умолчанию 1)

Непрозрачность (от 0 до 1).
visible boolean (по умолчанию true)

Видимость.
extent Extent | undefined

Границы отображения слоя. Слой не будет отображаться за пределами этих границ.
zIndex number | undefined

Индекс Z для отображения слоя. Во время отрисовки слои упорядочиваются сначала по индексу Z, а затем по положению. Когда undefined, для слоёв, добавленных в коллекцию layers карты, предполагается индекс Z 0, или Infinity, если использовался метод setMap() слоя.
minResolution number | undefined

Минимальное разрешение (включительно), при котором этот слой будет виден.
maxResolution number | undefined

Максимальное разрешение (исключительно), ниже которого этот слой будет виден.
minZoom number | undefined

Минимальный уровень масштабирования просмотра (исключительно), выше которого этот слой будет виден.
maxZoom number | undefined

Максимальный уровень масштабирования просмотра (включительно), при котором этот слой будет виден.
maxLines number (по умолчанию 100)

Максимальное количество меридианов и параллелей от центра карты. Значение по умолчанию 100 означает, что будет отображено не более 200 меридианов и 200 параллелей. Это значение подходит для конформных проекций, таких как Spherical Mercator. Если увеличить значение, будет нарисовано больше линий, и производительность отрисовки снизится.
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) области просмотра. 0 означает в нижней части области просмотра, 1 означает в верхней части.
latLabelPosition number (по умолчанию 1)

Положение метки широты в долях (0..1) области просмотра. 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
  })
});

Обратите внимание, что конфигурация по умолчанию не будет хорошо работать с конфигурациями, размещающими метки близко к верхней части области просмотра.
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
  })
});

Обратите внимание, что конфигурация по умолчанию не будет хорошо работать с конфигурациями, размещающими метки близко к левой части области просмотра.
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)

Повторять ли сетку по горизонтали.
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

Область слоя.
maxResolution число да change:maxresolution

Максимальное разрешение слоя.
maxZoom число да change:maxzoom

Максимальный уровень масштабирования слоя.
minResolution число да change:minresolution

Минимальное разрешение слоя.
minZoom число да change:minzoom

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

Непрозрачность слоя.
source SourceType | null да change:source

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

Значение свойства visible слоя.
zIndex число | undefined да change:zindex

Индекс Z слоя.

Методы

changed() inherited

Observable.js, line 68

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

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

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

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

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

get(key){*} inherited

Object.js, line 135

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

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

Имя ключа.
Возвращает:
Значение.

getAttributions(view){Array.<string>} inherited

layer/Layer.js, line 345

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

Имя Тип Описание
view View | ViewStateLayerStateExtent | undefined

Представление или FrameState. Требуется только когда слой не добавлен на карту.
Возвращает:
Атрибуты этого слоя для данного представления.

getExtent(){Extent | undefined} inherited

layer/Base.js, line 207

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

Возвращает:
Область слоя.

getFeatures(pixel){Promise<Array<FeatureLike>>} inherited

layer/BaseVector.js, line 178

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

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

Имя Тип Описание
pixel Pixel

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

getKeys(){Array.<string>} inherited

Object.js, line 148

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

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

getMaxResolution(){number} inherited

layer/Base.js, line 220

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

Возвращает:
Максимальное разрешение слоя.

getMaxZoom(){number} inherited

layer/Base.js, line 253

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

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

getMeridians(){Array<LineString>}

layer/Graticule.js, line 1106

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

Возвращает:
Меридианы.

getMinResolution(){number} inherited

layer/Base.js, line 231

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

Возвращает:
Минимальное разрешение слоя.

getMinZoom(){number} inherited

layer/Base.js, line 242

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

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

getOpacity(){number} inherited

layer/Base.js, line 263

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

Возвращает:
Непрозрачность слоя.

getParallels(){Array<LineString>}

layer/Graticule.js, строка 1175

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

Возвращает:
Параллели.

getProperties(){Object.<string, *>} унаследованный

Object.js, строка 157

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

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

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

Observable.js, строка 79

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

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

getSource(){SourceType | null} унаследованный

layer/Layer.js, строка 209

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

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

getStyle(){StyleLike | FlatStyleLike | null | undefined} унаследованный

layer/BaseVector.js, строка 204

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

Возвращает:
Стиль слоя.

getStyleFunction(){StyleFunction | undefined} унаследованный

layer/BaseVector.js, строка 213

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

Возвращает:
Функцию стиля слоя.

getVisible(){boolean} унаследованный

layer/Base.js, строка 282

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

Возвращает:
Значение свойства visible слоя.

getZIndex(){number | undefined} унаследованный

layer/Base.js, строка 293

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

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

isVisible(view){boolean} унаследованный

layer/Layer.js, строка 301

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

Имя Тип Описание
view Представление | ViewStateLayerStateExtent | undefined

Представление или FrameState. Требуется только тогда, когда слой не добавлен на карту.
Возвращает:
Слой виден на карте.

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

Observable.js, строка 152

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

Имя Тип Описание
type строка | Массив.<строка>

Тип события или массив типов событий.
listener функция

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

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

Observable.js, строка 164

Прослушать событие определенного типа один раз.

Имя Тип Описание
type строка | Массив.<строка>

Тип события или массив типов событий.
listener функция

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

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

Object.js, строка 215

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

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

Имя ключа.
value *

Значение.
silent boolean | undefined

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

setDeclutter(declutter) унаследованное

layer/BaseVector.js, строка 288
Имя Тип Описание
declutter boolean | string | number

Сгруппировать изображения и текст.

setExtent(extent) унаследованное

layer/Base.js, строка 313

Устанавливает область видимости слоя. Если undefined, слой будет виден во всех областях.

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

Область видимости слоя.

setMap(map) унаследованное

layer/Layer.js, строка 440

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

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

Имя Тип Описание
map Map | null

Карта.

setMaxResolution(maxResolution) унаследованное

layer/Base.js, строка 323

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

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

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

setMaxZoom(maxZoom) унаследованное

layer/Base.js, строка 345

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

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

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

setMinResolution(minResolution) унаследованное

layer/Base.js, строка 333

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

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

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

setMinZoom(minZoom) унаследованное

layer/Base.js, строка 357

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

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

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

setOpacity(opacity) унаследованное

layer/Base.js, строка 367

Установить непрозрачность слоя, допустимые значения находятся в диапазоне от 0 до 1.

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

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

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

Object.js, строка 235

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

Имя Тип Описание
values Object.<string, *>

Значения.
silent boolean | undefined

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

setSource(source) унаследованное

layer/Layer.js, строка 488

Установить источник слоя.

Имя Тип Описание
source SourceType | null

Источник слоя.

setStyle(style) унаследованное

layer/BaseVector.js, строка 276

Установите стиль для объектов. Это может быть один объект стиля, массив стилей или функция, которая принимает объект и разрешение и возвращает массив стилей. Если установлено значение 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, строка 378

Установите видимость слоя (true или false).

Имя Тип Описание
visible boolean

Видимость слоя.

setZIndex(zindex) унаследованное

layer/Base.js, строка 389

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

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

Индекс Z слоя.

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

Observable.js, строка 173

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

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

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

Функция-прослушиватель.

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

Object.js, строка 259

Сбросить свойство.

Имя Тип Описание
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_layer_Graticule-Graticule.html

Spec-Zone.ru

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