类:热力图

ol/layer/Heatmap~热力图


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

用于将矢量数据渲染为热力图的图层。请注意,在选项中设置的任何属性都将成为图层对象上的 BaseObject 属性;例如,在选项中设置 title: 'My Title' 表示 title 是可观察的,并且具有 get/set 访问器。

new Heatmap(options)

Name Type 描述
className string (defaults to 'ol-layer')

应用于图层元素的CSS类名。

opacity number (defaults to 1)

不透明度 (0, 1)。

visible boolean (defaults to true)

可见.

extent Extent | undefined

图层渲染的边界范围。图层将不会在此范围之外进行渲染。

zIndex number | undefined

用于图层渲染的 Z-index。在渲染时,图层将首先按 Z-index 排序,然后按位置排序。当undefined, a zIndex添加到地图的图层默认为 0layers集合,或Infinity当图层的setMap()采用了该方法。

minResolution number | undefined

此图层可见的最小分辨率(包含)。

maxResolution number | undefined

最大分辨率(排他性),低于此分辨率时图层可见。

minZoom number | undefined

图层在视图缩放级别高于此最小级别(不包含)时可见。

maxZoom number | undefined

该图层可见的最大视图缩放级别(包含)。

gradient Array.<string> (defaults to ['#00f', '#0ff', '#0f0', '#ff0', '#f00'])

热力图的颜色渐变,指定为 CSS 颜色字符串数组。

radius NumberExpression (defaults to 8)

半径(像素)。注意:对于线串,线宽为半径的两倍。

blur NumberExpression (defaults to 15)

模糊大小(以像素为单位)。该值被添加到radius上述参数用于设定模糊效果的最终尺寸。

weight WeightExpression (defaults to 'weight')

用于指定权重的要素属性。此外,还支持返回数值的表达式或从要素中计算权重的函数。权重值应介于 0 到 1 之间(超出范围的值将被钳制至该区间)。

filter BooleanExpression | undefined

可选的过滤表达式。

variables Object.<string, (number|Array.<number>|string|boolean)> | undefined

表达式中使用的变量(可选)

source VectorSourceType | undefined

点 数据源.

properties Object.<string, *> | undefined

任意可观察属性。可通过以下方式访问#get()#set().

触发事件:

继承

可观察属性

Name Type 可设置 ObjectEvent type 描述
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-index。

方法

递增修订计数器并触发“更改”事件。

dispatchEvent(event){boolean | undefined} inherited

分发一个事件,并调用所有监听此类型事件的监听器。事件参数可以是字符串,也可以是具有 type 属性的对象。

Name Type 描述
event BaseEvent | string

事件对象。

返回:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

获取值。

Name Type 描述
key string

键名。

返回:
Value.

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

获取给定视图中该图层数据源的归属。

Name Type 描述
view View | ViewStateLayerStateExtent | undefined

查看或FrameState仅当图层未添加到地图时才是必需的。

返回:
在给定视图下此图层的版权信息。

返回模糊大小(单位:像素)。

返回:
模糊大小(像素)。

getExtent(){Extent | undefined} inherited

若图层无论范围如何均可见,则返回其 extentundefined

返回:
图层范围

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

获取视口中与给定像素相交的最顶层要素。返回一个Promise,该Promise解析为一个要素数组。当检测到命中时,数组包含最顶层要素;否则为空。

该方法采用的命中检测算法为提升性能而优化,但准确性低于 map.getFeaturesAtPixel() 中使用的算法。文本内容不被考虑,图标仅通过其边界框表示,而非精确图像。

Name Type 描述
pixel Pixel

像素.

返回:
解析为要素数组的Promise。

getGradient(){Array.<string>}

将渐变颜色作为字符串数组返回。

返回:
Colors.

getKeys(){Array.<string>} inherited

获取对象属性名称列表。

返回:
List of property names.

getMaxResolution(){number} inherited

返回图层的最大分辨率。若图层未设置最大分辨率,则返回 Infinity。

返回:
图层的最大分辨率。

getMaxZoom(){number} inherited

返回图层的最大缩放级别。若图层未设置最大缩放,则返回 Infinity。

返回:
图层的最大缩放级别。

getMinResolution(){number} inherited

返回图层的最小分辨率。若图层未设置最小分辨率,则返回 0。

返回:
图层的最小分辨率。

getMinZoom(){number} inherited

返回图层的最小缩放级别。若图层未设置最小缩放级别,则返回负无穷大。

返回:
图层的最小缩放级别。

getOpacity(){number} inherited

返回图层的不透明度(介于0和1之间)。

返回:
图层的不透明度。

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

获取包含所有属性名称及对应值的对象。

返回:
Object.

返回半径的像素值。

返回:
半径大小(以像素为单位)。

getRevision(){number} inherited

获取该对象的版本号。每当对象被修改时,其版本号将自动递增。

返回:
Revision.

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-index,用于在渲染前对图层进行排序。如果图层是非托管的,则返回未定义。

返回:
图层的Z-index

isVisible(view){boolean} inherited

该图层在地图视图中可见,即在其最小/最大分辨率内,或在缩放级别和地理范围内,且未设置为 visible: false,同时不在设置为 visible: false 的图层组内。

Name Type 描述
view View | ViewStateLayerStateExtent | undefined

视图或FrameState仅当图层未添加到地图时才是必需的。

返回:
图层在地图视图中可见。

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

监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型的数组。

listener function

监听器函数

返回:
监听器的唯一键。若以事件类型数组作为首个参数调用,则返回值将是一个键数组。

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

一次性监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或其数组。

listener function

监听器函数。

返回:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

set(key, value, silent) inherited

设置值。

Name Type 描述
key string

键名。

value *

值。

silent boolean | undefined

更新而不触发事件。

setBlur(blur)

设置模糊半径(像素)。

Name Type 描述
blur NumberExpression

模糊半径(像素,支持表达式)

setDeclutter(declutter) inherited

Name Type 描述
declutter boolean | string | number

清理图像和文本。

setExtent(extent) inherited

设置图层的可见范围。如果 undefined,则图层在所有范围都可见。

Name Type 描述
extent Extent | undefined

图层的范围。

setFilter(filter)

设置过滤表达式

Name Type 描述
filter BooleanExpression

过滤表达式

setGradient(colors)

设置渐变颜色为字符串数组。

Name Type 描述
colors Array.<string>

坡度。

设置图层以在地图上其他图层之上渲染。地图不会在其图层集合中管理此图层。这适用于临时图层。要从地图中移除非托管图层,请使用 #setMap(null)

要将图层添加到地图并由地图管理,请使用 addLayer 替代。

Name Type 描述
map Map | null

地图.

setMaxResolution(maxResolution) inherited

设置图层可见的最大分辨率。

Name Type 描述
maxResolution number

图层的最大分辨率。

setMaxZoom(maxZoom) inherited

设置图层可见的最大缩放级别(不包含)。请注意,图层可见性的缩放级别基于视图缩放级别,而视图缩放级别可能与瓦片源缩放级别不同。

Name Type 描述
maxZoom number

图层的最大缩放级别。

setMinResolution(minResolution) inherited

设置图层可见的最小分辨率。

Name Type 描述
minResolution number

图层的最小分辨率

setMinZoom(minZoom) inherited

设置图层可见的最小缩放级别(包含)。请注意,图层可见的缩放级别基于视图缩放级别,而视图缩放级别可能与瓦片源缩放级别不同。

Name Type 描述
minZoom number

图层的最小缩放级别。

setOpacity(opacity) inherited

设置图层的不透明度,取值范围为 0 到 1。

Name Type 描述
opacity number

图层的不透明度

setProperties(values, silent) inherited

设置键值对集合。请注意,此操作将修改现有属性并添加新属性,且不会删除任何现有属性。

Name Type 描述
values Object.<string, *>

值。

silent boolean | undefined

更新时不触发事件。

setRadius(radius)

设置半径大小(像素)

Name Type 描述
radius NumberExpression

半径(像素),支持表达式。

setSource(source) inherited

设置图层源。

Name Type 描述
source SourceType | null

图层数据源。

设置要素的样式。这可以是单个样式对象、样式数组,或是一个接收要素和分辨率并返回样式数组的函数。如果设置为 null,则图层无样式(null 样式),因此仅具有自身样式的要素将在该图层中渲染。调用不带参数的 setStyle() 可重置为默认样式。有关默认样式的详细信息,请参阅 the ol/style/Style module

若图层样式为静态,建议使用 flat style 对象字面量,而非 Style 及符号化器构造函数(FillStroke 等)。

vectorLayer.setStyle({
  "fill-color": "yellow",
  "stroke-color": "black",
  "stroke-width": 4
})
Name Type 描述
style StyleLike | FlatStyleLike | null | undefined

图层样式

setVisible(visible) inherited

设置图层的可见性(truefalse)。

Name Type 描述
visible boolean

图层可见性

setWeight(weight)

设置权重表达式

Name Type 描述
weight WeightExpression

权重表达式

setZIndex(zindex) inherited

设置图层的Z索引,用于在渲染之前对图层进行排序。默认 Z 索引为 0。

Name Type 描述
zindex number

图层的z-index。

un(type, listener) inherited

取消监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

unset(key, silent) inherited

取消设置属性。

Name Type 描述
key string

键名。

silent boolean | undefined

取消设置而不触发事件。