扩展:图表

This page is a translated version of the page Extension:Graph and the translation is 47% complete.

Other languages:

English • ‎Türkçe • ‎français • ‎occitan • ‎polski • ‎русский • ‎中文 • ‎日本語 • ‎한국어

**MediaWiki擴充功能手冊**
Graph 发布状态：稳定版
实现	标签 , ContentHandler
描述	Data-driven graphs
作者	Yuri Astrakhan (Yurik ^讨论), Dan Andreescu, Frédéric Bolduc
许可协议	MIT授權條款
下载	下载扩展 Git ^[?]: 下载Git主线浏览存储库 (GitHub) 提交历史 repository contributors (GitHub) 代码复核
参数 $wgGraphDefaultVegaVer $wgGraphImgServiceUrl $wgGraphAllowedDomains
使用的钩子 ParserAfterParse ParserFirstCallInit
翻譯Graph擴充功能如在translatewiki.net可用
检查使用和版本矩阵。
问题	尚未完成的工作 · 回報錯誤

Graph扩展允许<graph>标签以JSON格式描述数据可视化内容，例如条形图，饼图，时间线和直方图（示范），该JSON格式呈现Vega的图表。

基本信息

圖表擴展允許基於Vega的圖表被加入至Wiki頁面中。圖表可以是靜態或互動式的。

插入圖表最簡單的方法就是使用預先製作的模板，如利用{{Graph:Chart}}製作長條圖。這些模板隱藏了所有Vega複雜的部份。開發者可藉由圖表沙盒開發圖表。（除了JSON格式，圖表沙盒也支援維基語法）

外部链接

Vega2文档 - 恢复了Vega2的文档页面。
導覽 - 在Wiki中使用圖表的建議。
互動式圖表教程 - 說明如何從頭開始構建複雜的互動式圖表。
範例 - 一些範例和使用技巧。
TechTalk 影片 - WMF技術講座上圖表擴展的討論，包括Lyra編輯器很棒的範例。（實驗室也有安裝）
Vega未來功能。（Jeffrey Heer的專題演講）
Vega - 所有Vega資源的聚集地。
有關Vega 2.0
介紹Vega互動式圖表的影片

安装

如果使用Vagrant ，请通过vagrant roles enable graph --provision安装

手动安装

需要JsonConfig 擴展
下载文件，并将其放置在您extensions/文件夹中的Graph目录内。
将下列代码放置在您的LocalSettings.php的底部：
```
wfLoadExtension( 'Graph' );
```
完成 – 在您的wiki上导航至Special:Version，以验证扩展已成功安装。

Additional config setup

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

Roles

Enable graphs role
Enable scribunto role
Enable imagemap role

Templates and Lua Modules

Copy Module:Graph locally
Copy Module:Graph/doc locally
Copy Template:Nowrap locally
Copy Module:Chart locally
Copy Module:Plotter/DefaultColors locally.

圖表範例

參考範例頁面獲得更多範例及使用技巧。

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 to replace the soon to be decomissioned Graphoid service.

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 there is frequently a difference in the redered 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}}

外部数据

HTTPS無法為圖表取得數據。但是可使用自定義的維基傳輸安全協議如wikiraw:或wikiapi:：

Graphoid服務和圖表擴展利用GraphAllowedDomains設定解析這些協議。 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開頭）
    # 允許訪問的網域，子網域也允許訪問。
    # 自定義的協議如'wikiraw'利用$gad來確認使用哪種協議。
    # 這樣一來wikiraw://en.wikipedia.org/Page 將會對https://en.wikipedia.org/w/api.php?action=query&titles=Page&... 請求API。
    'https' => [ 'wikipedia.org', 'wikimedia.org', ... ],
    'http' => [ 'wmflabs.org', ... ],
    
    # 下方列出所有wikirawupload:協議允許訪問的網域：
    # wikirawupload:協議要求完全吻合，不允許子網域的訪問。
    'wikirawupload' => [ 'upload.wikimedia.org' ],
    
    # Wikidata Sparql 可供查詢的網域：
    'wikidatasparql' => [ 'query.wikidata.org' ],
];

已知的錯誤和限制

圖表擴展已知錯誤
Graphoid服務已知錯誤
無法在時間軸中實現ISO 8601中的時間尺度。（只有格里曆適用）

Image upscaling on most browsers can be blurry by default.

Set the appropriate image-rendering property to solve.

內部事務

When parsing, the Graph extension expands all template parameters/expressions, and stores the complete graph definitions in the graph_specs page property, using graph hashes for IDs. This means you can easily locate a wiki's graphs with either Special:PageWithProps or the action API.

The graph extension adds HTML to the page where graphs should go, a <div> containing an <img> tag. 例子：

<div class="mw-wiki-graph-container">
  <img class="mw-wiki-graph-img"
    src="/api/rest_v1/page/graph/png/Extension%3AGraph%2FDemo/1686336/d243aa924db2f82926e0f317217fcce591fe8cd4.png" />
</div>

The <img> tag's href attribute points to the #Graphoid service, which provides a static image of the graph.

If the Graph extension is configured for interactivity, and if the client browser has JavaScript enabled and is not a legacy browser to which ResourceLoader does not ship JavaScript, then the client browser renders graphs on the fly. 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. As of 2015年11月, Wikimedia wikis only enable this interactive rendering for edit preview.

You can configure the Graph extension to always use just the <img> tag, and not add the Vega libraries or graph definition JSON. This mode will not work during editing, since page_props do not get updated until after the save. Once saved, the Graphoid service will be able to access the new graph definition via the action API.

安全功能

<graph> can be configured to disallow referencing untrusted data sources (e.g. Wikimedia only allows data from the Wikimedia sites). It can also send extra headers whenever accessing external data, e.g. Treat-as-Untrusted header that MediaWiki uses to prevent CSRF attacks.

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

配置

wgGraphIsTrusted

If false (default), passes Treat-as-Untrusted:1 header with all graph data requests

wgGraphImgServiceUrl

A format string to form a backend service request URL for the <img> tag. 例如：

$wgGraphImgServiceUrl = "//graphoid.wikimedia.org/%1\$s/v1/png/%2\$s/%3\$s/%4\$s.png";

输出URL为：

//graphoid.wikimedia.org/mediawiki.org/v1/png/Extension:Graph/0/be66c7016b9de3188ef6a585950f10dc83239837.png
/{domain}/v1/png/{title}/{revid}/{hash}.png

Parameters will be supplied in this order: 1=server, 2=title, 3=revid, 4=graph-hash-id. All parameters will be escaped with rawurlencode(). If the value is false (default), no <noscript> urls will be generated

其他变量

wgGraphUrlBlacklist variable has been removed in 787d64a11 (7 Dec 2015).

wgGraphDataDomains has been removed in e0813f85a (28 Jan 2016). Use a wgGraphAllowedDomains instead.

wgGraphUserServiceAlways variable has been removed in b735f63ff4b (30 Sep 2015).

Enabling Graph namespace

To store graph definitions as standalone pages in their own namespace, configure JsonConfig .

// See https://www.mediawiki.org/wiki/Extension:JsonConfig
$wgJsonConfigModels['graph.jsonconfig'] = 'graph\Content';
$wgJsonConfigs['graph.jsonconfig'] = array(
	'namespace' => <PICK-A-NS-NUMBER>,
	'nsName' => 'Graph',
	'isLocal' => true,
);

Graphoid service

警告：

WMF is no longer maintaining Graphoid and Graphoid will be undeployed from Wikimedia wikis in the near future.

This section should reference/sync-up with wikitech:Graphoid

Graphoid (git repo) is a node.js service that converts a graph definition into a static PNG image using the same Vega library code that runs in advanced browsers. The reason Graphoid was initially developed was to provide a static image so we wouldn't have to bundle Vega and d3 resource loader modules with every page response. See phab:T211881 for more details. The service is available on the Wikimedia cluster at https://www.mediawiki.org/api/rest_v1/#/Page%20content/get_page_graph_png__title___revision___graph_id_.

You can install it yourself:

$ sudo apt-get install libcairo2-dev libjpeg8-dev libpango1.0-dev libgif-dev build-essential g++
$ git clone https://gerrit.wikimedia.org/r/mediawiki/services/graphoid
$ cd graphoid
$ npm install
$ npm start

(note: this package is not being maintained (phab:T211881, and installation may fail, see phab:T196001 , phab:T239100. npm i --build-from-source may help.)

The service URLs contain the domain of the page (for example mediawiki.org), service version (v1), the title of the page with the graph (PageTitle), revision ID of the page (12345, but could be 0 for current), and a hash ID of the graph itself (also used in HTML page to identify graph definition), for example:

http://localhost:6927/mediawiki.org/v1/PageTitle/12345/a64b022a8fa5b7fc5e40a2c95cd0a114b2ae1174.png (deprecated url)

https://www.mediawiki.org/api/rest_v1/page/graph/png/Extension%3AGraph/3420825/72edc224f0a10b343c1e84f63dbfc97cac9bc957.png

You configure the Graph extension to use the Graphoid service in LocalSettings.php with a line like

$wgGraphImgServiceUrl = "//localhost:6927/%1\$s/v1/%2\$s/%3\$s/%4\$s.png"; //deprecated path, older versions only
$wgGraphImgServiceUrl = "//graphoid.wikimedia.org/%1\$s/v1/png/%2\$s/%3\$s/%4\$s.png"; //deprecated path, older versions only

Configure graphoid services

Graph extension workflow

You can further configure the service via its config file.

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. 有关更多详细信息，请参见phab:T89287。

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.

此扩展被用于一个或多个维基媒体项目上。这可能意味着扩展稳定且工作良好，足以用在同等高流量的网站上。请在维基媒体的CommonSettings.php和InitialiseSettings.php配置文件中寻找此扩展名称以查看安装它的网站。详细的已安装扩展的完整列表可在wiki的Special:Version页面找到。

参见

Extension:GraphViz — for displaying graphs of sets of vertices connected by edges (i.e. not charts, like this extension)
Plotly — The open source JavaScript graphing library (with 3d charting capabilities)
D3 — Data-Driven Documents