https://github.com/indoorequal/indoorequal.org

A web based indoor viewer that display vector tiles as well as GeoJSON, OSM and IMDF files
https://github.com/indoorequal/indoorequal.org

geojson imdf indoorequal mapbox-gl-js openstreetmap osm

Last synced: 3 days ago
JSON representation

A web based indoor viewer that display vector tiles as well as GeoJSON, OSM and IMDF files

• Host: GitHub
• URL: https://github.com/indoorequal/indoorequal.org
• Owner: indoorequal
• License: agpl-3.0
• Created: 2019-08-12T21:46:45.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T15:32:54.000Z (6 months ago)
• Last Synced: 2024-05-22T19:00:21.017Z (6 months ago)
• Topics: geojson, imdf, indoorequal, mapbox-gl-js, openstreetmap, osm
• Language: JavaScript
• Homepage: https://indoorequal.org
• Size: 6.34 MB
• Stars: 48
• Watchers: 5
• Forks: 9
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# indoorequal.org

A web based indoor viewer.

- display vector tiles from the [indoor= backend](https://github.com/indoorequal/indoorequal)

- render local or remote GeoJSON, OSM or [Indoor Mapping Data Format (IMDF)](https://register.apple.com/resources/imdf/) files

- provide an API to [control the viewer from another web page](#remote-command-api)

Discover:

- the backend: https://github.com/indoorequal/indoorequal

- the library to integrate indoor=: https://github.com/indoorequal/maplibre-gl-indoorequal

## Development

Using docker:

    ./script/server

And visit http://localhost:1234

## Configuration

A few configuration options are available by editing the `config.json` file:

- `mapTilerApiKey`: the [MapTiler](https://www.maptiler.com/) API Key

- `tilesUrl`: The URL of the indoor= tileJSON

- `indoorEqualApiKey`: the [indoor=](https://indoorequal.com/) API Key (optional if you don't use the official indoor= tileJSON

- `indoorMinZoom`: The minimum level of zoom when the indoor features are displayed

## Remote Command API

The remote command API allows you to interact with the viewer via the `window.postMessage()` method.

**Test page**: https://indoorequal.org/remote.html

**Example**

```javascript

const indoorEqualWindow = window.open("https://indoorequal.org/");

window.addEventListener('message', (e) => {

  if (e.data.event === 'ready') {

    const file = new File([JSON.stringify({type: 'FeatureCollection', features: []})], 'test.geojson');

    indoorEqualWindow.postMessage({ command: 'preview', file }, '*');

  }

});

```

**Open a preview**

With a file

Message: `{ command: 'preview', file: new File([], 'filename.geojson') }`

With an URL

Message: `{ command: 'preview', url: 'https://exemple.net/file.osm' }`

**Set level**

Message: `{ command: 'level', level: '0' }`

**Set coordinates**

Via the [bounding box](https://wiki.openstreetmap.org/wiki/Bounding_Box)

Message: `{ command: 'coordinates', bbox: [1.971874, 48.921259, 2.299404, 49.029990] }`

Via the center and the zoom

Message: `{ command: 'coordinates', center: { lng: 1.971874, lat: 48.921259 }, zoom: 1 }`

**Get levels**

Message: `{ command: 'levels' }`

Response: `{ event: 'levels', levels: ['0', '1', '2']}`

## Translation

Translations are managed via Transifex, [go here to translate it in your language](https://www.transifex.com/indoorequal/indoorequalorg/languages/).

## Deploy

Using docker:

    docker build -t indoor .

    docker run -p 8080:80 indoor

## License

GNU AGPL v3