Function useWellboreContext

Get the wellbore context from a parent Wellbore component.

Example

const { id } = useWellboreContext()

See

Wellbore

  • useWellboreContext(): WellboreContextProps

    Returns WellboreContextProps

    • OptionalfromMsl?: number

      what should be considered the top of the wellbore for visualization purposes (may be different from kickoff)

    • id: string

      wellbore id

    • segmentsPerMeter: number

      number of segments to use per meter for visualization purposes

    • simplificationThreshold: number

      a threshold value that can be set to reduce the number of segments where the trajectory is near linear

Settings