treetracker-web-map-core-test2
v2.7.5
Published
This is the core module for Greenstand web map application.
Downloads
18
Readme
treetracker-web-map-core
This is the core module for Greenstand web map application.
Dev Server
npm run dev
Testing
Integration Tests With Cypress
npm run cy
Debuging
To open detailed log (default is WARN), set the loglevel as below:
Linting and Formatting
Note: All of these actions will be automatically run when appropriate with lint-staged during the git pre-commit stage.
check for lint errors
npm run lint
check for lint errors with auto fix
npm run lint:fix
format with prettier
npm run format
sort package.json
npx sort-package-json
Publishing
build project as production module
npm run pre-publish
execute the github action to release the tag.
check issue 41 here
Usage
import module in different app
import { Map } from 'treetracker-web-map-core'
API
- construction:
map = new Map({
onLoad: () => console.log("onload"),
onClickTree: () => console.log("onClickTree"),
onFindNearestAt: () => console.log("onFindNearstAt"),
onError: () => console.log("onError"),
});
- listen to map events:
map.on("moveEnd", handleMoveEnd);
- set the filter for the map:
map.setFilters({
userid: 940,
})
this function will trigger rerendering of the map.
manipulate the map:
- gotoView(lat, lon, zoomLevel)
- gotoBounds(bounds)
- getInitialViewer() // get an appropriate view for the current map with filters
- selectTree(treeObject)
check dist/index.html
for a demo
how to debug the core on the client side
The senerio: sometime we need to find a easy way to debug the core in the client side, for example, the web map client repo, it's installing the core by npm, so it's hard to change code in core on the client side, we can install the core by folder
locally, and get the change on the client side immediately, to do so:
- Download the web map core repository,
git clonet [path to repo]
- Change to code you want in core
- Change the version number in
package.json
(this is neccessary, if don't do it, it's posssible the client will ignore/skip the installment) - Generate the bundle:
npm run pre-publish
(this is nessessary, the npm will fetch the bundle file rather than the src files) - Install the core in web map client:
npm install --save [relative path to the core folder]
- Restart the web map client