Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Maps: Custom GeoJson Support in Region Maps #794

Closed
hdhalter opened this issue Jul 11, 2022 · 9 comments · Fixed by #807
Closed

[Doc] Maps: Custom GeoJson Support in Region Maps #794

hdhalter opened this issue Jul 11, 2022 · 9 comments · Fixed by #807
Assignees
Labels
Closed - Complete Issue: Work is done and associated PRs closed dashboards v2.2.0
Milestone

Comments

@hdhalter
Copy link
Contributor

hdhalter commented Jul 11, 2022

See opensearch-project/geospatial#122

Support custom vector map/ GeoJson:

Today, we provide basic map tiles and standard vector map as part of MaRS service. While OpenSearch Dashboard allows you to configure a base map tiles using WMS map server, it does not let you configure a server to support user defined vector map layers. We do not support an exhaustive list of vector map (for example, we do not have US Counties, US Zip Codes), and this will always be a growing list. Customers who need specific vector map (GeoJSONs format) that we do not provide today out of the box, can import their own layer and use it for visualization.

@hdhalter hdhalter added enhancement New feature or request untriaged v2.2.0 and removed enhancement New feature or request labels Jul 11, 2022
@hdhalter hdhalter added this to the v2.2 milestone Jul 11, 2022
@hdhalter
Copy link
Contributor Author

Here's a pull request that pertains to this issue: opensearch-project/OpenSearch-Dashboards#1718

@hdhalter
Copy link
Contributor Author

hdhalter commented Jul 13, 2022

Hi @alicejw-aws , are you able to take this one? Thanks. The developer is vamshin.

alicejw1 added a commit to alicejw1/documentation-website that referenced this issue Jul 15, 2022
@alicejw1 alicejw1 linked a pull request Jul 15, 2022 that will close this issue
@alicejw1
Copy link
Contributor

Ready for tech review from engineers.

Hi @vamshin and @Shivamdhar, could you please take a look at this Draft PR for the documentation and let us know if you have any feedback. thanks
#807

@alicejw1
Copy link
Contributor

alicejw1 commented Jul 15, 2022

Here are some screen shots of a local doc build - for review purposes.

geoJson 1
geoJson 2
geoJson 3

@alicejw1 alicejw1 added the 3 - Tech review PR: Tech review in progress label Jul 15, 2022
@Shivamdhar
Copy link

Can we please add the following screenshot instead (for "Import Vector Map" tab):

Screen Shot 2022-07-15 at 2 34 21 PM

Also, do we have to specify that plugins (frontend plugin: https://github.com/opensearch-project/dashboards-maps, backend plugin: https://github.com/opensearch-project/geospatial) need to be installed alongside OpenSearch Dashboards and OpenSearch in order to have the Import Vector Map tab added to the current region map visualization tab? (so this basically depends on what users will be using - min version of OpenSearch and dashboards or the complete bundle). Please let me know if you need more details.

@kolchfa-aws
Copy link
Collaborator

@Shivamdhar: I changed the image. I will also add a statement on setup as you described. Could you please go over the PR opensearch-project/OpenSearch#807 and leave your comments in case anything is incorrect? Also, do you have a link to the testing environment for this? Thanks!

@Naarcha-AWS Naarcha-AWS added 6 - Done but waiting to merge PR: The work is done and ready to merge and removed 3 - Tech review PR: Tech review in progress labels Jul 21, 2022
@hdhalter hdhalter added Closed - Complete Issue: Work is done and associated PRs closed and removed 6 - Done but waiting to merge PR: The work is done and ready to merge labels Aug 1, 2022
kolchfa-aws added a commit that referenced this issue Aug 11, 2022
* for #794 (comment)

Signed-off-by: alicejw <[email protected]>

* add image

Signed-off-by: alicejw <[email protected]>

* remove temporary line in gemfile to build local doc site

Signed-off-by: alicejw <[email protected]>

* for file name remove underscore that prevented jekyll formatting to render properly

Signed-off-by: alicejw <[email protected]>

* adjust size of vector map image

Signed-off-by: alicejw <[email protected]>

* for example .geojson file and more details

Signed-off-by: alicejw <[email protected]>

* new line around heading

Signed-off-by: alicejw <[email protected]>

* Changed the image file

Signed-off-by: Fanit Kolchina <[email protected]>

* Added setup statement

Signed-off-by: Fanit Kolchina <[email protected]>

* Updated steps

Signed-off-by: Fanit Kolchina <[email protected]>

* Changed name of sample map

Signed-off-by: Fanit Kolchina <[email protected]>

* Made geojson one word

Signed-off-by: Fanit Kolchina <[email protected]>

* Note formatting

Signed-off-by: Fanit Kolchina <[email protected]>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

Signed-off-by: alicejw <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
@alicejw1 alicejw1 added Closed - Complete Issue: Work is done and associated PRs closed and removed 6 - Done but waiting to merge PR: The work is done and ready to merge labels Aug 25, 2022
@alicejw1
Copy link
Contributor

alicejw1 commented Sep 20, 2022

hi @Shivamdhar , i get some errors when i import the 5 counties json file into the OpenSearch Dashboards:
Image

I saved it with .json extension in Atom JSON editor and uploaded it.
I'd like to take an image of a custom region map that shows the counties for the blog.

do you happen to have an image I could use that shows what the region map looks like for the 5 counties? thanks!

@Shivamdhar
Copy link

Hello @alicejw-aws , please make sure that the start and end points for each polygon in the GeoJSON file are same.

{
  "type": "FeatureCollection",
  "name": "usa counties",
  "features": [
    { "type": "Feature", "properties": { "iso2": "US", "iso3": "KC-WA", "name": "King County", "country": "US", "county": "KC" }, "geometry": { "type": "Polygon", "coordinates":[[[-122.43713378906249,48.57842428752037],[-122.3712158203125,48.26491251331118],[-122.36022949218749,48.14043243818811],[-122.244873046875,48.026672195436014],[-122.2723388671875,47.916342040161155],[-122.4151611328125,47.82053186746053],[-122.4591064453125,47.69867153529717],[-122.398681640625,47.56911375866714],[-122.3272705078125,47.48380086737799],[-122.3382568359375,47.368594345213374],[-122.45361328124999,47.29040793812928],[-122.607421875,47.26804770458176],[-122.574462890625,47.09630525444073],[-122.50305175781249,46.924007100770275],[-122.354736328125,46.86394700508323],[-122.1185302734375,46.856434763486966],[-121.65710449218749,46.89023157359399],[-121.4483642578125,46.976504510552],[-121.3604736328125,47.05515408550348],[-121.28356933593749,47.212105775622426],[-121.2176513671875,47.35371061951363],[-121.0748291015625,47.468949677672484],[-120.9979248046875,47.56540738772852],[-120.9210205078125,47.724544549099676],[-120.8551025390625,48.026672195436014],[-120.87158203125,48.184401125107684],[-120.948486328125,48.37449671682332],[-121.1077880859375,48.542068763606466],[-121.5087890625,48.56388521347092],[-121.87683105468749,48.545705491847464],[-122.06909179687501,48.55297816440071],[-122.3052978515625,48.5493419587775],[-122.43713378906249,48.57842428752037]]] } },
    { "type": "Feature", "properties": { "iso2": "US", "iso3": "SJ-WA", "name": "San Juan County", "country": "US", "county": "SJ" }, "geometry": { "type": "Polygon", "coordinates":[[[-122.96173095703125,48.73807825631017],[-123.04962158203124,48.71452483966837],[-123.1512451171875,48.66012869453836],[-123.19244384765625,48.61656946813302],[-123.17596435546876,48.56206753526866],[-123.14849853515625,48.5275192374508],[-123.07708740234374,48.480204398955145],[-122.98645019531249,48.45653041501911],[-122.8875732421875,48.44195631996267],[-122.8106689453125,48.438312142641244],[-122.78594970703126,48.44560023585716],[-122.78594970703126,48.505687108189804],[-122.78320312499999,48.545705491847464],[-122.79144287109375,48.59477574898104],[-122.77496337890625,48.62383195130112],[-122.7557373046875,48.65105695744785],[-122.73651123046874,48.69821216562637],[-122.84637451171874,48.72358515157852],[-122.96173095703125,48.73807825631017]]] } },
    { "type": "Feature", "properties": { "iso2": "US", "iso3": "WW-WA", "name": "Walla Walla County", "country": "US", "county": "WW" }, "geometry": { "type": "Polygon", "coordinates":[[[-118.33442687988281,46.09204333606358],[-118.34884643554688,46.088709905656856],[-118.37047576904297,46.07561233580712],[-118.38249206542967,46.0653702518009],[-118.3838653564453,46.05298193687039],[-118.3787155151367,46.04416548185682],[-118.3656692504883,46.03558595870985],[-118.35159301757811,46.030818981314766],[-118.33339691162111,46.02819696848244],[-118.3114242553711,46.02938880791639],[-118.29666137695312,46.03201076421151],[-118.2784652709961,46.038922598236],[-118.2722854614258,46.0536967228988],[-118.2619857788086,46.076564991185734],[-118.25752258300781,46.092757616368665],[-118.2630157470703,46.10513700514936],[-118.29288482666016,46.10085214663405],[-118.31794738769531,46.09680503002718],[-118.33442687988281,46.09204333606358]]] } },
    { "type": "Feature", "properties": { "iso2": "US", "iso3": "LA-CA", "name": "Los Angeles County", "country": "US", "county": "LA" }, "geometry": { "type": "Polygon", "coordinates":[[[-118.71826171875,34.07086232376631],[-118.69628906249999,34.03445260967645],[-118.56994628906249,34.02990029603907],[-118.487548828125,33.957030069982316],[-118.37219238281249,33.86129311351553],[-118.45458984375,33.75631505992707],[-118.33923339843749,33.715201644740844],[-118.22937011718749,33.75631505992707],[-118.1414794921875,33.678639851675555],[-117.9107666015625,33.578014746143985],[-117.75146484375,33.4955977448657],[-117.55920410156249,33.55512901742288],[-117.3065185546875,33.5963189611327],[-117.0703125,33.67406853374198],[-116.69677734375,34.06176136129718],[-116.9439697265625,34.28445325435288],[-117.18017578125,34.42956713470528],[-117.3779296875,34.542762387234845],[-117.62512207031251,34.56990638085636],[-118.048095703125,34.615126683462194],[-118.44909667968749,34.542762387234845],[-118.61938476562499,34.38877925439021],[-118.740234375,34.21180215769026],[-118.71826171875,34.07086232376631]]] } },
    { "type": "Feature", "properties": { "iso2": "US", "iso3": "SD-CA", "name": "San Diego County", "country": "US", "county": "SD" }, "geometry": { "type": "Polygon", "coordinates":[[[-117.23510742187501,32.861132322810946],[-117.2406005859375,32.75494243654723],[-117.1636962890625,32.68099643258195],[-117.14172363281251,32.58384932565662],[-117.09228515624999,32.46342595776104],[-117.0538330078125,32.29177633471201],[-116.96044921875,32.194208672875384],[-116.85607910156249,32.16631295696736],[-116.6748046875,32.20350534542368],[-116.3671875,32.319633552035214],[-116.1474609375,32.55144352864431],[-116.1639404296875,32.80574473290688],[-116.4111328125,33.073130945006625],[-116.72973632812499,33.08233672856376],[-117.09228515624999,32.99484290420988],[-117.2515869140625,32.96258644191747], [-117.23510742187501,32.861132322810946]]] } }
  ]
}

Or you can use the following image -

image

@alicejw1
Copy link
Contributor

thank you @Shivamdhar we really appreciate this!

alicejw1 added a commit to alicejw1/documentation-website that referenced this issue Sep 21, 2022
alicejw1 added a commit that referenced this issue Sep 26, 2022
* for geoJSON file that has same start/endpoints for each polygon. see issue with more info #794 (comment)

Signed-off-by: alicejw <[email protected]>

* for additional images with borders and fixed errors in example GeoJSON file so it is cut and paste ready to use

Signed-off-by: alicejw <[email protected]>

* rename new image file because replacing file with same name caused build conflict

Signed-off-by: alicejw <[email protected]>

* image rename

Signed-off-by: alicejw <[email protected]>

* for doc reviewer edits and more clarification to procedural steps

Signed-off-by: alicejw <[email protected]>

* fix typo in UI name 'Region Map' visualization type

Signed-off-by: alicejw <[email protected]>

* to add prerequisite callout for the two required plugins

Signed-off-by: alicejw <[email protected]>

* remove commented-out note for link. unnecessary

Signed-off-by: alicejw <[email protected]>

* for doc review updates - changed example JSON file to include only 2 counties, and other rewrites

Signed-off-by: alicejw <[email protected]>

* remove modified region map and use original map with 2 counties

Signed-off-by: alicejw <[email protected]>

* we decided to show the grey outlined regions in the image

Signed-off-by: alicejw <[email protected]>

Signed-off-by: alicejw <[email protected]>
opensearch-trigger-bot bot pushed a commit that referenced this issue Sep 26, 2022
* for geoJSON file that has same start/endpoints for each polygon. see issue with more info #794 (comment)

Signed-off-by: alicejw <[email protected]>

* for additional images with borders and fixed errors in example GeoJSON file so it is cut and paste ready to use

Signed-off-by: alicejw <[email protected]>

* rename new image file because replacing file with same name caused build conflict

Signed-off-by: alicejw <[email protected]>

* image rename

Signed-off-by: alicejw <[email protected]>

* for doc reviewer edits and more clarification to procedural steps

Signed-off-by: alicejw <[email protected]>

* fix typo in UI name 'Region Map' visualization type

Signed-off-by: alicejw <[email protected]>

* to add prerequisite callout for the two required plugins

Signed-off-by: alicejw <[email protected]>

* remove commented-out note for link. unnecessary

Signed-off-by: alicejw <[email protected]>

* for doc review updates - changed example JSON file to include only 2 counties, and other rewrites

Signed-off-by: alicejw <[email protected]>

* remove modified region map and use original map with 2 counties

Signed-off-by: alicejw <[email protected]>

* we decided to show the grey outlined regions in the image

Signed-off-by: alicejw <[email protected]>

Signed-off-by: alicejw <[email protected]>
(cherry picked from commit a1d79db)
opensearch-trigger-bot bot pushed a commit that referenced this issue Sep 26, 2022
* for geoJSON file that has same start/endpoints for each polygon. see issue with more info #794 (comment)

Signed-off-by: alicejw <[email protected]>

* for additional images with borders and fixed errors in example GeoJSON file so it is cut and paste ready to use

Signed-off-by: alicejw <[email protected]>

* rename new image file because replacing file with same name caused build conflict

Signed-off-by: alicejw <[email protected]>

* image rename

Signed-off-by: alicejw <[email protected]>

* for doc reviewer edits and more clarification to procedural steps

Signed-off-by: alicejw <[email protected]>

* fix typo in UI name 'Region Map' visualization type

Signed-off-by: alicejw <[email protected]>

* to add prerequisite callout for the two required plugins

Signed-off-by: alicejw <[email protected]>

* remove commented-out note for link. unnecessary

Signed-off-by: alicejw <[email protected]>

* for doc review updates - changed example JSON file to include only 2 counties, and other rewrites

Signed-off-by: alicejw <[email protected]>

* remove modified region map and use original map with 2 counties

Signed-off-by: alicejw <[email protected]>

* we decided to show the grey outlined regions in the image

Signed-off-by: alicejw <[email protected]>

Signed-off-by: alicejw <[email protected]>
(cherry picked from commit a1d79db)
alicejw1 added a commit that referenced this issue Sep 26, 2022
* for geoJSON file that has same start/endpoints for each polygon. see issue with more info #794 (comment)

Signed-off-by: alicejw <[email protected]>

* for additional images with borders and fixed errors in example GeoJSON file so it is cut and paste ready to use

Signed-off-by: alicejw <[email protected]>

* rename new image file because replacing file with same name caused build conflict

Signed-off-by: alicejw <[email protected]>

* image rename

Signed-off-by: alicejw <[email protected]>

* for doc reviewer edits and more clarification to procedural steps

Signed-off-by: alicejw <[email protected]>

* fix typo in UI name 'Region Map' visualization type

Signed-off-by: alicejw <[email protected]>

* to add prerequisite callout for the two required plugins

Signed-off-by: alicejw <[email protected]>

* remove commented-out note for link. unnecessary

Signed-off-by: alicejw <[email protected]>

* for doc review updates - changed example JSON file to include only 2 counties, and other rewrites

Signed-off-by: alicejw <[email protected]>

* remove modified region map and use original map with 2 counties

Signed-off-by: alicejw <[email protected]>

* we decided to show the grey outlined regions in the image

Signed-off-by: alicejw <[email protected]>

Signed-off-by: alicejw <[email protected]>
(cherry picked from commit a1d79db)

Co-authored-by: Alice Williams <[email protected]>
alicejw1 added a commit that referenced this issue Sep 26, 2022
* for geoJSON file that has same start/endpoints for each polygon. see issue with more info #794 (comment)

Signed-off-by: alicejw <[email protected]>

* for additional images with borders and fixed errors in example GeoJSON file so it is cut and paste ready to use

Signed-off-by: alicejw <[email protected]>

* rename new image file because replacing file with same name caused build conflict

Signed-off-by: alicejw <[email protected]>

* image rename

Signed-off-by: alicejw <[email protected]>

* for doc reviewer edits and more clarification to procedural steps

Signed-off-by: alicejw <[email protected]>

* fix typo in UI name 'Region Map' visualization type

Signed-off-by: alicejw <[email protected]>

* to add prerequisite callout for the two required plugins

Signed-off-by: alicejw <[email protected]>

* remove commented-out note for link. unnecessary

Signed-off-by: alicejw <[email protected]>

* for doc review updates - changed example JSON file to include only 2 counties, and other rewrites

Signed-off-by: alicejw <[email protected]>

* remove modified region map and use original map with 2 counties

Signed-off-by: alicejw <[email protected]>

* we decided to show the grey outlined regions in the image

Signed-off-by: alicejw <[email protected]>

Signed-off-by: alicejw <[email protected]>
(cherry picked from commit a1d79db)

Co-authored-by: Alice Williams <[email protected]>
Naarcha-AWS pushed a commit that referenced this issue Oct 6, 2022
* for geoJSON file that has same start/endpoints for each polygon. see issue with more info #794 (comment)

Signed-off-by: alicejw <[email protected]>

* for additional images with borders and fixed errors in example GeoJSON file so it is cut and paste ready to use

Signed-off-by: alicejw <[email protected]>

* rename new image file because replacing file with same name caused build conflict

Signed-off-by: alicejw <[email protected]>

* image rename

Signed-off-by: alicejw <[email protected]>

* for doc reviewer edits and more clarification to procedural steps

Signed-off-by: alicejw <[email protected]>

* fix typo in UI name 'Region Map' visualization type

Signed-off-by: alicejw <[email protected]>

* to add prerequisite callout for the two required plugins

Signed-off-by: alicejw <[email protected]>

* remove commented-out note for link. unnecessary

Signed-off-by: alicejw <[email protected]>

* for doc review updates - changed example JSON file to include only 2 counties, and other rewrites

Signed-off-by: alicejw <[email protected]>

* remove modified region map and use original map with 2 counties

Signed-off-by: alicejw <[email protected]>

* we decided to show the grey outlined regions in the image

Signed-off-by: alicejw <[email protected]>

Signed-off-by: alicejw <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Closed - Complete Issue: Work is done and associated PRs closed dashboards v2.2.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants