Recomaps NPM | npm.io

Recomaps

Introduction

Recomaps is a Wrapper for openlayers map library.

The main purpose of this library is to help you to create maps with openlayers in React applications without any pain.

Simple example

<Map
  area={this.state.area}
  features={this.state.features}
  initialized={this.state.initialized && this.state.overlays.length > 0}
  layers={this.state.layers}
  zoomControlButtonEnable/>

Installation

  $ npm install recomaps

  import { Map } from 'recomaps'

Dev build

 $ npm install

$ npm start

Open http://localhost:3000 to view it in the browser.

$ npm run lib

API

Prop	Type	Description
center	array	lat, long e.g. 16, 52
layers	array	array of layers objects
overlays	array	array of overlays objects
layerSwitcherEnable	bool	Enable layer switcher
handleBaselayerChange	func	action after click base layer change
handleOverlayCheck	func	action after click base layer change
height	number	height of map in pixels, default is 400
name	string	layer name if different than 'name' eg. slug_name in layers objects, default is 'name'
bingMapKey	string	key to bing map
features	array	features = {type: string, coordinates: array}
featuresColor	string	color of the features
area	object	{coordinates: polygon, type: string} if exist count centroid and set map center
zoom	number	initial zoom
minZoom	number	minZoom
maxZoom	number	maxZoom
heatmap	string	URL of geojson to display heatmap
heatmapName	string	name of heatmap layer
zoomButtonColor	string	colof of zoom control button
zoomControlButtonEnable	bool	zoom control button enable
doubleClickZoomEnable	bool	double click interaction enable
dragPanEnable	bool	drag pan interaction enable
mouseWheelZoomEnable	bool	mouse wheel interaction enable