README

XYZ Maps JS: Display

XYZ Maps is an experimental and work in progress open-source map editor written in TypeScript/JavaScript. The display module of XYZ Maps is a highly customizable vector map display that's optimized for map editing, larger raw datasets and frequently changing data.

Installation

Install XYZ Map Display by using

# install using npm
npm install @here/xyz-maps-display

# install using yarn
yarn add @here/xyz-maps-display

Example Usage:

Create a map display

import MapDisplay from '@here/xyz-maps-display';

const display = new MapDisplay( mapDiv, {
    zoomLevel : 18,
    center: {
        longitude: 8.53422,
        latitude: 50.16212
    },
    // add layers to the display
    layers: layerSetup
});

Start developing

Install node module dependencies
```
yarn install
```
In case yarn is not installed already: install yarn
watch for source code changes and build dev version
```
yarn run watch-dev
```
Builds are located in located in ./dist/

Other

build dev version once yarn run build-dev (located in packages/*/dist/)
build release version only yarn run build-release (minified...)

Contributing

Your contributions are always welcome! Please have a look at the contribution guidelines first.

License

This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details

@here/xyz-maps-display

Usage no npm install needed!