OpenLayers v10.2.1 API - Class: Zoomify

new Zoomify(options) source/Zoomify.js, line 124

Name	Type	Description
`attributions`	AttributionLike \| undefined	Attributions.
`cacheSize`	number \| undefined	Deprecated. Use the cacheSize option on the layer instead.
`crossOrigin`	null \| string \| undefined	The `crossOrigin` attribute for loaded images. Note that you must provide a `crossOrigin` value you want to access pixel data with the Canvas renderer. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
`interpolate`	boolean (defaults to true)	Use interpolated values when resampling. By default, linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.
`projection`	ProjectionLike \| undefined	Projection.
`tilePixelRatio`	number \| undefined	The pixel ratio used by the tile service. For example, if the tile service advertizes 256px by 256px tiles but actually sends 512px by 512px images (for retina/hidpi devices) then `tilePixelRatio` should be set to `2`
`reprojectionErrorThreshold`	number (defaults to 0.5)	Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.
`url`	string	URL template or base URL of the Zoomify service. A base URL is the fixed part of the URL, excluding the tile group, z, x, and y folder structure, e.g. `http://my.zoomify.info/IMAGE.TIF/`. A URL template must include `{TileGroup}`, `{x}`, `{y}`, and `{z}` placeholders, e.g. `http://my.zoomify.info/IMAGE.TIF/{TileGroup}/{z}-{x}-{y}.jpg`. Internet Imaging Protocol (IIP) with JTL extension can be also used with `{tileIndex}` and `{z}` placeholders, e.g. `http://my.zoomify.info?FIF=IMAGE.TIF&JTL={z},{tileIndex}`. A `{?-?}` template pattern, for example `subdomain{a-f}.domain.com`, may be used instead of defining each one separately in the `urls` option.
`tierSizeCalculation`	TierSizeCalculation \| undefined	Tier size calculation method: `default` or `truncated`.
`size`	Size	Size.
`extent`	Extent \| undefined	Extent for the TileGrid that is created. Default sets the TileGrid in the fourth quadrant, meaning extent is `[0, -height, width, 0]`. To change the extent to the first quadrant (the default for OpenLayers 2) set the extent as `[0, 0, width, height]`.
`transition`	number \| undefined	Duration of the opacity transition for rendering. To disable the opacity transition, pass `transition: 0`.
`tileSize`	number (defaults to 256)	Tile size. Same tile size is used for all zoom levels.
`zDirection`	number \| NearestDirectionFunction (defaults to 0)	Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See `getZForResolution`.

Fires:

change (BaseEvent) - Generic change event. Triggered when the revision counter is increased.
error (BaseEvent) - Generic error event. Triggered when an error occurs.
propertychange (ObjectEvent) - Triggered when a property is changed.
tileloadend (TileSourceEvent) - Triggered when a tile finishes loading, either when its data is loaded, or when loading was aborted because the tile is no longer needed.
tileloaderror (TileSourceEvent) - Triggered if tile loading results in an error. Note that this is not the right place to re-fetch tiles. See load for details.
tileloadstart (TileSourceEvent) - Triggered when a tile starts loading.

Extends

TileImage

Methods

changed() inherited Observable.js, line 68

Increases the revision counter and dispatches a 'change' event.

clear() inherited source/Tile.js, line 253

Remove all cached reprojected tiles from the source. The next render cycle will create new tiles.

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name	Type	Description
`event`	BaseEvent \| string	Event object.

Returns:

false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited Object.js, line 135

Gets a value.

Name	Type	Description
`key`	string	Key name.

Returns:

Value.

getAttributions(){Attribution} inherited source/Source.js, line 129

Get the attribution function for the source.

Returns:

Attribution function.

getAttributionsCollapsible(){boolean} inherited source/Source.js, line 137

Returns:

Attributions are collapsible.

getKeys(){Array.<string>} inherited Object.js, line 148

Get a list of object property names.

Returns:

List of property names.

getProjection(){Projection | null} inherited source/Source.js, line 146

Get the projection of the source.

Returns:

Projection.

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

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited Observable.js, line 79

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

getState(){State} inherited source/Source.js, line 170

Get the state of the source, see State for possible states.

Returns:

State.

getTileGrid(){TileGrid | null} inherited source/Tile.js, line 189

Return the tile grid of the tile source.

Returns:

Tile grid.

getTileLoadFunction(){LoadFunction} inherited source/UrlTile.js, line 100

Deprecated. Use an ImageTile source instead. Return the tile load function of the source.

Returns:

TileLoadFunction

getTileUrlFunction(){UrlFunction} inherited source/UrlTile.js, line 110

Deprecated. Use an ImageTile source instead. Return the tile URL function of the source.

Returns:

TileUrlFunction

getUrls(){!Array.<string> | null} inherited source/UrlTile.js, line 124

Deprecated. Use an ImageTile source instead. Return the URLs used for this source. When a tileUrlFunction is used instead of url or urls, null will be returned.

Returns:

URLs.

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 152

Listen for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 164

Listen once for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

set(key, value, silent) inherited Object.js, line 215

Sets a value.

Name	Type	Description
`key`	string	Key name.
`value`	*	Value.
`silent`	boolean \| undefined	Update without triggering an event.

setAttributions(attributions) inherited source/Source.js, line 203

Set the attributions of the source.

Name	Type	Description
`attributions`	AttributionLike \| undefined	Attributions. Can be passed as `string`, `Array<string>`, `Attribution`, or `undefined`.

setProperties(values, silent) inherited Object.js, line 235

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name	Type	Description
`values`	Object.<string, *>	Values.
`silent`	boolean \| undefined	Update without triggering an event.

setRenderReprojectionEdges(render) inherited source/TileImage.js, line 280

Sets whether to render reprojection edges or not (usually for debugging).

Name	Type	Description
`render`	boolean	Render the edges.

setTileGridForProjection(projection, tilegrid) inherited source/TileImage.js, line 300

Sets the tile grid to use when reprojecting the tiles to the given projection instead of the default tile grid for the projection.

This can be useful when the default tile grid cannot be created (e.g. projection has no extent defined) or for optimization reasons (custom tile size, resolutions, ...).

Name	Type	Description
`projection`	ProjectionLike	Projection.
`tilegrid`	TileGrid	Tile grid to use for the projection.

setTileLoadFunction(tileLoadFunction) inherited source/UrlTile.js, line 161

Deprecated. Use an ImageTile source instead. Set the tile load function of the source.

Name	Type	Description
`tileLoadFunction`	LoadFunction	Tile load function.

setTileUrlFunction(tileUrlFunction, key) inherited source/UrlTile.js, line 173

Deprecated. Use an ImageTile source instead. Set the tile URL function of the source.

Name	Type	Description
`tileUrlFunction`	UrlFunction	Tile URL function.
`key`	string \| undefined	Optional new tile key for the source.

setUrl(url) inherited source/UrlTile.js, line 187

Set the URL to use for requests.

Name	Type	Description
`url`	string	URL.

setUrls(urls) inherited source/UrlTile.js, line 199

Deprecated. Use an ImageTile source instead. Set the URLs to use for requests.

Name	Type	Description
`urls`	Array.<string>	URLs.

un(type, listener) inherited Observable.js, line 173

Unlisten for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

unset(key, silent) inherited Object.js, line 259

Unsets a property.

Name	Type	Description
`key`	string	Key name.
`silent`	boolean \| undefined	Unset without triggering an event.