[API](/solutions/geotoolkit/geotoolkit_js/apis/readme) / [geotoolkit3d](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d) / [data](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8) / [well](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#well) / [MultiLateralPipeData](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralpipedata) / MultiLateralPipeData

# Class: MultiLateralPipeData

[well](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#well).[MultiLateralPipeData](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralpipedata).MultiLateralPipeData

Multilateral pipe data combines an array of wells into one object.

## Table of contents

Constructors
- [new MultiLateralPipeData(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.data-8.well-1.multilateralpipedata.multilateralpipedata.md#new multilateralpipedata(options))


Methods
| [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralpipedata.multilateralpipedata#getclassname) | [getPipe](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralpipedata.multilateralpipedata#getpipe) | [getPipeArray](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralpipedata.multilateralpipedata#getpipearray) |
|  --- | --- | --- |
| [removePipe](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralpipedata.multilateralpipedata#removepipe) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralpipedata.multilateralpipedata#getclassname-1) |


## Contents

Constructors
#### new MultiLateralPipeData(options)

• **new MultiLateralPipeData**(`options`)

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `options` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralpipedata#options) | The object of pipe data |


Methods
#### getClassName

▸ **getClassName**(): `string`

#### Returns

`string`

#### getPipe

▸ **getPipe**(`index`): [`PipeData`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralpipedata#pipedata)

Get n-th pipe

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `index` | `number` | The index of pipe |


#### Returns

[`PipeData`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralpipedata#pipedata)

The index-th pipe

#### getPipeArray

▸ **getPipeArray**(): [`PipeData`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralpipedata#pipedata)[]

Returns the pipe data as an array

#### Returns

[`PipeData`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralpipedata#pipedata)[]

#### removePipe

▸ **removePipe**(`index`): [`MultiLateralPipeData`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralpipedata.multilateralpipedata)

Remove n-th pipe from current pipes

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `index` | `number` | The index of pipe |


#### Returns

[`MultiLateralPipeData`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralpipedata.multilateralpipedata)

this

#### getClassName

▸ `Static` **getClassName**(): `string`

#### Returns

`string`