Class WellboreModule

constructor

• new WellboreModule(inputConfig?: InputConfig): WellboreModule

  Parameters

  • OptionalinputConfig: InputConfig

  Returns WellboreModule

asyncLoop

config

containers

currentZoom

groups

highlight

lineDict

marker

pointDict

roots

scaling

projector

• get projector(): Projector

  Returns Projector

addWellbore

• addWellbore(data: SourceData, group?: Group): void

  Add a single wellbore

  Parameters

  • data: SourceData

    Wellbore data

  • group: Group = ...

    Group to add wellbore into

  Returns void

clear

• clear(...keys: string[]): void

  Clear all data or data mapped to the groups specified by keys

  Parameters

  • ...keys: string[]

    Optional list of keys for which groups to clear

  Returns void

clearAll

• clearAll(): void

  Returns void

clearFilter

• clearFilter(...keys: string[]): void

  Parameters

  • ...keys: string[]

  Returns void

clearHighlight

• clearHighlight(onHighlightOff?: () => void): boolean

  Parameters

  • OptionalonHighlightOff: () => void

  Returns boolean

clearSelected

• clearSelected(...keys: string[]): void

  Parameters

  • ...keys: string[]

  Returns void

destroy

• destroy(): void

  Returns void

disable

• disable(...keys: string[]): void

  Parameters

  • ...keys: string[]

  Returns void

enable

• enable(...keys: string[]): void

  Parameters

  • ...keys: string[]

  Returns void

getRootRadius

• getRootRadius(zoom?: number): number

  Calculate root radius based on formula used in Shader.ts!

  Parameters

  • zoom: number = ...

    Reference zoom level

  Returns number

getWellboreRadius

• getWellboreRadius(zoom?: number): number

  Calculate wellbore radius based on formula used in Shader.ts!

  Parameters

  • zoom: number = ...

    Reference zoom level

  Returns number

hardFilter

• hardFilter(filterFunction: (v: SourceData) => boolean, ...keys: string[]): void

  "Hard" filtering function. Will turn wellbores that does not pass filter into "ghost" lines.

  Parameters

  • filterFunction: (v: SourceData) => boolean
  • ...keys: string[]

  Returns void

onAdd

• onAdd(map: Map): void

  Parameters

  • map: Map

  Returns void

onRemove

• onRemove(_map: Map): void

  Parameters

  • _map: Map

  Returns void

registerDetail

• registerDetail(key: string, groupKeys: string[], options: DetailOptions): void

  Registers a new detail on given group.

  Parameters

  • key: string

    Detail key.

  • groupKeys: string[]

    Target group keys.

  • options: DetailOptions

  Returns void

registerGroup

• registerGroup(key: string, options?: GroupOptions): void

  Parameters

  • key: string
  • Optionaloptions: GroupOptions

  Returns void

requestRedraw

• requestRedraw(): void

  Returns void

resize

• resize(zoom: number): void

  Parameters

  • zoom: number

  Returns void

set

• set(wells: SourceData[], key?: string, batchSize?: number): Promise<void>

  Parameters

  • wells: SourceData[]
  • key: string = 'default'
  • batchSize: number = null

  Returns Promise<void>

setCompletionVisibility

• setCompletionVisibility(visible: boolean, ...keys: string[]): void

  Enable/disable completion

  Parameters

  • visible: boolean
  • ...keys: string[]

  Returns void

setDetailVisibility

• setDetailVisibility(visible: boolean, key: string): void

  Enable/disable details

  Parameters

  • visible: boolean
  • key: string

    Key of detail to set visibility for

  Returns void

setHighlight

• setHighlight(label: string, ...keys: string[]): RealtimeWellbore

  Set highlight of wellbore module. Does not override mousemove events.

  Parameters

  • label: string
  • ...keys: string[]

    Keys of groups to search. Can improve performance.

  Returns RealtimeWellbore

  Screen coordinates (in pixels) of highlighted wellbore's root

setLabelVisibility

• setLabelVisibility(visible: boolean): void

  Enable/disable labels

  Parameters

  • visible: boolean

  Returns void

setSelected

• setSelected(selectFunction: (v: any) => boolean, ...keys: string[]): void

  Parameters

  • selectFunction: (v: any) => boolean
  • ...keys: string[]

  Returns void

setWellboresVisibility

• setWellboresVisibility(visible: boolean, ...keys: string[]): void

  Enable/disable wellbores

  Parameters

  • visible: boolean
  • ...keys: string[]

  Returns void

softFilter

• softFilter(filterFunction: (v: SourceData) => boolean, ...keys: string[]): void

  "Soft" filtering function. Will turn wellbores that does not pass filter gray-ish.

  Parameters

  • filterFunction: (v: SourceData) => boolean
  • ...keys: string[]

  Returns void