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

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
Overrides Observable.constructor
- Defined in dist/lib.es.d.ts:239

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
- Defined in dist/lib.es.d.ts:275
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
- datasets: Collection | (Dataset | DatasetGroup)[]
Returns void
- Defined in dist/lib.es.d.ts:280

locale

get locale(): string
Get the current locale.

Returns string
- Defined in dist/lib.es.d.ts:243

Methods

addDataset

addDataset(config: PartialDataset): Promise<Dataset>
Add a local Dataset and use it like any other dataset. The dataset will not be stored or persisted in any form
Parameters
- config: PartialDataset
  a JSON representation of the Dataset with recursively partial properties
Returns Promise<Dataset>
- Defined in dist/lib.es.d.ts:465

addExcludeDataset

addExcludeDataset(id: string): void
Exclude a Dataset from the session. The dataset will only be removed locally until page reload. The next time a method on this api is called, the dataset will be excluded. If the dataset is part of the activeDatasts collection, then it will be removed from that list.
Parameters
- id: string
  the ID of the Dataset that should be excluded
Returns void
- Defined in dist/lib.es.d.ts:472

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>
- Defined in dist/lib.es.d.ts:290

fetchBackendVersion

fetchBackendVersion(): Promise<any>
Get the backend version.

Returns Promise<any>
- Defined in dist/lib.es.d.ts:251

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

Deprecated
Use the search method instead
- Defined in dist/lib.es.d.ts:447

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

Deprecated
Use the search method instead
- Defined in dist/lib.es.d.ts:458

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

Deprecated
Use the search method instead
- Defined in dist/lib.es.d.ts:436

fireEvent

fireEvent(event: string, ...args: unknown[]): void
Parameters
- event: string
- ...args: unknown[]
Returns void
Inherited from Observable.fireEvent
- Defined in dist/lib.es.d.ts:1104

getCategories

getCategories(): Promise<Category[]>
Get all Categorys related to any previously fetched Dataset

Returns Promise<Category[]>
- Defined in dist/lib.es.d.ts:349

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
- Defined in dist/lib.es.d.ts:317

getDatasetCollections

getDatasetCollections(): Promise<DatasetCollection[]>
Get all DatasetCollections related to any previously fetched Dataset

Returns Promise<DatasetCollection[]>
- Defined in dist/lib.es.d.ts:353

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
- Defined in dist/lib.es.d.ts:365

getDatasetGroups

getDatasetGroups(): Promise<DatasetGroup[]>
Get all DatasetGroups related to any previously fetched Dataset

Returns Promise<DatasetGroup[]>
- Defined in dist/lib.es.d.ts:357

getDatasets

getDatasets(
filter?: string,
reload?: boolean,
): Promise<(Dataset | DatasetGroup)[]>
Request a list of all Dataset using a filter
Parameters
- Optionalfilter: string
  to get a list of available Dataset see syntax at https://www.jsonapi.net/usage/reading/filtering.html
- Optionalreload: boolean
  Omit the client cache
Returns Promise<(Dataset | DatasetGroup)[]>
a collection of Datasets
- Defined in dist/lib.es.d.ts:307

getOlGroup

getOlGroup(): LayerGroup
Get an OpenLayes colllection of the active Datasets to add for the map.

Returns LayerGroup
a OpenLayers LayerGroup
- Defined in dist/lib.es.d.ts:370

getOrganizations

getOrganizations(): Promise<Organization[]>
Get all Organizations related to any previously fetched Dataset

Returns Promise<Organization[]>
- Defined in dist/lib.es.d.ts:337

getOwners

getOwners(): Promise<Organization[]>
Get all owners (Organizations) related to any previously fetched Dataset

Returns Promise<Organization[]>
- Defined in dist/lib.es.d.ts:341

getTags

getTags(): Promise<Tag[]>
Get all Tags related to any previously fetched Dataset

Returns Promise<Tag[]>
- Defined in dist/lib.es.d.ts:345

isLoading

isLoading(): boolean
Is the api currently loading a DatasetState.

Returns boolean
- Defined in dist/lib.es.d.ts:374

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>
- Defined in dist/lib.es.d.ts:295

off

off(listener: EventListener_2): void
Remove a listen from an event
Parameters
- listener: EventListener_2
  returned by the on method
Returns void
Inherited from Observable.off
- Defined in dist/lib.es.d.ts:1103

on

on(
    event:
        | "change:activedatasets"
        | "change:activedatasets.add"
        | "change:activedatasets.remove"
        | "change:favorite"
        | "change:visible"
        | "change:opacity"
        | "change:locale"
        | "loading"
        | "datasetAdded",
    callback: EventListenerCallback,
): EventListener_2
Listen to an event
Parameters
- event:
      | "change:activedatasets"
      | "change:activedatasets.add"
      | "change:activedatasets.remove"
      | "change:favorite"
      | "change:visible"
      | "change:opacity"
      | "change:locale"
      | "loading"
      | "datasetAdded"
  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:activedatasets.add' the callback function is called with the event name and the added Dataset
  
  For 'change:activedatasets.remove' the callback function is called with the event name and the removed 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:opacity' the callback function is called with the event name and the Dataset that have changed the opacity 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
  
  For 'datasetAdded' the callback function is called with a Dataset that that is added to the store
Returns EventListener_2
A listener that can be used for removing the listener
Overrides Observable.on
- Defined in dist/lib.es.d.ts:267

query

query(
    filter: Filter,
    datasets?: (Dataset | DatasetGroup)[],
    options?: number | QueryOptions,
): Promise<QueryResult>[]
Query a list of Dataset with a Filter
Parameters
- filter: Filter
  An OpenLayers Filter to query with
- Optionaldatasets: (Dataset | DatasetGroup)[]
  Default is the current active and visible datasets
- Optionaloptions: number | QueryOptions
  Use QueryOptions.QueryOptions.limit and not the legacy number as limit
Returns Promise<QueryResult>[]
a list of queried dataset with the related hits
- Defined in dist/lib.es.d.ts:416

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
- Defined in dist/lib.es.d.ts:392

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
- Defined in dist/lib.es.d.ts:400

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
- Defined in dist/lib.es.d.ts:408

queryById

queryById(
id: string | number,
dataset: Dataset | DatasetGroup,
): Promise<QueryResult>
Query a Dataset for a specific feature using id
Parameters
- id: string | number
  A ID of a Feature from the Dataset
- dataset: Dataset | DatasetGroup
  The Dataset to query
Returns Promise<QueryResult>
a list of queried dataset with the related hit
- Defined in dist/lib.es.d.ts:384

removeExcludeDataset

removeExcludeDataset(id: string): void
Remove a Dataset from the exclution list. The next time a method on this api is called, the dataset will NOT be excluded.
Parameters
- id: string
  the ID of the Dataset that should be removed from the exclution list
Returns void
- Defined in dist/lib.es.d.ts:477

resetActiveDatasets

resetActiveDatasets(): Promise<void>
Reset to the initial list of active Dataset

Returns Promise<void>
- Defined in dist/lib.es.d.ts:299

save

save(): void
Returns void
- Defined in dist/lib.es.d.ts:270

search

search(
searchContext: SearchContext,
searchMethod?: "client" | "ai",
): Promise<(Dataset | DatasetGroup | Organization)[]>
Find Datasets, Dataset Collections or Organizations by text.
Parameters
- searchContext: SearchContext
- OptionalsearchMethod: "client" | "ai"
  'ai' (default) or 'client' as search method where 'ai' is using a AI based search engine and 'client' is a client side text search on multiple fields
Returns Promise<(Dataset | DatasetGroup | Organization)[]>
a list of Datasets, Dataset Collections or Organizations matching the search string and ordered by best match
- Defined in dist/lib.es.d.ts:423

serialize

serialize(): DatasetState[]
Serialize the current list of active Dataset

Returns DatasetState[]
a JSON representation of the active Datasets
- Defined in dist/lib.es.d.ts:285

setLocale

setLocale(locale: LocaleType): Promise<void>
Change the locale.
Parameters
- locale: LocaleType
Returns Promise<void>
- Defined in dist/lib.es.d.ts:247

subscribeActiveDatasetsAvailability

subscribeActiveDatasetsAvailability(): Promise<void>
Subscribe to auto updating availability status on all active Datasets

Returns Promise<void>
- Defined in dist/lib.es.d.ts:332

subscribeDatasetsAvailability

subscribeDatasetsAvailability(): Promise<void>
Subscribe to auto updating availability status on all currently fetched Datasets

Returns Promise<void>
- Defined in dist/lib.es.d.ts:327

Class Api

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Api

Accessors

activeDatasets

Returns Collection

Parameters

Returns void

locale

Returns string

Methods

addDataset

Parameters

Returns Promise<Dataset>

addExcludeDataset

Parameters

Returns void

deserialize

Parameters

Returns Promise<void>

fetchBackendVersion

Returns Promise<any>

findDatasetCollectionsByText

Parameters

Returns Promise<DatasetCollection[]>

Deprecated

findDatasetOwnersByText

Parameters

Returns Promise<Organization[]>

Deprecated

findDatasetsByText

Parameters

Returns Promise<(Dataset | DatasetGroup)[]>

Deprecated

fireEvent

Parameters

Returns void

getCategories

Returns Promise<Category[]>

getDataset

Parameters

Returns Promise<Dataset | DatasetGroup>

getDatasetCollections

Returns Promise<DatasetCollection[]>

getDatasetGroup

Parameters

Returns Promise<DatasetGroup>

getDatasetGroups

Returns Promise<DatasetGroup[]>

getDatasets

Parameters

Returns Promise<(Dataset | DatasetGroup)[]>

getOlGroup

Returns LayerGroup

getOrganizations

Returns Promise<Organization[]>

getOwners

Returns Promise<Organization[]>

getTags

Returns Promise<Tag[]>

isLoading

Returns boolean

load

Parameters

Returns Promise<void>

off

Parameters

Returns void

on

Parameters

Returns EventListener_2

query

Parameters