类:源

ol/source/Source~数据源


import Source from 'ol/source/Source.js';

抽象基类;通常仅用于派生子类,而不在应用程序中实例化。Layer 数据源的基类。

当数据源状态发生变化时,会触发通用 change 事件。

new Source(options)

Name Type 描述
attributions AttributionLike | undefined

版权信息。

attributionsCollapsible boolean (defaults to true)

归属是可折叠的。

projection ProjectionLike | undefined

投影默认为视图投影。

state State (defaults to 'ready')

状态。

wrapX boolean (defaults to false)

水平环绕。

interpolate boolean (defaults to false)

重采样时应使用插值。默认情况下,采用最近邻插值法。

触发事件:

子类

继承

方法

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

dispatchEvent(event){boolean | undefined} inherited

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

Name Type 描述
event BaseEvent | string

事件对象。

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

获取值。

Name Type 描述
key string

键名

返回:
值。

getAttributions(){Attribution}

获取源的归因函数。

返回:
版权功能。

getAttributionsCollapsible(){boolean}

返回:
归属是可折叠的。

getKeys(){Array.<string>} inherited

获取对象属性名称列表

返回:
属性名称列表

getProjection(){Projection | null}

获取源的投影

返回:
投影.

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

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

返回:
对象。

getRevision(){number} inherited

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

返回:
修订。

获取数据源状态,请参考 State 了解可能的状态。

返回:
状态。

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

在不触发事件的情况下更新。

setAttributions(attributions)

设置源的归属。

Name Type 描述
attributions AttributionLike | undefined

版权信息。可以作为string, Array<string>, Attribution,或undefined.

setProperties(values, silent) inherited

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

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

值。

silent boolean | undefined

更新时不触发事件。

un(type, listener) inherited

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

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

事件类型或其数组。

listener function

监听器函数。

unset(key, silent) inherited

移除属性。

Name Type 描述
key string

键名。

silent boolean | undefined

清除设置而不触发事件。