Class OgcApiFeaturesClient

This class covers the common part of the OGC API standard described in https://docs.ogc.org/is/19-072/19-072.html. It contains shared methods between clients of different OGC API standards. Any OGC API (Maps, Records, Features, STAC...) shall extend this class.

Hierarchy (View Summary)

OgcApiClient
- OgcApiFeaturesClient
  - OgcApiFeaturesClientGeorama
  - OgcApiFeaturesClientGmf

Index

Constructors

Properties

stateManager url

Accessors

Methods

conformance createItem deleteItem fetchAll getByRelationAndType getCollection getCollections getFetchOptions getItem getItems getLink getLinks getNextUrl getQueryables getSchema serviceDescription updateItem

Constructors

constructor

new OgcApiFeaturesClient(
options: OgcApiFeaturesClientOptions,
): OgcApiFeaturesClient
Parameters
- options: OgcApiFeaturesClientOptions
Returns OgcApiFeaturesClient
Overrides OgcApiClient.constructor
- Defined in src/tools/ogcapi/ogcapifeaturesclient.ts:41

Properties

stateManager

stateManager: StateManager

url

url: string

Accessors

state

get state(): State
Returns State
Inherited from OgcApiClient.state
- Defined in src/tools/ogcapi/ogcapiclient.ts:20

Methods

conformance

conformance(): Promise<string[]>
Returns Promise<string[]>
Inherited from OgcApiClient.conformance
- Defined in src/tools/ogcapi/ogcapiclient.ts:33

createItem

createItem(collectionId: string, item: Feature<Geometry>): Promise<boolean>
Parameters
- collectionId: string
- item: Feature<Geometry>
Returns Promise<boolean>
- Defined in src/tools/ogcapi/ogcapifeaturesclient.ts:100

deleteItem

deleteItem(_collectionId: string, _itemId: string): Promise<void>
Parameters
- _collectionId: string
- _itemId: string
Returns Promise<void>
- Defined in src/tools/ogcapi/ogcapifeaturesclient.ts:121

fetchAll

fetchAll(url: string, fetchOptions: RequestInit): Promise<any[]>
Parameters
- url: string
- fetchOptions: RequestInit
Returns Promise<any[]>
Inherited from OgcApiClient.fetchAll
- Defined in src/tools/ogcapi/ogcapiclient.ts:88

getByRelationAndType

getByRelationAndType(
    collectionId: string,
    relation: string,
    type: string,
): Promise<any>
Parameters
- collectionId: string
- relation: string
- type: string
Returns Promise<any>
Inherited from OgcApiClient.getByRelationAndType
- Defined in src/tools/ogcapi/ogcapiclient.ts:46

getCollection

getCollection(_collectionId: string): Promise<void>
Parameters
- _collectionId: string
Returns Promise<void>
- Defined in src/tools/ogcapi/ogcapifeaturesclient.ts:51

getCollections

getCollections(): Promise<void>
Returns Promise<void>
- Defined in src/tools/ogcapi/ogcapifeaturesclient.ts:47

`Protected`getFetchOptions

getFetchOptions(method?: HttpMethod): RequestInit
Parameters
- method: HttpMethod = 'GET'
Returns RequestInit
Inherited from OgcApiClient.getFetchOptions
- Defined in src/tools/ogcapi/ogcapiclient.ts:111

getItem

getItem(
    collectionId: string,
    itemId: string,
    crs?: string,
): Promise<Feature<Geometry>>
Parameters
- collectionId: string
- itemId: string
- crs: string = default_crs
Returns Promise<Feature<Geometry>>
- Defined in src/tools/ogcapi/ogcapifeaturesclient.ts:83

getItems

getItems(
    collectionId: string,
    extent?: number[],
    crs?: string,
): Promise<Feature<Geometry>[]>
Parameters
- collectionId: string
- Optionalextent: number[]
- crs: string = default_crs
Returns Promise<Feature<Geometry>[]>
- Defined in src/tools/ogcapi/ogcapifeaturesclient.ts:65

getLink

getLink(relation: string, path?: string, encodingType?: string): Promise<string>
Parameters
- relation: string
- path: string = ...
- encodingType: string = default_encoding
Returns Promise<string>
Inherited from OgcApiClient.getLink
- Defined in src/tools/ogcapi/ogcapiclient.ts:73

getLinks

getLinks(path: string): Promise<OgcApiLinksResponse[]>
Parameters
- path: string
Returns Promise<OgcApiLinksResponse[]>
Inherited from OgcApiClient.getLinks
- Defined in src/tools/ogcapi/ogcapiclient.ts:64

`Protected`getNextUrl

getNextUrl(responseJson: any, _currentUrl: string): string
Parameters
- responseJson: any
- _currentUrl: string
Returns string
Inherited from OgcApiClient.getNextUrl
- Defined in src/tools/ogcapi/ogcapiclient.ts:107

getQueryables

getQueryables(collectionId: string): Promise<OgcApiQueryablesResponse>
Parameters
- collectionId: string
Returns Promise<OgcApiQueryablesResponse>
- Defined in src/tools/ogcapi/ogcapifeaturesclient.ts:60

getSchema

getSchema(collectionId: string): Promise<any>
Parameters
- collectionId: string
Returns Promise<any>
- Defined in src/tools/ogcapi/ogcapifeaturesclient.ts:55

serviceDescription

serviceDescription(): Promise<void>
Returns Promise<void>
Inherited from OgcApiClient.serviceDescription
- Defined in src/tools/ogcapi/ogcapiclient.ts:29

updateItem

updateItem(
    _collectionId: string,
    _itemId: string,
    _item: Feature<Geometry>,
): Promise<void>
Parameters
- _collectionId: string
- _itemId: string
- _item: Feature<Geometry>
Returns Promise<void>
- Defined in src/tools/ogcapi/ogcapifeaturesclient.ts:117