❤
npm
Sign UpSign In

ymaps-regionmap

1.0.0 • Public • Published

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) on your CDN.

  2. Load both Yandex Maps JS API 2.1 and module source code by adding following code into <head> section of your page:

    <script src="http://api-maps.yandex.ru/2.1/?lang=ru_RU" type="text/javascript"></script>
    <!-- Change my.cdn.tld to your CDN host name -->
    <script src="http://my.cdn.tld/regionmap.min.js" type="text/javascript"></script>

    If you use GeoJSON data:

    <script src="http://api-maps.yandex.ru/2.1/?lang=ru_RU&coordOrder=longlat" type="text/javascript"></script>
    <!-- Change my.cdn.tld to your CDN host name -->
    <script src="http://my.cdn.tld/regionmap.min.js" type="text/javascript"></script>

    If you use npm:

    <script src="http://api-maps.yandex.ru/2.1/?lang=ru_RU" type="text/javascript"></script>
    npm i --save git+https://github.com/yandex-shri-fx-team/ymaps-regionmap.git
    require('ymaps-regionmap');
     
    // Or with babel
    import 'ymaps-regionmap';

  3. Get access to module functions by using ymaps.modules.require method:

    ymaps.modules.require(['Regionmap'], function (Regionmap) {
         var regionmap = new Regionmap();
    });

Regionmap

Regionmap module.

Requires: module:option.Manager, module:Polygonmap

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.
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
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
Returns: Map - Reference to Map instance.
Access: public

Examples

Displaying regionmap over geographical map

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

Readme

Keywords

Package Sidebar

Install

npm i ymaps-regionmap

Repository

github.com/yandex-shri-fx-team/ymaps-regionmap

Homepage

github.com/yandex-shri-fx-team/ymaps-regionmap#readme

Weekly Downloads

1

Version

1.0.0

License

MIT

Unpacked Size

19.4 kB

Total Files

11

Last publish

Collaborators

  • ruslankhh
  • shackijj
  • ruslanxdev
Try on RunKit
Report malware