API / geotoolkit / welllog3d / data / Borehole3DData / Borehole3DData
data.Borehole3DData.Borehole3DData
Borehole3DData holds the data to create Borehole3D object.
↳
Borehole3DData
Constructors
- [new Borehole3DData(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.welllog3d.data-6.borehole3ddata.borehole3ddata.md#new borehole3ddata(options))
Methods
Constructors
• new Borehole3DData(options?)
| Name | Type |
|---|---|
Optional options | Options |
ArrayLogAbstractData.constructor
Methods
▸ calculateLimits(calculateValues): Borehole3DData
Recalculate depth limits and optional value limits
| Name | Type | Description |
|---|---|---|
calculateValues | boolean | Recalculate depth limits and optional value limits or not |
this
▸ dataChanged(): void
Notifies this shape that the data was changed outside of its knowledge
void
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
ArrayLogAbstractData.getClassName
▸ getDataOrder(): Order
Get order of depths
enum describing order of data
▸ getDepths(): number[]
Return an array of depths
number[]
▸ getIndexUnit(): AbstractUnit
Returns index unit
ArrayLogAbstractData.getIndexUnit
▸ getMaxAngle(): number
Return maximum angle of columns in radians
number
ArrayLogAbstractData.getMaxAngle
▸ getMaxDepth(): number
Return maximum depth
number
ArrayLogAbstractData.getMaxDepth
▸ getMaxRadius(): number
Return maximum radius of columns
number
▸ getMaxValue(): number
Return maximum value
number
ArrayLogAbstractData.getMaxValue
▸ getMinAngle(): number
Return minimum angle of columns in radians
number
ArrayLogAbstractData.getMinAngle
▸ getMinDepth(): number
Return minimum depth
number
ArrayLogAbstractData.getMinDepth
▸ getMinRadius(): number
Return minimum radius of columns
number
▸ getMinValue(): number
Return minimum value
number
ArrayLogAbstractData.getMinValue
▸ getName(): string
Return name of the data
string
▸ getNumberOfRows(): number
Return number of rows
number
number of rows
ArrayLogAbstractData.getNumberOfRows
▸ getRadiusNullValue(): number
Get the radiusnullvalue of the data
number
radiusnullvalue
▸ getRow(index): Borehole3DDataRow
Return a row by index
| Name | Type | Description |
|---|---|---|
index | number | index of the row |
a row
▸ getRows(): Borehole3DDataRow[]
A array of the rows. if the data in changed then it is necessary to call updateLimits to recalculate the data limits
▸ getTimeStamp(): number
Return the value to indicate if data source was changed
number
ArrayLogAbstractData.getTimeStamp
▸ getValuesNullValue(): number
Get the valuesnullvalue of the data
number
valuesnullvalue
▸ 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
ArrayLogAbstractData.hasEventListener
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
ArrayLogAbstractData.isDisposed
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(type, source, args?): Borehole3DData
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?): Borehole3DData
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: Borehole3DData, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): Borehole3DData
Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: Borehole3DData, args: EventMap[E]) => void | to be called |
this
▸ setIndexUnit(unit?): Borehole3DData
Sets index unit
| Name | Type | Description |
|---|---|---|
Optional unit | string | AbstractUnit | index unit |
this
ArrayLogAbstractData.setIndexUnit
▸ setName(name): Borehole3DData
Set name of the data
| Name | Type | Description |
|---|---|---|
name | string | The data name |
this
▸ setRadiusNullValue(value): Borehole3DData
Set the radiusnullvalue of the data
| Name | Type | Description |
|---|---|---|
value | number | nullvalue |
this
▸ setSilent(bool): Borehole3DData
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
ArrayLogAbstractData.setSilent
▸ setValuesNullValue(value): Borehole3DData
Set the valuesnullvalue of the data
| Name | Type | Description |
|---|---|---|
value | number | nullvalue |
this
▸ Protected update(args?): void
Notify if data is changed
| Name | Type | Description |
|---|---|---|
Optional args | LogDataEvent | optional parameters |
void
▸ updateLimits(): Borehole3DData
Recalculate depth and value limits
this
▸ Protected updateTimeStamp(): void
Update time stamp
void
ArrayLogAbstractData.updateTimeStamp
▸ Static createFrom(log2dData, radius?): Borehole3DData
Create a Borehole3DData with a fixed radius from Log2DVisualData.
| Name | Type | Description |
|---|---|---|
log2dData | Log2DVisualData | Log2DVisualData |
Optional radius | number | Optional, Default to 1 |
Borehole3DData
▸ Static getClassName(): string
string