类:图像层

ol/layer/Image~图像图层


import ImageLayer from 'ol/layer/Image.js';

支持任意范围和分辨率的服务器渲染图像。请注意,在选项中设置的任何属性都将成为图层对象的 BaseObject 属性;例如,设置 title: 'My Title' 将使得 title 可观察,并具备 get/set 访问器。

new ImageLayer(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对于添加到地图的图层,默认为0。layers集合,或Infinity当图层的setMap()采用了该方法。

minResolution number | undefined

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

maxResolution number | undefined

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

minZoom number | undefined

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

maxZoom number | undefined

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

map Map | undefined

将图层设置为地图的叠加层。地图不会在其图层集合中管理该图层,且该图层将渲染于顶层。这适用于临时图层。将图层添加到地图并由地图管理的标准方法是使用map.addLayer().

source ImageSource | undefined

该图层的数据源。

properties Object.<string, *> | undefined

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

触发事件:

继承

可观察的属性

Name Type 可设置 ObjectEvent type 描述
extent Extent | undefined 是的 change:extent

图层范围

maxResolution number 是的 change:maxresolution

图层的最大分辨率。

maxZoom number 是的 change:maxzoom

图层的最大缩放级别。

minResolution number 是的 change:minresolution

图层的最小分辨率。

minZoom number 是的 change:minzoom

图层的最小缩放级别。

opacity number 是的 change:opacity

图层的透明度。

source SourceType | null 是的 change:source

图层源(或null若尚未设置)。

visible boolean 是的 change:visible

The value of the visible图层的属性

zIndex number | undefined 是的 change:zindex

图层的 z-index。

方法

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

dispatchEvent(event){boolean | undefined} inherited

派发事件并调用所有监听该类型事件的监听器。事件参数可以是字符串,也可以是包含 type 属性的对象。

Name Type 描述
event BaseEvent | string

事件对象。

返回:
false 如果事件对象上调用了 preventDefault,或者任何侦听器返回了 false。

获取一个值。

Name Type 描述
key string

键名。

返回:
值。

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

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

Name Type 描述
view View | ViewStateLayerStateExtent | undefined

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

返回:
给定视图中该图层的归属信息。

getData(pixel){Uint8ClampedArray | Uint8Array | Float32Array | DataView | null}

获取指定像素位置的数据,将返回一个四元素 RGBA 数组。对于超出图层范围的请求,将返回 null;仅当数据源的 crossOrigin 属性被设置时,才能检索图像数据。

// display layer data on every pointer move
map.on('pointermove', (event) => {
  console.log(layer.getData(event.pixel));
});
Name Type 描述
pixel Pixel

像素.

返回:
像素数据。

getExtent(){Extent | undefined} inherited

返回图层的 extent;若图层无论范围如何均可见,则返回 undefined

返回:
图层范围。

getKeys(){Array.<string>} inherited

获取对象属性名列表。

返回:
属性名称列表

getMaxResolution(){number} inherited

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

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

getMaxZoom(){number} inherited

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

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

getMinResolution(){number} inherited

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

返回:
图层的最小分辨率

getMinZoom(){number} inherited

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

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

getOpacity(){number} inherited

返回图层的不透明度(在 0 到 1 之间)。

返回:
图层不透明度

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

获取包含所有属性名和属性值的对象。

返回:
对象。

getRevision(){number} inherited

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

返回:
修订。

getSource(){SourceType | null} inherited

获取图层数据源。

返回:
图层源(如果未设置,则使用 null

getVisible(){boolean} inherited

返回此图层的 visible 属性值。要确定图层在地图上是否可见,请改用 isVisible()

返回:
图层 visible 属性值。

getZIndex(){number | undefined} inherited

返回图层的 Z-index,用于在渲染前对图层进行排序。若图层为非托管状态,则返回 undefined。

返回:
图层的z索引。

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

监听函数。

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

set(key, value, silent) inherited

设置值。

Name Type 描述
key string

键名。

value *

值。

silent boolean | undefined

更新而不触发事件。

setExtent(extent) inherited

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

Name Type 描述
extent Extent | undefined

图层范围

设置要在地图上其他图层之上渲染的图层。地图不会在其图层集合中管理此图层。这对于临时图层非常有用。要从地图中移除非托管图层,请使用 #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

更新时不触发事件。

setSource(source) inherited

设置图层源。

Name Type 描述
source SourceType | null

图层源

setVisible(visible) inherited

设置图层可见性(truefalse

Name Type 描述
visible boolean

图层的可见性。

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

在不触发事件的情况下取消设置。