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:91

Properties

_listeners

_listeners: EventListener_2[]

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:120
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:125

locale

get locale(): string
Get the current locale.

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

Methods

_applyParams

_applyParams(
params: Record<string, string>,
filter?: string,
): Record<string, string>
Parameters
- params: Record<string, string>
- Optionalfilter: string
Returns Record<string, string>
- Defined in dist/lib.es.d.ts:145

_filterDatasets

_filterDatasets(
datasets: (Dataset | DatasetGroup)[],
): (Dataset | DatasetGroup)[]
Parameters
- datasets: (Dataset | DatasetGroup)[]
Returns (Dataset | DatasetGroup)[]
- Defined in dist/lib.es.d.ts:152

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:135

fetchBackendVersion

fetchBackendVersion(): Promise<any>
Returns Promise<any>
- Defined in dist/lib.es.d.ts:100

findDatasetCollectionsByText

findDatasetCollectionsByText(
    searchString: string,
    datasetCollection?: 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
- OptionaldatasetCollection: DatasetCollection[]
- Optionaloptions: IFuseOptions<DatasetCollection>
  Options for the search
Returns Promise<DatasetCollection[]>
a list of datasetCollections matching the search string and ordered by best match
- Defined in dist/lib.es.d.ts:274

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[]
- Optionaloptions: IFuseOptions<Organization>
  Options for the search
Returns Promise<Organization[]>
a list of Dataset Owners matching the search string and ordered by best match
- Defined in dist/lib.es.d.ts:283

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

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:849

getCategories

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

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

getDataset

getDataset(
    id: string,
    includeAttributes?: boolean,
    reload?: boolean,
): Promise<Dataset | DatasetGroup>
Request a Dataset with a specific id
Parameters
- id: string
  of a Dataset
- OptionalincludeAttributes: boolean
- Optionalreload: boolean
Returns Promise<Dataset | DatasetGroup>
a the Dataset
- Defined in dist/lib.es.d.ts:159

getDatasetCollections

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

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

getDatasetGroup

getDatasetGroup(
    id: string,
    includeAttributes?: boolean,
    reload?: boolean,
): Promise<DatasetGroup>
Request a DatasetGroup with a specific id
Parameters
- id: string
  of a DatasetGroup
- OptionalincludeAttributes: boolean
- Optionalreload: boolean
Returns Promise<DatasetGroup>
a the DatasetGroup
- Defined in dist/lib.es.d.ts:205

getDatasetGroups

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

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

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
Returns Promise<(Dataset | DatasetGroup)[]>
a collection of Datasets
- Defined in dist/lib.es.d.ts:151

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:210

getOrganizations

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

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

getOwners

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

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

getTags

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

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

isLoading

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

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

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:140

monitorDatasetChanges

monitorDatasetChanges(dataset: Dataset | DatasetGroup): void
Parameters
- dataset: Dataset | DatasetGroup
Returns void
- Defined in dist/lib.es.d.ts:153

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:848

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

query

query(
    filter: Filter,
    datasets?: (Dataset | DatasetGroup)[],
    options?: number | QueryOptions,
): Promise<QueryResult>[]
Query a list of Dataset with a Filter
Parameters
- filter: Filter
- 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:256

queryByCoordinate

queryByCoordinate(
    coordinate: Coordinate,
    datasets?: (Dataset | DatasetGroup)[],
    options?: QueryOptions,
): Promise<QueryResult>[]
Query a list of Dataset with a coordinate
Parameters
- coordinate: Coordinate
- Optionaldatasets: (Dataset | DatasetGroup)[]
  Default is the current active and visible datasets
- Optionaloptions: QueryOptions
Returns Promise<QueryResult>[]
a list of queried dataset with the related hits
- Defined in dist/lib.es.d.ts:232

queryByExtent

queryByExtent(
    extent: Extent,
    datasets?: (Dataset | DatasetGroup)[],
    options?: QueryOptions,
): Promise<QueryResult>[]
Query a list of Dataset with an extent
Parameters
- extent: Extent
- Optionaldatasets: (Dataset | DatasetGroup)[]
  Default is the current active and visible datasets
- Optionaloptions: QueryOptions
Returns Promise<QueryResult>[]
a list of queried dataset with the related hits
- Defined in dist/lib.es.d.ts:240

queryByGeometry

queryByGeometry(
    geometry: Geometry,
    datasets?: (Dataset | DatasetGroup)[],
    options?: number | QueryOptions,
): Promise<QueryResult>[]
Query a list of Dataset with a geometry
Parameters
- geometry: Geometry
- 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:248

queryById

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

resetActiveDatasets

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

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

save

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

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:130

setLocale

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

subscribeActiveDatasetsAvailability

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

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

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:169

Class Api

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Api

Properties

_listeners

Accessors

activeDatasets

Returns Collection

Parameters

Returns void

locale

Returns string

Methods

_applyParams

Parameters

Returns Record<string, string>

_filterDatasets

Parameters

Returns (Dataset | DatasetGroup)[]

deserialize

Parameters

Returns Promise<void>

fetchBackendVersion

Returns Promise<any>

findDatasetCollectionsByText

Parameters

Returns Promise<DatasetCollection[]>

findDatasetOwnersByText

Parameters

Returns Promise<Organization[]>

findDatasetsByText

Parameters

Returns Promise<(Dataset | DatasetGroup)[]>

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>

monitorDatasetChanges

Parameters

Returns void

off

Parameters

Returns void

on

Parameters