Last updated

API / geotoolkit / welllog / data / ArrayLogAbstractData / ArrayLogAbstractData

Class: ArrayLogAbstractData

data.ArrayLogAbstractData.ArrayLogAbstractData

Define abstract data source for array log visuals like Log2DVisual

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new ArrayLogAbstractData(name)

Protected new ArrayLogAbstractData(name?)

Constructor

Parameters

Name Type Description
Optional namestringname of data

Overrides

EventDispatcher.constructor

Methods

dispose

dispose(): void

Dispose.

Returns

void

Inherited from

EventDispatcher.dispose


getClassName

getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName


getIndexUnit

getIndexUnit(): AbstractUnit

Returns index unit

Returns

AbstractUnit


getMaxAngle

Abstract getMaxAngle(): number

Return maximum angle of columns in radians

Returns

number


getMaxDepth

Abstract getMaxDepth(): number

Return maximum depth

Returns

number


getMaxValue

Abstract getMaxValue(): number

Return maximum value

Returns

number


getMinAngle

Abstract getMinAngle(): number

Return minimum angle of columns in radians

Returns

number


getMinDepth

Abstract getMinDepth(): number

Return minimum depth

Returns

number


getMinValue

Abstract getMinValue(): number

Return minimum value

Returns

number


getName

getName(): string

Return name of the data

Returns

string


getNumberOfRows

Abstract getNumberOfRows(): number

Return number of rows

Returns

number

number of rows


getRow

Abstract getRow(index): AbstractDataRow

Return a row by index

Parameters

Name Type Description
indexnumberindex of the row

Returns

AbstractDataRow

a row


getTimeStamp

getTimeStamp(): number

Return the value to indicate if data source was changed

Returns

number


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


notify

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

Notify listeners

Type parameters

NameType
Eextends string

Parameters

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

Returns

ArrayLogAbstractData

this

Overrides

EventDispatcher.notify


off

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

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: ArrayLogAbstractData, args: EventMap[E]) => voidfunction to be called

Returns

ArrayLogAbstractData

this

Overrides

EventDispatcher.off


on

on<E>(type, callback): ArrayLogAbstractData

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: ArrayLogAbstractData, args: EventMap[E]) => voidto be called

Returns

ArrayLogAbstractData

this

Overrides

EventDispatcher.on


setIndexUnit

setIndexUnit(unit?): ArrayLogAbstractData

Sets index unit

Parameters

Name Type Description
Optional unitstring | AbstractUnitindex unit

Returns

ArrayLogAbstractData

this


setName

setName(name): ArrayLogAbstractData

Set name of the data

Parameters

Name Type Description
namestringThe data name

Returns

ArrayLogAbstractData

this


setSilent

setSilent(bool): ArrayLogAbstractData

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

ArrayLogAbstractData

this

Inherited from

EventDispatcher.setSilent


update

Protected update(args?): void

Notify if data is changed

Parameters

Name Type Description
Optional argsLogDataEventoptional parameters

Returns

void


updateTimeStamp

Protected updateTimeStamp(): void

Update time stamp

Returns

void


getClassName

Static getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName