Spec-Zone.ru › OpenLayers

ol/layer/Heatmap~Heatmap 


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

Слой для отображения векторных данных в виде тепловой карты. Обратите внимание: любое свойство, заданное в параметрах, устанавливается как свойство BaseObject объекта слоя; например, если задать title: 'My Title' в параметрах, это означает, что свойство title является наблюдаемым и имеет методы доступа get/set.

new Heatmap(options)

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

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

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

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

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

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

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

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

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

Максимальный уровень масштабирования вида (включительно), при котором этот слой будет виден.
gradient Array.<string> (по умолчанию ['#00f', '#0ff', '#0f0', '#ff0', '#f00'])

Цветовой градиент тепловой карты, заданный в виде массива строк с цветами CSS.
radius NumberExpression (по умолчанию 8)

Размер радиуса в пикселях. Обратите внимание: для LineStrings ширина линии будет вдвое больше радиуса.
blur NumberExpression (по умолчанию 15)

Размер размытия в пикселях. Это значение добавляется к указанному выше параметру radius, чтобы получить итоговый размер эффекта размытия.
weight WeightExpression (по умолчанию 'weight')

Атрибут объекта, используемый для задания веса. Также поддерживаются выражения, возвращающие число, и функции, возвращающие вес для объекта. Значения веса должны находиться в диапазоне от 0 до 1 (значения за пределами диапазона будут ограничены этими значениями).
filter BooleanExpression | undefined

Необязательное выражение фильтра.
variables Object.<string, (number|Array.<number>|string|boolean)> | undefined

Переменные, используемые в выражениях (необязательно)
source VectorSourceType | undefined

Источник точек.
background BackgroundColor | undefined

Цвет фона слоя. Если он не задан, фон отображаться не будет.
properties Object.<string, *> | undefined

Произвольные наблюдаемые свойства. Доступ к ним можно получить с помощью #get() и #set().
События:
  • change (BaseEvent) — общее событие изменения. Вызывается при увеличении счётчика версий.
  • change:blur (ObjectEvent)
  • change:extent (ObjectEvent)
  • change:gradient (ObjectEvent)
  • change:maxResolution (ObjectEvent)
  • change:maxZoom (ObjectEvent)
  • change:minResolution (ObjectEvent)
  • change:minZoom (ObjectEvent)
  • change:opacity (ObjectEvent)
  • change:radius (ObjectEvent)
  • change:source (ObjectEvent)
  • change:visible (ObjectEvent)
  • change:zIndex (ObjectEvent)
  • error (BaseEvent) — общее событие ошибки. Вызывается при возникновении ошибки.
  • postrender (RenderEvent) — вызывается после отображения слоя.
  • prerender (RenderEvent) — вызывается перед отображением слоя.
  • propertychange (ObjectEvent) — вызывается при изменении свойства.
  • sourceready (BaseEvent)

Расширяет

  • BaseVectorLayer

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

Имя Тип Можно задать Тип ObjectEvent Описание
blur NumberExpression да change:blur

Размер размытия в пикселях.
extent Extent | undefined да change:extent

Область слоя.
gradient Array.<string> да change:gradient

Цвета.
maxResolution number да change:maxresolution

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

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

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

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

Непрозрачность слоя.
radius NumberExpression да change:radius

Размер радиуса в пикселях.
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

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

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

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

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

Object.js, строка 136

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

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

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

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

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

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

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

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

getBlur(){NumberExpression}

layer/Heatmap.js, строка 178

Возвращает размер размытия в пикселях.

Возвращает:
Размер размытия в пикселях.

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

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

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

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

getFeatures(pixel){Promise<Array<FeatureLike>>} унаследовано

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

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

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

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

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

getGradient(){Array.<string>}

layer/Heatmap.js, строка 190

Возвращает цвета градиента в виде массива строк.

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

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

Object.js, строка 149

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Object.js, строка 158

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

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

getRadius(){NumberExpression}

layer/Heatmap.js, строка 200

Возвращает размер радиуса в пикселях.

Возвращает:
Размер радиуса в пикселях.

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 string | Array.<string>

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

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

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

Observable.js, строка 164

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

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

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

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

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

Object.js, строка 218

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

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

Имя ключа.
value *

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

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

setBlur(blur)

layer/Heatmap.js, строка 219

Задаёт размер размытия в пикселях.

Имя Тип Описание
blur NumberExpression

Размер размытия в пикселях (поддерживаются выражения).

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

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

Устраняет перекрытие изображений и текста.

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

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

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

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

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

setFilter(filter)

layer/Heatmap.js, строка 262

Задаёт выражение фильтра

Имя Тип Описание
filter BooleanExpression

Выражение фильтра

setGradient(colors)

layer/Heatmap.js, строка 236

Задаёт цвета градиента в виде массива строк.

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

Градиент.

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

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

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

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

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

Карта.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Object.js, строка 238

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

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

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

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

setRadius(radius)

layer/Heatmap.js, строка 246

Задать размер радиуса в пикселях.

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

Размер радиуса в пикселях (поддерживает выражения).

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

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

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

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

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

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

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

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

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

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

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

setWeight(weight)

layer/Heatmap.js, строка 273

Задать выражение веса

Имя Тип Описание
weight WeightExpression

Выражение веса

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

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

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

Spec-Zone.ru

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