Class WellboreModule

Class with common functions shared by all layers.

Hierarchy (view full)

Constructors

constructor

Properties

asyncLoop config containers currentZoom groups highlight lineDict marker pixiOverlay pointDict root roots scaling visibility

Accessors

projector

Methods

addWellbore clear clearAll clearFilter clearHighlight clearSelected destroy disable enable getRootRadius getWellboreRadius hardFilter onAdd onRemove registerDetail registerGroup requestRedraw resize set setCompletionVisibility setDetailVisibility setHighlight setLabelVisibility setSelected setVisibility setWellboresVisibility softFilter toggle

Constructors

constructor

Properties

asyncLoop

asyncLoop: AsyncLoop = ...

config

config: Config

containers

containers: {
    labels: Container<DisplayObject>;
    roots: Container<DisplayObject>;
    wellbores: Container<DisplayObject>;
}

currentZoom

currentZoom: number = 20

groups

groups: {
    [key: string]: Group;
} = {}

highlight

highlight: Highlight = ...

lineDict

lineDict: LineDictionary<WellboreData>

marker

marker: Graphics

pixiOverlay

pixiOverlay: pixiOverlayBase

Function for pixi overlay.

pointDict

pointDict: PointDictionary<RootData>

root

root: Container<DisplayObject>

Root container for layer.

roots

roots: RootData[] = []

scaling

scaling: ((zoom: number) => number)

Zoom event handler.

visibility

visibility: boolean = true

True if layer is currently visible.

Accessors

projector

Methods

addWellbore

  • addWellbore(data, group?): void

  • Add a single wellbore

    Parameters

    • data: SourceData

      Wellbore data

    • group: Group = ...

      Group to add wellbore into

    Returns void

clear

  • clear(...keys): void

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

    Parameters

    • Rest...keys: string[]

      Optional list of keys for which groups to clear

    Returns void

clearAll

clearFilter

clearHighlight

  • clearHighlight(onHighlightOff?): boolean

  • Parameters

    • OptionalonHighlightOff: (() => void)
        • (): void

        • Returns void

    Returns boolean

clearSelected

destroy

disable

enable

getRootRadius

  • getRootRadius(zoom?): number

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

    Parameters

    • zoom: number = ...

      Reference zoom level

    Returns number

getWellboreRadius

  • getWellboreRadius(zoom?): number

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

    Parameters

    • zoom: number = ...

      Reference zoom level

    Returns number

hardFilter

  • hardFilter(filterFunction, ...keys): void

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

    Parameters

    • filterFunction: ((v: SourceData) => boolean)
        • (v): boolean

        • Parameters

          • v: SourceData

          Returns boolean

    • Rest...keys: string[]

    Returns void

onAdd

onRemove

registerDetail

  • registerDetail(key, groupKeys, options): 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, options?): void

  • Parameters

    • key: string
    • Optionaloptions: GroupOptions

    Returns void

requestRedraw

resize

set

  • set(wells, key?, batchSize?): Promise<void>

  • Parameters

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

    Returns Promise<void>

setCompletionVisibility

  • setCompletionVisibility(visible, ...keys): void

  • Enable/disable completion

    Parameters

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

    Returns void

setDetailVisibility

  • setDetailVisibility(visible, key): void

  • Enable/disable details

    Parameters

    • visible: boolean
    • key: string

      Key of detail to set visibility for

    Returns void

setHighlight

  • setHighlight(label, ...keys): RealtimeWellbore

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

    Parameters

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

      Keys of groups to search. Can improve performance.

    Returns RealtimeWellbore

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

setLabelVisibility

  • setLabelVisibility(visible): void

  • Enable/disable labels

    Parameters

    • visible: boolean

    Returns void

setSelected

  • setSelected(selectFunction, ...keys): void

  • Parameters

    • selectFunction: ((v: any) => boolean)
        • (v): boolean

        • Parameters

          • v: any

          Returns boolean

    • Rest...keys: string[]

    Returns void

setVisibility

  • setVisibility(visible): boolean

  • Set visibility of the root PIXI container to a given value.

    Parameters

    • visible: boolean

      Should layer be visible?

    Returns boolean

    True if new visibility was set

setWellboresVisibility

  • setWellboresVisibility(visible, ...keys): void

  • Enable/disable wellbores

    Parameters

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

    Returns void

softFilter

  • softFilter(filterFunction, ...keys): void

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

    Parameters

    • filterFunction: ((v: SourceData) => boolean)
        • (v): boolean

        • Parameters

          • v: SourceData

          Returns boolean

    • Rest...keys: string[]

    Returns void

toggle

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods