Class LoadImageControl

A map control that opens images and GeoTIFFs (file chooser, URL, or drag and drop) as EnhancedGeoTIFF sources.

Example

const layer = new GpuCorrectedTileLayer();
map.addLayer(layer);
map.addControl(new LoadImageControl({ layer }));
map.addControl(new EnhanceControl({ layer }));

Hierarchy

Control
- LoadImageControl

Index

Constructors

constructor

Methods

openChooser isLoading loadFile loadUrl setMap disposeInternal createSource

Constructors

constructor

new LoadImageControl(options?: LoadImageControlOptions): LoadImageControl
Parameters
- options: LoadImageControlOptions = {}
Returns LoadImageControl
Overrides Control.constructor
- Defined in browser-image-enhancement/src/openlayers/load-image-control.ts:171

Methods

openChooser

openChooser(): void
Opens the browser's file chooser, as the open button does without onOpen.

Returns void
- Defined in browser-image-enhancement/src/openlayers/load-image-control.ts:225

isLoading

isLoading(): boolean
Whether a load is in progress.

Returns boolean
- Defined in browser-image-enhancement/src/openlayers/load-image-control.ts:230

loadFile

loadFile(
    file: Blob,
    name?: string,
    options?: LoadFileOptions,
): Promise<EnhancedGeoTIFF>
Loads a GeoTIFF, or an ordinary picture placed over the view. Resolves with the new source once it is on the layer (and the map fitted to it).
Parameters
- file: Blob
- name: string = ...
- options: LoadFileOptions = {}
Returns Promise<EnhancedGeoTIFF>
- Defined in browser-image-enhancement/src/openlayers/load-image-control.ts:238

loadUrl

loadUrl(url: string): Promise<EnhancedGeoTIFF>
Loads a COG (or any GeoTIFF the server allows range requests on) from url.
Parameters
- url: string
Returns Promise<EnhancedGeoTIFF>
- Defined in browser-image-enhancement/src/openlayers/load-image-control.ts:251

setMap

setMap(map: Map | null): void
Remove the control from its current map and attach it to the new map. Pass null to just remove the control from the current map. Subclasses may set up event handlers to get notified about changes to the map here.
Parameters
- map: Map | null
  Map.
Returns void

Api
Overrides Control.setMap
- Defined in browser-image-enhancement/src/openlayers/load-image-control.ts:255

`Protected`disposeInternal

disposeInternal(): void
Protected
Extension point for disposable objects.

Returns void
Overrides Control.disposeInternal
- Defined in browser-image-enhancement/src/openlayers/load-image-control.ts:293

createSource

createSource(file: Blob, options?: LoadFileOptions): Promise<EnhancedGeoTIFF>
Makes the source loadFile would show for the GeoTIFF file, with the same options, but neither shows it nor calls onLoad: for replacing the source of a layer of your own (a file the same image is read from in another way, say). Resolves once the GeoTIFF has been read.
Parameters
- file: Blob
- options: LoadFileOptions = {}
Returns Promise<EnhancedGeoTIFF>
- Defined in browser-image-enhancement/src/openlayers/load-image-control.ts:323

Class LoadImageControl

Example

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns LoadImageControl

Methods

openChooser

Returns void

isLoading

Returns boolean

loadFile

Parameters

Returns Promise<EnhancedGeoTIFF>

loadUrl

Parameters

Returns Promise<EnhancedGeoTIFF>

setMap

Parameters

Returns void

Api

`Protected`disposeInternal

Returns void

createSource

Parameters

Returns Promise<EnhancedGeoTIFF>

Settings

On This Page

Class LoadImageControl

Example

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns LoadImageControl

Methods

openChooser

Returns void

isLoading

Returns boolean

loadFile

Parameters

Returns Promise<EnhancedGeoTIFF>

loadUrl

Parameters

Returns Promise<EnhancedGeoTIFF>

setMap

Parameters

Returns void

Api

ProtecteddisposeInternal

Returns void

createSource

Parameters

Returns Promise<EnhancedGeoTIFF>

Settings

On This Page

`Protected`disposeInternal