Difference between revisions of "Extension:Graph/Demo"
Joelmartin (talk | contribs) m (Text replacement - "</translate>" to "") |
Joelmartin (talk | contribs) m (Text replacement - "<!--T:(.*)-->" to "") |
||
Line 3: | Line 3: | ||
− | + | ||
This page shows some examples of what [[Extension:Graph | Graph extension]] can produce. | This page shows some examples of what [[Extension:Graph | Graph extension]] can produce. | ||
− | + | ||
Graphs use [<tvar|url1>http://vega.github.io/vega/</> Vega grammar] ([<tvar|url2>https://github.com/vega/vega/wiki</> documentation]) as underlying technology. | Graphs use [<tvar|url1>http://vega.github.io/vega/</> Vega grammar] ([<tvar|url2>https://github.com/vega/vega/wiki</> documentation]) as underlying technology. | ||
− | + | ||
Vega team is working on [<tvar|url>http://vega.github.io/</> other tools] to make Graphs easier to use. | Vega team is working on [<tvar|url>http://vega.github.io/</> other tools] to make Graphs easier to use. | ||
− | + | ||
For interactive graphs [<tvar|url>https://github.com/vega/vega/wiki/Tutorial</> this tutorial] will explain building graphs step by step. | For interactive graphs [<tvar|url>https://github.com/vega/vega/wiki/Tutorial</> this tutorial] will explain building graphs step by step. | ||
− | + | ||
For other graph ideas, see [<tvar|url>http://vega.github.io/vega-editor/?spec=bar</> Vega examples]. | For other graph ideas, see [<tvar|url>http://vega.github.io/vega-editor/?spec=bar</> Vega examples]. | ||
− | == Graph templates == | + | == Graph templates == |
+ | |||
− | |||
The easiest way to use graphs is via pre-built templates such as the [[:en:Template:Graph:Chart|Graph:Chart]] (available on many Wikipedias), or more specialized [[:en:Template:Graph:PieChart|PieChart]]. | The easiest way to use graphs is via pre-built templates such as the [[:en:Template:Graph:Chart|Graph:Chart]] (available on many Wikipedias), or more specialized [[:en:Template:Graph:PieChart|PieChart]]. | ||
− | + | ||
Graph:Chart supports many common graph types such as line, area, and pie charts: | Graph:Chart supports many common graph types such as line, area, and pie charts: | ||
Line 48: | Line 48: | ||
− | == Vega 2.0 interactive examples == | + | == Vega 2.0 interactive examples == |
+ | |||
− | |||
See [[Extension:Graph/Interactive Graph Tutorial|tutorial]] how to build this: | See [[Extension:Graph/Interactive Graph Tutorial|tutorial]] how to build this: | ||
{{Extension:Graph/Demo/HistoricalFertilityRates}} | {{Extension:Graph/Demo/HistoricalFertilityRates}} | ||
Line 67: | Line 67: | ||
− | == Using RESTBase API == | + | == Using RESTBase API == |
+ | |||
− | |||
Show pageview graphs for a range of dates, using pageview analytics API. | Show pageview graphs for a range of dates, using pageview analytics API. | ||
− | + | ||
See <tvar|1>{{ll|Template:Graph:PageViews}}</>. | See <tvar|1>{{ll|Template:Graph:PageViews}}</>. | ||
− | ''' | + | ''' Current page and en.wikipedia.org's main page for the last 30 days''' |
<pre> | <pre> | ||
{{Template:Graph:PageViews}} | {{Template:Graph:PageViews}} | ||
Line 85: | Line 85: | ||
− | + | ||
''' Current page and en.wikipedia main page for the last 30 days - per type''' | ''' Current page and en.wikipedia main page for the last 30 days - per type''' | ||
{{Extension:Graph/Demo/Pageviews2|mediawiki|{{FULLPAGENAME}}|30}} | {{Extension:Graph/Demo/Pageviews2|mediawiki|{{FULLPAGENAME}}|30}} | ||
Line 91: | Line 91: | ||
− | == Using MediaWiki API == | + | == Using MediaWiki API == |
+ | |||
− | |||
This graph shows edit history for a wiki page. | This graph shows edit history for a wiki page. | ||
− | + | ||
See <tvar|1>{{template|Graph:PageHistory}}</>. | See <tvar|1>{{template|Graph:PageHistory}}</>. | ||
{| | {| | ||
− | ! | + | ! Current Page |
− | ! [[wikipedia:Albert Einstein|Albert Einstein]] | + | ! [[wikipedia:Albert Einstein|Albert Einstein]] from en.wikipedia.org |
|- | |- | ||
| {{ Graph:PageHistory | width=500 | height=300 }} | | {{ Graph:PageHistory | width=500 | height=300 }} | ||
Line 108: | Line 108: | ||
− | + | ||
This graph shows the number of pages in each subcategory. | This graph shows the number of pages in each subcategory. | ||
− | + | ||
See [[<tvar|1>Special:MyLanguage/Extension:Graph/Demo/CategoryPie</>|graph source code]]. | See [[<tvar|1>Special:MyLanguage/Extension:Graph/Demo/CategoryPie</>|graph source code]]. | ||
{| | {| | ||
! [[:Category:Extensions by category|Category:'''Extensions by category''']]. | ! [[:Category:Extensions by category|Category:'''Extensions by category''']]. | ||
− | ! [[:en:Category:People|Category:'''People''']] | + | ! [[:en:Category:People|Category:'''People''']] from en.wikipedia.org |
|- | |- | ||
| {{Extension:Graph/Demo/CategoryPie|Extensions by category}} | | {{Extension:Graph/Demo/CategoryPie|Extensions by category}} | ||
Line 123: | Line 123: | ||
− | == Using Wikidata Query Service API == | + | == Using Wikidata Query Service API == |
+ | |||
− | |||
See [[Extension:Graph/Demo/Sparql|more examples]]. | See [[Extension:Graph/Demo/Sparql|more examples]]. | ||
Line 131: | Line 131: | ||
− | == Trees == | + | == Trees == |
− | === Cartesian tree === | + | === Cartesian tree === |
[[Extension:Graph/Demo/CartesianTree]] | [[Extension:Graph/Demo/CartesianTree]] | ||
Line 140: | Line 140: | ||
− | === Radial tree === | + | === Radial tree === |
[[Extension:Graph/Demo/RadialTree]] | [[Extension:Graph/Demo/RadialTree]] | ||
Line 153: | Line 153: | ||
− | ==Timeline / lifeline== | + | ==Timeline / lifeline== |
<graph> | <graph> | ||
Line 283: | Line 283: | ||
− | == More maps examples == | + | == More maps examples == |
+ | |||
− | |||
This transcludes the page <tvar|1>[[Extension:Graph/Demo/Map]]</>. | This transcludes the page <tvar|1>[[Extension:Graph/Demo/Map]]</>. | ||
− | + | ||
The <code><nowiki><graph></nowiki></code> tag's JSON data on that page specifies that its <code>countries</code> data comes from a separate URL, [[Extension:Graph/Demo/RawData:WorldMap-iso2-json]], that contains map data in JSON format. | The <code><nowiki><graph></nowiki></code> tag's JSON data on that page specifies that its <code>countries</code> data comes from a separate URL, [[Extension:Graph/Demo/RawData:WorldMap-iso2-json]], that contains map data in JSON format. | ||
− | + | ||
(MediaWiki doesn't know this wiki page should be formatted as JSON yet, it will eventually use a JSON content handler.) | (MediaWiki doesn't know this wiki page should be formatted as JSON yet, it will eventually use a JSON content handler.) | ||
− | + | ||
One of the elements in the <code><nowiki><graph></nowiki></code> tag's JSON data specifies a highlight color for each country, in the format <code>"''country-code''":"''highlight-color''"</code>: | One of the elements in the <code><nowiki><graph></nowiki></code> tag's JSON data specifies a highlight color for each country, in the format <code>"''country-code''":"''highlight-color''"</code>: | ||
Line 302: | Line 302: | ||
− | + | ||
Vega usually works with data in the format <source lang="javascript" inline>[{"id":"country-code", "v":"highlight-color"}, ...]</source>, so I created a helper Lua function to convert the data: | Vega usually works with data in the format <source lang="javascript" inline>[{"id":"country-code", "v":"highlight-color"}, ...]</source>, so I created a helper Lua function to convert the data: | ||
Line 308: | Line 308: | ||
− | + | ||
The Lua function's output is data in Vega's format: | The Lua function's output is data in Vega's format: | ||
Line 319: | Line 319: | ||
− | + | ||
Here is a more complex data processing example: [[Extension:Graph/Demo/MapTemplate|MapTemplate]] is expanded with the data from Lua which takes it from the 2010 population distribution in the world (data based on [http://esa.un.org/wpp/ UN data]). | Here is a more complex data processing example: [[Extension:Graph/Demo/MapTemplate|MapTemplate]] is expanded with the data from Lua which takes it from the 2010 population distribution in the world (data based on [http://esa.un.org/wpp/ UN data]). | ||
− | + | ||
To generate this graph, I use Lua module [[:Module:Graph:Utils|Graph:Utils]]'s function <code>parseCsv</code> to extract the year 2010 column from the [[Extension:Graph/Demo/RawData:PopulationByCountryHistoric-csv]] page (in csv format), and pass that data as the first unnamed parameter to the [[Extension:Graph/Demo/MapTemplate|MapTemplate]] graph. | To generate this graph, I use Lua module [[:Module:Graph:Utils|Graph:Utils]]'s function <code>parseCsv</code> to extract the year 2010 column from the [[Extension:Graph/Demo/RawData:PopulationByCountryHistoric-csv]] page (in csv format), and pass that data as the first unnamed parameter to the [[Extension:Graph/Demo/MapTemplate|MapTemplate]] graph. | ||
− | + | ||
Additional optional parameter specifies that it should be scaled to 80%. | Additional optional parameter specifies that it should be scaled to 80%. | ||
Line 334: | Line 334: | ||
− | + | ||
Note how the legend it wrongly positioned. | Note how the legend it wrongly positioned. | ||
− | + | ||
That won't happen at lower scales. | That won't happen at lower scales. | ||
− | == Passing MediaWiki template parameters == | + | == Passing MediaWiki template parameters == |
+ | |||
− | |||
If you're using a wiki page as a template, you can pass [[Help:Templates#Parameters|parameters]] to it, like any other MediaWiki template. | If you're using a wiki page as a template, you can pass [[Help:Templates#Parameters|parameters]] to it, like any other MediaWiki template. | ||
− | + | ||
As an example, the graph specification in [[Extension:Graph/Demo/TemplateSample|TemplateSample]] does not hardcode a fill color for <code>marks.properties.update.fill.value</code>; instead it sets the fill color to <code><nowiki>{{{1|#ccc}}}</nowiki></code>. | As an example, the graph specification in [[Extension:Graph/Demo/TemplateSample|TemplateSample]] does not hardcode a fill color for <code>marks.properties.update.fill.value</code>; instead it sets the fill color to <code><nowiki>{{{1|#ccc}}}</nowiki></code>. | ||
− | + | ||
So if you visit that page or transclude it with no parameter, the graph fills with color <code style="background-color:#ccc">#ccc</code>; but if you transclude that page you can specify the fill color as the first template parameter. | So if you visit that page or transclude it with no parameter, the graph fills with color <code style="background-color:#ccc">#ccc</code>; but if you transclude that page you can specify the fill color as the first template parameter. | ||
Line 363: | Line 363: | ||
− | === Using a template for repeated graphs === | + | === Using a template for repeated graphs === |
+ | |||
− | |||
This is very useful if you have multiple graphs of the same form: you can put the verbose graph JSON and additional repetive wikitext in a template and only pass the parameters to it that vary, such as title and values. [[Talk:MediaWiki Developer Summit 2015/Lessons learned#Template_test | See a sample of this approach]]. | This is very useful if you have multiple graphs of the same form: you can put the verbose graph JSON and additional repetive wikitext in a template and only pass the parameters to it that vary, such as title and values. [[Talk:MediaWiki Developer Summit 2015/Lessons learned#Template_test | See a sample of this approach]]. | ||
− | == Overlaying two types of data == | + | == Overlaying two types of data == |
+ | |||
− | |||
Falkensee graph sample, see [[Extension:Graph/Demo/falkensee|code]]. | Falkensee graph sample, see [[Extension:Graph/Demo/falkensee|code]]. | ||
Line 376: | Line 376: | ||
− | == Embedded directly with <nowiki><graph></nowiki> == | + | == Embedded directly with <nowiki><graph></nowiki> == |
+ | |||
− | |||
This example is a <code><nowiki><graph></nowiki></code> tag containing the graph JSON inside the current page. | This example is a <code><nowiki><graph></nowiki></code> tag containing the graph JSON inside the current page. | ||
Line 444: | Line 444: | ||
− | == Horizontal bar graph == | + | == Horizontal bar graph == |
[[Extension:Graph/Demo/HorizontalBarGraphSample]] | [[Extension:Graph/Demo/HorizontalBarGraphSample]] | ||
Line 451: | Line 451: | ||
− | == Editing graph data == | + | == Editing graph data == |
+ | |||
− | |||
Editing JSON by hand is fiddly and prone to error. so you should use a JSON checker such as [http://jsonlint.com/ JSONLint] or a JSON editor such as the [http://vega.github.io/vega-editor/ Vega Live Editor] to edit JSON before you copy and paste it into the wiki page. If the <code><nowiki><graph></nowiki></code> tag's data is directly embedded in the page such as the example above, then if you use VisualEditor to edit the page you can directly edit graph data. | Editing JSON by hand is fiddly and prone to error. so you should use a JSON checker such as [http://jsonlint.com/ JSONLint] or a JSON editor such as the [http://vega.github.io/vega-editor/ Vega Live Editor] to edit JSON before you copy and paste it into the wiki page. If the <code><nowiki><graph></nowiki></code> tag's data is directly embedded in the page such as the example above, then if you use VisualEditor to edit the page you can directly edit graph data. | ||
[[Category:Extension:Graph{{#translation:}}|Demo]] | [[Category:Extension:Graph{{#translation:}}|Demo]] |
Revision as of 14:32, 21 December 2019
This page shows some examples of what Graph extension can produce.
Graphs use [<tvar|url1>http://vega.github.io/vega/</> Vega grammar] ([<tvar|url2>https://github.com/vega/vega/wiki</> documentation]) as underlying technology.
Vega team is working on [<tvar|url>http://vega.github.io/</> other tools] to make Graphs easier to use.
For interactive graphs [<tvar|url>https://github.com/vega/vega/wiki/Tutorial</> this tutorial] will explain building graphs step by step.
For other graph ideas, see [<tvar|url>http://vega.github.io/vega-editor/?spec=bar</> Vega examples].
Graph templates
The easiest way to use graphs is via pre-built templates such as the Graph:Chart (available on many Wikipedias), or more specialized PieChart.
Graph:Chart supports many common graph types such as line, area, and pie charts:
{{Graph:Chart|width=600|height=100|xAxisTitle=X|yAxisTitle=Y |type=rect|x=1,2,3,4,5,6,7,8|y=10,12,6,14,2,10,7,9}} {{Graph:Chart|width=100|height=100|type=pie|legend=Legende |x=A,B,C,D,E,F,G,H,I|y1=100,200,150,300,100,100,150,50,200 |y2=7,8,9,8,8,9,10,9,5|showValues=}} {{Graph:Chart|width=400|height=100|xAxisTitle=X|yAxisTitle=Y |legend=Legend|type=stackedarea|x=1,2,3,4,5,6|y1=10,12,6,14,2,10 |y2=2,4,6,8,13,11|interpolate=monotone|colors=seagreen,orchid}}
Vega 2.0 interactive examples
See tutorial how to build this: Template:Extension:Graph/Demo/HistoricalFertilityRates
Extension:Graph/Demo/Dimpvis Template:Extension:Graph/Demo/Dimpvis
Extension:Graph/Demo/Airports Template:Extension:Graph/Demo/Airports
Extension:Graph/Demo/OverviewDetail Template:Extension:Graph/Demo/OverviewDetail
Extension:Graph/Demo/IndexChart Template:Extension:Graph/Demo/IndexChart
Using RESTBase API
Show pageview graphs for a range of dates, using pageview analytics API.
See <tvar|1>Template:Graph:PageViews </>.
Current page and en.wikipedia.org's main page for the last 30 days
{{Template:Graph:PageViews}} {{Template:Graph:PageViews|30|Main Page|en.wikipedia.org}}
Current page and en.wikipedia main page for the last 30 days - per type Template:Extension:Graph/Demo/Pageviews2 Template:Extension:Graph/Demo/Pageviews2
Using MediaWiki API
This graph shows edit history for a wiki page.
See <tvar|1>
- REDIRECT Template:Template link expanded
![]()
|
</>.
Current Page | Albert Einstein from en.wikipedia.org |
---|---|
This graph shows the number of pages in each subcategory.
See [[<tvar|1>Special:MyLanguage/Extension:Graph/Demo/CategoryPie</>|graph source code]].
Category:Extensions by category. | Category:People from en.wikipedia.org |
---|---|
Template:Extension:Graph/Demo/CategoryPie | Template:Extension:Graph/Demo/CategoryPie |
Using Wikidata Query Service API
See more examples.
Template:Extension:Graph/Demo/Sparql/Largest disasters
Trees
Cartesian tree
Extension:Graph/Demo/CartesianTree
Template:Extension:Graph/Demo/CartesianTree
Radial tree
Extension:Graph/Demo/RadialTree
Template:Extension:Graph/Demo/RadialTree
Dendrogram
Extension:Graph/Demo/Dendrogram
Template:Extension:Graph/Demo/Dendrogram
Timeline / lifeline
More maps examples
This transcludes the page <tvar|1>Extension:Graph/Demo/Map</>.
The <graph>
tag's JSON data on that page specifies that its countries
data comes from a separate URL, Extension:Graph/Demo/RawData:WorldMap-iso2-json, that contains map data in JSON format.
(MediaWiki doesn't know this wiki page should be formatted as JSON yet, it will eventually use a JSON content handler.)
One of the elements in the <graph>
tag's JSON data specifies a highlight color for each country, in the format "country-code":"highlight-color"
:
{"BR":"pink","US":"blue","CN":"red","DZ":"green","AU":"purple"}
Vega usually works with data in the format [{"id":"country-code", "v":"highlight-color"}, ...]
, so I created a helper Lua function to convert the data:
{{#invoke:Graph:Utils|expandDict|{"BR":"pink","US":"blue","CN":"red","DZ":"green","AU":"purple"} }}
The Lua function's output is data in Vega's format:
[{"id":"US","v":"blue"},{"id":"AU","v":"purple"},{"id":"CN","v":"red"},{"id":"BR","v":"pink"},{"id":"DZ","v":"green"}]
Template:Extension:Graph/Demo/Map
Here is a more complex data processing example: MapTemplate is expanded with the data from Lua which takes it from the 2010 population distribution in the world (data based on UN data).
To generate this graph, I use Lua module Graph:Utils's function parseCsv
to extract the year 2010 column from the Extension:Graph/Demo/RawData:PopulationByCountryHistoric-csv page (in csv format), and pass that data as the first unnamed parameter to the MapTemplate graph.
Additional optional parameter specifies that it should be scaled to 80%.
{{Extension:Graph/Demo/MapTemplate|{{#invoke:Graph:Utils|parseCsv|Extension:Graph/Demo/RawData:PopulationByCountryHistoric-csv|2010}}|scale=180}}
Template:Extension:Graph/Demo/MapTemplate
Note how the legend it wrongly positioned.
That won't happen at lower scales.
Passing MediaWiki template parameters
If you're using a wiki page as a template, you can pass parameters to it, like any other MediaWiki template.
As an example, the graph specification in TemplateSample does not hardcode a fill color for marks.properties.update.fill.value
; instead it sets the fill color to {{{1|#ccc}}}
.
So if you visit that page or transclude it with no parameter, the graph fills with color #ccc
; but if you transclude that page you can specify the fill color as the first template parameter.
{{Extension:Graph/Demo/TemplateSample}} {{Extension:Graph/Demo/TemplateSample | blue}} {{Extension:Graph/Demo/TemplateSample | #f00dee}}
Template:Extension:Graph/Demo/TemplateSample Template:Extension:Graph/Demo/TemplateSample Template:Extension:Graph/Demo/TemplateSample
Using a template for repeated graphs
This is very useful if you have multiple graphs of the same form: you can put the verbose graph JSON and additional repetive wikitext in a template and only pass the parameters to it that vary, such as title and values. See a sample of this approach.
Overlaying two types of data
Falkensee graph sample, see code.
Template:Extension:Graph/Demo/falkensee
Embedded directly with <graph>
This example is a <graph>
tag containing the graph JSON inside the current page.
Horizontal bar graph
Extension:Graph/Demo/HorizontalBarGraphSample
Template:Extension:Graph/Demo/HorizontalBarGraphSample
Editing graph data
Editing JSON by hand is fiddly and prone to error. so you should use a JSON checker such as JSONLint or a JSON editor such as the Vega Live Editor to edit JSON before you copy and paste it into the wiki page. If the <graph>
tag's data is directly embedded in the page such as the example above, then if you use VisualEditor to edit the page you can directly edit graph data.