Class Api

The Api is the core component of the Lagvaelger:

import Api from "@dmp/lagvaelger-client-api"

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 src/api.ts:100

Properties

`Private` _activeDatasets

_activeDatasets: Collection = ...

`Private` _endpoint

_endpoint: string

`Private` _excludedDatasets

_excludedDatasets: string[] = []

`Private` _initialDatasetState

_initialDatasetState: DatasetState[] = ...

`Private` _loadingQueue

_loadingQueue: number = 0

`Private` _olGroup

_olGroup: LayerGroup = ...

`Private` _onlyQueryable

_onlyQueryable: boolean

`Private` _onlyRenderable

_onlyRenderable: boolean

`Private` _options

_options: ApiOptions

`Private` _store

_store: JsonApiStore

`Private` _testdata

_testdata: TestdataOptions = ...

`Private` hasSubscribed

hasSubscribed: boolean = false

`Private` isPolling

isPolling: boolean = false

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 src/api.ts:180
set activeDatasets(datasets: Dataset[] | Collection): void
Change the collection of active Dataset. The order defines the rendering order in the map and ind the layerswitch
Parameters
- datasets: Dataset[] | Collection
Returns void
- Defined in src/api.ts:188

Methods

`Private` _activeDatasetsChanged

_activeDatasetsChanged(): void
Returns void
- Defined in src/api.ts:165

`Private` _filterDatasets

_filterDatasets(datasets: Dataset[]): Dataset[]
Parameters
- datasets: Dataset[]
Returns Dataset[]
- Defined in src/api.ts:293

`Private` _getActiveOlLayers

_getActiveOlLayers(): BaseLayer[]
Returns BaseLayer[]
- Defined in src/api.ts:156

`Private` addToLoadingQueue

addToLoadingQueue(): void
Returns void
- Defined in src/api.ts:473

`Private` applyParams

applyParams(params: Record<string, string>, filter?: string): Record<string, string>
Parameters
- params: Record<string, string>
- Optional filter: string
Returns Record<string, string>
- Defined in src/api.ts:259

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 src/api.ts:206

fetchBackendVersion

fetchBackendVersion(): Promise<any>
Returns Promise<any>
- Defined in src/api.ts:129

`Protected` fireEvent

fireEvent(event: string, ...args: unknown[]): void
Parameters
- event: string
- Rest ...args: unknown[]
Returns void
Inherited from Observable.fireEvent
- Defined in src/observable.ts:36

getCategories

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

Returns Promise<Category[]>
- Defined in src/api.ts:425

getDataset

getDataset(id: string, includeAttributes?: boolean): Promise<Dataset>
Request a Dataset with a specific id

Returns
a the Dataset
Parameters
- id: string
  
  of a Dataset
- includeAttributes: boolean = false
Returns Promise<Dataset>
- Defined in src/api.ts:314

getDatasetCollections

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

Returns Promise<DatasetCollection[]>
- Defined in src/api.ts:435

getDatasets

getDatasets(filter?: string, reload?: boolean): Promise<Dataset[]>
Request a list of all Dataset using a filter

Returns
a collection of Datasets
Parameters
- Optional filter: string
  
  to get a list of available Dataset
- reload: boolean = false
Returns Promise<Dataset[]>
- Defined in src/api.ts:272

getOlGroup

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

Returns
a OpenLayers LayerGroup

Returns LayerGroup
- Defined in src/api.ts:455

getOrganizations

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

Returns Promise<Organization[]>
- Defined in src/api.ts:395

getOwners

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

Returns Promise<Organization[]>
- Defined in src/api.ts:403

getTags

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

Returns Promise<Tag[]>
- Defined in src/api.ts:415

isLoading

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

Returns boolean
- Defined in src/api.ts:467

load

load(datasetState?: DatasetState[]): Promise<void>
Load an initial list of active Dataset
Parameters
- Optional datasetState: DatasetState[]
  
  a JSON representation of the active Datasets
Returns Promise<void>
- Defined in src/api.ts:244

monitorDatasetChanges

monitorDatasetChanges(dataset: Dataset): void
Parameters
- dataset: Dataset
Returns void
- Defined in src/api.ts:300

off

off(listener: EventListener): void
Remove a listen from an event
Parameters
- listener: EventListener
  
  returned by the on method
Returns void
Inherited from Observable.off
- Defined in src/observable.ts:31

on

on(event: "change:visible" | "change:favorite" | "change:activedatasets" | "loading", callback: EventListenerCallback): EventListener
Listen to an event

Returns
A listener that can be used for removing the listener
Parameters
- event: "change:visible" | "change:favorite" | "change:activedatasets" | "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 'loading' the callback function is called with a boolean that indicates if a DatasetState is loading
Returns EventListener
Overrides Observable.on
- Defined in src/api.ts:149

pollDatasetsAvailability

pollDatasetsAvailability(): Promise<void>
Poll availability status and update all Datasets that has been previously fetched

Returns Promise<void>
- Defined in src/api.ts:357

query

query(filter: Filter, datasets?: Dataset[]): Promise<QueryResult>[]
Query a list of Dataset with a Filter

Returns
a list of queried dataset with the related hits
Parameters
- filter: Filter
- Optional datasets: Dataset[]
Returns Promise<QueryResult>[]
- Defined in src/api.ts:539

queryByCoordinate

queryByCoordinate(coordinate: Coordinate, datasets?: Dataset[], options?: QueryOptions): Promise<QueryResult>[]
Query a list of Dataset with a coordinate

Returns
a list of queried dataset with the related hits
Parameters
- coordinate: Coordinate
- Optional datasets: Dataset[]
  
  optional. Default is active, visible datasets
- Optional options: QueryOptions
Returns Promise<QueryResult>[]
- Defined in src/api.ts:497

queryByExtent

queryByExtent(extent: Extent, datasets?: Dataset[], options?: QueryOptions): Promise<QueryResult>[]
Query a list of Dataset with an extent

Returns
a list of queried dataset with the related hits
Parameters
- extent: Extent
- Optional datasets: Dataset[]
  
  optional. Default is active, visible datasets
- Optional options: QueryOptions
Returns Promise<QueryResult>[]
- Defined in src/api.ts:513

`Private` removeFromLoadingQueue

removeFromLoadingQueue(): void
Returns void
- Defined in src/api.ts:480

resetActiveDatasets

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

Returns Promise<void>
- Defined in src/api.ts:255

save

save(): void
Returns void
- Defined in src/api.ts:171

serialize

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

Returns
a JSON representation of the active Datasets

Returns DatasetState[]
- Defined in src/api.ts:197

subscribeDatasetsAvailability

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

Returns Promise<void>
- Defined in src/api.ts:386

Class Api

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: ApiOptions

Returns Api

Properties

Private _activeDatasets

Private _endpoint

Private _excludedDatasets

Private _initialDatasetState

Private _loadingQueue

Private _olGroup

Private _onlyQueryable

Private _onlyRenderable

Private _options

Private _store

Private _testdata

Private hasSubscribed

Private isPolling

Accessors

activeDatasets

Returns Collection

Parameters

datasets: Dataset[] | Collection

Returns void

Methods

Private _activeDatasetsChanged

Returns void

Private _filterDatasets

Parameters

datasets: Dataset[]

Returns Dataset[]

Private _getActiveOlLayers

Returns BaseLayer[]

Private addToLoadingQueue

Returns void

Private applyParams

Parameters

params: Record<string, string>

Optional filter: string

Returns Record<string, string>

deserialize

Parameters

datasetState: DatasetState[]

Returns Promise<void>

fetchBackendVersion

Returns Promise<any>

Protected fireEvent

Parameters

event: string

Rest ...args: unknown[]

Returns void

getCategories

Returns Promise<Category[]>

getDataset

Returns

Parameters

id: string

includeAttributes: boolean = false

Returns Promise<Dataset>

getDatasetCollections

Returns Promise<DatasetCollection[]>

getDatasets

Returns

Parameters

Optional filter: string

reload: boolean = false

Returns Promise<Dataset[]>

getOlGroup

Returns

Returns LayerGroup

getOrganizations

Returns Promise<Organization[]>

`Private` _activeDatasets

`Private` _endpoint

`Private` _excludedDatasets

`Private` _initialDatasetState

`Private` _loadingQueue

`Private` _olGroup

`Private` _onlyQueryable

`Private` _onlyRenderable

`Private` _options

`Private` _store

`Private` _testdata

`Private` hasSubscribed

`Private` isPolling

`Private` _activeDatasetsChanged

`Private` _filterDatasets

`Private` _getActiveOlLayers

`Private` addToLoadingQueue

`Private` applyParams

`Optional` filter: string

`Protected` fireEvent

`Rest` ...args: unknown[]

`Optional` filter: string

`Optional` datasetState: DatasetState[]

`Optional` datasets: Dataset[]

`Optional` datasets: Dataset[]

`Optional` options: QueryOptions

`Optional` datasets: Dataset[]

`Optional` options: QueryOptions

`Private` removeFromLoadingQueue