扩展:图表
 發布狀態： 穩定版本 |
|
|---|---|
| 实现 | 标签, ContentHandler |
| 描述 | Data-driven graphs |
| 作者 | |
| MediaWiki | >= 1.39.0 |
| 许可协议 | MIT授權條款 |
| 下載 | |
|
|
| 翻譯Graph扩展，若在translatewiki.net可用 | |
| 問題 | 尚未完成的工作 · 报告錯誤 |
Graph扩展允许<graph>标签以JSON格式描述数据可视化内容，例如条形图，饼图，时间线和直方图（示范），该JSON格式呈现Vega的图表。
基本信息
圖表擴展允許将基於Vega的圖表加入至Wiki頁面中。圖表可以是交互式的。
插入圖表最簡單的方法就是使用預先製作的模板，如利用{{Graph:Chart}}製作長條圖。 這些模板隱藏了所有Vega複雜的部份。 開發者可藉由圖表沙盒開發圖表。 （除了JSON格式，圖表沙盒也支援維基語法） The extension integrates with VisualEditor, providing a simple tool/wizard which generates basic graphs, by entering values directly to the editor.
外部链接
- 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 (only if you decided to use Vagrant)
- 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:Chart/Default_colors locally.
- Copy File:Circle_frame.svg 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.
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}}
外部数据
HTTPS無法為圖表取得數據。
但是可使用自定義的維基傳輸安全協議如wikiraw:或wikiapi:：
圖表擴展利用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' ],
];
已知的錯誤和限制
- phab:tag/graph - 圖表擴展已知錯誤
- 無法在時間軸中實現ISO 8601中的時間尺度。（只有格里曆適用）
內部事務
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.
例子：
<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.
安全功能
<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 | ||
配置
wgGraphAllowedDomains
See the section on external data.
其他变量
- - wgGraphUrlBlacklist has been removed in 787d64a11.
- - wgGraphDataDomains has been removed in e0813f85a. Use wgGraphAllowedDomains instead.
- - wgGraphUserServiceAlways has been removed in b735f63ff4b.
- - wgGraphIsTrusted has been removed in cf80f43e15.
- - $wgGraphImgServiceUrl was deprecated.
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,
);
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页面。 |
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
TypeError: undefined is not an object (evaluating 'datum.firstYear.value')
To fix: Make sure you have not set default as null
参见
- 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
| This extension is included in the following packages and/or wiki farms: |