Installation

Universal Layer Manager consists of a core library @ulm/core and adapters for specific map libraries. Install the core package, then add an adapter for the map library you are using.

Core

npm

npm install @ulm/core

pnpm

pnpm add @ulm/core

yarn

yarn add @ulm/core

Dates for time info

You only need this if your layers carry time info. Dates are Temporal values, and not every browser supports Temporal yet, so install the polyfill as well:

npm

npm install temporal-polyfill

pnpm

pnpm add temporal-polyfill

yarn

yarn add temporal-polyfill

Then import Temporal from it wherever you create dates:

import { Temporal } from 'temporal-polyfill';

The TypeScript types come with @ulm/core, so there is nothing else to install.

Adapters

Leaflet

npm

npm install @ulm/leaflet leaflet

pnpm

pnpm add @ulm/leaflet leaflet

yarn

yarn add @ulm/leaflet leaflet

If you are using TypeScript, also install @types/leaflet.

MapLibre

npm

npm install @ulm/maplibre maplibre-gl

pnpm

pnpm add @ulm/maplibre maplibre-gl

yarn

yarn add @ulm/maplibre maplibre-gl

maplibre-gl brings its own TypeScript types. The adapter needs maplibre-gl 6, and like it, is published as ES modules only.

ArcGIS

npm

npm install @ulm/arcgis @arcgis/core

pnpm

pnpm add @ulm/arcgis @arcgis/core

yarn

yarn add @ulm/arcgis @arcgis/core

@arcgis/core brings its own TypeScript types. The adapter needs @arcgis/core 5, and like it, is published as ES modules only.

OpenLayers

npm

npm install @ulm/openlayers ol

pnpm

pnpm add @ulm/openlayers ol

yarn

yarn add @ulm/openlayers ol

ol brings its own TypeScript types. The adapter needs ol 10, and like it, is published as ES modules only.

Other map libraries

For other map libraries, you can write your own adapter.

From a local clone

To run the examples or contribute, clone the repository and build it:

git clone https://github.com/antarctica/universal-layer-manager.git
cd universal-layer-manager
npm install
npm run build
npm run dev   # start the examples