Extension:Graph/zh

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

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

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

外部链接

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

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  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  and.

relates to a Wikimedia Commons filename.

is the fallback images width in pixels.

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

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

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

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.

外部数据
HTTPS無法為圖表取得數據. 但是可使用自定義的維基傳輸安全協議如 或 ：

Graphoid服務和圖表擴展利用 設定解析這些協議. 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 T168601).

已知的錯誤和限制
Set the appropriate image-rendering property to solve.
 * 圖表擴展已知錯誤
 * Graphoid服務已知錯誤
 * 無法在時間軸中實現ISO 8601中的時間尺度. （只有格里曆適用）
 * Image upscaling on most browsers can be blurry by default.

內部事務
When parsing, the Graph extension expands all template parameters/expressions, and stores the complete graph definitions in the  page property, using graph hashes for IDs. This means you can easily locate a wiki's graphs with either Special:PageWithProps or [//www.mediawiki.org/w/api.php?action=query&list=pageswithprop&continue=&formatversion=2&pwppropname=graph_specs the action API].

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

The tag's   attribute points to the #Graphoid service, which provides a [//www.mediawiki.org/api/rest_v1/page/graph/png/Extension%3AGraph%2FDemo/1686336/d243aa924db2f82926e0f317217fcce591fe8cd4.png 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  ResourceLoader JavaScript module to the page that includes the Vega library, and puts the JSON of graph definitions into a JavaScript   variable named. Once the client has loaded this module, the Vega JavaScript library populates each with an HTML canvas and draws the graph in it, replacing the static image. , Wikimedia wikis only enable this interactive rendering for edit preview.

You can configure the Graph extension to always use just the tag, and not add the Vega libraries or graph definition JSON. This mode will not work during editing, since  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.

安全功能
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.  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.

wgGraphIsTrusted
If  (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 &lt;img> tag. 例如：

输出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  (default), no  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.

Graphoid service
Graphoid 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 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:

(note: this package is not being maintained (T211881, and installation may fail, see T196001, 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

Configure graphoid services


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

参见

 * 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