Class FeatureService

OGC Features API service class

Hierarchy

Service
- FeatureService

Index

Constructors

Accessors

Methods

getCollection getCollections getConformance getFeature getFeatures getQueryables searchFeatures

Constructors

constructor

new FeatureService(config): FeatureService
constructor
Parameters
- config: IServiceConfig
Returns FeatureService
Inherited from Service.constructor
- Defined in packages/shared/dist/service.d.ts:49

Accessors

baseUrl

get baseUrl(): string
base url

Returns string
Inherited from Service.baseUrl
- Defined in packages/shared/dist/service.d.ts:53

Methods

getCollection

getCollection(collectionId, options?): Promise<ICollection>
Get a feature collection by id
Parameters
- collectionId: string
  
  collection id
- options: IServiceRequestOptions = {}
  
  options
Returns Promise<ICollection>
- Defined in packages/features/src/features.ts:67

getCollections

getCollections(options?): Promise<IGetCollectionsResponse>
Get a list of feature collections
Parameters
- options: IServiceRequestOptions = {}
  
  options
Returns Promise<IGetCollectionsResponse>
- Defined in packages/features/src/features.ts:51

getConformance

getConformance(options?): Promise<IGetConformanceResponse>
get a list of conformed standards
Parameters
- Optional options: IServiceRequestOptions
  
  options
Returns Promise<IGetConformanceResponse>
Inherited from Service.getConformance
- Defined in packages/shared/dist/service.d.ts:58

getFeature

getFeature(collectionId, featureId, options?): Promise<IFeature>
Get a feature from a collection by id
Parameters
- collectionId: string
  
  collection id
- featureId: string
  
  feature id
- options: IGetFeatureOptions = {}
  
  options
Returns Promise<IFeature>
- Defined in packages/features/src/features.ts:134

getFeatures

getFeatures(collectionId, options?): Promise<IGetFeaturesResponse>
Get features from a collection
Parameters
- collectionId: string
  
  collection id
- options: IGetFeaturesOptions = {}
  
  options
Returns Promise<IGetFeaturesResponse>
- Defined in packages/features/src/features.ts:95

getQueryables

getQueryables(collectionId, options?): Promise<IQueryables>
Get queryables from a collection by id
Parameters
- collectionId: string
  
  collection id
- options: IServiceRequestOptions = {}
  
  options
Returns Promise<IQueryables>
- Defined in packages/features/src/features.ts:81

searchFeatures

searchFeatures(collectionId, options?): Promise<IGetFeaturesResponse>
Search features from a collection
Parameters
- collectionId: string
  
  collection id
- options: IGetFeaturesOptions = {}
Returns Promise<IGetFeaturesResponse>
- Defined in packages/features/src/features.ts:113

Generated using TypeDoc