Skip to content

API / geotoolkit / ivaapbackend / surface / RemoteGridSurfaceDataSource / RemoteGridSurfaceDataSource

Class: RemoteGridSurfaceDataSource

surface.RemoteGridSurfaceDataSource.RemoteGridSurfaceDataSource

Provides utility class to load surface data from IVAAP backend

Hierarchy

Table of contents

Constructors
  • [new RemoteGridSurfaceDataSource(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.ivaapbackend.surface.remotegridsurfacedatasource.remotegridsurfacedatasource.md#new remotegridsurfacedatasource(options))
Methods
Css Properties
Name Type Description
hostnamestringThe host name for requests

Contents

Constructors

new RemoteGridSurfaceDataSource(options)

• new RemoteGridSurfaceDataSource(options?)

Parameters

Name Type
Optional optionsOptions

Inherited from

RemoteDataSource<RemoteGridSurfaceDataSource.MetaInfo&gt;.constructor

Methods

dispose

▸ dispose(): void

Dispose

Returns

void

Inherited from

RemoteDataSource.dispose


getClassName

▸ getClassName(): string

Returns

string

Inherited from

RemoteDataSource.getClassName


getHostName

▸ getHostName(): string

Gets host name

Returns

string

Inherited from

RemoteDataSource.getHostName


getHttpService

▸ getHttpService(): AbstractHttpService

Gets a http service associated with this data source

Returns

AbstractHttpService

Inherited from

RemoteDataSource.getHttpService


getId

▸ getId(): string

Gets data identifier

Returns

string

Inherited from

RemoteDataSource.getId


▸ getLinks(): Link[]

Gets links

Returns

Link[]

Inherited from

RemoteDataSource.getLinks


getMetaData

▸ getMetaData(): MetaInfo

Returns meta information from IVAAP backend

Returns

MetaInfo

meta meta data

Inherited from

RemoteDataSource.getMetaData


getProperties

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

Returns

OptionsOut

An object containing the properties

Inherited from

RemoteDataSource.getProperties


loadMeta

▸ loadMeta(url): Promise<MetaInfo&gt;

Load meta data

Parameters

Name Type Description
urlstringurl of metaData information

Returns

Promise<MetaInfo&gt;

The promise for the MetaData

Overrides

RemoteDataSource.loadMeta


loadSurface

▸ loadSurface(): Promise<SurfaceStream&gt;

Loads surface

Returns

Promise<SurfaceStream&gt;


setHostName

▸ Protected setHostName(host): RemoteGridSurfaceDataSource

Sets host name

Parameters

Name Type Description
hoststringthe host name

Returns

RemoteGridSurfaceDataSource

Inherited from

RemoteDataSource.setHostName


setHttpService

▸ Protected setHttpService(service): RemoteGridSurfaceDataSource

Sets a http service associated with this data source

Parameters

Name Type Description
serviceAbstractHttpServicethe http service

Returns

RemoteGridSurfaceDataSource

Inherited from

RemoteDataSource.setHttpService


setId

▸ Protected setId(id): RemoteGridSurfaceDataSource

Sets data identifier

Parameters

Name Type Description
idstringthe identifier

Returns

RemoteGridSurfaceDataSource

Inherited from

RemoteDataSource.setId


▸ Protected setLinks(links): RemoteGridSurfaceDataSource

Sets links

Parameters

Name Type Description
linksLink[]the links

Returns

RemoteGridSurfaceDataSource

Inherited from

RemoteDataSource.setLinks


setMetaData

▸ Protected setMetaData(meta): RemoteGridSurfaceDataSource

Sets meta information

Parameters

Name Type Description
metaMetaInfothe meta information

Returns

RemoteGridSurfaceDataSource

Inherited from

RemoteDataSource.setMetaData


setProperties

▸ setProperties(properties?): RemoteGridSurfaceDataSource

Sets all the properties pertaining to this object

Parameters

Name Type Description
Optional propertiesOptionsAn object containing the properties to set

Returns

RemoteGridSurfaceDataSource

this

Inherited from

RemoteDataSource.setProperties


getClassName

▸ Static getClassName(): string

Returns

string

Inherited from

RemoteDataSource.getClassName