API / geotoolkit / welllog / data / ArrayLogAbstractData / ArrayLogAbstractData
data.ArrayLogAbstractData.ArrayLogAbstractData
Define abstract data source for array log visuals like Log2DVisual
↳
ArrayLogAbstractData
Constructors
Methods
Constructors
• Protected new ArrayLogAbstractData(name?)
Constructor
| Name | Type | Description |
|---|---|---|
Optional name | string | name of data |
EventDispatcher.constructor
Methods
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ getIndexUnit(): AbstractUnit
Returns index unit
▸ Abstract getMaxAngle(): number
Return maximum angle of columns in radians
number
▸ Abstract getMaxDepth(): number
Return maximum depth
number
▸ Abstract getMaxValue(): number
Return maximum value
number
▸ Abstract getMinAngle(): number
Return minimum angle of columns in radians
number
▸ Abstract getMinDepth(): number
Return minimum depth
number
▸ Abstract getMinValue(): number
Return minimum value
number
▸ getName(): string
Return name of the data
string
▸ Abstract getNumberOfRows(): number
Return number of rows
number
number of rows
▸ Abstract getRow(index): AbstractDataRow
Return a row by index
| Name | Type | Description |
|---|---|---|
index | number | index of the row |
a row
▸ getTimeStamp(): number
Return the value to indicate if data source was changed
number
▸ 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
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(type, source, args?): ArrayLogAbstractData
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | ArrayLogAbstractData | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ 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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: ArrayLogAbstractData, args: EventMap[E]) => void | function to be called |
this
▸ 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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: ArrayLogAbstractData, args: EventMap[E]) => void | to be called |
this
▸ setIndexUnit(unit?): ArrayLogAbstractData
Sets index unit
| Name | Type | Description |
|---|---|---|
Optional unit | string | AbstractUnit | index unit |
this
▸ setName(name): ArrayLogAbstractData
Set name of the data
| Name | Type | Description |
|---|---|---|
name | string | The data name |
this
▸ setSilent(bool): ArrayLogAbstractData
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ Protected update(args?): void
Notify if data is changed
| Name | Type | Description |
|---|---|---|
Optional args | LogDataEvent | optional parameters |
void
▸ Protected updateTimeStamp(): void
Update time stamp
void
▸ Static getClassName(): string
string