Class WellborepathLayer<T>

Type Parameters

T extends [number, number][]

Hierarchy

SVGLayer<T>
- WellborepathLayer

Index

Constructors

Properties

_options elm rescaleEvent

Accessors

data element id interactive isLoading isVisible opacity options order referenceSystem

Methods

clearData getData getInternalLayerIds onInteractivityChanged onMount onOpacityChanged onOrderChanged onRescale onResize onUnmount onUpdate optionsRescale render renderWellborePath setData setVisibility

Constructors

constructor

new WellborepathLayer<T>(id?: string, options?: WellborepathLayerOptions<T>): WellborepathLayer<T>
Type Parameters
- T extends [number, number][]
Parameters
- Optional id: string
- Optional options: WellborepathLayerOptions<T>
Returns WellborepathLayer<T>
Overrides SVGLayer.constructor
- Defined in layers/WellborePathLayer.ts:34

Properties

`Protected` _options

_options: LayerOptions<T>

elm

elm: Selection<SVGElement, unknown, null, undefined>

rescaleEvent

rescaleEvent: OnRescaleEvent

Accessors

data

get data(): T
Returns T
Inherited from SVGLayer.data
- Defined in layers/base/Layer.ts:123
set data(data: T): void
Parameters
- data: T
Returns void
Inherited from SVGLayer.data
- Defined in layers/base/Layer.ts:127

element

get element(): HTMLElement
Returns HTMLElement
Inherited from SVGLayer.element
- Defined in layers/base/Layer.ts:68

id

get id(): string
Returns string
Inherited from SVGLayer.id
- Defined in layers/base/Layer.ts:64

interactive

get interactive(): boolean
Returns boolean
Inherited from SVGLayer.interactive
- Defined in layers/base/Layer.ts:111
set interactive(shouldBeInteractive: boolean): void
Parameters
- shouldBeInteractive: boolean
Returns void
Inherited from SVGLayer.interactive
- Defined in layers/base/Layer.ts:106

isLoading

get isLoading(): boolean
Returns boolean
Inherited from SVGLayer.isLoading
- Defined in layers/base/Layer.ts:84
set isLoading(loading: boolean): void
Parameters
- loading: boolean
Returns void
Inherited from SVGLayer.isLoading
- Defined in layers/base/Layer.ts:80

isVisible

get isVisible(): boolean
Returns boolean
Inherited from SVGLayer.isVisible
- Defined in layers/base/Layer.ts:131

opacity

get opacity(): number
Returns number
Inherited from SVGLayer.opacity
- Defined in layers/base/Layer.ts:93
set opacity(opacity: number): void
Parameters
- opacity: number
Returns void
Inherited from SVGLayer.opacity
- Defined in layers/base/Layer.ts:88

options

get options(): LayerOptions<T>
Returns LayerOptions<T>
Inherited from SVGLayer.options
- Defined in layers/base/Layer.ts:72
set options(options: LayerOptions<T>): void
Parameters
- options: LayerOptions<T>
Returns void
Inherited from SVGLayer.options
- Defined in layers/base/Layer.ts:76

order

get order(): number
Returns number
Inherited from SVGLayer.order
- Defined in layers/base/Layer.ts:102
set order(order: number): void
Parameters
- order: number
Returns void
Inherited from SVGLayer.order
- Defined in layers/base/Layer.ts:97

referenceSystem

get referenceSystem(): IntersectionReferenceSystem
Returns IntersectionReferenceSystem
Inherited from SVGLayer.referenceSystem
- Defined in layers/base/Layer.ts:115
set referenceSystem(referenceSystem: IntersectionReferenceSystem): void
Parameters
- referenceSystem: IntersectionReferenceSystem
Returns void
Inherited from SVGLayer.referenceSystem
- Defined in layers/base/Layer.ts:119

Methods

clearData

clearData(includeReferenceSystem?: boolean): void
Clears data and (optionally) the reference system
Parameters
- includeReferenceSystem: boolean = true
  
  (optional) if true also removes reference system, default is true
Returns void
Inherited from SVGLayer.clearData
- Defined in layers/base/Layer.ts:151

getData

getData(): T
Returns T
Inherited from SVGLayer.getData
- Defined in layers/base/Layer.ts:135

getInternalLayerIds

getInternalLayerIds(): string[]
Some layers might be built up of several internal layers that should individually be visibility-togglable. Reasons for having multiple internal layers might be tightly related data between layers or need for sharing render context

Returns
list of internal layer ids

Returns string[]
Inherited from SVGLayer.getInternalLayerIds
- Defined in layers/base/Layer.ts:214

onInteractivityChanged

onInteractivityChanged(shouldBeInteractive: boolean): void
Parameters
- shouldBeInteractive: boolean
Returns void
Inherited from SVGLayer.onInteractivityChanged
- Defined in layers/base/SVGLayer.ts:57

onMount

onMount(event: OnMountEvent): void
Parameters
- event: OnMountEvent
Returns void
Inherited from SVGLayer.onMount
- Defined in layers/base/SVGLayer.ts:9

onOpacityChanged

onOpacityChanged(opacity: number): void
Parameters
- opacity: number
Returns void
Inherited from SVGLayer.onOpacityChanged
- Defined in layers/base/SVGLayer.ts:45

onOrderChanged

onOrderChanged(order: number): void
Parameters
- order: number
Returns void
Inherited from SVGLayer.onOrderChanged
- Defined in layers/base/SVGLayer.ts:51

onRescale

onRescale(event: OnRescaleEvent): void
Parameters
- event: OnRescaleEvent
Returns void
Overrides SVGLayer.onRescale
- Defined in layers/WellborePathLayer.ts:48

onResize

onResize(event: OnResizeEvent): void
Parameters
- event: OnResizeEvent
Returns void
Inherited from SVGLayer.onResize
- Defined in layers/base/SVGLayer.ts:30

onUnmount

onUnmount(): void
Returns void
Inherited from SVGLayer.onUnmount
- Defined in layers/base/SVGLayer.ts:24

onUpdate

onUpdate(event: OnUpdateEvent<T>): void
Parameters
- event: OnUpdateEvent<T>
Returns void
Overrides SVGLayer.onUpdate
- Defined in layers/WellborePathLayer.ts:43

optionsRescale

optionsRescale(event: OnRescaleEvent): void
Parameters
- event: OnRescaleEvent
Returns void
Inherited from SVGLayer.optionsRescale
- Defined in layers/base/Layer.ts:195

render

render(): void
Returns void
- Defined in layers/WellborePathLayer.ts:57

`Private` renderWellborePath

renderWellborePath(data: [number, number][]): string
Parameters
- data: [number, number][]
Returns string
- Defined in layers/WellborePathLayer.ts:80

setData

setData(data: T): void
Parameters
- data: T
Returns void
Inherited from SVGLayer.setData
- Defined in layers/base/Layer.ts:139

setVisibility

setVisibility(visible: boolean): void
Parameters
- visible: boolean
Returns void
Inherited from SVGLayer.setVisibility
- Defined in layers/base/SVGLayer.ts:38

Generated using TypeDoc