# Yandex Maps API Regionmap Module
Yandex.Maps API module for data visualization.
**Regionmap** is a graphical representation of some spatial data, where depending on the number of entered points regions are painted in different colors.
`Regionmap` class allows to construct and display such representations over geographical maps.
## Loading
1. Put module source code ([regionmap.min.js](https://github.com/yandex-shri-fx-team/ymaps-regionmap/blob/master/umd/regionmap.min.js)) on your CDN.
2. Load both [Yandex Maps JS API 2.1](http://api.yandex.com/maps/doc/jsapi/) and module source code by adding following code into <head> section of your page:
```html
```
If you use [GeoJSON](http://geojson.org) data:
```html
```
If you use [npm](https://www.npmjs.com):
```html
```
```bash
npm i --save git+https://github.com/yandex-shri-fx-team/ymaps-regionmap.git
```
```js
require('ymaps-regionmap');
// Or with babel
import 'ymaps-regionmap';
```
3. Get access to module functions by using [ymaps.modules.require](http://api.yandex.ru/maps/doc/jsapi/2.1/ref/reference/modules.require.xml) method:
```js
ymaps.modules.require(['Regionmap'], function (Regionmap) {
var regionmap = new Regionmap();
});
```
## Regionmap
Regionmap module.
**Requires**: module:option.Manager, module:Polygonmap
* [Regionmap](#module_Regionmap)
* [Regionmap](#exp_module_Regionmap--Regionmap) ⏏
* [new Regionmap([data], [options])](#new_module_Regionmap--Regionmap_new)
* [.setMap(map)](#module_Regionmap--Regionmap+setMap) ⇒ Regionmap
* [.getMap()](#module_Regionmap--Regionmap+getMap) ⇒ Map
### Regionmap ⏏
**Kind**: Exported class
#### new Regionmap([data], [options])
| Param | Type | Description |
| --- | --- | --- |
| [data] | Object | Points, GeoJSON FeatureCollections. |
| [options] | Object | Options for customization. See more options in [Polygonmap](https://github.com/yandex-shri-fx-team/ymaps-polygonmap#readme). |
| options.regionOptions | object | Options for Yandex.Maps API Regions. |
#### regionmap.setMap(map) ⇒ Regionmap
Set Map instance to render Polygonmap object.
**Kind**: instance method of [Regionmap](#exp_module_Regionmap--Regionmap)
**Returns**: Regionmap - Self-reference.
**Access**: public
| Param | Type | Description |
| --- | --- | --- |
| map | Map | Map instance. |
#### regionmap.getMap() ⇒ Map
Get the Map instance.
**Kind**: instance method of [Regionmap](#exp_module_Regionmap--Regionmap)
**Returns**: Map - Reference to Map instance.
**Access**: public
## Examples
### Displaying regionmap over geographical map
```js
ymaps.modules.require(['Regionmap'], function (Regionmap) {
const dataPoints = {
type: 'FeatureCollection',
features: [{
id: 'id1',
type: 'Feature',
geometry: {
type: 'Point',
coordinates: [37.782551, -122.445368]
}
}, {
id: 'id2',
type: 'Feature',
geometry: {
type: 'Point',
coordinates: [37.782745, -122.444586]
}
}]
};
const regionmap = new Regionmap(dataPoints);
regionmap.setMap(myMap);
});
```
## Demo
- https://yandex-shri-fx-team.github.io/ymaps-regionmap