Skip to content

Commit 0767f96

Browse files
committed
update docs for new reimplementation
1 parent 6b58395 commit 0767f96

File tree

3 files changed

+15
-22
lines changed

3 files changed

+15
-22
lines changed

doc/widgets/choroplethmap.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,43 +4,36 @@ Choropleth Map
44
A thematic map in which areas are shaded in proportion to the measurement of the statistical variable being displayed.
55

66
**Inputs**
7-
- Data: An input data set.
7+
8+
- Data: input dataset
89

910
**Outputs**
10-
- Selected Data: A subset of instances selected from the map.
11-
- Data: Data set with an appended meta attribute specifying selected and unselected data.
11+
- Selected Data: instances selected from the map.
12+
- Data: data with an additional column showing whether a point is selected
1213

1314

1415
**Choropleth** provides an easy way to visualize how a measurement varies across a geographic area or show the level of variability within a region. There are several levels of granularity available, from countries to states, counties, or municipalities.
1516

1617
![](images/Choropleth-stamped.png)
1718

18-
1. Aggregation properties:
19-
- Latitude attribute.
20-
- Longitude attribute.
21-
- Attribute to color the region by.
22-
- Aggregation level. Default counts the number of occurences of the region in the data. Count defined shows which regions appear in the data. Sum, mean, median, max, min and standard deviation work for numeric data, while mode works for categorical.
23-
- Administrative level. 0 is for countries, 1 is for states (US)/counties/Bundesländer/provinces, 2 is for counties (US)/municipalities.
24-
2. Visualization properties:
25-
- Color steps defines into how many bins to split numeric data.
26-
- Color quantization defines the coloring scale (equidistant, logarithmic, quantile, k-means).
27-
- Opacity sets transparency of the color.
28-
- If *Show legend* is off, legend will be hidden.
29-
- If *Show map labels* is off, region names' will be hidden.
30-
- If *Show region details in a tooltip* is off, hovering over the region won't display anything.
31-
3. If *Send Selection Automatically* is on, selection will be commited automatically. Alternatively, press *Send Selection*.
32-
33-
To reset the zoom level, press the target icon in the to left corner of the map. For zoom, use to + and - icons or mouse scroll. To select a region, click on it in the visualization. To select more than one region, hold Shift.
19+
1. Set latitude and longitude attributes, if the widget didn't recognize them automatically.
20+
2. Set *Attribute* to color the region by. Set *Agg.* which by default counts the number of occurrences of the region in the data. *Count defined* shows which regions appear in the data. *Sum*, *Mean*, *Median*, *Maximal*, *Minimal* and *Std.* (standard deviation) work for numeric data, while *Mode* works for categorical. Set *Detail* level to countries, states (US)/counties/Bundesländer/provinces or counties (US)/municipalities.
21+
3. Adjust plot properties:
22+
- *Bin width* for discretize displayed color.
23+
- *Opacity* sets transparency of regions.
24+
- *Show legend* displays a legend on the right. Click and drag the legend to move it.
25+
4. *Select, zoom, pan and zoom to fit* are the options for exploring the map. The manual selection of data instances works as an angular/square selection tool. Scroll in or out for zoom.
26+
5. If *Send automatically* is ticked, changes are communicated automatically. Alternatively, press *Send*.
3427

3528
Example
3629
-------
3730

38-
We will use *HDI* data from the **Datasets** widget. Open the widget, find *HDI* data, select it and press *Send*. **Choropleth** widget requires latitude and longitude pairs, so we will use **Geocoding** to extract this information. We used the attribute *Country* and found lat/lon pairs that **Choropleth** can use.
31+
We will use *HDI* data from the **Datasets** widget. Open the widget, find *HDI* data and double click. **Choropleth** widget requires latitude and longitude pairs, so we will use **Geocoding** to extract this information. We used the attribute *Country* and found lat/lon pairs that **Choropleth** can use.
3932

4033
**Choropleth** will automatically look for attributes named *latitude*, *longitude*, *lat*, *lon* or similar. It will use them for plotting. Alternatively, set the attributes manually.
4134

42-
Since *HDI* attribute is our target variable, it will automatically be used for coloring. You can change it in the *Attribute* dropdown. We have set the level of aggregation to *max*, but since we have only one value per country, we could use *sum* or *min* just as well.
35+
Since *HDI* attribute is our target variable, it will automatically be used for coloring. We change it in the *Attribute* dropdown to *Life expectancy*. We have set the level of aggregation to *Mean*, but since we have only one value per country, we could use *Sum* or *Median* just as well.
4336

44-
The widget shows HDI values as reported by the United Nations per country. Yellow countries are those with a high HDI and blue ones are the ones with a low HDI value.
37+
The widget shows life expectancy as reported by the United Nations per country. Yellow countries are those with a high Life expectancy and blue ones are the ones with a low life expectancy.
4538

4639
![](images/Choropleth-Example.png)
213 KB
Loading
206 KB
Loading

0 commit comments

Comments
 (0)