Class: ImageCanvasSource

ol/source/ImageCanvas~ImageCanvasSource


import ImageCanvasSource from 'ol/source/ImageCanvas.js';

以 canvas 元素为图像的图像数据源的基类。

new ImageCanvasSource(options)

Name Type Description
attributions AttributionLike | undefined

归属信息。

canvas函数 函数Type | undefined

Canvas 函数。返回数据源用作图像的 canvas 元素的函数。传递给该函数的参数为:Extent 图像范围、{number} 图像分辨率、{number} 地图像素比、Size 图像尺寸和 Projection 图像投影。此函数返回的 canvas 会被数据源缓存。如果函数返回的值后来被更改,则应在数据源上调用 changed 以使数据源使当前缓存的图像失效。参见:changed

interpolate boolean (defaults to true)

重采样时是否使用插值。默认情况下, 重采样时使用线性插值。设置为 false 可使用 the nearest neighbor instead.

projection ProjectionLike | undefined

投影。默认为视图投影。

ratio number (defaults to 1.5)

比率。1 表示 canvas 为地图视口的大小,2 表示地图视口宽高的两倍,以此类推。必须为 1 或更高。

resolutions Array.<number> | undefined

分辨率。如果指定,将为这些分辨率创建新的 canvas

state State | undefined

数据源状态。

触发事件:

Extends

Methods

增加修订计数器并分发 'change' 事件。

dispatchEvent(event){boolean | undefined} inherited

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

Name Type Description
event BaseEvent | string

事件对象。

返回值:
如果有人在事件对象上调用了 preventDefault 或任何监听器返回 false,则返回 false

获取一个值。

Name Type Description
key string

键名。

返回值:
值。

获取数据源的归属函数。

返回值:
Attribution function.

getAttributionsCollapsible(){boolean} inherited

返回值:
归属信息是否可折叠。

getKeys(){Array.<string>} inherited

获取对象属性名列表。

返回值:
属性名列表。

getProjection(){Projection | null} inherited

获取数据源的投影。

返回值:
投影。

getProperties(){NoInfer.<Properties>} inherited

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

返回值:
对象。

getRevision(){number} inherited

获取此对象的版本号。 每次对象被修改时,其版本号将递增。

返回值:
版本号。

获取数据源的状态,可能的状态参见 State。

返回值:
状态。

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

监听特定类型的事件。

Name Type Description
type string | Array.<string>

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

listener function

监听器函数。

返回值:
监听器的唯一键。如果第一个参数是事件类型数组,则返回键的数组。

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

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

Name Type Description
type string | Array.<string>

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

listener function

监听器函数。

返回值:
监听器的唯一键。如果第一个参数是事件类型数组,则返回键的数组。

刷新数据源。数据源将被清除,并从服务器重新加载数据。

set(key, value, silent) inherited

设置一个值。

Name Type Description
key string

键名。

value *

值。

silent boolean | undefined

更新但不触发事件。

setAttributions(attributions) inherited

设置数据源的归属信息。

Name Type Description
attributions AttributionLike | undefined

归属信息。可以作为字符串、Array<string>、Attribution 或 undefined 传入。

setProperties(values, silent) inherited

设置一组键值对。 注意,这会更改任何现有属性并添加新属性(不会移除任何现有属性)。

Name Type Description
values Partial.<NoInfer.<Properties>>

值。

silent boolean | undefined

更新但不触发事件。

un(type, listener) inherited

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

Name Type Description
type string | Array.<string>

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

listener function

监听器函数。

unset(key, silent) inherited

取消设置一个属性。

Name Type Description
key string

键名。

silent boolean | undefined

取消设置但不触发事件。