blob: 68cbcc67be3d2420583392058f003c0d1acab79f [file] [log] [blame]
"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[4244],{95788:(e,a,t)=>{t.d(a,{Iu:()=>s,yg:()=>c});var n=t(11504);function r(e,a,t){return a in e?Object.defineProperty(e,a,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[a]=t,e}function l(e,a){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);a&&(n=n.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),t.push.apply(t,n)}return t}function i(e){for(var a=1;a<arguments.length;a++){var t=null!=arguments[a]?arguments[a]:{};a%2?l(Object(t),!0).forEach((function(a){r(e,a,t[a])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):l(Object(t)).forEach((function(a){Object.defineProperty(e,a,Object.getOwnPropertyDescriptor(t,a))}))}return e}function u(e,a){if(null==e)return{};var t,n,r=function(e,a){if(null==e)return{};var t,n,r={},l=Object.keys(e);for(n=0;n<l.length;n++)t=l[n],a.indexOf(t)>=0||(r[t]=e[t]);return r}(e,a);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n<l.length;n++)t=l[n],a.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var o=n.createContext({}),p=function(e){var a=n.useContext(o),t=a;return e&&(t="function"==typeof e?e(a):i(i({},a),e)),t},s=function(e){var a=p(e.components);return n.createElement(o.Provider,{value:a},e.children)},y="mdxType",m={inlineCode:"code",wrapper:function(e){var a=e.children;return n.createElement(n.Fragment,{},a)}},g=n.forwardRef((function(e,a){var t=e.components,r=e.mdxType,l=e.originalType,o=e.parentName,s=u(e,["components","mdxType","originalType","parentName"]),y=p(t),g=r,c=y["".concat(o,".").concat(g)]||y[g]||m[g]||l;return t?n.createElement(c,i(i({ref:a},s),{},{components:t})):n.createElement(c,i({ref:a},s))}));function c(e,a){var t=arguments,r=a&&a.mdxType;if("string"==typeof e||r){var l=t.length,i=new Array(l);i[0]=g;var u={};for(var o in a)hasOwnProperty.call(a,o)&&(u[o]=a[o]);u.originalType=e,u[y]="string"==typeof e?e:r,i[1]=u;for(var p=2;p<l;p++)i[p]=t[p];return n.createElement.apply(null,i)}return n.createElement.apply(null,t)}g.displayName="MDXCreateElement"},74852:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>o,contentTitle:()=>i,default:()=>m,frontMatter:()=>l,metadata:()=>u,toc:()=>p});var n=t(45072),r=(t(11504),t(95788));const l={title:"Country Map Tools",hide_title:!0,sidebar_position:1,version:1},i=void 0,u={unversionedId:"miscellaneous/country-map-tools",id:"miscellaneous/country-map-tools",title:"Country Map Tools",description:"The Country Map Visualization",source:"@site/docs/miscellaneous/country-map-tools.mdx",sourceDirName:"miscellaneous",slug:"/miscellaneous/country-map-tools",permalink:"/docs/miscellaneous/country-map-tools",draft:!1,editUrl:"https://github.com/apache/superset/edit/master/docs/docs/miscellaneous/country-map-tools.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{title:"Country Map Tools",hide_title:!0,sidebar_position:1,version:1},sidebar:"tutorialSidebar",previous:{title:"Querying across databases",permalink:"/docs/databases/meta-database"},next:{title:"Timezones",permalink:"/docs/miscellaneous/timezones"}},o={},p=[{value:"The Country Map Visualization",id:"the-country-map-visualization",level:2},{value:"Included Maps",id:"included-maps",level:2},{value:"Adding a New Country",id:"adding-a-new-country",level:2}],s={toc:p},y="wrapper";function m(e){let{components:a,...t}=e;return(0,r.yg)(y,(0,n.c)({},s,t,{components:a,mdxType:"MDXLayout"}),(0,r.yg)("h2",{id:"the-country-map-visualization"},"The Country Map Visualization"),(0,r.yg)("p",null,"The Country Map visualization allows you to plot lightweight choropleth maps of\nyour countries by province, states, or other subdivision types. It does not rely\non any third-party map services but would require you to provide the\n",(0,r.yg)("a",{parentName:"p",href:"https://en.wikipedia.org/wiki/ISO_3166-2"},"ISO-3166-2")," codes of your country's\ntop-level subdivisions. Comparing to a province or state's full names, the ISO\ncode is less ambiguous and is unique to all regions in the world."),(0,r.yg)("h2",{id:"included-maps"},"Included Maps"),(0,r.yg)("p",null,"The current list of countries can be found in the src\n",(0,r.yg)("a",{parentName:"p",href:"https://github.com/apache/superset/blob/master/superset-frontend/plugins/legacy-plugin-chart-country-map/src/countries.ts"},"legacy-plugin-chart-country-map/src/countries.ts")),(0,r.yg)("p",null,"The Country Maps visualization already ships with the maps for the following countries:"),(0,r.yg)("ul",null,(0,r.yg)("li",{parentName:"ul"},"Afghanistan"),(0,r.yg)("li",{parentName:"ul"},"Albania"),(0,r.yg)("li",{parentName:"ul"},"Algeria"),(0,r.yg)("li",{parentName:"ul"},"Argentina"),(0,r.yg)("li",{parentName:"ul"},"Australia"),(0,r.yg)("li",{parentName:"ul"},"Austria"),(0,r.yg)("li",{parentName:"ul"},"Belgium"),(0,r.yg)("li",{parentName:"ul"},"Bolivia"),(0,r.yg)("li",{parentName:"ul"},"Brazil"),(0,r.yg)("li",{parentName:"ul"},"Bulgaria"),(0,r.yg)("li",{parentName:"ul"},"Burundi"),(0,r.yg)("li",{parentName:"ul"},"Canada"),(0,r.yg)("li",{parentName:"ul"},"Chile"),(0,r.yg)("li",{parentName:"ul"},"China"),(0,r.yg)("li",{parentName:"ul"},"Colombia"),(0,r.yg)("li",{parentName:"ul"},"Costa Rica"),(0,r.yg)("li",{parentName:"ul"},"Cuba"),(0,r.yg)("li",{parentName:"ul"},"Cyprus"),(0,r.yg)("li",{parentName:"ul"},"Denmark"),(0,r.yg)("li",{parentName:"ul"},"Dominican Republic"),(0,r.yg)("li",{parentName:"ul"},"Ecuador"),(0,r.yg)("li",{parentName:"ul"},"Egypt"),(0,r.yg)("li",{parentName:"ul"},"El_salvador"),(0,r.yg)("li",{parentName:"ul"},"Estonia"),(0,r.yg)("li",{parentName:"ul"},"Ethiopia"),(0,r.yg)("li",{parentName:"ul"},"France"),(0,r.yg)("li",{parentName:"ul"},"France Regions"),(0,r.yg)("li",{parentName:"ul"},"Finland"),(0,r.yg)("li",{parentName:"ul"},"Germany"),(0,r.yg)("li",{parentName:"ul"},"Guatemala"),(0,r.yg)("li",{parentName:"ul"},"Haiti"),(0,r.yg)("li",{parentName:"ul"},"Honduras"),(0,r.yg)("li",{parentName:"ul"},"Iceland"),(0,r.yg)("li",{parentName:"ul"},"India"),(0,r.yg)("li",{parentName:"ul"},"Indonesia"),(0,r.yg)("li",{parentName:"ul"},"Iran"),(0,r.yg)("li",{parentName:"ul"},"Italy"),(0,r.yg)("li",{parentName:"ul"},"Italy Regions"),(0,r.yg)("li",{parentName:"ul"},"Japan"),(0,r.yg)("li",{parentName:"ul"},"Jordan"),(0,r.yg)("li",{parentName:"ul"},"Kazakhstan"),(0,r.yg)("li",{parentName:"ul"},"Kenya"),(0,r.yg)("li",{parentName:"ul"},"Korea"),(0,r.yg)("li",{parentName:"ul"},"Kuwait"),(0,r.yg)("li",{parentName:"ul"},"Kyrgyzstan"),(0,r.yg)("li",{parentName:"ul"},"Latvia"),(0,r.yg)("li",{parentName:"ul"},"Liechtenstein"),(0,r.yg)("li",{parentName:"ul"},"Lithuania"),(0,r.yg)("li",{parentName:"ul"},"Malaysia"),(0,r.yg)("li",{parentName:"ul"},"Mexico"),(0,r.yg)("li",{parentName:"ul"},"Morocco"),(0,r.yg)("li",{parentName:"ul"},"Myanmar"),(0,r.yg)("li",{parentName:"ul"},"Netherlands"),(0,r.yg)("li",{parentName:"ul"},"Nicaragua"),(0,r.yg)("li",{parentName:"ul"},"Nigeria"),(0,r.yg)("li",{parentName:"ul"},"Norway"),(0,r.yg)("li",{parentName:"ul"},"Oman"),(0,r.yg)("li",{parentName:"ul"},"Pakistan"),(0,r.yg)("li",{parentName:"ul"},"Panama"),(0,r.yg)("li",{parentName:"ul"},"Papua New Guinea"),(0,r.yg)("li",{parentName:"ul"},"Paraguay"),(0,r.yg)("li",{parentName:"ul"},"Peru"),(0,r.yg)("li",{parentName:"ul"},"Philippines"),(0,r.yg)("li",{parentName:"ul"},"Portugal"),(0,r.yg)("li",{parentName:"ul"},"Poland"),(0,r.yg)("li",{parentName:"ul"},"Puerto_rico"),(0,r.yg)("li",{parentName:"ul"},"Qatar"),(0,r.yg)("li",{parentName:"ul"},"Russia"),(0,r.yg)("li",{parentName:"ul"},"Rwanda"),(0,r.yg)("li",{parentName:"ul"},"Saint Barthelemy"),(0,r.yg)("li",{parentName:"ul"},"Saint Martin"),(0,r.yg)("li",{parentName:"ul"},"Saudi Arabia"),(0,r.yg)("li",{parentName:"ul"},"Singapore"),(0,r.yg)("li",{parentName:"ul"},"Slovenia"),(0,r.yg)("li",{parentName:"ul"},"Spain"),(0,r.yg)("li",{parentName:"ul"},"Sri Lanka"),(0,r.yg)("li",{parentName:"ul"},"Sweden"),(0,r.yg)("li",{parentName:"ul"},"Switzerland"),(0,r.yg)("li",{parentName:"ul"},"Syria"),(0,r.yg)("li",{parentName:"ul"},"Tajikistan"),(0,r.yg)("li",{parentName:"ul"},"Tanzania"),(0,r.yg)("li",{parentName:"ul"},"Thailand"),(0,r.yg)("li",{parentName:"ul"},"Timorleste"),(0,r.yg)("li",{parentName:"ul"},"Turkey"),(0,r.yg)("li",{parentName:"ul"},"Turkey Regions"),(0,r.yg)("li",{parentName:"ul"},"Turkmenistan"),(0,r.yg)("li",{parentName:"ul"},"Uganda"),(0,r.yg)("li",{parentName:"ul"},"Uk"),(0,r.yg)("li",{parentName:"ul"},"Ukraine"),(0,r.yg)("li",{parentName:"ul"},"United Arab Emirates"),(0,r.yg)("li",{parentName:"ul"},"Uruguay"),(0,r.yg)("li",{parentName:"ul"},"USA"),(0,r.yg)("li",{parentName:"ul"},"Uzbekistan"),(0,r.yg)("li",{parentName:"ul"},"Venezuela"),(0,r.yg)("li",{parentName:"ul"},"Vietnam"),(0,r.yg)("li",{parentName:"ul"},"Zambia")),(0,r.yg)("h2",{id:"adding-a-new-country"},"Adding a New Country"),(0,r.yg)("p",null,"To add a new country to the list, you'd have to edit files in\n",(0,r.yg)("a",{parentName:"p",href:"https://github.com/apache/superset/tree/master/superset-frontend/plugins/legacy-plugin-chart-country-map"},"@superset-ui/legacy-plugin-chart-country-map"),"."),(0,r.yg)("ol",null,(0,r.yg)("li",{parentName:"ol"},"Generate a new GeoJSON file for your country following the guide in ",(0,r.yg)("a",{parentName:"li",href:"https://github.com/apache/superset/blob/master/superset-frontend/plugins/legacy-plugin-chart-country-map/scripts/Country%20Map%20GeoJSON%20Generator.ipynb"},"this Jupyter notebook"),"."),(0,r.yg)("li",{parentName:"ol"},"Edit the countries list in ",(0,r.yg)("a",{parentName:"li",href:"https://github.com/apache/superset/blob/master/superset-frontend/plugins/legacy-plugin-chart-country-map/src/countries.ts"},"legacy-plugin-chart-country-map/src/countries.ts"),"."),(0,r.yg)("li",{parentName:"ol"},"Install superset-frontend dependencies: ",(0,r.yg)("inlineCode",{parentName:"li"},"cd superset-frontend && npm install")),(0,r.yg)("li",{parentName:"ol"},"Verify your countries in Superset plugins storybook: ",(0,r.yg)("inlineCode",{parentName:"li"},"npm run plugins:storybook"),"."),(0,r.yg)("li",{parentName:"ol"},"Build and install Superset from source code.")))}m.isMDXComponent=!0}}]);