[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) / [MultiLateralWellData](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralwelldata) / MultiLateralWellData

# Class: MultiLateralWellData

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

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

## Table of contents

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


Methods
| [addWell](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralwelldata.multilateralwelldata#addwell) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralwelldata.multilateralwelldata#getclassname) | [getOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralwelldata.multilateralwelldata#getoptions) |
|  --- | --- | --- |
| [getWell](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralwelldata.multilateralwelldata#getwell) | [getWellArray](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralwelldata.multilateralwelldata#getwellarray) | [removeWell](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralwelldata.multilateralwelldata#removewell) |
| [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralwelldata.multilateralwelldata#getclassname-1) |


## Contents

Constructors
#### new MultiLateralWellData(options)

• **new MultiLateralWellData**(`options`)

#### Parameters

| Name  | Type  |
|  --- | --- |
| `options` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralwelldata#options) |


Methods
#### addWell

▸ **addWell**(`well`): [`MultiLateralWellData`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralwelldata.multilateralwelldata)

Add a well into existing well object

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `well` | [`Data`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralwelldata#data) | The new well object |


#### Returns

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

this

#### getClassName

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

#### Returns

`string`

#### getOptions

▸ **getOptions**(): [`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralwelldata#optionsout)

Returns the well data's options

#### Returns

[`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralwelldata#optionsout)

options The array of well objects

#### getWell

▸ **getWell**(`index`): [`Data`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralwelldata#data)

Get n-th well

#### Parameters

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


#### Returns

[`Data`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralwelldata#data)

The index-th well

#### getWellArray

▸ **getWellArray**(): [`Data`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralwelldata#data)[]

Returns the well data as an array

#### Returns

[`Data`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.data-8#multilateralwelldata#data)[]

#### removeWell

▸ **removeWell**(`index`): [`MultiLateralWellData`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.data-8.well-1.multilateralwelldata.multilateralwelldata)

Remove n-th well from current wells

#### Parameters

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


#### Returns

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

this

#### getClassName

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

#### Returns

`string`