Class Api

The Api is the core component of @dmp/map-components:

import Api from "@dmp/map-components"

const api = new Api()

Hierarchy

  • Observable
    • Api

Constructors

constructor

Accessors

activeDatasets locale

Methods

deserialize fetchBackendVersion findDatasetCollectionsByText findDatasetOwnersByText findDatasetsByText fireEvent getCategories getDataset getDatasetCollections getDatasetGroup getDatasetGroups getDatasets getOlGroup getOrganizations getOwners getTags isLoading load off on query queryByCoordinate queryByExtent queryByGeometry queryById resetActiveDatasets save serialize setLocale subscribeActiveDatasetsAvailability

Constructors

constructor

  • new Api(options: ApiOptions): Api

  • The constructor creates a api object to use in components like a layer control or to add to a map.

    Parameters

    • options: ApiOptions

      contains the initial settings for the API.

    Returns Api

Accessors

activeDatasets

  • get activeDatasets(): Collection

  • Get a collection of active Dataset. The order defines the rendering order in the map and ind the layerswitch

    Returns Collection

  • set activeDatasets(datasets: Collection | (Dataset | DatasetGroup)[]): void

  • Change the collection of active Dataset. The order defines the rendering order in the map and ind the layerswitch

    Parameters

    Returns void

locale

  • get locale(): string

  • Get the current locale.

    Returns string

Methods

deserialize

  • deserialize(datasetState: DatasetState[]): Promise<void>

  • Deserialize a JSON to change the list active Dataset

    Parameters

    • datasetState: DatasetState[]

      a JSON representation of the active Datasets

    Returns Promise<void>

fetchBackendVersion

  • fetchBackendVersion(): Promise<any>

  • Get the backend version.

    Returns Promise<any>

findDatasetCollectionsByText

  • findDatasetCollectionsByText(
        searchString: string,
        datasetCollections?: DatasetCollection[],
        options?: IFuseOptions<DatasetCollection>,
    ): Promise<DatasetCollection[]>

  • Find Dataset Collections by text. Match text in id, title, description and tags.

    Parameters

    • searchString: string

      String containing the

    • OptionaldatasetCollections: DatasetCollection[]

      Default is all datasetCollections

    • Optionaloptions: IFuseOptions<DatasetCollection>

      Options for the search

    Returns Promise<DatasetCollection[]>

    a list of datasetCollections matching the search string and ordered by best match

findDatasetOwnersByText

  • findDatasetOwnersByText(
        searchString: string,
        owners?: Organization[],
        options?: IFuseOptions<Organization>,
    ): Promise<Organization[]>

  • Find Dataset Owners by text. Match text in id, title, description and tags.

    Parameters

    • searchString: string

      String containing the

    • Optionalowners: Organization[]

      Default is all Owners

    • Optionaloptions: IFuseOptions<Organization>

      Options for the search

    Returns Promise<Organization[]>

    a list of Dataset Owners matching the search string and ordered by best match

findDatasetsByText

  • findDatasetsByText(
        searchString: string,
        datasets?: (Dataset | DatasetGroup)[],
        options?: IFuseOptions<Dataset | DatasetGroup>,
    ): Promise<(Dataset | DatasetGroup)[]>

  • Find datasets by text. Match text in id, title, description, owners, category and tags.

    Parameters

    • searchString: string

      String containing the

    • Optionaldatasets: (Dataset | DatasetGroup)[]

      Default is the current active and visible datasets

    • Optionaloptions: IFuseOptions<Dataset | DatasetGroup>

      Options for the search

    Returns Promise<(Dataset | DatasetGroup)[]>

    a list of dataset matching the search string and ordered by best match

fireEvent

  • fireEvent(event: string, ...args: unknown[]): void

  • Parameters

    • event: string
    • ...args: unknown[]

    Returns void

getCategories

getDataset

  • getDataset(
        id: string,
        includeAttributes?: boolean,
        reload?: boolean,
    ): Promise<Dataset | DatasetGroup>

  • Request a Dataset with a specific id

    Parameters

    • id: string

      A Dataset ID

    • OptionalincludeAttributes: boolean

      Include all the details of a Dataset like wfsSource attributes and more

    • Optionalreload: boolean

      Omit the client cache

    Returns Promise<Dataset | DatasetGroup>

    a the Dataset

getDatasetCollections

getDatasetGroup

  • getDatasetGroup(
        id: string,
        includeAttributes?: boolean,
        reload?: boolean,
    ): Promise<DatasetGroup>

  • Request a DatasetGroup with a specific id

    Parameters

    • id: string

      A DatasetGroup ID

    • OptionalincludeAttributes: boolean

      Include all the details of a Dataset like wfsSource attributes and more

    • Optionalreload: boolean

      Omit the client cache

    Returns Promise<DatasetGroup>

    a the DatasetGroup

getDatasetGroups

getDatasets

getOlGroup

  • getOlGroup(): LayerGroup

  • Get an OpenLayes colllection of the active Datasets to add for the map.

    Returns LayerGroup

    a OpenLayers LayerGroup

getOrganizations

getOwners

getTags

  • getTags(): Promise<Tag[]>

  • Get all Tags related to any previously fetched Dataset

    Returns Promise<Tag[]>

isLoading

  • isLoading(): boolean

  • Is the api currently loading a DatasetState.

    Returns boolean

load

  • load(datasetState?: DatasetState[]): Promise<void>

  • Load an initial list of active Dataset

    Parameters

    • OptionaldatasetState: DatasetState[]

      a JSON representation of the active Datasets

    Returns Promise<void>

off

  • off(listener: EventListener_2): void

  • Remove a listen from an event

    Parameters

    • listener: EventListener_2

      returned by the on method

    Returns void

on

  • on(
        event:
            | "change:activedatasets"
            | "change:favorite"
            | "change:visible"
            | "change:locale"
            | "loading",
        callback: EventListenerCallback,
    ): EventListener_2

  • Listen to an event

    Parameters

    • event:
          | "change:activedatasets"
          | "change:favorite"
          | "change:visible"
          | "change:locale"
          | "loading"

      Name of the event

    • callback: EventListenerCallback

      When the event is triggered

      • For 'change:activedatasets' the callback function is called with the event name and the new list of active Dataset
      • For 'change:favorite' the callback function is called with the event name and the Dataset that have changed the favorite state
      • For 'change:visible' the callback function is called with the event name and the Dataset that have changed the visible state
      • For 'change:locale' the callback function is called with the event name and the locale
      • For 'loading' the callback function is called with a boolean that indicates if a DatasetState is loading

    Returns EventListener_2

    A listener that can be used for removing the listener

query

queryByCoordinate

  • queryByCoordinate(
        coordinate: Coordinate,
        datasets?: (Dataset | DatasetGroup)[],
        options?: QueryOptions,
    ): Promise<QueryResult>[]

  • Query a list of Dataset with a coordinate

    Parameters

    • coordinate: Coordinate

      The coordinate to query with

    • Optionaldatasets: (Dataset | DatasetGroup)[]

      Default is the current active and visible datasets

    • Optionaloptions: QueryOptions

      Options for the query

    Returns Promise<QueryResult>[]

    a list of queried dataset with the related hits

queryByExtent

  • queryByExtent(
        extent: Extent,
        datasets?: (Dataset | DatasetGroup)[],
        options?: QueryOptions,
    ): Promise<QueryResult>[]

  • Query a list of Dataset with an extent

    Parameters

    • extent: Extent

      The bounding box to query with

    • Optionaldatasets: (Dataset | DatasetGroup)[]

      Default is the current active and visible datasets

    • Optionaloptions: QueryOptions

      Options for the query

    Returns Promise<QueryResult>[]

    a list of queried dataset with the related hits

queryByGeometry

  • queryByGeometry(
        geometry: Geometry,
        datasets?: (Dataset | DatasetGroup)[],
        options?: number | QueryOptions,
    ): Promise<QueryResult>[]

  • Query a list of Dataset with a geometry

    Parameters

    • geometry: Geometry

      An OpenLayers Geometry to query with

    • Optionaldatasets: (Dataset | DatasetGroup)[]

      Default is the current active and visible datasets

    • Optionaloptions: number | QueryOptions

      Use QueryOptions.limit and not the legacy number as limit

    Returns Promise<QueryResult>[]

    a list of queried dataset with the related hits

queryById

resetActiveDatasets

  • resetActiveDatasets(): Promise<void>

  • Reset to the initial list of active Dataset

    Returns Promise<void>

save

  • save(): void

  • Returns void

serialize

  • serialize(): DatasetState[]

  • Serialize the current list of active Dataset

    Returns DatasetState[]

    a JSON representation of the active Datasets

setLocale

  • setLocale(locale: LocaleType): Promise<void>

  • Change the locale.

    Parameters

    Returns Promise<void>

subscribeActiveDatasetsAvailability

  • subscribeActiveDatasetsAvailability(): Promise<void>

  • Subscribe to auto updating availability status on all active Datasets

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods