{"id":29802971,"url":"https://github.com/2gis/mapgl-terra-draw","last_synced_at":"2025-07-28T10:44:56.217Z","repository":{"id":300835124,"uuid":"1007333671","full_name":"2gis/mapgl-terra-draw","owner":"2gis","description":"TerraDraw adapter for MapGL JS API","archived":false,"fork":false,"pushed_at":"2025-07-10T19:32:06.000Z","size":1544,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-11T05:03:37.066Z","etag":null,"topics":["mapgl","terra-draw"],"latest_commit_sha":null,"homepage":"https://2gis.github.io/mapgl-terra-draw/","language":"TypeScript","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/2gis.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,"zenodo":null}},"created_at":"2025-06-23T20:41:40.000Z","updated_at":"2025-07-10T19:32:10.000Z","dependencies_parsed_at":"2025-06-24T07:22:09.793Z","dependency_job_id":"15a5b0b2-7b72-4895-914d-f647a5d5574e","html_url":"https://github.com/2gis/mapgl-terra-draw","commit_stats":null,"previous_names":["itanka9/mapgl-terra-draw","2gis/mapgl-terra-draw"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/2gis/mapgl-terra-draw","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2gis%2Fmapgl-terra-draw","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2gis%2Fmapgl-terra-draw/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2gis%2Fmapgl-terra-draw/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2gis%2Fmapgl-terra-draw/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/2gis","download_url":"https://codeload.github.com/2gis/mapgl-terra-draw/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2gis%2Fmapgl-terra-draw/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267504043,"owners_count":24098336,"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","status":"online","status_checked_at":"2025-07-28T02:00:09.689Z","response_time":68,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["mapgl","terra-draw"],"created_at":"2025-07-28T10:44:55.623Z","updated_at":"2025-07-28T10:44:56.202Z","avatar_url":"https://github.com/2gis.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MapGL TerraDraw Adapter\n\n[TerraDraw](https://github.com/JamesLMilner/terra-draw) adapter for [MapGL JS API](http://docs.2gis.com/en/mapgl) or just a simple drawing tool.\n\n![intro pic](/docs/intro.png)\n\n[Demo](https://2gis.github.io/mapgl-terra-draw/)\n\n[Drawing Modes User Manual](MODES.md)\n\n## Getting started\n\nInstall library\n\n```bash\nnpm install @2gis/mapgl-terra-draw\n```\n\nUse ui-helper `createTerraDrawWithUI` and not forget to plug css:\n\n```ts\nimport { load } from '@2gis/mapgl';\nimport { createTerraDrawWithUI } from '@2gis/mapgl-terra-draw';\nimport '@2gis/mapgl-terra-draw/dist/mapgl-terra-draw.css';\n\nload().then((mapgl) =\u003e {\n    const map = new mapgl.Map('map', {\n        center: [55.31878, 25.23584],\n        zoom: 13,\n        key: 'Your MapGL JS API key',\n        enableTrackResize: true,\n    });\n\n    map.on('styleload', () =\u003e {\n        createTerraDrawWithUI({\n            map,\n            mapgl: mapgl as any,\n            controls: ['color', 'select', 'point', 'polygon', 'circle', 'download', 'clear'],\n        });\n    });\n});\n```\n\n## Advanced usage\n\nIf advanced cases (use your custom drawing mode, customize a very flexible TerraDraw [selection behaviour](https://github.com/JamesLMilner/terra-draw/blob/main/guides/4.MODES.md#selection-mode), design a fancy UI, e.g.) you can use `TerraDrawMapGlAdapter` class directly.\n\nThis gives you much more flexibility, but puts a some bunch of work on your side. Here is a simple example:\n\n```ts\nimport { load } from '@2gis/mapgl';\nimport {\n    TerraDraw,\n    TerraDrawPointMode,\n    TerraDrawPolygonMode,\n    TerraDrawSelectMode,\n} from 'terra-draw';\nimport { TerraDrawMapGlAdapter } from '@2gis/mapgl-terra-draw';\n\nload().then((mapgl) =\u003e {\n    const map = new mapgl.Map('map', {\n        center: [55.31878, 25.23584],\n        zoom: 13,\n        key: 'Your MapGL JS API key',\n        enableTrackResize: true,\n    });\n\n    map.on('styleload', () =\u003e {\n        const draw = new TerraDraw({\n            adapter: new TerraDrawMapGlAdapter({\n                map,\n                mapgl,\n                coordinatePrecision: 9,\n            }),\n            modes: [\n                new TerraDrawSelectMode(),\n                new TerraDrawPointMode(),\n                new TerraDrawPolygonMode(),\n            ],\n        });\n\n        const buttons = document.createElement('div');\n        buttons.style.display = 'flex';\n        buttons.style.flexDirection = 'column';\n        buttons.style.gap = '8px';\n        new mapgl.Control(map, buttons, { position: 'centerLeft' });\n\n        const selectButton = document.createElement('button');\n        selectButton.innerText = 'select';\n        selectButton.addEventListener('click', () =\u003e {\n            draw.setMode('select');\n        });\n        buttons.appendChild(selectButton);\n\n        const pointButton = document.createElement('button');\n        pointButton.innerText = 'point';\n        pointButton.addEventListener('click', () =\u003e {\n            draw.setMode('point');\n        });\n        buttons.appendChild(pointButton);\n\n        const polygonButton = document.createElement('button');\n        polygonButton.innerText = 'polygon';\n        polygonButton.addEventListener('click', () =\u003e {\n            draw.setMode('polygon');\n        });\n        buttons.appendChild(polygonButton);\n\n        const clearButton = document.createElement('button');\n        clearButton.innerText = 'clear';\n        clearButton.addEventListener('click', () =\u003e {\n            draw.clear();\n        });\n        buttons.appendChild(clearButton);\n\n        draw.start();\n    });\n});\n```\n\n## How to get a drawed data\n\nUse a [.getSnapshot()](https://jameslmilner.github.io/terra-draw/classes/terra_draw.TerraDraw.html#getSnapshot) method of a TerraDraw.\n\n```ts\nconst { draw } = createTerraDrawWithUI({\n    ...\n});\n\n...\n\ndraw.getSnapshot();\n```\n\n\n## Material Icons\n\nUI relies on Material Icons font to display icons. So you should include following `link` to your HTML head.\n\n```html\n\u003clink rel=\"stylesheet\" href=\"https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined\" /\u003e\n```\n\n## Deploy\n\n```\nnpm run build\nnpm publish --access=public\n```\n\n## LICENSE\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2gis%2Fmapgl-terra-draw","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F2gis%2Fmapgl-terra-draw","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2gis%2Fmapgl-terra-draw/lists"}