Last updated

API / geotoolkit / map / sources / connectors / PreloadedImage / PreloadedImage

Class: PreloadedImage

connectors.PreloadedImage.PreloadedImage

Source connector that sends http requests to load the data, and after that creates DOM image with the received base64 data This approach allows user to effectively abort the requests, if necessary, and the DOM image data reload occurs quickly due to browser cache

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new PreloadedImage(options)

new PreloadedImage(options?)

Parameters

Name Type Description
Optional optionsOptionsoptions

Overrides

DOMImage.constructor

Methods

abort

abort(key?): PreloadedImage

Aborts the previous queries sent

Parameters

Name Type Description
Optional keystringkey of the queries to abort (all queries aborted if nothing provided)

Returns

PreloadedImage

this

Inherited from

DOMImage.abort


abortConnection

Protected abortConnection(connection): PreloadedImage

Aborts the connection provided

Parameters

Name Type Description
connectionConnectionconnection to abort

Returns

PreloadedImage

this

Inherited from

DOMImage.abortConnection


addConnection

Protected addConnection(key, connection): PreloadedImage

Adds connection to the list

Parameters

Name Type Description
keystringkey of the connection (null if no provided)
connectionConnectionconnection to add to the list

Returns

PreloadedImage

this

Inherited from

DOMImage.addConnection


clone

clone(): AbstractConnector<Connection>

All subclasses should override copyConstructor or provide custom implementation for this method

Returns

AbstractConnector<Connection>

clone

Inherited from

DOMImage.clone


getClassName

getClassName(): string

Returns

string

Inherited from

DOMImage.getClassName


getConnection

Protected getConnection(key): Connection

Returns connection by the key

Parameters

Name Type Description
keystringkey for the connection

Returns

Connection

connection

Inherited from

DOMImage.getConnection


isLoading

isLoading(): boolean

Checks if some connections are still loading

Returns

boolean

Inherited from

DOMImage.isLoading


removeConnection

Protected removeConnection(key, connection): PreloadedImage

Removes connection from the list

Parameters

Name Type Description
keystringkey of the connection (null if no provided)
connectionConnectionconnection to remvoe from the list

Returns

PreloadedImage

this

Inherited from

DOMImage.removeConnection


send

send(url, options, callback): void

Sends a request using the query provided

Parameters

Name Type Description
urlstringthe url requested
optionsSendOptionsextra options for the request (null if no needed)
callbackSendCallbackthe result handler that's called when response is received

Returns

void

Overrides

DOMImage.send


getClassName

Static getClassName(): string

Returns

string

Inherited from

DOMImage.getClassName