{"id":24988702,"url":"https://github.com/maptalks/maptalks.snap","last_synced_at":"2025-04-12T00:09:55.209Z","repository":{"id":54567110,"uuid":"522466284","full_name":"maptalks/maptalks.snap","owner":"maptalks","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-10T02:22:06.000Z","size":367,"stargazers_count":10,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-12T00:09:44.793Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maptalks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-08T08:30:48.000Z","updated_at":"2025-03-10T06:37:50.000Z","dependencies_parsed_at":"2024-11-19T10:30:19.174Z","dependency_job_id":"6d468100-1b73-4df9-87fb-89de61058f51","html_url":"https://github.com/maptalks/maptalks.snap","commit_stats":{"total_commits":45,"total_committers":2,"mean_commits":22.5,"dds":0.0888888888888889,"last_synced_commit":"baff338f63b8acdcae2f44d5d7306dca28f59d00"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maptalks%2Fmaptalks.snap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maptalks%2Fmaptalks.snap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maptalks%2Fmaptalks.snap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maptalks%2Fmaptalks.snap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maptalks","download_url":"https://codeload.github.com/maptalks/maptalks.snap/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248497809,"owners_count":21113984,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-04T12:05:07.668Z","updated_at":"2025-04-12T00:09:55.200Z","avatar_url":"https://github.com/maptalks.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# maptalks.snap\n\nmaptalks snap plugin  \n[maptalks.js](https://github.com/maptalks/maptalks.js) version required \u003e= `1.0.0-rc.11`\n\n## Features\n\n* Support Geometry Edit/Draw\n* Impressive performance  [perf test](https://maptalks.github.io/maptalks.snap/test/perf.html)\n\n## Install\n\n* NPM\n\n```sh\n  npm i maptalks\n  # or\n  # npm i maptalks-gl\n  npm i maptalks.snap\n```\n\n* CDN\n\n```html\n\u003cscript type=\"text/javascript\" src=\"https://unpkg.com/maptalks/dist/maptalks.min.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"https://unpkg.com/maptalks.snap/dist/maptalks.snap.js\"\u003e\u003c/script\u003e\n```\n\n## Examples\n\n [edit Geometry](https://maptalks.github.io/maptalks.snap/test/index.html)\u003cbr\u003e\n [draw Geometry](https://maptalks.github.io/maptalks.snap/test/draw.html)\u003cbr\u003e\n [custom filtergeometries](https://maptalks.github.io/maptalks.snap/test/filtergeometries.html)\u003cbr\u003e\n [filtergeometries from multi layers](https://maptalks.github.io/maptalks.snap/test/multilayerfilter.html)\u003cbr\u003e\n [filtergeometries from VT Layer](https://maptalks.github.io/maptalks.snap/test/vt-snap.html)\u003cbr\u003e\n [perf test](https://maptalks.github.io/maptalks.snap/test/perf.html)  \n [drag point](https://maptalks.github.io/maptalks.snap/test/dragpoint.html)\n\n ## API\n\n### Snap\n\n#### constructor(map, options)\n\n - map\n - options\n   - {Number} tolerance `snapTo threshold`\n\n   - {Function } filterGeometries `filter geometries for snap collision. If it is empty, all geometries on the layer where the geometry is located will be obtained`\n\n```js\nimport {\n    Snap\n} from 'maptalks.snap';\nconst snap = new Snap(map, {\n    //snapTo threshold\n    tolerance: 15,\n    // filter geometries for snap collision\n    filterGeometries: function() {\n        //you can return geometries for snap collision\n        return layer.geometries().filter(geo =\u003e {\n            return geo instanceof maptalks.Polygon;\n        })\n    }\n});\n\nsnap.on('snap', (e) =\u003e {\n    console.log(e);\n})\n\n//if you use cdn,Snap Hanging under maptalks namespace\n// const snap = new maptalks.Snap(map, {\n//     //snapTo threshold\n//     tolerance: 15,\n//     // filter geometries for snap collision\n//     filterGeometries: function() {\n//         //you can return geometries for snap collision\n//         return layer.geometries().filter(geo =\u003e {\n//             return geo instanceof maptalks.Polygon;\n//         })\n//     }\n// });\nsnap.effectGeometry(polygon);\n//update options\nsnap.config({\n    tolerance: 18,\n    //other opiton params\n    ...\n})\n```\n\n  \n\n#### methods\n\n  + effectGeometry(geometry) ` effect geometry for snap`  \n  \n\n```js\nsnap.effectGeometry(polygon);\nsnap.effectGeometry(lineString);\n```\n\n  + unEffectGeometry(geometry) `remove geometry snap behavior`\n  \n\n```js\nsnap.unEffectGeometry(polygon);\nsnap.unEffectGeometry(lineString);\n```\n\n  + dispose() `dispose Snap`\n\n```js\nsnap.dispose();\n```\n\n#### events\n\n   + snap\n\n   \n\n```js\n     snap.on('snap', (e) =\u003e {\n         console.log(e);\n     })\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaptalks%2Fmaptalks.snap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaptalks%2Fmaptalks.snap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaptalks%2Fmaptalks.snap/lists"}