Difference between revisions of "Template:Interactive COVID-19 maps/common/doc"

From blackwiki
Jump to navigation Jump to search
imported>Wugapodes
(document)
 
imported>Wugapodes
(template data)
 
Line 21: Line 21:
 
See [[Template:Interactive COVID-19 maps]] for a list of maps which are made using this template.
 
See [[Template:Interactive COVID-19 maps]] for a list of maps which are made using this template.
  
 +
 +
== TemplateData ==
 +
<templatedata>
 +
{
 +
"params": {
 +
"id": {
 +
"label": "HTML identifier",
 +
"description": "Unique string to identify this graph",
 +
"example": "covid-map",
 +
"type": "string",
 +
"default": "covid-map",
 +
"suggested": true
 +
},
 +
"scale": {
 +
"label": "Scaling coefficient",
 +
"description": "A percentage value (as a decimal) to resize the map",
 +
"example": "1.2",
 +
"type": "number",
 +
"default": "0.8",
 +
"autovalue": "{{{scale|0.8}}}",
 +
"suggested": true
 +
},
 +
"width": {
 +
"label": "Width",
 +
"description": "Default width",
 +
"type": "number",
 +
"default": "625",
 +
"deprecated": "Use scale"
 +
},
 +
"height": {
 +
"label": "Height",
 +
"description": "Default height",
 +
"type": "number",
 +
"default": "325",
 +
"autovalue": "",
 +
"deprecated": "Use scale"
 +
},
 +
"padding": {
 +
"label": "Padding",
 +
"default": "12"
 +
},
 +
"data-coloring": {
 +
"label": "Country fill data",
 +
"description": "Dataset used to set the fill color for countries",
 +
"example": "Template:Interactive COVID-19 maps/data/Deaths by country-csv",
 +
"type": "wiki-page-name",
 +
"required": true
 +
},
 +
"data-dates": {
 +
"label": "By-date totals",
 +
"description": "Global totals by date",
 +
"example": "Template:Interactive COVID-19 maps/data/Cumulative deaths by date-csv",
 +
"type": "wiki-page-name",
 +
"required": true
 +
},
 +
"color-ramp-type": {
 +
"label": "Color ramp type",
 +
"type": "string",
 +
"default": "log"
 +
},
 +
"domain-min": {
 +
"label": "Minimum value"
 +
},
 +
"domain-magnitude": {
 +
"label": "Maximum order of magnitude",
 +
"description": "The order of magnitude for the scale maximum",
 +
"example": "4",
 +
"type": "number",
 +
"required": true
 +
},
 +
"legend-title": {
 +
"label": "Legend title",
 +
"description": "Title for the legend",
 +
"example": "COVID-19 deaths",
 +
"type": "string",
 +
"suggested": true
 +
},
 +
"title": {
 +
"label": "Title",
 +
"description": "Title for the graph",
 +
"type": "string",
 +
"suggested": true
 +
}
 +
},
 +
"description": "A meta-template for creating interactive data visualizations using maps",
 +
"paramOrder": [
 +
"title",
 +
"data-coloring",
 +
"domain-min",
 +
"domain-magnitude",
 +
"data-dates",
 +
"legend-title",
 +
"scale",
 +
"id",
 +
"width",
 +
"height",
 +
"padding",
 +
"color-ramp-type"
 +
],
 +
"format": "block"
 +
}
 +
</templatedata>
  
 
<includeonly>{{sandbox other||
 
<includeonly>{{sandbox other||

Latest revision as of 00:00, 21 March 2020

This template serves as a meta-template for the construction of interactive maps. While designed for use with COVID-19 related data, it should be sufficiently general for most purposes as long as the data are in the correct format. Editors interested in using or maintaining this meta-template should read the interactive graph tutorial which this template is based off-of.

Usage

{{Interactive COVID-19 maps/common
 | id               = {{{id|<!--default value-->}}}
 | data-coloring    = <!-- Wikilink without [[]] pointing to page with CSV data used to fill in countries. See [[Template:Interactive COVID-19 maps/data/Confirmed covid cases-csv]] for an example -->
 | data-dates       = <!-- Same as above, but this data is a by-date, global total, rather than by-country-by-date total. See [[Template:Interactive COVID-19 maps/data/global Confirmed covid cases by date-csv]] for an example -->
 | color-ramp-type  = <!-- The type of color ramp to use. Default is log, see [https://github.com/vega/vega/wiki/Scales] for other types. -->
 | domain-min       = <!-- Scale minimum -->
 | domain-magnitude = <!-- If color-ramp-type is log, the order of magnitude for the maximum. For example, a value of 2 would have a scale maximum of 100, 3 -> 1000, 4 -> 10000, etc --> 
 | legend-title     = <!-- Title to use for the legend -->
 | title            = <!-- Title for the entire graph -->
 | scale            = {{{scale|<!-- default value -->}}}
}}

Examples

See Template:Interactive COVID-19 maps for a list of maps which are made using this template.


TemplateData

A meta-template for creating interactive data visualizations using maps

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Titletitle

Title for the graph

Stringsuggested
Country fill datadata-coloring

Dataset used to set the fill color for countries

Example
Template:Interactive COVID-19 maps/data/Deaths by country-csv
Pagerequired
Minimum valuedomain-min

no description

Unknownoptional
Maximum order of magnitudedomain-magnitude

The order of magnitude for the scale maximum

Example
4
Numberrequired
By-date totalsdata-dates

Global totals by date

Example
Template:Interactive COVID-19 maps/data/Cumulative deaths by date-csv
Pagerequired
Legend titlelegend-title

Title for the legend

Example
COVID-19 deaths
Stringsuggested
Scaling coefficientscale

A percentage value (as a decimal) to resize the map

Default
0.8
Example
1.2
Auto value
{{{scale|0.8}}}
Numbersuggested
HTML identifierid

Unique string to identify this graph

Default
covid-map
Example
covid-map
Stringsuggested
Widthwidth

Default width

Default
625
Numberdeprecated
Heightheight

Default height

Default
325
Auto value
Numberdeprecated
Paddingpadding

no description

Default
12
Unknownoptional
Color ramp typecolor-ramp-type

no description

Default
log
Stringoptional