类:IIIF

ol/source/IIIF~IIIF标准


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

IIIF图像API服务的图层源。

new IIIF(options)

Name Type 描述
attributions AttributionLike | undefined

归属。

attributionsCollapsible boolean (defaults to true)

归属是可折叠的。

cacheSize number | undefined

已废弃。请使用图层的 cacheSize 选项。

crossOrigin null | string | undefined

请求的 crossOrigin 选项值。

extent Extent (defaults to [0, -height, width, 0])

范围。

format string (defaults to 'jpg')

请求的图像格式。

interpolate boolean (defaults to true)

重采样时请使用插值。默认情况下,重采样采用线性插值;若设置为 false,则改用最近邻插值。

projection ProjectionLike | undefined

投影.

quality string | undefined

请求的IIIF图像质量。版本1默认为“原生”,版本2和3默认为“默认”。

reprojectionErrorThreshold number (defaults to 0.5)

允许的最大重投影误差(以像素为单位)。较高的值可提升重投影性能,但会降低精度。

resolutions Array.<number> | undefined

IIIF 'scaleFactors' 中指定的支持缩放因子

size Size

图像尺寸:[宽度, 高度]。

sizes Array<Size> | undefined

支持的缩放图像尺寸。IIIF info.json 的 'sizes' 属性内容,以 Size 对象数组表示。

state State | undefined

源状态。

supports Array.<string> (defaults to [])

支持 IIIF 的区域和尺寸计算功能。

tilePixelRatio number | undefined

瓦片像素比。

tileSize number | Size | undefined

图块尺寸。所有缩放级别均使用相同的图块尺寸。如果图块尺寸为数值,则默认为方形图块。如果IIIF影像服务支持任意分块(支持sizeByH、sizeByW、sizeByWh或sizeByPct以及regionByPx或regionByPct),则默认tilesize为256。

transition number | undefined

过渡效果。

url string | undefined

IIIF图像服务的基础URL应与IIIF图像ID一致。

version Versions (defaults to Versions.VERSION2)

服务的IIIF图像API版本。

zDirection number | NearestDirectionFunction (defaults to 0)

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

触发事件:

继承

方法

递增修订计数器并分发“change”事件。

从源中清除所有缓存的重投影切片。下一渲染周期将创建新的切片。

dispatchEvent(event){boolean | undefined} inherited

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

Name Type 描述
event BaseEvent | string

事件对象。

返回:
false 若事件对象上已调用 preventDefault 方法,或任一监听器返回了 false 值。

获取值。

Name Type 描述
key string

键名。

返回:
值。

获取源的署名函数。

返回:
归属功能。

getAttributionsCollapsible(){boolean} inherited

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

getKeys(){Array.<string>} inherited

获取对象属性名列表。

返回:
属性名列表。

getProjection(){Projection | null} inherited

获取数据源的投影。

返回:
投影.

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

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

返回:
对象。

getRevision(){number} inherited

获取该对象的版本号。每次修改对象时,其版本号都会递增。

返回:
修订。

获取源的状态,请参阅 State 了解可能的状态。

返回:
状态。

getTileGrid(){TileGrid | null} inherited

返回瓦片源的瓦片网格。

返回:
瓦片 网格.

已弃用。请改用 ImageTile 源。返回源的瓦片加载函数。

返回:
瓦片加载函数

已弃用。请改用 ImageTile 源。 返回源的瓦片URL函数。

返回:
瓦片URL函数

getUrls(){!Array.<string> | null} inherited

已弃用。请改用ImageTile源。返回此源所使用的URL。当使用tileUrlFunction而非url或urls时,将返回null。

返回:
网址。

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) inherited

设置源的归属信息。

Name Type 描述
attributions AttributionLike | undefined

归属。 可以传递为string, Array<string>, Attribution,或者undefined.

setProperties(values, silent) inherited

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

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

值。

silent boolean | undefined

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

setRenderReprojectionEdges(render) inherited

设置是否渲染重投影边缘(通常用于调试)。

Name Type 描述
render boolean

渲染边缘。

setTileGridForProjection(projection, tilegrid) inherited

设置用于将瓦片重新投影到指定投影的瓦片网格,而非该投影的默认瓦片网格。

当默认瓦片网格无法创建时(例如投影范围未定义),或为优化目的(如自定义瓦片大小、分辨率等),这可能很有用。

Name Type 描述
projection ProjectionLike

投影.

tilegrid TileGrid

用于投影的瓦片网格。

setTileLoadFunction(tileLoadFunction) inherited

已弃用。请改用ImageTile源。设置源的瓦片加载函数。

Name Type 描述
tileLoadFunction LoadFunction

瓦片加载函数

setTileUrlFunction(tileUrlFunction, key) inherited

已弃用。请改用 ImageTile 源。设置源的瓦片URL函数。

Name Type 描述
tileUrlFunction UrlFunction

瓦片URL函数

key string | undefined

源的可选新瓦片键。

设置请求所使用的URL。

Name Type 描述
url string

网址。

已弃用。请改用 ImageTile 源。设置用于请求的URL。

Name Type 描述
urls Array.<string>

网址。

un(type, listener) inherited

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

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

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

listener function

监听器函数。

unset(key, silent) inherited

清除属性。

Name Type 描述
key string

键名。

silent boolean | undefined

取消设置而不触发事件。