Last updated

API / geotoolkit / welllog / data / loaders / AbstractLoader / AbstractLoader

Class: AbstractLoader

loaders.AbstractLoader.AbstractLoader

Abstract data loader that loads data by requested range

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new AbstractLoader()

new AbstractLoader()

Inherited from

EventDispatcher.constructor

Methods

dispose

dispose(): void

Dispose.

Returns

void

Inherited from

EventDispatcher.dispose


getClassName

getClassName(): string

Returns

string

Overrides

EventDispatcher.getClassName


getDataRange

getDataRange(): Range

Returns log data range

Returns

Range

data range


hasEventListener

hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

Parameters

Name Type Description
typestringtype of event or property
Optional callbackFunctionto be called, if null, check if any callback is registered

Returns

boolean

Inherited from

EventDispatcher.hasEventListener


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

EventDispatcher.isDisposed


isSilent

isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

Returns

boolean

Inherited from

EventDispatcher.isSilent


load

Abstract load(range, scale): Promise<void>

Requests data from the server

Parameters

Name Type Description
rangeRangerange
scalenumberscale

Returns

Promise<void>


notify

notify(type, source, args?): AbstractLoader

Notify listeners

Parameters

Name Type Description
typestringevent types
sourceanyof the event
Optional argsanyarguments of the event

Returns

AbstractLoader

this

Inherited from

EventDispatcher.notify


off

off(type?, callback?): AbstractLoader

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.

Parameters

Name Type Description
Optional typestringtype of the event
Optional callbackEventListenerfunction to be called

Returns

AbstractLoader

this

Inherited from

EventDispatcher.off

off<E>(type, callback): AbstractLoader

Type parameters

NameType
Eextends string

Parameters

Name Type
typeE
callback(eventType: E, sender: AbstractLoader, args: EventMap[E]) => void

Returns

AbstractLoader

Inherited from

EventDispatcher.off


on

on(type, callback, options?): AbstractLoader

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

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.

Parameters

Name Type Description
typestringtype of event or property
callbackEventListenerto be called
Optional optionsOptionsoptions of subscription

Returns

AbstractLoader

this

Inherited from

EventDispatcher.on

on<E>(type, callback, options?): AbstractLoader

Type parameters

NameType
Eextends string

Parameters

Name Type
typeE
callback(eventType: E, sender: AbstractLoader, args: EventMap[E]) => void
Optional optionsOptions

Returns

AbstractLoader

Inherited from

EventDispatcher.on


setSilent

setSilent(bool): AbstractLoader

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

AbstractLoader

this

Inherited from

EventDispatcher.setSilent


getClassName

Static getClassName(): string

Returns

string

Overrides

EventDispatcher.getClassName