Spec-Zone.ru › OpenLayers

ol/layer/Heatmap~Heatmap


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

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

new Heatmap(options)

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

Имя CSS-класса, устанавливаемого для элемента слоя.

opacity number (по умолчанию 1)

Непрозрачность (0, 1).

visible boolean (по умолчанию true)

Видимость.

extent Extent | undefined

Ограничивающая область для отрисовки слоя. Слой не будет отрисовываться за пределами этой области.

zIndex number | undefined

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

minResolution number | undefined

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

maxResolution number | undefined

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

minZoom number | undefined

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

maxZoom number | undefined

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

gradient Array.<string> (по умолчанию ['#00f', '#0ff', '#0f0', '#ff0', '#f00'])

Градиент цвета тепловой карты, задаваемый массивом CSS-строк цвета.

radius number (по умолчанию 8)

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

blur number (по умолчанию 15)

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

weight string | function (по умолчанию 'weight')

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

source VectorSourceType | 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 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

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

visible boolean да change:visible

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

zIndex number | undefined да change:zindex

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

Методы

changed() inherited

Observable.js, line 68

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

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

Отправляет событие и вызывает все обработчики, которые слушают события этого типа. Параметр события может быть строкой или объектом с свойством 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 Представление | ViewStateLayerStateExtent | undefined

Представление или FrameState. Требуется только когда слой не добавлен в карту.

Возвращает:
Атрибуты этого слоя в данном представлении.

getBlur(){number}

layer/Heatmap.js, line 126

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

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

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 Пиксель

Пиксель.

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

getGradient(){Array.<string>}

layer/Heatmap.js, line 136

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

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

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, если у слоя нет максимального уровня масштабирования.

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

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).

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

getProperties(){Object.<string, *>} inherited

Object.js, line 157

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

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

getRadius(){number}

layer/Heatmap.js, line 146

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

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

getRevision(){number} inherited

Observable.js, line 79

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

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

getSource(){SourceType | null} inherited

layer/Layer.js, line 209

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

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

getStyle(){StyleLike | FlatStyleLike | null | undefined} inherited

layer/BaseVector.js, line 204

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

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

getStyleFunction(){StyleFunction | undefined} inherited

layer/BaseVector.js, line 213

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

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

getVisible(){boolean} inherited

layer/Base.js, line 282

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

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

getZIndex(){number | undefined} inherited

layer/Base.js, line 293

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

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

isVisible(view){boolean} inherited

layer/Layer.js, line 301

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

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

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

Возвращает:
Слой виден на представлении карты.

on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 152

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

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

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

listener функция

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

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

once(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

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

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

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

listener функция

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

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

set(key, value, silent) inherited

Object.js, line 215

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

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

Имя ключа.

value *

Значение.

silent boolean | undefined

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

setBlur(blur)

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

Устанавливает размер размытия в пикселях.

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

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

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

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

Объединить изображения и текст.

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

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

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

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

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

setGradient(colors)

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

Устанавливает цвета градиента как массив строк.

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

Градиент.

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

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

setRadius(radius)

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

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

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

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

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-индекс слоя, используемый для упорядочивания слоев перед отрисовкой. Значение 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_Heatmap-Heatmap.html

Spec-Zone.ru

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