{"id":23210034,"url":"https://github.com/dqunbp/mapbox-gl-draw-rectangle-restrict-area","last_synced_at":"2025-07-07T11:14:43.303Z","repository":{"id":35130758,"uuid":"210639428","full_name":"dqunbp/mapbox-gl-draw-rectangle-restrict-area","owner":"dqunbp","description":null,"archived":false,"fork":false,"pushed_at":"2023-03-03T18:07:51.000Z","size":5172,"stargazers_count":9,"open_issues_count":19,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-12-17T05:57:31.889Z","etag":null,"topics":["draw-rectangle","mapbox-gl","mapbox-gl-draw","rectangle"],"latest_commit_sha":null,"homepage":"https://dqunbp.github.io/mapbox-gl-draw-rectangle-restrict-area/","language":"JavaScript","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/dqunbp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2019-09-24T15:41:36.000Z","updated_at":"2024-11-04T08:13:18.000Z","dependencies_parsed_at":"2024-06-18T21:53:01.969Z","dependency_job_id":null,"html_url":"https://github.com/dqunbp/mapbox-gl-draw-rectangle-restrict-area","commit_stats":{"total_commits":36,"total_committers":3,"mean_commits":12.0,"dds":"0.11111111111111116","last_synced_commit":"e6b5897c23e194102f105e7bc32b012993e436e1"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dqunbp%2Fmapbox-gl-draw-rectangle-restrict-area","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dqunbp%2Fmapbox-gl-draw-rectangle-restrict-area/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dqunbp%2Fmapbox-gl-draw-rectangle-restrict-area/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dqunbp%2Fmapbox-gl-draw-rectangle-restrict-area/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dqunbp","download_url":"https://codeload.github.com/dqunbp/mapbox-gl-draw-rectangle-restrict-area/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230321291,"owners_count":18208340,"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":["draw-rectangle","mapbox-gl","mapbox-gl-draw","rectangle"],"created_at":"2024-12-18T18:31:41.580Z","updated_at":"2024-12-18T18:31:42.071Z","avatar_url":"https://github.com/dqunbp.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mapbox-gl-draw-rectangle-restrict-area\n\n[mapbox-gl](https://github.com/mapbox/mapbox-gl-draw) Draw rectangle mode, with optional area limitation\n\n## [DEMO](https://dqunbp.github.io/mapbox-gl-draw-rectangle-restrict-area/)\n\n[![NPM](https://img.shields.io/npm/v/mapbox-gl-draw-rectangle-restrict-area.svg)](https://www.npmjs.com/package/mapbox-gl-draw-rectangle-restrict-area)\n\n## Features\n\n- One/two click drawing\n- Mobile compabillity\n- Area square restriction **Optional**\n\n## Install\n\n```bash\nnpm install --save @mapbox/mapbox-gl-draw mapbox-gl-draw-rectangle-restrict-area\n```\n\n## Usage\n\n```js\nimport MapboxDraw from \"@mapbox/mapbox-gl-draw\";\nimport DrawRectangle, {\n  DrawStyles,\n} from \"mapbox-gl-draw-rectangle-restrict-area\";\n\nconst map = new mapboxgl.Map({\n  container: \"map\", // container id\n  style: \"mapbox://styles/mapbox/streets-v11\",\n  center: [-91.874, 42.76], // starting position\n  zoom: 12, // starting zoom\n});\n\nconst draw = new MapboxDraw({\n  userProperties: true,\n  displayControlsDefault: false,\n  styles: DrawStyles,\n  modes: Object.assign(MapboxDraw.modes, {\n    draw_rectangle: DrawRectangle,\n  }),\n});\nmap.addControl(draw);\n\n// when mode drawing should be activated\ndraw.changeMode(\"draw_rectangle\", {\n  areaLimit: 5 * 1_000_000, // 5 km2, optional\n  escapeKeyStopsDrawing: true, // default true\n  allowCreateExceeded: false, // default false\n  exceedCallsOnEachMove: false, // default false\n  exceedCallback: (area) =\u003e console.log(\"exceeded!\", area), // optional\n  areaChangedCallback: (area) =\u003e console.log(\"updated\", area), // optional\n});\n```\n\n## Styles\n\n### Exceeded features\n\nExeeded size feature has `user_size_exceed: true` property\n\n### Default styles\n\n`mapbox-gl-draw-rectangle-restrict-area` use [default mapbox-gl-draw styles](https://github.com/mapbox/mapbox-gl-draw/blob/master/src/lib/theme.js) with 2 overrided layers:\n\n```js\n[\n  {\n    id: \"gl-draw-polygon-fill-active\",\n    type: \"fill\",\n    filter: [\"all\", [\"==\", \"active\", \"true\"], [\"==\", \"$type\", \"Polygon\"]],\n    paint: {\n      \"fill-color\": [\n        \"case\",\n        [\"!\", [\"to-boolean\", [\"get\", \"user_size_exceed\"]]], // turns to red if feature has `user_size_exceed: true` prop\n        \"#fbb03b\",\n        \"#ff0000\",\n      ],\n      \"fill-opacity\": 0.2,\n    },\n  },\n  {\n    id: \"gl-draw-polygon-stroke-active\",\n    type: \"line\",\n    filter: [\"all\", [\"==\", \"active\", \"true\"], [\"==\", \"$type\", \"Polygon\"]],\n    layout: {\n      \"line-cap\": \"round\",\n      \"line-join\": \"round\",\n    },\n    paint: {\n      \"line-color\": [\n        \"case\",\n        [\"!\", [\"to-boolean\", [\"get\", \"user_size_exceed\"]]],\n        \"#fbb03b\",\n        \"#ff0000\",\n      ],\n      \"line-dasharray\": [0.2, 2],\n      \"line-width\": 2,\n    },\n  },\n];\n```\n\nYou also can export it\n\n```js\nimport { ActivePolygonStyles } from \"mapbox-gl-draw-rectangle-restrict-area\";\n```\n\n### Override styles\n\nYou can override default drawing styles with `overrideDefaultStyles` helper function\n\n```js\nimport { overrideDefaultStyles } from \"mapbox-gl-draw-rectangle-restrict-area\";\n\nconst drawStyles = overrideDefaultStyles(\u003cyour_custom_styles\u003e);\n```\n\nDefault styles with same ids will be replaced.\n\n## [Example](https://github.com/dqunbp/mapbox-gl-draw-rectangle-restrict-area/blob/master/example/index.js)\n\n## License\n\nMIT © [dqunbp](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdqunbp%2Fmapbox-gl-draw-rectangle-restrict-area","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdqunbp%2Fmapbox-gl-draw-rectangle-restrict-area","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdqunbp%2Fmapbox-gl-draw-rectangle-restrict-area/lists"}