Skip to content

Commit c5dceb2

Browse files
LiamConnorsLiamConnors
committed
add new maps page
1 parent eb10265 commit c5dceb2

File tree

8 files changed

+474
-0
lines changed

8 files changed

+474
-0
lines changed

‎docs/content/plotly_js/maps/outline-map-locations/country-names-example.html‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: "locationmode: 'country names'"
3+
language: plotly_js
4+
suite: outline-map-locations
5+
order: 3
6+
sitemap: false
7+
arrangement: horizontal
8+
markdown_content: |
9+
Set `locationmode: 'country names'` to use full country names in `locations`.
10+
---
11+
var data = [{
12+
type: 'choropleth',
13+
locations: ['United States', 'Canada', 'United Kingdom'],
14+
locationmode: 'country names',
15+
z: [1, 1, 1],
16+
colorscale: [[0, '#636efa'], [1, '#636efa']],
17+
showscale: false
18+
}];
19+
20+
var layout = {
21+
title: 'Choropleth with Country Names'
22+
};
23+
24+
Plotly.newPlot('myDiv', data, layout);

‎docs/content/plotly_js/maps/outline-map-locations/country-names-warning.html‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Country Names Warning
3+
language: plotly_js
4+
suite: outline-map-locations
5+
order: 3.5
6+
sitemap: false
7+
arrangement: horizontal
8+
markdown_content: |
9+
> How Plotly matches 'country names' will change in a future version. Matching will become stricter and some country names may no longer match. We recommend using `locationmode: 'ISO-3'` with ISO codes for `locations` to ensure consistent behavior across versions.
10+
---

‎docs/content/plotly_js/maps/outline-map-locations/intro.html‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Locations for Outline-based Maps
3+
language: plotly_js
4+
suite: outline-map-locations
5+
order: 0
6+
sitemap: false
7+
arrangement: horizontal
8+
markdown_content: |
9+
With outline-based maps, you can visualize data for specific regions using the `locations` and `locationmode` parameters.
10+
11+
The following map types in Plotly.js support these parameters:
12+
- `choropleth` - color regions based on data values
13+
- `scattergeo` - show markers at geographic locations
14+
15+
The `locations` parameter accepts region identifiers and the `locationmode` parameter controls interpretation:
16+
17+
- `'ISO-3'` - three-letter ISO country codes (e.g., `'USA'`, `'CAN'`, `'GBR'`)
18+
- `'USA-states'` - two-letter US state abbreviations (e.g., `'CA'`, `'TX'`, `'NY'`)
19+
- `'country names'` - full country names (e.g., `'United States'`)
20+
---

‎docs/content/plotly_js/maps/outline-map-locations/iso3-example.html‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: "locationmode: 'ISO-3'"
3+
language: plotly_js
4+
suite: outline-map-locations
5+
order: 1
6+
sitemap: false
7+
arrangement: horizontal
8+
markdown_content: |
9+
Set `locationmode: 'ISO-3'` to use three-letter ISO country codes in `locations`.
10+
---
11+
12+
var data = [{
13+
type: 'choropleth',
14+
locations: ['USA', 'CAN', 'MEX', 'BRA', 'RUS'],
15+
locationmode: 'ISO-3',
16+
z: [100, 85, 72, 95, 68],
17+
colorscale: 'Viridis'
18+
}];
19+
20+
var layout = {
21+
title: 'Choropleth with ISO-3 Country Codes',
22+
geo: {
23+
projection: {
24+
type: 'natural earth'
25+
}
26+
}
27+
};
28+
29+
Plotly.newPlot('myDiv', data, layout);

‎docs/content/plotly_js/maps/outline-map-locations/iso3-table.html‎

Lines changed: 279 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,279 @@
1+
---
2+
name: Supported ISO Codes
3+
language: plotly_js
4+
suite: outline-map-locations
5+
order: 1.5
6+
sitemap: false
7+
arrangement: horizontal
8+
markdown_content: |
9+
The following ISO codes are supported when `locationmode='ISO-3'`:
10+
11+
<table style="text-align: left; margin-left: 0; margin-right: auto;">
12+
<thead>
13+
<tr>
14+
<th style="text-align: left;">Name</th>
15+
<th style="text-align: left;">ISO Code</th>
16+
</tr>
17+
</thead>
18+
<tbody>
19+
<tr><td>Afghanistan</td><td>AFG</td></tr>
20+
<tr><td>Aksai Chin</td><td>XAC</td></tr>
21+
<tr><td>Åland Islands</td><td>ALA</td></tr>
22+
<tr><td>Albania</td><td>ALB</td></tr>
23+
<tr><td>Algeria</td><td>DZA</td></tr>
24+
<tr><td>American Samoa</td><td>ASM</td></tr>
25+
<tr><td>Andorra</td><td>AND</td></tr>
26+
<tr><td>Angola</td><td>AGO</td></tr>
27+
<tr><td>Anguilla</td><td>AIA</td></tr>
28+
<tr><td>Antarctica</td><td>ATA</td></tr>
29+
<tr><td>Antigua and Barbuda</td><td>ATG</td></tr>
30+
<tr><td>Argentina</td><td>ARG</td></tr>
31+
<tr><td>Armenia</td><td>ARM</td></tr>
32+
<tr><td>Aruba</td><td>ABW</td></tr>
33+
<tr><td>Arunachal Pradesh</td><td>XAP</td></tr>
34+
<tr><td>Australia</td><td>AUS</td></tr>
35+
<tr><td>Austria</td><td>AUT</td></tr>
36+
<tr><td>Azerbaijan</td><td>AZE</td></tr>
37+
<tr><td>Azores Islands</td><td>PRT</td></tr>
38+
<tr><td>Bahamas</td><td>BHS</td></tr>
39+
<tr><td>Bahrain</td><td>BHR</td></tr>
40+
<tr><td>Bangladesh</td><td>BGD</td></tr>
41+
<tr><td>Barbados</td><td>BRB</td></tr>
42+
<tr><td>Belarus</td><td>BLR</td></tr>
43+
<tr><td>Belgium</td><td>BEL</td></tr>
44+
<tr><td>Belize</td><td>BLZ</td></tr>
45+
<tr><td>Benin</td><td>BEN</td></tr>
46+
<tr><td>Bermuda</td><td>BMU</td></tr>
47+
<tr><td>Bhutan</td><td>BTN</td></tr>
48+
<tr><td>Bir Tawil</td><td>XBT</td></tr>
49+
<tr><td>Bolivia (Plurinational State of)</td><td>BOL</td></tr>
50+
<tr><td>Bonaire</td><td>BES</td></tr>
51+
<tr><td>Bosnia and Herzegovina</td><td>BIH</td></tr>
52+
<tr><td>Botswana</td><td>BWA</td></tr>
53+
<tr><td>Bouvet Island</td><td>BVT</td></tr>
54+
<tr><td>Brazil</td><td>BRA</td></tr>
55+
<tr><td>British Virgin Islands</td><td>VGB</td></tr>
56+
<tr><td>Brunei Darussalam</td><td>BRN</td></tr>
57+
<tr><td>Bulgaria</td><td>BGR</td></tr>
58+
<tr><td>Burkina Faso</td><td>BFA</td></tr>
59+
<tr><td>Burundi</td><td>BDI</td></tr>
60+
<tr><td>Cabo Verde</td><td>CPV</td></tr>
61+
<tr><td>Cambodia</td><td>KHM</td></tr>
62+
<tr><td>Cameroon</td><td>CMR</td></tr>
63+
<tr><td>Canada</td><td>CAN</td></tr>
64+
<tr><td>Canary Islands</td><td>ESP</td></tr>
65+
<tr><td>Cayman Islands</td><td>CYM</td></tr>
66+
<tr><td>Central African Republic</td><td>CAF</td></tr>
67+
<tr><td>Chad</td><td>TCD</td></tr>
68+
<tr><td>Chagos Archipelago</td><td>MUS</td></tr>
69+
<tr><td>Chile</td><td>CHL</td></tr>
70+
<tr><td>China</td><td>CHN</td></tr>
71+
<tr><td>Christmas Island</td><td>CXR</td></tr>
72+
<tr><td>Cocos (Keeling) Islands</td><td>CCK</td></tr>
73+
<tr><td>Colombia</td><td>COL</td></tr>
74+
<tr><td>Comoros</td><td>COM</td></tr>
75+
<tr><td>Congo</td><td>COG</td></tr>
76+
<tr><td>Cook Islands</td><td>COK</td></tr>
77+
<tr><td>Costa Rica</td><td>CRI</td></tr>
78+
<tr><td>Côte d'Ivoire</td><td>CIV</td></tr>
79+
<tr><td>Croatia</td><td>HRV</td></tr>
80+
<tr><td>Cuba</td><td>CUB</td></tr>
81+
<tr><td>Curaçao</td><td>CUW</td></tr>
82+
<tr><td>Cyprus</td><td>CYP</td></tr>
83+
<tr><td>Czechia</td><td>CZE</td></tr>
84+
<tr><td>Democratic People's Republic of Korea</td><td>PRK</td></tr>
85+
<tr><td>Democratic Republic of the Congo</td><td>COD</td></tr>
86+
<tr><td>Denmark</td><td>DNK</td></tr>
87+
<tr><td>Djibouti</td><td>DJI</td></tr>
88+
<tr><td>Dominica</td><td>DMA</td></tr>
89+
<tr><td>Dominican Republic</td><td>DOM</td></tr>
90+
<tr><td>Ecuador</td><td>ECU</td></tr>
91+
<tr><td>Egypt</td><td>EGY</td></tr>
92+
<tr><td>El Salvador</td><td>SLV</td></tr>
93+
<tr><td>Equatorial Guinea</td><td>GNQ</td></tr>
94+
<tr><td>Eritrea</td><td>ERI</td></tr>
95+
<tr><td>Estonia</td><td>EST</td></tr>
96+
<tr><td>Eswatini</td><td>SWZ</td></tr>
97+
<tr><td>Ethiopia</td><td>ETH</td></tr>
98+
<tr><td>Falkland Islands (Malvinas)</td><td>FLK</td></tr>
99+
<tr><td>Faroe Islands</td><td>FRO</td></tr>
100+
<tr><td>Fiji</td><td>FJI</td></tr>
101+
<tr><td>Finland</td><td>FIN</td></tr>
102+
<tr><td>France</td><td>FRA</td></tr>
103+
<tr><td>French Guiana</td><td>GUF</td></tr>
104+
<tr><td>French Polynesia</td><td>PYF</td></tr>
105+
<tr><td>French Southern Territories</td><td>ATF</td></tr>
106+
<tr><td>Gabon</td><td>GAB</td></tr>
107+
<tr><td>Galápagos Islands</td><td>ECU</td></tr>
108+
<tr><td>Gambia</td><td>GMB</td></tr>
109+
<tr><td>Gaza</td><td>PSE</td></tr>
110+
<tr><td>Georgia</td><td>GEO</td></tr>
111+
<tr><td>Germany</td><td>DEU</td></tr>
112+
<tr><td>Ghana</td><td>GHA</td></tr>
113+
<tr><td>Gibraltar</td><td>GIB</td></tr>
114+
<tr><td>Greece</td><td>GRC</td></tr>
115+
<tr><td>Greenland</td><td>GRL</td></tr>
116+
<tr><td>Grenada</td><td>GRD</td></tr>
117+
<tr><td>Guadeloupe</td><td>GLP</td></tr>
118+
<tr><td>Guam</td><td>GUM</td></tr>
119+
<tr><td>Guatemala</td><td>GTM</td></tr>
120+
<tr><td>Guernsey</td><td>GGY</td></tr>
121+
<tr><td>Guinea</td><td>GIN</td></tr>
122+
<tr><td>Guinea-Bissau</td><td>GNB</td></tr>
123+
<tr><td>Guyana</td><td>GUY</td></tr>
124+
<tr><td>Haiti</td><td>HTI</td></tr>
125+
<tr><td>Halaib Triangle</td><td>XHT</td></tr>
126+
<tr><td>Heard Island and McDonald Islands</td><td>HMD</td></tr>
127+
<tr><td>Honduras</td><td>HND</td></tr>
128+
<tr><td>Hong Kong</td><td>HKG</td></tr>
129+
<tr><td>Hungary</td><td>HUN</td></tr>
130+
<tr><td>Iceland</td><td>ISL</td></tr>
131+
<tr><td>Ilemi Triangle</td><td>XIT</td></tr>
132+
<tr><td>India</td><td>IND</td></tr>
133+
<tr><td>Indonesia</td><td>IDN</td></tr>
134+
<tr><td>Iran (Islamic Republic of)</td><td>IRN</td></tr>
135+
<tr><td>Iraq</td><td>IRQ</td></tr>
136+
<tr><td>Ireland</td><td>IRL</td></tr>
137+
<tr><td>Isle of Man</td><td>IMN</td></tr>
138+
<tr><td>Israel</td><td>ISR</td></tr>
139+
<tr><td>Italy</td><td>ITA</td></tr>
140+
<tr><td>Jamaica</td><td>JAM</td></tr>
141+
<tr><td>Jammu and Kashmir</td><td>XJK</td></tr>
142+
<tr><td>Japan</td><td>JPN</td></tr>
143+
<tr><td>Jersey</td><td>JEY</td></tr>
144+
<tr><td>Jordan</td><td>JOR</td></tr>
145+
<tr><td>Kazakhstan</td><td>KAZ</td></tr>
146+
<tr><td>Kenya</td><td>KEN</td></tr>
147+
<tr><td>Kingdom of the Netherlands</td><td>NLD</td></tr>
148+
<tr><td>Kiribati</td><td>KIR</td></tr>
149+
<tr><td>Kuwait</td><td>KWT</td></tr>
150+
<tr><td>Kyrgyzstan</td><td>KGZ</td></tr>
151+
<tr><td>Lao People's Democratic Republic</td><td>LAO</td></tr>
152+
<tr><td>Latvia</td><td>LVA</td></tr>
153+
<tr><td>Lebanon</td><td>LBN</td></tr>
154+
<tr><td>Lesotho</td><td>LSO</td></tr>
155+
<tr><td>Liberia</td><td>LBR</td></tr>
156+
<tr><td>Libya</td><td>LBY</td></tr>
157+
<tr><td>Liechtenstein</td><td>LIE</td></tr>
158+
<tr><td>Lithuania</td><td>LTU</td></tr>
159+
<tr><td>Luxembourg</td><td>LUX</td></tr>
160+
<tr><td>Macao</td><td>MAC</td></tr>
161+
<tr><td>Madagascar</td><td>MDG</td></tr>
162+
<tr><td>Madeira Island</td><td>PRT</td></tr>
163+
<tr><td>Malawi</td><td>MWI</td></tr>
164+
<tr><td>Malaysia</td><td>MYS</td></tr>
165+
<tr><td>Maldives</td><td>MDV</td></tr>
166+
<tr><td>Mali</td><td>MLI</td></tr>
167+
<tr><td>Malta</td><td>MLT</td></tr>
168+
<tr><td>Marshall Islands</td><td>MHL</td></tr>
169+
<tr><td>Martinique</td><td>MTQ</td></tr>
170+
<tr><td>Mauritania</td><td>MRT</td></tr>
171+
<tr><td>Mauritius</td><td>MUS</td></tr>
172+
<tr><td>Mayotte</td><td>MYT</td></tr>
173+
<tr><td>Mexico</td><td>MEX</td></tr>
174+
<tr><td>Micronesia (Federated States of)</td><td>FSM</td></tr>
175+
<tr><td>Monaco</td><td>MCO</td></tr>
176+
<tr><td>Mongolia</td><td>MNG</td></tr>
177+
<tr><td>Montenegro</td><td>MNE</td></tr>
178+
<tr><td>Montserrat</td><td>MSR</td></tr>
179+
<tr><td>Morocco</td><td>MAR</td></tr>
180+
<tr><td>Mozambique</td><td>MOZ</td></tr>
181+
<tr><td>Myanmar</td><td>MMR</td></tr>
182+
<tr><td>Namibia</td><td>NAM</td></tr>
183+
<tr><td>Nauru</td><td>NRU</td></tr>
184+
<tr><td>Nepal</td><td>NPL</td></tr>
185+
<tr><td>New Caledonia</td><td>NCL</td></tr>
186+
<tr><td>New Zealand</td><td>NZL</td></tr>
187+
<tr><td>Nicaragua</td><td>NIC</td></tr>
188+
<tr><td>Niger</td><td>NER</td></tr>
189+
<tr><td>Nigeria</td><td>NGA</td></tr>
190+
<tr><td>Niue</td><td>NIU</td></tr>
191+
<tr><td>Norfolk Island</td><td>NFK</td></tr>
192+
<tr><td>North Macedonia</td><td>MKD</td></tr>
193+
<tr><td>Northern Mariana Islands</td><td>MNP</td></tr>
194+
<tr><td>Norway</td><td>NOR</td></tr>
195+
<tr><td>Oman</td><td>OMN</td></tr>
196+
<tr><td>Pakistan</td><td>PAK</td></tr>
197+
<tr><td>Palau</td><td>PLW</td></tr>
198+
<tr><td>Panama</td><td>PAN</td></tr>
199+
<tr><td>Papua New Guinea</td><td>PNG</td></tr>
200+
<tr><td>Paraguay</td><td>PRY</td></tr>
201+
<tr><td>Peru</td><td>PER</td></tr>
202+
<tr><td>Philippines</td><td>PHL</td></tr>
203+
<tr><td>Pitcairn</td><td>PCN</td></tr>
204+
<tr><td>Poland</td><td>POL</td></tr>
205+
<tr><td>Portugal</td><td>PRT</td></tr>
206+
<tr><td>Puerto Rico</td><td>PRI</td></tr>
207+
<tr><td>Qatar</td><td>QAT</td></tr>
208+
<tr><td>Republic of Korea</td><td>KOR</td></tr>
209+
<tr><td>Republic of Moldova</td><td>MDA</td></tr>
210+
<tr><td>Réunion</td><td>REU</td></tr>
211+
<tr><td>Romania</td><td>ROU</td></tr>
212+
<tr><td>Russian Federation</td><td>RUS</td></tr>
213+
<tr><td>Rwanda</td><td>RWA</td></tr>
214+
<tr><td>Saba</td><td>BES</td></tr>
215+
<tr><td>Saint Barthélemy</td><td>BLM</td></tr>
216+
<tr><td>Saint Helena</td><td>SHN</td></tr>
217+
<tr><td>Saint Kitts and Nevis</td><td>KNA</td></tr>
218+
<tr><td>Saint Lucia</td><td>LCA</td></tr>
219+
<tr><td>Saint Martin</td><td>MAF</td></tr>
220+
<tr><td>Saint Pierre and Miquelon</td><td>SPM</td></tr>
221+
<tr><td>Saint Vincent and the Grenadines</td><td>VCT</td></tr>
222+
<tr><td>Samoa</td><td>WSM</td></tr>
223+
<tr><td>Sao Tome and Principe</td><td>STP</td></tr>
224+
<tr><td>Saudi Arabia</td><td>SAU</td></tr>
225+
<tr><td>Senegal</td><td>SEN</td></tr>
226+
<tr><td>Serbia</td><td>SRB</td></tr>
227+
<tr><td>Seychelles</td><td>SYC</td></tr>
228+
<tr><td>Sierra Leone</td><td>SLE</td></tr>
229+
<tr><td>Singapore</td><td>SGP</td></tr>
230+
<tr><td>Sint Eustatius</td><td>BES</td></tr>
231+
<tr><td>Sint Maarten</td><td>SXM</td></tr>
232+
<tr><td>Slovakia</td><td>SVK</td></tr>
233+
<tr><td>Slovenia</td><td>SVN</td></tr>
234+
<tr><td>Solomon Islands</td><td>SLB</td></tr>
235+
<tr><td>Somalia</td><td>SOM</td></tr>
236+
<tr><td>South Africa</td><td>ZAF</td></tr>
237+
<tr><td>South Georgia and the South Sandwich Islands</td><td>SGS</td></tr>
238+
<tr><td>South Sudan</td><td>SSD</td></tr>
239+
<tr><td>Spain</td><td>ESP</td></tr>
240+
<tr><td>Sri Lanka</td><td>LKA</td></tr>
241+
<tr><td>Sudan</td><td>SDN</td></tr>
242+
<tr><td>Suriname</td><td>SUR</td></tr>
243+
<tr><td>Svalbard and Jan Mayen Islands</td><td>SJM</td></tr>
244+
<tr><td>Sweden</td><td>SWE</td></tr>
245+
<tr><td>Switzerland</td><td>CHE</td></tr>
246+
<tr><td>Syrian Arab Republic</td><td>SYR</td></tr>
247+
<tr><td>Taiwan</td><td>TWN</td></tr>
248+
<tr><td>Tajikistan</td><td>TJK</td></tr>
249+
<tr><td>Thailand</td><td>THA</td></tr>
250+
<tr><td>Timor-Leste</td><td>TLS</td></tr>
251+
<tr><td>Togo</td><td>TGO</td></tr>
252+
<tr><td>Tokelau</td><td>TKL</td></tr>
253+
<tr><td>Tonga</td><td>TON</td></tr>
254+
<tr><td>Trinidad and Tobago</td><td>TTO</td></tr>
255+
<tr><td>Tunisia</td><td>TUN</td></tr>
256+
<tr><td>Türkiye</td><td>TUR</td></tr>
257+
<tr><td>Turkmenistan</td><td>TKM</td></tr>
258+
<tr><td>Turks and Caicos Islands</td><td>TCA</td></tr>
259+
<tr><td>Tuvalu</td><td>TUV</td></tr>
260+
<tr><td>Uganda</td><td>UGA</td></tr>
261+
<tr><td>Ukraine</td><td>UKR</td></tr>
262+
<tr><td>United Arab Emirates</td><td>ARE</td></tr>
263+
<tr><td>United Kingdom of Great Britain and Northern Ireland</td><td>GBR</td></tr>
264+
<tr><td>United Republic of Tanzania</td><td>TZA</td></tr>
265+
<tr><td>United States of America</td><td>USA</td></tr>
266+
<tr><td>United States Virgin Islands</td><td>VIR</td></tr>
267+
<tr><td>Uruguay</td><td>URY</td></tr>
268+
<tr><td>Uzbekistan</td><td>UZB</td></tr>
269+
<tr><td>Vanuatu</td><td>VUT</td></tr>
270+
<tr><td>Venezuela (Bolivarian Republic of)</td><td>VEN</td></tr>
271+
<tr><td>Viet Nam</td><td>VNM</td></tr>
272+
<tr><td>West Bank</td><td>PSE</td></tr>
273+
<tr><td>Western Sahara</td><td>ESH</td></tr>
274+
<tr><td>Yemen</td><td>YEM</td></tr>
275+
<tr><td>Zambia</td><td>ZMB</td></tr>
276+
<tr><td>Zimbabwe</td><td>ZWE</td></tr>
277+
</tbody>
278+
</table>
279+
---

‎docs/content/plotly_js/maps/outline-map-locations/outline_map_locations_plotly_js_index.html‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
description: How to specify country codes, names, and US states for outline-based maps
3+
display_as: maps
4+
language: plotly_js
5+
layout: base
6+
name: Locations for Outline-based Maps
7+
order: 11
8+
page_type: example_index
9+
permalink: javascript/outline-map-locations/
10+
thumbnail: thumbnail/choropleth.jpg
11+
---
12+
13+
{% assign examples = site.posts | where:"language","plotly_js" | where:"suite","outline-map-locations" | sort: "order" %}
14+
{% include posts/auto_examples.html examples=examples %}

0 commit comments

Comments
 (0)