Class: UTFGrid

ol/source/UTFGrid~UTFGrid


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

从 TileJSON 格式加载的 UTFGrid 交互数据的图层数据源。

new UTFGrid(options)

Name Type Description
preemptive boolean (defaults to true)

如果为 true,UTFGrid 数据源根据瓦片的"可见性"加载瓦片。这提高了响应速度,但增加了流量。注意如果设置为 false(懒加载),您需要向 forDataAtCoordinateAndResolution 方法传递 true 作为 request,否则永远不会加载数据。

jsonp boolean (defaults to false)

使用带回调的 JSONP 加载 TileJSON。当服务器不支持 CORS 时有用。

tileJSON Config | undefined

此数据源的 TileJSON 配置。如果未提供,必须配置 url

url string | undefined

提供此数据源配置的 TileJSON 端点。请求将通过 JSONP 进行。如果未提供,必须配置 tileJSON

wrapX boolean (defaults to true)

是否水平环绕世界。

zDirection number | NearestDirection函数 (defaults to 0)

选择在整数缩放级别之间使用更高还是更低缩放级别的瓦片。参见 getZForResolution

触发事件:

Extends

Methods

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

移除数据源中所有缓存的重投影瓦片。下一个渲染周期将创建新的瓦片。

dispatchEvent(event){boolean | undefined} inherited

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

Name Type Description
event BaseEvent | string

事件对象。

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

forDataAtCoordinateAndResolution(coordinate, resolution, callback, request)

使用给定坐标和分辨率的可用数据调用回调(默认同步),如果尚未加载或出错则为 null

Name Type Description
coordinate Coordinate

坐标。

resolution number

分辨率。

callback function

回调。

request boolean | undefined

如果为 true,回调始终为异步。如果尚未加载,将请求瓦片数据。

获取一个值。

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。

返回值:
状态。

getTemplate(){string | undefined}

返回template from TileJSON.

返回值:
The template from TileJSON.

getTileGrid(){TileGrid | null} inherited

返回瓦片数据源的瓦片网格。

返回值:
瓦片网格。

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

取消设置但不触发事件。