IIIFLayer | ow-leaflet-iiif - v1.0.4

Hierarchy

TileLayer
- IIIFLayer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IIIFLayer(url: string, options?: Partial<IIIFLayerOptions>): IIIFLayer

Overrides TileLayer.constructor
- Defined in layer.ts:38
IIIF Layer constructor.

Parameters
- url: string
  
  The IIIF info endpoint for an image (ex: https://stacks.stanford.edu/image/iiif/hg676jb4964%2F0380_796-44/info.json)
- options: Partial<IIIFLayerOptions> = ...
  
  List of options for the layer
Returns IIIFLayer

Properties

_url

_url: string = ""

height

height: number = 0

initializePromise

initializePromise: Promise<void>

map

map: null | Map = null

options

options: IIIFLayerOptions

server

server: ServerCapabilities = ...

width

width: number = 0

zoomLayers

zoomLayers: { height: number; scale: number; tiles: [number, number]; width: number; zoom: number }[] = ...

Methods

Protected _isValidTile

_isValidTile(coords: Coords): boolean

- Defined in layer.ts:196
Parameters
- coords: Coords
Returns boolean

Private changeFormat

changeFormat(value: string): void

- Defined in layer.ts:290
Parameters
- value: string
Returns void

Private changeMirroring

changeMirroring(value: boolean): void

- Defined in layer.ts:309
Parameters
- value: boolean
Returns void

Private changeQuality

changeQuality(value: string): void

- Defined in layer.ts:295
Parameters
- value: string
Returns void

Private changeRotation

changeRotation(value: number): void

- Defined in layer.ts:300
Parameters
- value: number
Returns void

Private computeZoomLayers

computeZoomLayers(): void

- Defined in layer.ts:246
Compute the different images by zoom level

Returns void

Private getBounds

getBounds(): LatLngBounds

- Defined in layer.ts:225
Compute the bounds of the layer.

Returns LatLngBounds

getTileUrl

getTileUrl(coords: Coords): string

Overrides TileLayer.getTileUrl
- Defined in layer.ts:146
Generate the tile IIIF url based on the tile coordinates

Parameters
- coords: Coords
Returns string

initialize

initialize(url: string, options: Partial<IIIFLayerOptions>): IIIFLayer

- Defined in layer.ts:56
Initialize the layer by calling the info endpoint of the image,
compute the server capabilities and set the initial state.

override

Parameters
- url: string
- options: Partial<IIIFLayerOptions>
Returns IIIFLayer

onAdd

onAdd(map: Map): IIIFLayer

Overrides TileLayer.onAdd
- Defined in layer.ts:97
Parameters
- map: Map
Returns IIIFLayer

onRemove

onRemove(map: Map): IIIFLayer

Overrides TileLayer.onRemove
- Defined in layer.ts:127
Parameters
- map: Map
Returns IIIFLayer

Private onTileLoadStyle

onTileLoadStyle(tile: TileEvent): void

- Defined in layer.ts:317
Handle border of images when the tiles are not full.

Parameters
- tile: TileEvent
Returns void

Private registerEvents

registerEvents(map: Map): void

- Defined in layer.ts:270
Parameters
- map: Map
Returns void

Private unRegisterEvents

unRegisterEvents(map: Map): void

- Defined in layer.ts:280
Parameters
- map: Map
Returns void

Generated using TypeDoc