@2gis/deck2gis-layer
v2.0.9
Published
Deck.gl layers implementations into 2gis map
Downloads
715
Keywords
Readme
deck2gisLayer
Deck.gl layers implementations into 2gis map
Usage
Install with NPM
npm install @2gis/deck2gis-layer
Important
The current version of the
Deck2gisLayer
plugin is only compatible with thedeck.gl@^8
Use # deck2gisLayer
Import the deck2gisLayer plugin to your project and use it:
import { Deck2gisLayer, initDeck } from '@2gis/deck2gis-layer';
// Init mapgl
const map = new mapgl.Map('container', {
center: [55.31878, 25.23584],
zoom: 13,
key: 'Your API access key',
});
// Init deck.gl
const deck = initDeck(map, Deck, { antialiasing: 'msaa' });
// create Deck2gisLayer
const layer = new Deck2gisLayer<HexagonLayer<any>>({
id: 'deckgl-HexagonLayer',
deck,
type: HexagonLayer,
data,
antialiasing: true,
parameters: { depthTest: true },
radius: 480,
getPosition: (d: any) => [d.point.lon, d.point.lat],
});
// add deck layer into map
map.addLayer(deckLayer);
Contributing
Deck2gisLayer uses github-flow to accept & merge fixes and improvements. Basic process is:
- Fork the repo.
- Create a branch.
- Add or fix some code.
- Run testing suite with
npm run test:screenshots
and make sure nothing is broken - Add some tests for your new code or fix broken tests.
- Commit & push.
- Create a new pull request to original repo.
Pull requests with failing tests will not be accepted.
Also, if you modify packages or add them to package.json
, make sure you use npm
and update package-lock.json
.
Tests
Run tests
npm run test:screenshots
Release
npm
- Update the package version by running
npm version patch|minor|major
. This command returns a new package version. Let assume it's 1.2.3 - Push changes to github and merge them to the «master» branch
- Go to https://github.com/2gis/deck2gisLayer/releases/new
- Click the «Choose tag» button and create a new tag according to the version in package.json, for example v1.2.3
- Make sure the release target is the «master» branch
- Paste the release tag into the «Release title» field, for example v1.2.3
- Add a release description
- Click the «Publish release» button
- Go to https://github.com/2gis/deck2gisLayer/actions and wait for completing the release workflow
Demo
- Just execute
npm run deploy-gh-pages
on your local machine from a commit you want to deploy as a demo.