feat: add map components documentation #97
Conversation
|
… add-map-component-documentation
…ies/developer-portal into add-map-component-documentation
|
I think we need to add the versions for each map component for which this information is on. |
Co-authored-by: netanelC <[email protected]>
Co-authored-by: netanelC <[email protected]>
Co-authored-by: netanelC <[email protected]>
…ies/developer-portal into add-map-component-documentation
CptSchnitz
changed the title
| @@ -0,0 +1,3 @@ | |||
| { | |||
| "position": 2 | |||
| } | |||
|
|
||
| OpenLayers - [Docs](https://openlayers.org/en/latest/apidoc/), [Examples](https://openlayers.org/en/latest/examples/), [Playground](https://codesandbox.io/examples/package/openlayers) | ||
|
|
||
| EsriJS - [Docs](https://developers.arcgis.com/javascript/latest/), [Examples](https://developers.arcgis.com/javascript/latest/sample-code/), [Playground](https://developers.arcgis.com/javascript/3/samples/playground/) |
There was a problem hiding this comment.
Swap between what is map compontent and whining about so many
There was a problem hiding this comment.
Add short summary of the common map viewers
There was a problem hiding this comment.
Change this map to be Comparison
There was a problem hiding this comment.
Start the page with inline TOC
https://docusaurus.io/docs/markdown-features/toc#inline-table-of-contents
There was a problem hiding this comment.
I tried it out and I think that adding a TOC in the page isn't relevant.
There was a problem hiding this comment.
I made the change with comparison.
| | ----------- | ----------- | ----------- | ----------- | ----------- | ----------- | ----------- | ----------- | | ||
| | Cesium | ✅ | ❌ | ✅ | ❌ | ✅ | | | | ||
| | Leaflet | ✅ | ❌ | ✅ | ➖ Possible with package or TileLayer Hack | ✅ | | | | ||
| | OpenLayers | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | |
There was a problem hiding this comment.
|
|
||
| ### Supported data types and protocols | ||
|
|
||
| | **Viewer** | **WMS** | **Can read WMS capabilities** | **WMTS** | **Can read WMTS capabilities** | **Tile Layer** | **GeoTiff** | **COG** | |
There was a problem hiding this comment.
What do you mean?
…ies/developer-portal into add-map-component-documentation
|
|
||
| A map viewer is a visual component to help us display `geographic` data such as raster, vector, 3D and DEM. It does all of the heavy-lifting in fetching, calculating and displaying the data correctly. | ||
|
|
||
| There are many features that a map viewer could implement, please read more about the different libraries and features [here](/docs/KnowledgeBase/MapViewers/map-components.md). |
There was a problem hiding this comment.
Also, relative links will probably be more robust
|
|
||
| ### OpenLayers 🆓 | ||
|
|
||
| An open-source JavaScript library for displaying map data in web browsers as slippy maps. It provides an API for building rich web-based geographic applications similar to Google Maps and Bing Maps. |
|
|
||
| ### ArcGIS JS SDK 💰 | ||
|
|
||
| ArcGIS is a family of client, server and online geographic information system (GIS) software developed and maintained by Esri. |
|
|
||
| ITowns is a javascript framework for 3D geographic data visualisation. It can display a wide range of data such as ortho-images, Digital Elevation Models (DEM) or 3D models. | ||
|
|
||
| ITowns is based on Three.js, which is a javascript library that implements WebGL to render sophisticated 3D Geometry on a webpage. |
There was a problem hiding this comment.
|
|
||
| ## Projections | ||
|
|
||
| If you don't know what a `projection` is, please read more [here](/docs/KnowledgeBase/terms#mapping), or on [wikipedia 🌐](https://en.wikipedia.org/wiki/Map_projection). |
There was a problem hiding this comment.
Link terms in header and give o short explaination here?
There was a problem hiding this comment.
Also, explain about the MC projections?
There was a problem hiding this comment.
Also, EPSG: 4326 is NOT a projection, but a geographic CRS.
|
|
||
| ### Supported data types and protocols | ||
|
|
||
| | **Viewer** | **WFS** | **GeoJSON** | **Features** | **Drawing** | |
There was a problem hiding this comment.
They are there to fill in the future. They are currently unknown and will slowly be added.
|
|
||
| ### Vector Tiles | ||
|
|
||
| | **Viewer** | **Query** | **Symbology** | **OGC Vector Tiles** | |
There was a problem hiding this comment.
Added some information.
| | OpenLayers | ✅ | ❌ | ✅ | | ||
| | ArcGIS JS SDK | ✅ | ✅ | ❌ | | ||
| | iTowns | ✅ | ❌ | ❌ | | ||
| | Mapbox v1 | ✅ | ✅ But for v1 | ❌ | |
| | **Viewer** | **Query** | **Symbology** | **OGC Vector Tiles** | | ||
| | ----------- | ----------- | ----------- | ----------- | | ||
| | Cesium | ❌ | ❌ | ❌ | | ||
| | Leaflet | ❌ | | ❌ | |
There was a problem hiding this comment.
What's not ture? I'll check again, this could be outdated.
There was a problem hiding this comment.
It looks like there is support for vector tiles with some plugins, added.
There was a problem hiding this comment.
- Consider running through chatGPT for fact-checking
- Consider unifying to "formats" and "features" tables, for simplicity
- Consider making the tables "smart" (i.e. ability to interactively choose columns)
- Consider running through chatGPT for formatting uniformity
|
when is it gonna be merged? @shimoncohen |
|
bump , when will it be merged? @shimoncohen |
… add-map-component-documentation
| @@ -18,6 +18,11 @@ tags: | |||
|
|
|||
| In this page we list some features that you may be interested in and show which map viewers support them. | |||
|
|
|||
| :::caution | |||
| Not all mentioned featuresare supported by MapColonies. | |||
No description provided.