Skip to content

Latest commit

 

History

History
213 lines (136 loc) · 7.01 KB

README.md

File metadata and controls

213 lines (136 loc) · 7.01 KB
Raw

openlayers-indoorequal build npm

openlayers-indoorequal is an OpenLayers library to display indoor data from indoor=.

It provides:

  • a default style of the indoor tiles
  • a way to customize the style
  • 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:

OpenLayers compatibility

  • OL < 8: use version 0.0.8
  • OL 8 & 9: use version ~0.1.0
  • OL 10: use version >= 0.2.0

Install

With NPM

npm install --save openlayers-indoorequal

In the browser

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

Example

Get your free key at indoorequal.com.

import Map from 'ol/Map';
import TileLayer from 'ol/layer/Tile';
import OSM from 'ol/source/OSM';
import IndoorEqual, { LevelControl } from 'openlayers-indoorequal';
import 'openlayers-indoorequal/openlayers-indoorequal.css';

const apiKey = '<your-indoorequal-api-key>';

const map = new Map({
  target: 'map',
  layers: [
    new TileLayer({
      source: new OSM(),
    }),
  ],
});

const indoorEqual = new IndoorEqual(map, { apiKey });

const control = new LevelControl(indoorEqual);
map.addControl(control);

Loading the default sprite

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

To load the sprite, set the spriteBaseUrl property option on the constructor 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/openlayers-indoorequal/sprite"
},

Then load the sprite:

const indoorequal = new IndoorEqual(map, { apiKey: 'myKey', spriteBaseUrl: '/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/openlayers-indoorequal/sprite' },
      ],
    }),
  ],
};

Then load the sprite:

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

API

Table of Contents

LevelControl

Extends Control

A control to display the available levels

Parameters

  • indoorEqual IndoorEqual the IndoorEqual instance

  • options Object (optional, default {})

    • options.target string? Specify a target if you want the control to be rendered outside of the map's viewport.

Returns LevelControl this

IndoorEqual

Extends BaseObject

Load the indoor= source and layers in your map.

Parameters

  • map Object the OpenLayers instance of the map

  • options Object (optional, default {})

    • options.defaultStyle boolean? False to not set the default style. Default true.
    • options.spriteBaseUrl string? The base url of the sprite (without .json or .png). If not set, no sprite will be used in the default style.
    • options.url string? Override the default tiles URL (https://tiles.indoorequal.org/).
    • options.apiKey string? The API key if you use the default tile URL (get your free key at indoorequal.com).
    • options.heatmap boolean? Should the heatmap layer be visible at start (true : visible, false : hidden). Defaults to true/visible.

Returns IndoorEqual this

setStyle

Set the style for displayed features. This function takes a feature and resolution and returns an array of styles. If set to null, the layer has no style (a null style), so only features that have their own styles will be rendered in the layer. Call setStyle() without arguments to reset to the default style. See module:ol/style for information on the default style.

Parameters
  • styleFunction function the style function

setHeatmapVisible

Change the heatmap layer visibility

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

IndoorEqual#change:levels

Emitted when the list of available levels has been updated

Type: Array

IndoorEqual#change:level

Emitted when the current level has been updated

Type: string

Develop

Run tests

yarn test [--watch]

Build a new version

yarn build

Generate the documentation

yarn doc

License

BSD