{"id":16960543,"url":"https://github.com/randomfractals/unfolded-map-renderer","last_synced_at":"2025-03-21T15:33:07.819Z","repository":{"id":157150054,"uuid":"427618296","full_name":"RandomFractals/unfolded-map-renderer","owner":"RandomFractals","description":"Unfolded Map πŸ—ΊοΈ Notebook πŸ““ Renderer for VSCode.","archived":false,"fork":false,"pushed_at":"2021-11-13T14:15:56.000Z","size":4285,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-26T10:46:40.099Z","etag":null,"topics":["cell","data","flat-data","geo","geo-location","geo-spatial","map","notebook","output","renderer","unfolded","view","vscode"],"latest_commit_sha":null,"homepage":"https://github.com/RandomFractals/unfolded-map-renderer","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RandomFractals.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2021-11-13T09:13:39.000Z","updated_at":"2023-04-16T09:47:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"b3337d2d-9c1e-477e-9ee9-970d8cd45a6b","html_url":"https://github.com/RandomFractals/unfolded-map-renderer","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RandomFractals%2Funfolded-map-renderer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RandomFractals%2Funfolded-map-renderer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RandomFractals%2Funfolded-map-renderer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RandomFractals%2Funfolded-map-renderer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RandomFractals","download_url":"https://codeload.github.com/RandomFractals/unfolded-map-renderer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244822716,"owners_count":20516154,"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":["cell","data","flat-data","geo","geo-location","geo-spatial","map","notebook","output","renderer","unfolded","view","vscode"],"created_at":"2024-10-13T22:49:12.497Z","updated_at":"2025-03-21T15:33:07.792Z","avatar_url":"https://github.com/RandomFractals.png","language":"TypeScript","funding_links":["https://ko-fi.com/dataPixy'"],"categories":[],"sub_categories":[],"readme":"# unfolded-map-renderer\n\n[![Apache-2.0 License](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](http://opensource.org/licenses/Apache-2.0)\n\u003ca href='https://ko-fi.com/dataPixy' target='_blank' title='support: https://ko-fi.com/dataPixy'\u003e\n \u003cimg height='24' style='border:0px;height:20px;' src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=2' alt='https://ko-fi.com/dataPixy' /\u003e\n\u003c/a\u003e\n\n\u003ch1 align=\"center\"\u003e\n \u003cimg width=\"64\" height=\"64\" src=\"docs/images/notebook.png\" /\u003e\n \u003cimg width=\"64\" height=\"64\" src=\"docs/images/plus.png\" /\u003e\n \u003cimg width=\"64\" height=\"64\" src=\"resources/icons/map.png\" /\u003e\n \u003cimg width=\"64\" height=\"64\" src=\"docs/images/equals.png\" /\u003e\n \u003cimg width=\"64\" height=\"64\" src=\"docs/images/heart.png\" /\u003e \n \u003cbr /\u003e\n \u003cbr /\u003e\n Unfolded Map πŸ—ΊοΈ Notebook πŸ““ Renderer for VSCode\n\u003c/h1\u003e\n\nSee [Geo Data Viewer](https://github.com/RandomFractals/geo-data-viewer) πŸ—ΊοΈ vscode extension for advanced [Geo Data Analytics](https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.geo-data-viewer) with [kepler.gl](https://kepler.gl/)\n\n## Unfolded Map πŸ—ΊοΈ Renderer\n\nUnfolded Map πŸ—ΊοΈ Notebook πŸ““ Renderer uses [Unfolded Map SDK](https://docs.unfolded.ai/map-sdk/javascript-map-sdk) JavaScript library for interactive preview of Geo datasets loaded in [VSCode Notebooks](https://code.visualstudio.com/api/extension-guides/notebook) πŸ“š\n\n![Unfolded Map πŸ—ΊοΈ Notebook πŸ““ Renderer](https://github.com/RandomFractals/unfolded-map-renderer/blob/main/docs/images/unfolded-map-notebook-renderer.png?raw=true \n \"Unfolded Map πŸ—ΊοΈ Notebook πŸ““ Renderer\")\n\n# Features\n\n- View Location data from `CSV`, `XML`, `JSON`, and [`GeoJSON`](https://www.rfc-editor.org/rfc/rfc7946.html) Notebook πŸ““ cell βŒ— data output on the [Unfolded Studio](https://kepler.gl) map πŸ—ΊοΈ\n- View `JSON`, `CSV`, and `XML` data without Geo Location information in `JSON` format in a scrollable text container with [`code pre-wrap`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/code) for a quick copy/paste to other places:\n\n![Unfolded Map πŸ—ΊοΈ Renderer Text Output](https://github.com/RandomFractals/unfolded-map-renderer/blob/main/docs/images/unfolded-map-text-output.png?raw=true \n \"Unfolded Map πŸ—ΊοΈ Renderer Text Output\")\n\n# Supported Data Formats\n\nUnfolded Map πŸ—ΊοΈ Notebook πŸ““ Renderer supports loading Location data from the following output formats:\n\n| Data Mime Type | Location Data | Geo Location Processing Description |\n| --- | --- | --- |\n| `application/geo+json` | [Point](https://www.rfc-editor.org/rfc/rfc7946.html#section-3.1.2) | `GeoJSON` Location `Point` coordinates are displayed using [Unfolded Map πŸ—ΊοΈ SDK](https://docs.unfolded.ai/map-sdk/javascript-map-sdk) JavaScript library. See our [unfoldedMap.js](https://github.com/RandomFractals/unfolded-map-renderer/blob/main/src/renderer/unfoldedMap.js) for more info about that setup. |\n| `application/json` | Objects that contain geo location property pairs ending with: `latitude`/`longitude`, `lat/lng`, or `lat/lng`| Flat `JSON` data objects and arrays are processed by our custom [`GeoConverter`](https://github.com/RandomFractals/unfolded-map-renderer/blob/main/src/renderer/geoConverter.ts) to extract Location information and covert loaded dataset to `GeoJSON` for display on the map. |\n| `text/csv` | `CSV` data with column names in the 1st header row and columns ending with: `latitude`/`longitude`, `lat/lng`, or `lat/lng` | `CSV` data is parsed with [d3-dsv](https://github.com/d3/d3-dsv) JavaScript library and converted to flat `JSON` data array and then to `GeoJSON` with our [`GeoConverter`](https://github.com/RandomFractals/unfolded-map-renderer/blob/main/src/renderer/geoConverter.ts) to display locations on the map. |\n| `application/xml` or `text/xml` | `XML` data with root node children that contain attributes ending with: `latitude`/`longitude`, `lat/lng`, or `lat/lng` | `XML` data is parsed with [fast-xml-parser](https://github.com/NaturalIntelligence/fast-xml-parser) to load it into `JSON` data objects array and then processed with our [`GeoConverter`](https://github.com/RandomFractals/unfolded-map-renderer/blob/main/src/renderer/geoConverter.ts) to display locations on the map. `XML` data support is very alpha and experimental at this point, and might be removed later. |\n| `application/vnd.code.notebook.stdout` or `text/plain` | Location data as `string` in `CSV`, `XML`, `JSON` or `GeoJSON` data format as described above | Text data typically comes from display and [`console.log()`](https://developer.mozilla.org/en-US/docs/Web/API/console/log) instructions in vscode notebooks. We try to parse text as `JSON` with [`JSON.parse()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse), as `CSV` with [d3-dsv.csvParse()](https://github.com/d3/d3-dsv#csvParse), and as `XML` with [fast-xml-parser](https://github.com/NaturalIntelligence/fast-xml-parser). If those parse methods fail, or provided notebook cell text output contains no location data we can extract, we display text output in a custom scrollable text container with [`code pre-wrap`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/code) for a quick copy/paste to other places. Otherwise, loaded data is converted to `GeoJSON` with our [`GeoConverter`](https://github.com/RandomFractals/unfolded-map-renderer/blob/main/src/renderer/geoConverter.ts) for locations display on the map. |\n\n# πŸ—ΊοΈ Examples\n\nInstall and use [Data Table 🈸 for Notebooks πŸ“š](https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.vscode-data-table) built-in [Notebook πŸ““ Examples](https://github.com/RandomFractals/vscode-data-table#-examples) to view Unfolded Map πŸ—ΊοΈ with provided sample [Geo datasets](https://github.com/RandomFractals/vscode-data-table/tree/main/data). You can access built-in Data Table 🈸 Notebook πŸ““ Examples via `Data Table: Notebook Examples` command from `View -\u003e Command Palette...`\n\n![Data Table 🈸 Notebook Examples](https://github.com/RandomFractals/keplergl-notebook-renderer/blob/main/docs/images/data-table-notebook-examples.png?raw=true \n \"Data Table 🈸 Notebook Examples\")\n\n### REST Book Example\n\n1. Install [REST Book](https://marketplace.visualstudio.com/items?itemName=tanhakabir.rest-book) πŸ““ vscode extension\n\n2. Load [World Cities](https://github.com/RandomFractals/unfolded-map-renderer/blob/main/notebooks/world-cities.restbook) REST Book πŸ““\n\n3. Run All cells βŒ—\n\n4. Click on `...` in the gutter of `GET` data output and change it to KeplerGL Map πŸ—ΊοΈ renderer:\n\n![World Cities REST Book πŸ““](https://github.com/RandomFractals/unfolded-map-renderer/blob/main/docs/images/unfolded-map-notebook-renderer.png?raw=true \n \"World Cities REST Book πŸ““\")\n\n# Recommended Extensions\n\nRecommended extensions for working with Interactive Notebooks πŸ“š data 🈸 charts πŸ“ˆ and geo πŸ—ΊοΈ data formats in [VSCode](https://code.visualstudio.com/):\n\n| Extension | Description |\n| --- | --- |\n| [REST Book](https://marketplace.visualstudio.com/items?itemName=tanhakabir.rest-book) | Notebook extension for running REST queries |\n| [TypeScript Notebooks](https://marketplace.visualstudio.com/items?itemName=donjayamanne.typescript-notebook) | TypeScript with [Jupyter](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter) Notebooks πŸ“š |\n| [.NET Interactive Notebooks](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.dotnet-interactive-vscode) | .NET Interactive [Jupyter](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter) Notebooks πŸ“š |\n| [Pyolite](https://marketplace.visualstudio.com/items?itemName=joyceerhl.vscode-pyolite) 🐍 | [Pyodide](https://pyodide.org) 🐍 kernel for [JupyterLite](https://github.com/jtpio/jupyterlite) Notebooks πŸ“š |\n| [Observable JS](https://marketplace.visualstudio.com/items?itemName=GordonSmith.observable-js) | Observable JS compiler with [Observable](https://observablehq.com/@observablehq/observable-for-jupyter-users?collection=@observablehq/observable-for-jupyter-users) `js` and `md` code outline and previews. |\n| [JS Notebook πŸ““ Inspector πŸ•΅οΈ](https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.js-notebook-inspector) | Provides Interactive Preview of [Observable JS Notebooks](https://observablehq.com/documentation#notebook-fundamentals) πŸ“š, Notebook πŸ““ nodes βŽ‡ \u0026 cells βŒ— source code |\n| [Data Preivew 🈸](https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.vscode-data-preview) | Data Preview 🈸 extension for importing πŸ“€ viewing πŸ”Ž slicing πŸ”ͺ dicing 🎲 charting πŸ“Š \u0026 exporting πŸ“₯ large JSON array/config, YAML, Apache Arrow, Avro \u0026 Excel data files |\n| [Geo Data Viewer πŸ—ΊοΈ](https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.geo-data-viewer) | [kepler.gl](https://kepler.gl) Geo Data Analytics tool to gen. some snazzy πŸ—ΊοΈs w/0 `Py` 🐍 `pyWidgets` βš™οΈ `pandas` 🐼 or `react` βš›οΈ |\n| [Vega Viewer πŸ“ˆ](https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.vscode-vega-viewer) | Provides Interactive Preview of Vega \u0026 Vega-Lite maps πŸ—ΊοΈ \u0026 graphs πŸ“ˆ |\n| [DeltaXML XPath Notebook πŸ““](https://marketplace.visualstudio.com/items?itemName=deltaxml.xpath-notebook) | XPath 3.1 Notebook for Visual Studio Code |\n| [GeoJSON Snippets](https://marketplace.visualstudio.com/items?itemName=analytic-signal.snippets-geojson) | Create geospatial objects using GeoJSON snippets |\n| [Data Table 🈸](https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.vscode-data-table)| Data Table 🈸 for Notebook πŸ““ cell βŒ— data outputs |\n\n# Dev Log\n\nSee [#UnfoldedMapRenderer πŸ—ΊοΈ tag on Twitter](https://twitter.com/hashtag/UnfoldedMapRenderer?src=hashtag_click\u0026f=live) for the latest and greatest updates on this vscode extension and what's in store next.\n\n# Dev Build\n\n```bash\n$ git clone https://github.com/RandomFractals/unfolded-map-renderer\n$ cd unfolded-map-renderer\n$ npm install\n$ npm run compile\n$ code .\n```\n`F5` to launch Unfolded Map πŸ—ΊοΈ Renderer extension vscode debug session.\n\n||\n\n```bash\nunfolded-map-renderer\u003evsce package\n```\nto generate `VSIX` Unfolded Map πŸ—ΊοΈ Renderer extension package with [vsce](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#vsce) from our latest for local dev install in vscode.\n\n# Contributions\n\nAny and all test, code or feedback contributions are welcome. \n\nOpen an [issue](https://github.com/RandomFractals/unfolded-map-renderer/issues) or create a pull request to make this Unfolded Map πŸ—ΊοΈ Renderer vscode extension work better for all.\n\n# Backers\n\n\u003ca href='https://ko-fi.com/dataPixy' target='_blank'\u003e\n \u003cimg height='36' style='border:0px;height:36px;' border='0'\n src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=2' \n alt='support me on ko-fi.com' /\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frandomfractals%2Funfolded-map-renderer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frandomfractals%2Funfolded-map-renderer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frandomfractals%2Funfolded-map-renderer/lists"}