https://github.com/pulsejet/instimapweb

TypeScript implementation of InstiMap for InstiApp
https://github.com/pulsejet/instimapweb

instiapp map openlayers typescript web

Last synced: 14 days ago
JSON representation

TypeScript implementation of InstiMap for InstiApp

• Host: GitHub
• URL: https://github.com/pulsejet/instimapweb
• Owner: pulsejet
• License: mit
• Created: 2019-02-15T08:23:24.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-02-24T06:53:53.000Z (almost 6 years ago)
• Last Synced: 2024-12-07T00:40:52.936Z (about 1 month ago)
• Topics: instiapp, map, openlayers, typescript, web
• Language: TypeScript
• Homepage:
• Size: 3.92 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# InstiMap Web

[![InstiApp](https://insti.app/instiapp-badge-gh.svg)](https://insti.app/map)

[![License](https://img.shields.io/github/license/pulsejet/instimapweb.svg?style=flat)](https://github.com/pulsejet/instimapweb/blob/master/LICENSE.md)

JavaScript implementation of InstiMap for InstiApp

## Installation

Install in your project as `npm install instimapweb`

## API

The following important calls are available

* `getMap` - Construct and get the map from locations. This is supposed to be called only once

* `getGPS` - Try to get a watch on geolocation

* `moveToLocation` - Move the marker to an `ILocation`

* `moveMarker` - Move the marker to a location

* `cleanup` - Clear geolocation watch if any

* `setResidencesVisible` - set if residences are visible

## Configuration

`getMap` takes as the first argument a configuration as follows:

```

mapPath: string;

mapMinPath: string;

markersBase: string;

attributions: string;

map_id: string;

marker_id: string;

user_marker_id: string;

```

## License

Peremissively licensed under MIT License.

**Note** The map used in the app is not distributed under this license, please contact [Prof. Mandar Rane](http://www.mrane.com/) for using/distributing the map in any format.