/mapbox-gl-indoorequal

A maplibre-gl.js plugin to display data from indoor=

Primary LanguageJavaScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

mapbox-gl-indoorequal build npm

mapbox-gl-indoorequal is a maplibre-gl or mapbox-gl.js plugin to display indoor data from indoor=.

It provides:

  • load vector tiles from indoorequal.org tile server or your own
  • display GeoJSON data
  • a default style of the indoor tiles
  • a way to customize the style and load your sprites
  • a level control to change the level displayed on the map
  • a programatic API to list the levels available and set the level displayed

See the demo.

Discover:

Install

Recommended versions:

  • mapbox-gl to use is the 1.12 (released in august 2020) or higher
  • maplibre-gl 1.15.2

With NPM

npm install --save mapbox-gl-indoorequal

In the browser

<script src="https://unpkg.com/mapbox-gl-indoorequal@latest/dist/mapbox-gl-indoorequal.umd.min.js"></script>
<link href="https://unpkg.com/mapbox-gl-indoorequal@latest/mapbox-gl-indoorequal.css" rel="stylesheet" />

Example

Get your free key at indoorequal.com.

import maplibregl from 'maplibre-gl';
import IndoorEqual from 'mapbox-gl-indoorequal';
import 'mapbox-gl-indoorequal/mapbox-gl-indoorequal.css';

mapboxgl.accessToken = '<your-token>';

const map = new maplibregl.Map({
  container: 'map',
  style: 'https://demotiles.maplibre.org/style.json',
  center: [2.3601072, 48.876853],
  zoom: 18
});

const indoorEqual = new IndoorEqual(map, { apiKey: 'mykey' });
map.addControl(indoorEqual);

Loading the default sprite

The default style make uses of a sprite that has to be loaded manually as mapbox-gl require an absolute path. The sprite is already builded and available in the sprite directory.

To load the sprite, use the loadSprite method with the absolute path to the sprite and its name /directory-to-change/indoorequal.

Usage with Parcel

Install the parcel-plugin-static-files-copy package and add to your package.json:

"staticFiles": {
  "staticPath": "node_modules/mapbox-gl-indoorequal/sprite"
},

Then load the sprite:

const indoorequal = new IndoorEqual(map, { apiKey: 'myKey' });
indoorequal.loadSprite('/indoorequal');

Usage with webpack

Install the copy-webpack-plugin package and add to your webpack config:

const CopyPlugin = require('copy-webpack-plugin');

module.exports = {
  plugins: [
    new CopyPlugin({
      patterns: [
        { from: 'node_modules/mapbox-gl-indoorequal/sprite' },
      ],
    }),
  ],
};

Then load the sprite:

const indoorequal = new IndoorEqual(map, { apiKey: 'myKey' });
indoorequal.loadSprite('/indoorequal');

API

Table of Contents

IndoorEqual

Load the indoor= source and layers in your map.

Parameters

  • map object the mapbox-gl/maplibre-gl instance of the map

  • options object (optional, default {})

    • options.url string? Override the default tiles URL (https://tiles.indoorequal.org/).
    • options.geojson object? GeoJSON data with with key as layer name and value with geojson features
    • options.apiKey string? The API key if you use the default tile URL (get your free key at indoorequal.com).
    • options.layers array? The layers to be used to style indoor= tiles. Take a look a the layers.js file file and the vector schema
    • options.heatmap boolean? Should the heatmap layer be visible at start (true : visible, false : hidden). Defaults to true/visible.

Properties

  • level string The current level displayed
  • levels array The levels that can be displayed in the current view

Returns IndoorEqual this

remove

Remove any layers, source and listeners and controls

on

Add an event listener

Parameters
  • name string the name of the event
  • fn function the function to be called when the event is emitted

off

Remove an event listener.

Parameters
  • name string the name of the event
  • fn function the same function when on() was called

onAdd

Add the level control to the map Used when adding the control via the map instance: map.addControl(indoorEqual)

onRemove

Remove the level control Used when removing the control via the map instance: map.removeControl(indoorEqual)

setLevel

Set the displayed level.

Parameters
  • level string the level to be displayed

updateLevel

Set the displayed level.

Parameters
  • level string the level to be displayed

Meta

  • deprecated: Use setLevel instead

loadSprite

Load a sprite and add all images to the map

Parameters

  • baseUrl string the baseUrl where to load the sprite

  • options object (optional, default {})

    • options.update boolean? Update existing image (default false)

Returns Promise It resolves an hash of images.

setHeatmapVisible

Change the heatmap layer visibility

Parameters
  • visible boolean True to make it visible, false to hide it

IndoorEqual#levelschange

Emitted when the list of available levels has been updated

Type: array

IndoorEqual#levelchange

Emitted when the current level has been updated

Type: string

Develop

Build the plugin and watch for changes

yarn dev

Run tests

yarn test [--watch]

Build a new version

yarn build

Generate the documentation

yarn doc

Generate the sprite

yarn sprite

License

BSD