Extensão:Chart

Manual de extensões do MediaWiki

Chart Estado da versão: estável
Implementação	Marcação
Descrição	Renders charts
Autor(es)	TODO
Política de compatibilidade	Master maintains backward compatibility.
MediaWiki	>= 1.44
Modifica o banco de dados	Não
Licença	GNU GPL (Licença Pública Geral) 3.0 ou superior
Download	Baixar extensão Git [?]: Navegar pelo repositório (Phabricator · GitHub) Revisão de código no Gerrit Registro de commits no Git Baixar tarball do código-fonte README
Parâmetros $wgChartCliPath $wgChartServiceUrl $wgChartProgressiveEnhancement
Hooks usados ParserFirstCallInit
Quarterly downloads	38 (Ranked 79th)
Para traduzir a extensão Chart, verifique sua disponibilidade no translatewiki.net
Problemas	Tarefas em aberto · Relatar um bug

A extensão Chart fornece recursos básicos de visualização de dados interativos projetados para substituir a extensão Graph e, possivelmente, também a extensão EasyTimeline . Essa extensão está atualmente em desenvolvimento para as wikis da Wikimedia. Veja Extension:Chart/Project para obter mais detalhes sobre o processo de desenvolvimento.

Essa extensão suporta os seguintes tipos de gráficos:

• Gráfico de linhas
• Gráfico de área
• Gráfico de barras
• Gráfico de pizza

Instalação

A extensão Chart requer a instalação da extensão JsonConfig , bem como o download da biblioteca JavaScript (na realidade, TypeScript) Chart Renderer.

Veja o arquivo README.md no repositório para obter as instruções completas de configuração.

Como usar

Todos os gráficos deste exemplo podem ser renderizados a partir da mesma fonte de dados: Data:Chart_Example_Data.tab, um conjunto de dados fictício. Exemplos de conteúdo para essas páginas podem ser encontrados no diretório sample.

Para renderizar um gráfico, você deve definir uma definição de gráfico para associar à fonte de dados que deseja renderizar. A chart definition is a relatively simple JSON file. Na definição do gráfico, especifique o seguinte:

• license – a licença sob a qual o gráfico está disponível
• version – a versão do esquema de gráfico que está sendo usada (atualmente, a única versão é 1)
• type – o tipo de gráfico a ser renderizado; os tipos atualmente suportados são: line, area, bar, pie
• source – onde obter os dados para o gráfico (atualmente, somente os conjuntos de Dados Tabulares podem ser usados como fonte dos dados)
• xAxis -> title – rótulo do eixo x
• xAxis -> format – none ou auto (default, auto has compact notation like 2K for 2000 and thousands separators)
• yAxis -> title – rótulo do eixo y
• yAxis -> format – ver acima
• mediawikiCategories – lista de categorias do MediaWiki para monitorar esse gráfico

{
    "license": "CC0-1.0",
    "version": 1,
    "source": "Chart Example Data.tab",
    "type": "line",
    "title": {
        "en": "Example Chart Title"
    },
    "xAxis": {
        "title": {
        	"en": "Example X Axis Title"
        },
        "format": "none"
    },
    "yAxis": {
        "title": {
            "en": "Example Y Axis Title"
        },
        "format": "none"
    },
    "mediawikiCategories": [
        {
            "name": "Example category",
            "sort": "Its sortkey"
        }
    ]
}

Depois que um gráfico é definido, você pode facilmente renderizá-lo usando a função #chart. Nesse caso, os dados do gráfico são definidos em Data:Chart_Example_Data.tab e o gráfico em si é definido em Data:Example.Line.chart:

{{#chart:Example.Line.chart}}

Personalização

No momento a personalização dos gráficos é limitada. A esperança é que, após testes, discussões e avaliações, possam ser encontradas soluções de personalização que não comprometam a acessibilidade, a renderização específica do dispositivo ou a segurança.

Dimensionamento

Atualmente, os gráficos ocupam a largura total de onde é colocado.

O objetivo final é garantir que os gráficos possam ser renderizados de forma legível, independentemente do dispositivo em que forem lidos; consulte T376845 para obter mais detalhes.

Temas

Atualmente, os gráficos estão restritos a uma única paleta de cores padrão. Essa paleta foi cuidadosamente projetada tendo em mente a acessibilidade. O raciocínio por trás dessas escolhas de cores pode ser explorado em T369863.

Alguns gráficos exigem temas de cores específicos, por exemplo, para representar dados relacionados a partidos políticos. Ainda há uma questão em aberto sobre a melhor forma de oferecer suporte a esse tipo de personalização sem comprometer a capacidade de uso dos leitores com necessidades de acessibilidade (por exemplo, daltonismo).

Internacionalização

Os gráficos só podem ser incorporados no idioma de conteúdo da wiki; portanto, por exemplo, a string de consulta "uselang" (por exemplo, ?uselang=es) não afetará o gráfico.

O formato do gráfico suporta a definição de texto como título e rótulos em diferentes idiomas, de modo que o mesmo gráfico possa ser usado em wikis de diferentes idiomas. Veja este exemplo de um gráfico com suporte para vários idiomas exibido numa wiki em espanhol.

Problemas conhecidos

Veja esta visualização filtrada de phab:tag/charts/.

Types of chart

For all charts, data is expected to be arranged in columns, with the first column representing the x-axis and the following columns representing series on the y-axis.

Line

Raw data

Bar

Raw data

Area

Raw data

Pie

Pie charts are a special chart type, and data sources may require modification to be rendered appropriately.

When reading data, any non-number columns (e.g., the x-axis) will be discarded, and the sum of all rows will be represented on the chart.

For example, where multiple rows depict values for A, B, and C on numerous dates, e.g., January 1st and January 2nd, the pie chart segment for A will represent the sum of all A's row values across those dates.

Raw data

Finding existing charts

Charts that can be used in articles live on Wikimedia Commons and can be tracked using MediaWiki categories.

This query can be used as a proxy to find charts that others have made and contribute translations.

The set of wiki pages that use charts on any particular wiki can be found in the category whose name is defined at MediaWiki:chart-render-category (Category:Pages using the Chart extension on this wiki). Please make sure to connect your wiki categories to d:Q131382738 and d:Q131406605 to make the interwiki search easier.

Migrating from the Graph extension

Please see Category:Pages with disabled graphs for charts that need to be migrated to the Charts extension.

Technical documentation

Given the problems with Extension:Graph , all the decisions regarding the new extension have been carefully considered, with the hope of building trust and confidence in its replacement.

So far, the technical decisions are documented in the code repository in the doc/adr folder.