@geogirafe/lib-geoportal
    Preparing search index...

    Class representing an OGC API Features (OAPIF) client that interacts with a server implementing the OGC API - Features standard. This class provides functionality to fetch, manage, and manipulate collections and their spatial data from the server.

    Extends OgcApiClient<ServerOgcApiFeatures>: Provides base client functionalities.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    initialized: boolean
    serverConfig: ServerOgc

    Accessors

    Methods

    • 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>

    • 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[]>

    • 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>

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

      Parameters

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

      Returns 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>[]>

    • 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>

    • Updates an existing item in the specified collection.

      Parameters

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

      Returns Promise<boolean>