-
Name Type Description classNamestring (defaults to 'ol-layer') 设置到图层元素的 CSS 类名。
opacitynumber (defaults to 1) 不透明度 (0, 1)。
visibleboolean (defaults to true) 可见性。
extentExtent | undefined 图层渲染的边界范围。 图层不会在此范围之外渲染。
zIndexnumber | undefined 图层渲染的 z-index。在渲染时,图层将按 Z-index 排序,然后按位置排序。当
undefined时,添加到地图layers集合的图层假定zIndex为 0,或使用图层setMap()方法时为Infinity。minResolutionnumber | undefined 此图层可见的最小分辨率(含)。
maxResolutionnumber | undefined 此图层可见的最大分辨率(不含)。
minZoomnumber | undefined 此图层可见的最小视图缩放级别(不含)。
maxZoomnumber | undefined 此图层可见的最大视图缩放级别(含)。
gradientArray.<string> (defaults to ['#00f', '#0ff', '#0f0', '#ff0', '#f00']) 热力图的颜色渐变,指定为 CSS 颜色字符串数组。
radiusNumberExpression (defaults to 8) 半径大小(像素)。注意对于 LineString,线的宽度将是半径的两倍。
blurNumberExpression (defaults to 15) 模糊大小(像素)。此值与上面的
radius参数相加,形成模糊效果的最终大小。weightWeightExpression (defaults to 'weight') 用于权重的要素属性。这也支持返回数字的表达式或从要素返回权重的函数。权重值应在 0 到 1 之间(超出范围的值将被限制在该范围内)。
filterBooleanExpression | undefined 可选的过滤表达式。
variables对象。<string, (number|Array.<number>|string|boolean)> | undefined 表达式中使用的变量(可选)
sourceVectorSourceType | undefined 点数据源。
properties对象。<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)
-
Extends
Observable Properties
| Name | Type | Settable | ObjectEvent type | Description |
|---|---|---|---|---|
blur |
NumberExpression | yes | change:blur |
模糊大小(像素)。 |
extent |
Extent | undefined | yes | change:extent |
图层范围。 |
gradient |
Array.<string> | yes | change:gradient |
颜色。 |
maxResolution |
number | yes | change:maxresolution |
图层的最大分辨率。 |
maxZoom |
number | yes | change:maxzoom |
图层的最大缩放级别。 |
minResolution |
number | yes | change:minresolution |
图层的最小分辨率。 |
minZoom |
number | yes | change:minzoom |
图层的最小缩放级别。 |
opacity |
number | yes | change:opacity |
图层的不透明度。 |
radius |
NumberExpression | yes | change:radius |
半径大小(像素)。 |
source |
SourceType | null | yes | change:source |
图层数据源(如果尚未设置则为 |
visible |
boolean | yes | change:visible |
图层 |
zIndex |
number | undefined | yes | change:zindex |
图层的 Z-index。 |
Methods
-
增加修订计数器并分发 'change' 事件。
-
分发事件并调用所有监听此类型事件的监听器。事件参数可以是一个字符串或一个 具有
type属性的对象。Name Type Description eventBaseEvent | string 事件对象。
返回值:
如果有人在事件对象上调用了 preventDefault 或任何监听器返回 false,则返回false。
-
获取一个值。
Name Type Description keystring 键名。
返回值:
值。
-
获取此图层数据源在给定视图下的归属信息。
Name Type Description viewView | ViewStateLayerStateExtent | undefined View 或
FrameState。仅在图层未添加到地图时需要。返回值:
此图层在给定视图下的归属信息。
-
返回blur size in pixels.
返回值:
模糊大小(像素)。
-
返回图层的
范围,如果无论范围如何都可见则返回undefined。返回值:
图层范围。
-
获取与视口上给定像素相交的最上层要素。返回一个解析为要素数组的 Promise。当检测到命中时,数组将包含最上层的要素,否则为空。
此方法使用的命中检测算法针对性能进行了优化,但不如
map.getFeaturesAtPixel()中使用的算法准确。文本不被考虑,图标仅由其边界框表示而非精确图像。Name Type Description pixelPixel 像素。
返回值:
解析为要素数组的 Promise。
-
返回渐变颜色(字符串数组)。
返回值:
颜色。
-
获取对象属性名列表。
返回值:
属性名列表。
-
返回图层的最大分辨率。如果图层未设置最大分辨率则返回 Infinity。
返回值:
图层的最大分辨率。
-
返回图层的最大缩放级别。如果图层未设置最大缩放则返回 Infinity。
返回值:
图层的最大缩放级别。
-
返回图层的最小分辨率。如果图层未设置最小分辨率则返回 0。
返回值:
图层的最小分辨率。
-
返回图层的最小缩放级别。如果图层未设置最小缩放则返回 -Infinity。
返回值:
图层的最小缩放级别。
-
返回图层的不透明度(0 到 1 之间)。
返回值:
图层的不透明度。
-
获取包含所有属性名和值的对象。
返回值:
对象。
-
返回半径大小(像素)。
返回值:
半径大小(像素)。
-
获取此对象的版本号。 每次对象被修改时,其版本号将递增。
返回值:
版本号。
-
获取图层数据源。
返回值:
图层数据源(如果尚未设置则为null)。
-
获取要素的样式。返回构造时传递给
style选项或setStyle方法的值。返回值:
图层样式。
-
获取样式函数。
返回值:
图层样式函数。
-
返回此图层
visible属性的值。要确定图层在地图上是否可见,请改用isVisible()。返回值:
图层visible属性的值。
-
返回图层的 Z-index,用于在渲染前排列图层顺序。如果图层未管理则返回 undefined。
返回值:
图层的 Z-index。
-
图层在地图视图中可见,即在其最小/最大分辨率或缩放级别和范围内,未设置为
visible: false,且不在设置为visible: false的图层组内。Name Type Description viewView | ViewStateLayerStateExtent | undefined View 或
FrameState。仅在图层未添加到地图时需要。返回值:
图层在地图视图中可见。
-
监听特定类型的事件。
Name Type Description typestring | Array.<string> 事件类型或事件类型数组。
listenerfunction 监听器函数。
返回值:
监听器的唯一键。如果第一个参数是事件类型数组,则返回键的数组。
-
仅监听一次特定类型的事件。
Name Type Description typestring | Array.<string> 事件类型或事件类型数组。
listenerfunction 监听器函数。
返回值:
监听器的唯一键。如果第一个参数是事件类型数组,则返回键的数组。
-
设置一个值。
Name Type Description keystring 键名。
value* 值。
silentboolean | undefined 更新但不触发事件。
-
设置blur size in pixels.
Name Type Description blurNumberExpression 模糊大小(像素),支持表达式。
-
Name Type Description declutterboolean | string | number 去除图像和文本重叠。
-
设置图层可见的范围。如果为
undefined,图层在所有范围中都可见。Name Type Description extentExtent | undefined 图层的范围。
-
设置filter expression
Name Type Description filterBooleanExpression 过滤表达式
-
设置渐变颜色(字符串数组)。
Name Type Description colorsArray.<string> 渐变。
-
将图层设置为在地图上渲染在其他图层之上。地图不会在其图层集合中管理此图层。这适用于临时图层。要从地图中移除非托管图层,请使用
#setMap(null)。要将图层添加到地图并由地图管理,请改用
addLayer。Name Type Description mapMap | null 地图。
-
设置图层可见的最大分辨率。
Name Type Description maxResolutionnumber 图层的最大分辨率。
-
设置图层可见的最大缩放(不含)。注意,图层可见性的缩放级别基于视图缩放级别,这可能与瓦片数据源的缩放级别不同。
Name Type Description maxZoomnumber 图层的最大缩放。
-
设置图层可见的最小分辨率。
Name Type Description minResolutionnumber 图层的最小分辨率。
-
设置图层可见的最小缩放(含)。注意,图层可见性的缩放级别基于视图缩放级别,这可能与瓦片数据源的缩放级别不同。
Name Type Description minZoomnumber 图层的最小缩放。
-
设置图层的不透明度,允许值范围为 0 到 1。
Name Type Description opacitynumber 图层的不透明度。
-
设置一组键值对。 注意,这会更改任何现有属性并添加新属性(不会移除任何现有属性)。
Name Type Description valuesPartial.<NoInfer.<Properties>> 值。
silentboolean | undefined 更新但不触发事件。
-
设置半径大小(像素)。
Name Type Description radiusNumberExpression 半径大小(像素),支持表达式。
-
设置图层数据源。
Name Type Description sourceSourceType | null 图层数据源。
-
设置要素的样式。可以是单个样式对象、样式数组,或接受要素和分辨率并返回样式数组的函数。如果设置为
null,图层没有样式(null样式),因此只有具有自身样式的要素会在图层中渲染。不带参数调用setStyle()可重置为默认样式。有关默认样式的信息,请参见ol/style/Style 模块。如果您的图层使用静态样式,可以使用
扁平样式对象字面量,而不必使用Style和符号化构造函数(Fill、Stroke等):vectorLayer.setStyle({ "fill-color": "yellow", "stroke-color": "black", "stroke-width": 4 })Name Type Description styleStyleLike | FlatStyleLike | null | undefined 图层样式。
-
设置图层的可见性(
true或false)。Name Type Description visibleboolean 图层的可见性。
-
设置weight expression
Name Type Description weightWeightExpression 权重表达式
-
设置图层的 Z-index,用于在渲染前排列图层顺序。 默认 Z-index 为 0。
Name Type Description zindexnumber 图层的 z-index。
-
取消监听特定类型的事件。
Name Type Description typestring | Array.<string> 事件类型或事件类型数组。
listenerfunction 监听器函数。
-
取消设置一个属性。
Name Type Description keystring 键名。
silentboolean | undefined 取消设置但不触发事件。