ol/layer/Heatmap~Heatmap
import Heatmap from 'ol/layer/Heatmap.js';
Слой для отрисовки векторных данных в виде тепловой карты. Обратите внимание, что любой свойство, заданное в опциях, устанавливается как свойство BaseObject объекта слоя; например, установка title: 'My Title' в опциях означает, что title является наблюдаемым и имеет геттеры/сеттеры.
-
new Heatmap(options)
-
Имя Тип Описание classNamestring (по умолчанию 'ol-layer') Имя CSS-класса, устанавливаемого для элемента слоя.
opacitynumber (по умолчанию 1) Непрозрачность (0, 1).
visibleboolean (по умолчанию true) Видимость.
extentExtent | undefined Ограничивающая область для отрисовки слоя. Слой не будет отрисовываться за пределами этой области.
zIndexnumber | undefined Индекс Z для отрисовки слоя. Во время отрисовки слои упорядочиваются сначала по индексу Z, а затем по позиции. При
undefined, предполагается индекс Z равный 0 для слоев, добавленных в коллекциюlayersкарты, илиInfinity, когда используется методsetMap()слоя.minResolutionnumber | undefined Минимальное разрешение (включительно), при котором этот слой будет видимым.
maxResolutionnumber | undefined Максимальное разрешение (исключительно), ниже которого этот слой будет видимым.
minZoomnumber | undefined Минимальный уровень масштаба представления (исключительно), выше которого этот слой будет видимым.
maxZoomnumber | undefined Максимальный уровень масштаба представления (включительно), при котором этот слой будет видимым.
gradientArray.<string> (по умолчанию ['#00f', '#0ff', '#0f0', '#ff0', '#f00']) Градиент цвета тепловой карты, задаваемый массивом CSS-строк цвета.
radiusnumber (по умолчанию 8) Размер радиуса в пикселях.
blurnumber (по умолчанию 15) Размер размытия в пикселях.
weightstring | function (по умолчанию 'weight') Атрибут объекта-признака для веса или функция, возвращающая вес из признака. Значения веса должны быть от 0 до 1 (и значения вне этого диапазона будут ограничены этим диапазоном).
sourceVectorSourceType | undefined Источник точек.
propertiesObject.<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)
-
Расширяет
Наблюдаемые свойства
| Имя | Тип | Устанавливаемое | ObjectEvent тип | Описание |
|---|---|---|---|---|
blur | number | да | 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 | number | да | change:radius | Размер радиуса в пикселе. |
source | SourceType | null | да | change:source | Источник слоя (или |
visible | boolean | да | change:visible | Значение свойства |
zIndex | number | undefined | да | change:zindex | Индекс Z слоя. |
Методы
-
changed() inherited
-
Увеличивает счётчик ревизий и отправляет событие 'change'.
-
dispatchEvent(event){boolean | undefined} inherited
-
Отправляет событие и вызывает все обработчики, которые слушают события этого типа. Параметр события может быть строкой или объектом с свойством
type.Имя Тип Описание eventBaseEvent | string Объект события.
Возвращает:
false, если кто-то вызвал preventDefault на объекте события или если какой-либо из обработчиков вернул false.
-
Получает значение.
Имя Тип Описание keystring Имя ключа.
Возвращает:
Значение.
-
getAttributions(view){Array.<string>} inherited
-
Получить атрибуты источника этого слоя для данного представления.
Имя Тип Описание viewПредставление | ViewStateLayerStateExtent | undefined Представление или
FrameState. Требуется только когда слой не добавлен в карту.Возвращает:
Атрибуты этого слоя в данном представлении.
-
getBlur(){number}
-
Возвращает размер размытия в пикселях.
Возвращает:
Размер размытия в пикселях.
-
Возвращает
extentслоя илиundefined, если он будет виден независимо от области.Возвращает:
Область слоя.
-
getFeatures(pixel){Promise<Array<FeatureLike>>} inherited
-
Получить самый верхний объект, который пересекает заданный пиксель на представлении. Возвращает промис, который разрешается массивом объектов. Массив будет содержать самый верхний объект при обнаружении попадания или будет пустым.
Алгоритм обнаружения попадания, используемый для этого метода, оптимизирован для производительности, но менее точен, чем тот, который используется в
map.getFeaturesAtPixel(). Текст не учитывается, а значки представлены только своей ограничивающей рамкой, а не точным изображением.Имя Тип Описание pixelПиксель Пиксель.
Возвращает:
Промис, который разрешается массивом объектов.
-
getGradient(){Array.<string>}
-
Возвращает цвета градиента в виде массива строк.
Возвращает:
Цвета.
-
Получить список имён свойств объекта.
Возвращает:
Список имён свойств.
-
getMaxResolution(){number} inherited
-
Возвращает максимальное разрешение слоя. Возвращает Infinity, если у слоя нет максимального разрешения.
Возвращает:
Максимальное разрешение слоя.
-
getMaxZoom(){number} inherited
-
Возвращает максимальный уровень масштабирования слоя. Возвращает Infinity, если у слоя нет максимального уровня масштабирования.
Возвращает:
Максимальный уровень масштабирования слоя.
-
getMinResolution(){number} inherited
-
Возвращает минимальное разрешение слоя. Возвращает 0, если у слоя нет минимального разрешения.
Возвращает:
Минимальное разрешение слоя.
-
getMinZoom(){number} inherited
-
Возвращает минимальный уровень масштабирования слоя. Возвращает -Infinity, если у слоя нет минимального уровня масштабирования.
Возвращает:
Минимальный уровень масштабирования слоя.
-
getOpacity(){number} inherited
-
Возвращает непрозрачность слоя (от 0 до 1).
Возвращает:
Непрозрачность слоя.
-
Получить объект со всеми именами и значениями свойств.
Возвращает:
Объект.
-
getRadius(){number}
-
Возвращает размер радиуса в пикселях.
Возвращает:
Размер радиуса в пикселях.
-
getRevision(){number} inherited
-
Получить номер версии этого объекта. Каждый раз, когда объект изменяется, его номер версии увеличивается.
Возвращает:
Версия.
-
getSource(){SourceType | null} inherited
-
Получить источник слоя.
Возвращает:
Источник слоя (илиnull, если ещё не задан).
-
getStyle(){StyleLike | FlatStyleLike | null | undefined} inherited
-
Получить стиль для объектов. Возвращает то, что было передано в опцию
styleпри создании или методуsetStyle.Возвращает:
Стиль слоя.
-
getStyleFunction(){StyleFunction | undefined} inherited
-
Получить функцию стиля.
Возвращает:
Функция стиля слоя.
-
getVisible(){boolean} inherited
-
Возвращает значение свойства
visibleэтого слоя. Чтобы узнать, виден ли слой на карте, используйтеisVisible().Возвращает:
Значение свойстваvisibleслоя.
-
getZIndex(){number | undefined} inherited
-
Возвращает Z-индекс слоя, используемый для упорядочивания слоев перед отрисовкой. Возвращает undefined, если слой не управляется.
Возвращает:
Z-индекс слоя.
-
isVisible(view){boolean} inherited
-
Слой виден на представлении карты, т.е. в пределах его минимально/максимального разрешения или масштаба и области, не установлен в
visible: falseи не находится внутри группы слоев, установленной вvisible: false.Имя Тип Описание viewПредставление | ViewStateLayerStateExtent | undefined Представление или
FrameState. Требуется только тогда, когда слой не добавлен на карту.Возвращает:
Слой виден на представлении карты.
-
Прослушивание события определенного типа.
Имя Тип Описание typeстрока | Массив.<строка> Тип события или массив типов событий.
listenerфункция Функция-обработчик.
Возвращает:
Уникальный ключ для обработчика. Если вызван с массивом типов событий в качестве первого аргумента, возвращение будет массивом ключей.
-
Прослушивание события определенного типа один раз.
Имя Тип Описание typeстрока | Массив.<строка> Тип события или массив типов событий.
listenerфункция Функция-обработчик.
Возвращает:
Уникальный ключ для обработчика. Если вызван с массивом типов событий в качестве первого аргумента, возвращение будет массивом ключей.
-
Устанавливает значение.
Имя Тип Описание keystring Имя ключа.
value* Значение.
silentboolean | undefined Обновить без срабатывания события.
-
setBlur(blur)
-
Устанавливает размер размытия в пикселях.
Имя Тип Описание blurnumber Размер размытия в пикселях.
-
setDeclutter(declutter) унаследованный
-
Имя Тип Описание declutterboolean | string | number Объединить изображения и текст.
-
setExtent(extent) унаследованный
-
Устанавливает область видимости слоя. Если
undefined, слой будет виден во всех областях.Имя Тип Описание extentExtent | undefined Область видимости слоя.
-
setGradient(colors)
-
Устанавливает цвета градиента как массив строк.
Имя Тип Описание colorsArray.<string> Градиент.
-
setMap(map) унаследованный
-
Устанавливает слой для отображения поверх других слоев на карте. Карта не будет управлять этим слоем в своем списке слоев. Это полезно для временных слоев. Чтобы удалить неуправляемый слой с карты, используйте
#setMap(null).Чтобы добавить слой на карту и иметь возможность управлять им с помощью карты, используйте
addLayerвместо этого.Имя Тип Описание mapMap | null Карта.
-
setMaxResolution(maxResolution) унаследованный
-
Установить максимальное разрешение, при котором слой отображается.
Имя Тип Описание maxResolutionnumber Максимальное разрешение слоя.
-
setMaxZoom(maxZoom) унаследованный
-
Устанавливает максимальный уровень масштабирования (исключительно), при котором слой отображается. Обратите внимание, что уровни масштабирования для видимости слоя основаны на уровне масштабирования представления, который может отличаться от уровня масштабирования источника плиток.
Имя Тип Описание maxZoomnumber Максимальный уровень масштабирования слоя.
-
setMinResolution(minResolution) унаследованный
-
Установить минимальное разрешение, при котором слой отображается.
Имя Тип Описание minResolutionnumber Минимальное разрешение слоя.
-
setMinZoom(minZoom) унаследованный
-
Устанавливает минимальный уровень масштабирования (включительно), при котором слой отображается. Обратите внимание, что уровни масштабирования для видимости слоя основаны на уровне масштабирования представления, который может отличаться от уровня масштабирования источника плиток.
Имя Тип Описание minZoomnumber Минимальный уровень масштабирования слоя.
-
setOpacity(opacity) унаследованный
-
Устанавливает непрозрачность слоя, допустимые значения находятся в диапазоне от 0 до 1.
Имя Тип Описание opacitynumber Непрозрачность слоя.
-
setProperties(values, silent) унаследованный
-
Устанавливает набор пар ключ-значение. Обратите внимание, что это изменяет все существующие свойства и добавляет новые (не удаляет существующие свойства).
Имя Тип Описание valuesObject.<string, *> Значения.
silentboolean | undefined Обновить без срабатывания события.
-
setRadius(radius)
-
Устанавливает размер радиуса в пикселях.
Имя Тип Описание radiusnumber Размер радиуса в пикселях.
-
setSource(source) унаследованный
-
Устанавливает источник слоя.
Имя Тип Описание sourceSourceType | null Источник слоя.
-
setStyle(style) унаследованный
-
Устанавливает стиль для объектов. Это может быть один объект стиля, массив стилей или функция, которая принимает объект и разрешение и возвращает массив стилей. Если установлено значение
null, слой не имеет стиля (стильnull), поэтому только объекты, имеющие собственные стили, будут отображаться в слое. ВызовитеsetStyle()без аргументов, чтобы сбросить до стиля по умолчанию. См.the ol/style/Style moduleдля получения информации о стиле по умолчанию.Если у вашего слоя статический стиль, вы можете использовать
flat styleобъекты-литералы вместо использования конструкторовStyleи символизатора (Fill,Strokeи т. д.):vectorLayer.setStyle({ "fill-color": "yellow", "stroke-color": "black", "stroke-width": 4 })Имя Тип Описание styleStyleLike | FlatStyleLike | null | undefined Стиль слоя.
-
setVisible(visible) унаследованный
-
Устанавливает видимость слоя (
trueилиfalse).Имя Тип Описание visibleboolean Видимость слоя.
-
setZIndex(zindex) унаследованный
-
Устанавливает Z-индекс слоя, используемый для упорядочивания слоев перед отрисовкой. Значение Z-индекса по умолчанию — 0.
Имя Тип Описание zindexnumber Z-индекс слоя.
-
un(type, listener) унаследованный
-
Отключить прослушивание определенного типа событий.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-прослушиватель.
-
unset(key, silent) унаследованный
-
Удаляет свойство.
Имя Тип Описание keystring Имя ключа.
silentboolean | 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