[API](/solutions/geotoolkit/geotoolkit_js/apis/readme) / [geotoolkit](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit) / [ivaapbackend](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend) / [reservoir](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#reservoir) / [RemoteReservoirDataSource](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource) / RemoteReservoirDataSource

# Class: RemoteReservoirDataSource

[reservoir](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#reservoir).[RemoteReservoirDataSource](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource).RemoteReservoirDataSource

Provide utility class to load reservoir data from IVAAP backend

## Hierarchy

- [`RemoteDataSource`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource)<[`MetaInfo`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#metainfo)&gt;
↳ **`RemoteReservoirDataSource`**


## Table of contents

Constructors
- [new RemoteReservoirDataSource(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource.md#new remotereservoirdatasource(options))


Methods
| [dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#dispose) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#getclassname) | [getHostName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#gethostname) |
|  --- | --- | --- |
| [getHttpService](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#gethttpservice) | [getId](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#getid) | [getLinks](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#getlinks) |
| [getMetaData](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#getmetadata) | [getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#getproperties) | [isZFPEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#iszfpenabled) |
| [loadCells](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#loadcells) | [loadMeta](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#loadmeta) | [loadValues](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#loadvalues) |
| [setHostName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#sethostname) | [setHttpService](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#sethttpservice) | [setId](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#setid) |
| [setLinks](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#setlinks) | [setMetaData](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#setmetadata) | [setOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#setoptions) |
| [setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#setproperties) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource#getclassname-1) |


Css Properties
| Name  | Type  | Description |
|  --- | --- | --- |
| `hostname` | `string` | The host name for requests |


## Contents

Constructors
#### new RemoteReservoirDataSource(options)

• **new RemoteReservoirDataSource**(`options?`)

#### Parameters

| Name  | Type  |
|  --- | --- |
| `Optional` `options` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#options) |


#### Overrides

RemoteDataSource&lt;RemoteReservoirDataSource.MetaInfo&amp;gt;.constructor

Methods
#### dispose

▸ **dispose**(): `void`

Dispose

#### Returns

`void`

#### Overrides

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#dispose)

#### getClassName

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

#### Returns

`string`

#### Overrides

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#getclassname)

#### getHostName

▸ **getHostName**(): `string`

Gets host name

#### Returns

`string`

#### Inherited from

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[getHostName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#gethostname)

#### getHttpService

▸ **getHttpService**(): [`AbstractHttpService`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.http.abstracthttpservice.abstracthttpservice)

Gets a http service associated with this data source

#### Returns

[`AbstractHttpService`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.http.abstracthttpservice.abstracthttpservice)

#### Inherited from

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[getHttpService](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#gethttpservice)

#### getId

▸ **getId**(): `string`

Gets data identifier

#### Returns

`string`

#### Inherited from

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[getId](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#getid)

#### getLinks

▸ **getLinks**(): [`Link`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#commonremotedatasource#link)[]

Gets links

#### Returns

[`Link`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#commonremotedatasource#link)[]

#### Inherited from

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[getLinks](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#getlinks)

#### getMetaData

▸ **getMetaData**(): [`MetaInfo`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#metainfo)

Returns meta information from IVAAP backend

#### Returns

[`MetaInfo`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#metainfo)

meta meta data

#### Inherited from

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[getMetaData](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#getmetadata)

#### getProperties

▸ **getProperties**(): [`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#abstractremotedatasource#optionsout)

Gets all the properties pertaining to this object

#### Returns

[`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#abstractremotedatasource#optionsout)

An object containing the properties

#### Inherited from

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#getproperties)

#### isZFPEnabled

▸ **isZFPEnabled**(): `boolean`

Returns true if browser supports WebAssembly and ZFP is enabled

#### Returns

`boolean`

#### loadCells

▸ **loadCells**(`level?`, `idNode?`, `filterSpec?`, `onProgress?`, `cancel?`): `Promise`<[`LegacyCell`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#legacycell)[] | [`ArrayCells`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#arraycells)&gt;

Load reservoir cells

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `level` | `number` | the level of resolution |
| `Optional` `idNode` | `number` | the node index |
| `Optional` `filterSpec` | `string` | the filter that should be applied |
| `Optional` `onProgress` | (`event`: `ProgressEvent`<`EventTarget`&gt;) => `void` | a function to be executed to handle progress |
| `Optional` `cancel` | [`Cancel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.cancel.cancel) | a Cancel object that can be used to cancel the loading. |


#### Returns

`Promise`<[`LegacyCell`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#legacycell)[] | [`ArrayCells`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#arraycells)&gt;

and promise with cells data, the Promise return type change based on the value set to this dataSource
constructor "efficientdatalayout" option.
If set to false or not specified, the return type will be the deprecated LegacyCellType[] type.
If set to true, the return type will be the new TypedArrayCells type.

#### loadMeta

▸ **loadMeta**(`url`, `onProgress?`, `cancel?`): `Promise`<[`MetaInfo`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#metainfo)&gt;

Load the reservoir MetaDatas from the given URL

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `url` | `string` | url of metaData information |
| `Optional` `onProgress` | (`event`: `ProgressEvent`<`EventTarget`&gt;) => `void` | a function to be executed to handle progress |
| `Optional` `cancel` | [`Cancel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.cancel.cancel) | a Cancel object that can be used to cancel the loading |


#### Returns

`Promise`<[`MetaInfo`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#metainfo)&gt;

The promise for the MetaData

#### Overrides

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[loadMeta](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#loadmeta)

#### loadValues

▸ **loadValues**(`ordinal?`, `filterSpec?`, `onProgress?`, `cancel?`): `Promise`<[`LegacyValues`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#legacyvalues) | [`ArrayValues`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#arrayvalues)&gt;

Load reservoir values

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `ordinal` | `string` | the ordinal number of a requested property in a list of properties |
| `Optional` `filterSpec` | `string` | the filter that should be applied |
| `Optional` `onProgress` | (`event`: `ProgressEvent`<`EventTarget`&gt;) => `void` | a function to be executed to handle progress |
| `Optional` `cancel` | [`Cancel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.cancel.cancel) | a Cancel object that can be used to cancel the loading. |


#### Returns

`Promise`<[`LegacyValues`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#legacyvalues) | [`ArrayValues`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#arrayvalues)&gt;

and promise with cells data, the Promise return type change based on the value set to this dataSource
constructor "efficientdatalayout" option.
If set to false or not specified, the return type will be the deprecated LegacyValuesType[] type.
If set to true, the return type will be the new TypedArrayValues type.

#### setHostName

▸ `Protected` **setHostName**(`host`): [`RemoteReservoirDataSource`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource)

Sets host name

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `host` | `string` | the host name |


#### Returns

[`RemoteReservoirDataSource`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource)

#### Inherited from

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[setHostName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#sethostname)

#### setHttpService

▸ `Protected` **setHttpService**(`service`): [`RemoteReservoirDataSource`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource)

Sets a http service associated with this data source

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `service` | [`AbstractHttpService`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.http.abstracthttpservice.abstracthttpservice) | the http service |


#### Returns

[`RemoteReservoirDataSource`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource)

#### Inherited from

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[setHttpService](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#sethttpservice)

#### setId

▸ `Protected` **setId**(`id`): [`RemoteReservoirDataSource`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource)

Sets data identifier

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `id` | `string` | the identifier |


#### Returns

[`RemoteReservoirDataSource`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource)

#### Inherited from

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[setId](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#setid)

#### setLinks

▸ `Protected` **setLinks**(`links`): [`RemoteReservoirDataSource`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource)

Sets links

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `links` | [`Link`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#commonremotedatasource#link)[] | the links |


#### Returns

[`RemoteReservoirDataSource`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource)

#### Inherited from

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[setLinks](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#setlinks)

#### setMetaData

▸ `Protected` **setMetaData**(`meta`): [`RemoteReservoirDataSource`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource)

Sets meta information

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `meta` | [`MetaInfo`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#metainfo) | the meta information |


#### Returns

[`RemoteReservoirDataSource`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource)

#### Inherited from

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[setMetaData](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#setmetadata)

#### setOptions

▸ **setOptions**(`options`): [`RemoteReservoirDataSource`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource)

Set this RemoteReservoirDataSource options

#### Parameters

| Name  | Type  |
|  --- | --- |
| `options` | [`OptionsBase`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#remotereservoirdatasource#optionsbase) |


#### Returns

[`RemoteReservoirDataSource`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource)

#### setProperties

▸ **setProperties**(`properties?`): [`RemoteReservoirDataSource`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource)

Sets all the properties pertaining to this object

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `properties` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.ivaapbackend#abstractremotedatasource#options) | An object containing the properties to set |


#### Returns

[`RemoteReservoirDataSource`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.reservoir.remotereservoirdatasource.remotereservoirdatasource)

this

#### Inherited from

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#setproperties)

#### getClassName

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

#### Returns

`string`

#### Overrides

[RemoteDataSource](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.ivaapbackend.remotedatasource.remotedatasource#getclassname-1)