Last updated

API / geotoolkit / welllog / multiwell / LatLonDistanceStrategy / LatLonDistanceStrategy

Class: LatLonDistanceStrategy

multiwell.LatLonDistanceStrategy.LatLonDistanceStrategy

Computes distance based on well's lat-long coordinates Use: multiWellWidget.setDistanceStrategy(new LatLonDistanceStrategy(options));

Hierarchy

Table of contents

Constructors
Methods
Css Properties
Name Type Description
unitstringDesired distance unit

Contents

Constructors

new LatLonDistanceStrategy(options)

new LatLonDistanceStrategy(options)

Creates Lat-Lon Distance Strategy

Parameters

Name Type Description
optionsOptionsarray of wells

Overrides

AbstractDistanceStrategy.constructor

Methods

dispose

dispose(): void

Dispose.

Returns

void

Inherited from

AbstractDistanceStrategy.dispose


getClassName

getClassName(): string

Returns

string

Inherited from

AbstractDistanceStrategy.getClassName


getDistance

getDistance(well1, well2): number

Returns distance in pixels

Parameters

Name Type
well1ITrack
well2ITrack

Returns

number

Overrides

AbstractDistanceStrategy.getDistance


getHeaderLabel

getHeaderLabel(well1, well2): string

Returns visible depth range

Parameters

Name Type
well1ITrack
well2ITrack

Returns

string

Overrides

AbstractDistanceStrategy.getHeaderLabel


getProperties

getProperties(): Options

Gets all the properties pertaining to this object

Returns

Options

properties object


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

AbstractDistanceStrategy.hasEventListener


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

AbstractDistanceStrategy.isDisposed


isSilent

isSilent(): boolean

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

Returns

boolean

Inherited from

AbstractDistanceStrategy.isSilent


notify

notify<E>(type, source, args?): LatLonDistanceStrategy

Notify listeners

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEevent types
sourceAbstractDistanceStrategyof the event
Optional argsEventMap[E]arguments of the event

Returns

LatLonDistanceStrategy

this

Inherited from

AbstractDistanceStrategy.notify


off

off<E>(type?, callback?): LatLonDistanceStrategy

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
Optional typeEtype of the event
Optional callback(eventType: E, sender: LatLonDistanceStrategy, args: EventMap[E]) => voidfunction to be called

Returns

LatLonDistanceStrategy

this

Inherited from

AbstractDistanceStrategy.off


on

on<E>(type, callback): LatLonDistanceStrategy

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event or property
callback(eventType: E, sender: LatLonDistanceStrategy, args: EventMap[E]) => voidto be called

Returns

LatLonDistanceStrategy

this

Inherited from

AbstractDistanceStrategy.on


setProperties

setProperties(options): LatLonDistanceStrategy

Sets all the properties pertaining to this object

Parameters

Name Type
optionsOptions

Returns

LatLonDistanceStrategy


setSilent

setSilent(bool): LatLonDistanceStrategy

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

LatLonDistanceStrategy

this

Inherited from

AbstractDistanceStrategy.setSilent


getClassName

Static getClassName(): string

Returns

string

Inherited from

AbstractDistanceStrategy.getClassName