API / geotoolkit / ivaapbackend / well / RasterLogProvider / RasterLogProvider
well.RasterLogProvider.RasterLogProvider
Raster log image data provider for IVAAP backends.
Wraps the IVAAP rasterlogimages tile service, applying image transformation (morphing correction) via WebGL before delivering each tile.
↳
RasterLogProvider
Constructors
- [new RasterLogProvider(baseUrl, httpService, sourceInfo, contentType, segmentId, metadataUrl)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.ivaapbackend.well.rasterlogprovider.rasterlogprovider.md#new rasterlogprovider(baseurl, httpservice, sourceinfo, contenttype, segmentid, metadataurl))
Methods
Constructors
• new RasterLogProvider(baseUrl, httpService, sourceInfo, contentType?, segmentId?, metadataUrl?)
Creates a new RasterLogProvider.
| Name | Type | Description |
|---|---|---|
baseUrl | string | base server URL (typically the IVAAP host) |
httpService | AbstractHttpService | authenticated HTTP service |
sourceInfo | SourceInfo | source info from the rasterlogimages metadata endpoint |
Optional contentType | string | image content type; defaults to 'body' |
Optional segmentId | string | optional segment id; if omitted, the first matching section is used |
Optional metadataUrl | string | full metadata URL used to load sourceInfo; when provided, enables loadImageByType to fetch image types not present in sourceInfo by substituting the content-type value in the URL and appending /content |
EventDispatcher.constructor
Methods
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ getImageInfo(): ImageInfo
Returns metadata for the currently selected image section.
Throws
if the provider was not successfully initialized
▸ getImageLoader(): ImageCallback<TileRequest>
Returns an image loader callback for tiled image rendering. Each tile is fetched from the IVAAP tile endpoint as JSON and the embedded image bytes are morphed using WebGL before being returned as a data URL.
image loader callback for use with tiled image visuals
▸ getImagesInfo(): ImageSection[]
Returns metadata for all available image sections in the source.
▸ getSegmentId(): string
Returns the segment id of the currently opened image section, or null when the provider is not opened.
string
▸ getTileURLFormatter(): Formatter<TileRequest>
Returns a formatter function for tiled image rendering. The formatter maps tile device coordinates to original image pixel coordinates and builds the IVAAP tile service URL.
Formatter<TileRequest>
formatter callback for use with tiled image visuals
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
EventDispatcher.hasEventListener
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isOpened(): boolean
Returns true if the provider has successfully opened a data section.
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ loadImageByType(type, segmentId?): Promise<string>
Loads a full (non-tiled) image of the given content type from the IVAAP rasterlogimages endpoint and returns a blob object URL suitable for use as an <img> src.
The method looks up an image section whose type matches the supplied argument, retrieves the Content HATEOAS link from that section, fetches the image as a binary blob, and wraps it in a blob object URL. The caller is responsible for revoking the URL when it is no longer needed.
Throws
if the provider is not opened
| Name | Type | Description |
|---|---|---|
type | string | content type identifier, e.g. 'TopScale' or 'Header' |
Optional segmentId | string | optional segment id; falls back to the first matching section when omitted |
Promise<string>
a promise that resolves to a blob object URL string, or null when no section with the requested type exists in the source info
▸ notify(type, source, args?): RasterLogProvider
Notify listeners
| Name | Type | Description |
|---|---|---|
type | string | event types |
source | any | of the event |
Optional args | any | arguments of the event |
this
▸ off(type?, callback?): RasterLogProvider
Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.
| Name | Type | Description |
|---|---|---|
Optional type | string | type of the event |
Optional callback | EventListener | function to be called |
this
▸ off<E>(type, callback): RasterLogProvider
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: RasterLogProvider, args: EventMap[E]) => void |
▸ on(type, callback, options?): RasterLogProvider
Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target. </p>
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
callback | EventListener | to be called |
Optional options | Options | options of subscription |
this
▸ on<E>(type, callback, options?): RasterLogProvider
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: RasterLogProvider, args: EventMap[E]) => void |
Optional options | Options |
▸ setSilent(bool): RasterLogProvider
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ updateSegment(segmentId?): Promise<never> | RasterLogProvider
Re-initializes the provider for a different segment. Call this when the user switches between log segments (e.g. different depth intervals).
| Name | Type | Description |
|---|---|---|
Optional segmentId | string | the new segment id; if omitted, first matching section is used |
Promise<never> | RasterLogProvider
this, or a rejected Promise if no matching section is found
▸ Static getClassName(): string
string