Class OgcApiFeaturesClientGeorama

initialized

state

• get state(): State

  Returns State

url

• get url(): string

  Returns string

createItem

• createItem(
      collectionId: string,
      item: Feature<Geometry>,
      crsCode: string,
  ): Promise<boolean>

  Creates an item in the specified collection with the specified geometry and CRS code. Geometries are reprojected if the server does not support the items current CRS.

  Parameters

  • collectionId: string
  • item: Feature<Geometry>
  • crsCode: string

  Returns Promise<boolean>

deleteItem

• deleteItem(collectionId: string, itemId: string): Promise<boolean>

  Deletes an item from a specific collection.

  Parameters

  • collectionId: string
  • itemId: string

  Returns Promise<boolean>

fetchAll

• fetchAll(
      url: string | URL,
      dataListName: string,
      fetchOptions: RequestInit,
  ): Promise<any[]>

  Fetches all paginated resources from the specified URL until the entire dataset is retrieved. dataListName is the attribute name that holds the list of data items in the response JSON. For feature items, the attribute name is 'features', for collections, it's 'collections'.

  Parameters

  • url: string | URL
  • dataListName: string
  • fetchOptions: RequestInit

  Returns Promise<any[]>

getCollectionRelation

• getCollectionRelation(
      collectionId: string,
      relation: string,
      encodingType?: string,
  ): Promise<any>

  Retrieves the related resource for a specified collection and relation type (e.g. schema, self, parent, etc.)

  Parameters

  • collectionId: string
  • relation: string
  • encodingType: string = OgcApiDefaultEncoding

  Returns Promise<any>

getCollections

• getCollections(): Promise<OapifCollection[]>

  Returns Promise<OapifCollection[]>

getItem

• getItem(
      collectionId: string,
      itemId: string,
      crsCode?: string,
  ): Promise<Feature<Geometry>>

  Retrieves a single item from the specified collection by its ID.

  Parameters

  • collectionId: string
  • itemId: string
  • OptionalcrsCode: string

  Returns Promise<Feature<Geometry>>

getItems

• getItems(
      collectionId: string,
      crsCode?: string,
      extent?: number[],
      limit?: number,
  ): Promise<Feature<Geometry>[]>

  Retrieves items from a specified collection, optionally applying filters like CRS (Coordinate Reference System), spatial extent, and limit.

  Parameters

  • collectionId: string
  • OptionalcrsCode: string
  • Optionalextent: number[]
  • Optionallimit: number

  Returns Promise<Feature<Geometry>[]>

getLink

• getLink(
      relation: string,
      path?: string | URL,
      encodingType?: string,
  ): Promise<string>

  Retrieves a specific link from the OGC API resource based on the given relation and encoding type.

  Parameters

  • relation: string
  • path: string | URL = ...
  • encodingType: string = OgcApiDefaultEncoding

  Returns Promise<string>

getLinks

• getLinks(path: string | URL): Promise<OgcApiLinksResponse[]>

  Fetches and retrieves links from the specified path or URL and returns them in a sanitized format.

  Parameters

  • path: string | URL

  Returns Promise<OgcApiLinksResponse[]>

getQueryables

• getQueryables(collectionId: string): Promise<OapifSchemaResponse>

  Parameters

  • collectionId: string

  Returns Promise<OapifSchemaResponse>

getSchema

• getSchema(collectionId: string): Promise<OapifSchemaResponse>

  Retrieves the schema associated with a specified collection.

  Parameters

  • collectionId: string

  Returns Promise<OapifSchemaResponse>

getServer

• getServer(): Promise<ServerOgcApiFeatures>

  Returns Promise<ServerOgcApiFeatures>

loadConformance

• loadConformance(): Promise<string[]>

  Load the list of conformance classes, which describe what kind of functionality the server provides.

  Returns Promise<string[]>

updateItem

• updateItem(
      collectionId: string,
      itemId: string,
      item: Feature<Geometry>,
      crsCode: string,
  ): Promise<boolean>

  Updates an existing item in the specified collection.

  Parameters

  • collectionId: string
  • itemId: string
  • item: Feature<Geometry>
  • crsCode: string

  Returns Promise<boolean>