Extension:Graph

**MediaWiki extensions manual**
Graph; Release status: unmaintained
Implementation	Tag, ContentHandler
Description	Data-driven graphs
Author(s)	Yuri Astrakhan (Yurik talk),; Dan Andreescu,; Frédéric Bolduc;
MediaWiki	>= 1.43
License	MIT License
Download	Download extension ; Git [?]: Download Git master; browse repository (Phabricator · GitHub); commit history; repository contributors (GitHub); code review;
	Parameters $wgGraphDefaultVegaVer; $wgGraphAllowHttp; $wgGraphAllowedDomains;
	Hooks used OutputPageParserOutput; ParserFirstCallInit;
Quarterly downloads	31 (Ranked 102nd)
Public wikis using	884 (Ranked 281st)
	Translate the Graph extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

Translate this page

The Graph extension allows a ‎<graph> tag to describe data visualizations such as bar charts, pie charts, timelines, and histograms (demo) in a JSON format that renders a Vega-based graph.

General info

Graph extension allows powerful Vega based graphs to be added to the wiki pages. Graphs can be interactive.

The easiest way to add a graph is to use a ready-made template such as {{Graph:Chart}}. These templates hide all Vega complexities. Power users can use the Graph Sandbox to develop graphs. Graph sandbox allows wiki template syntax in addition to JSON. The extension integrates with VisualEditor, providing a simple tool/wizard which generates basic graphs, by entering values directly to the editor.

Useful links

Vega 2 documentation – restored Vega 2 documentation pages on nyurik/vega/wiki.
Guide – General recommendations on how to use graphs in wiki.
Interactive Tutorial – step by step instructions how to build a complex interactive graph from scratch
Demo page – for many samples and usage tricks.
TechTalk Video – a WMF tech talk discussing the Graph extension, including a great demo of the Lyra editor (also installed on labs).
You may also be interested in some of the Vega future capabilities (Keynote by Jeffrey Heer).
Vega for devs - best place of all Vega resources
Migrating to Vega 2.0
Video introduction into interactive Vega

Installation

Requires JsonConfig extension
Download and move the extracted Graph folder to your extensions/ directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Graph
Add the following code at the bottom of your LocalSettings.php file:
```
wfLoadExtension( 'Graph' );
```
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Vagrant installation:

If using Vagrant , install with vagrant roles enable graph --provision

Additional config setup

If you are looking to replicate a production environment like en.wiki you will need to complete the following steps:

Install Scribunto , Imagemap and TemplateStyles , and enable SVG uploads
- If you use vagrant, you can use vagrant roles enable --provision scribunto imagemap templatestyles svg
Import mediawiki.org's Module:Graph, Module:Graph/doc, Template:Nowrap and Template:Nowrap/styles.css (export link)
Import enwiki's Module:Chart and Module:Chart/Default colors (export link)
Import the file File:Circle_frame.svg

Debugging graphs and porting graphs from Vega 2 to Vega 5

A sandbox is provided at Special:GraphSandbox that works similar to the Vega graph editor. The MediaWiki tool includes compatibility code that maps older Vega schemas to the currently enabled version. Inserting an old schema in the main text area will print a modified and modernized schema underneath the graph where possible.

Similar to vega.github.io/editor, the Vega object can be inspected via the VEGA_DEBUG JavaScript global. See Vega's debugging guide on how to use it.

Migrating schemas from older Vega versions

Previously Graph supported Vega 2. You can paste the JSON of graphs in http://vega.github.io/vega-editor/?mode=vega to see how they previously rendered for comparison with Vega 5.

Special:GraphSandbox (for latest code see the beta cluster version of the sandbox) can be used to map older schemas to new schemas. Copy the old schema into the main textarea and the updated schema will appear in the text area below the graph. Copy the new schema into your code.

Charts examples

See Demo page for many samples and usage tricks.

User defined fallback

When using client side rendering, it is possible to use Wikimedia Commons to provide a static fallback image to noscript users. This is a temporary solution until a new service is put in place to provide server side rendering.

The user must first upload the static graph to Wikimedia Commons.

Fallback images have two variables: fallback and fallbackWidth.

fallback relates to a Wikimedia Commons filename.

fallbackWidth is the fallback images width in pixels.

These variables are pass through the graph in the following way:

<graph fallback="Graph test seddon.png" fallbackWidth=450>

Where lua modules are used such as Module:Graph then these variables can be provided via the tag function. If Template:Graph:Chart were adapted, it would look like this:

{{safesubst:#tag:graph|{{safesubst:#invoke:Graph|chartWrapper}} | fallback = {{{fallback|''}}} |  fallbackWidth= {{{fallbackWidth|''}}} }}

It would then be utilised in a template in the following manner:

{{Graph:Chart|width=400|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|fallback=Graph test seddon.png|fallbackWidth=450}}

If a fallbackWidth isn't provided but an image is defined then the extension will derive the width from the provided graph width. The reason for this is there is frequently a difference in the rendered image width and the actual image width.

{{Graph:Chart|width=400|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|fallback=Graph test seddon.png}}

External data

HTTP(S) protocol cannot be used to get data for the graph. Instead, use one of the custom wiki protocols like wikiraw:, wikiapi:, and others.

Graph extension uses the GraphAllowedDomains setting to control how these protocols are resolved: Note that because queries rely on the structure of wikibase items, they may suddenly stop working if the underlying data is edited and changes, as it may yield incomplete, empty or invalid data that can't be used to create a graph. In these cases the graph will end up empty (see phab:T168601).

$wgGraphAllowedDomains = [
    # http + https keys lists all of the domains allowed for the external data access.
    # Any domain listed here automatically permits all subdomains as well.
    # Custom protocols like 'wikiraw' use it to determine which protocol to use.
    # This way wikiraw://en.wikipedia.org/Page will be an api request to https://en.wikipedia.org/w/api.php?action=query&titles=Page&...
    'https' => [ 'wikipedia.org', 'wikimedia.org', ... ],
    'http' => [ 'wmflabs.org', ... ],
    
    # list of domains allowed for the wikirawupload: protocol access.
    # Exact match only, no subdomains.
    'wikirawupload' => [ 'upload.wikimedia.org' ],
    
    # same as wikirawupload but for Wikidata Sparql queries
    'wikidatasparql' => [ 'query.wikidata.org' ],
];

Internals

When parsing, the Graph extension expands all template parameters/expressions, and stores the complete graph definitions in the ParserOutput, using graph hashes for IDs.

The graph extension adds HTML to the page where graphs should go, a ‎<div> with a graph-id as the attribute. Sample:

<div class="mw-graph" data-graph-id="72edc224f0a10b343c1e84f63dbfc97cac9bc957">
</div>

The Graph extension adds an ext.graph ResourceLoader JavaScript module to the page that includes the Vega library, and puts the JSON of graph definitions into a JavaScript mediawiki.config variable named wgGraphSpecs. Once the client has loaded this module, the Vega JavaScript library populates each ‎<div> with an HTML canvas and draws the graph in it, replacing the static image.

Security features

‎<graph> can be configured to disallow referencing untrusted data sources (e.g. Wikimedia only allows data from the Wikimedia sites).

License

Vega library is distributed under a modified BSD license acceptable under for us to use.

“	This appears to be a copy of the BSD license, with some minor (acceptable) modifications. It's not a problem for us to use it, although ideally they would not make changes like this to the license. It's better if people do not make these changes to their license, to avoid confusion (like this) about whether the license is safe for open-source use.	”
—Stephen LaPorte

Configuration

wgGraphAllowedDomains

See the section on external data.

VisualEditor module

Since summer 2015, the Graph extension also comes with a module (ext.graph.VisualEditor) which enables graph editing within VisualEditor.

This module was a result of a Google Summer of Code 2015 project. See phab:T89287 for more details.

This module allows users to see graphs within VisualEditor, as opposed to alien extension nodes. Furthermore, users can open up a dialog to edit a graph's type, data and padding. The UI also offers a way to edit a graph's raw JSON specification within VE without having to switch to the classic wikitext editor, in case more advanced users want to tweak settings not supported by the UI.

This first step serves as a stepping stone for many possibilities with graph editing within VisualEditor, and there are a lot of ways in which the module can be improved and expanded.

Troubleshooting broken graphs

Errors with graphs will be logged in the developer console.

Error: Bad constructor arguments (phab:T277906)

To fix: Replace filepath:Earthmap1000x500compac.jpg with filepath:Earthmap1000x500.jpg

Example.

TypeError: undefined is not an object (evaluating 'datum.firstYear.value')

To fix: Make sure you have not set default as null