Module:Graph/doc

Uit Wiki Raamsdonks Erfgoed

Dit is de documentatiepagina voor Module:Graph

Module with helper functions for the Graph extension to display graphs and maps. From de:Modul:Graph.

Functions for templates

chart

Creates a JSON object for <graph> to display charts. In the article namespace the template {{GraphChart}} should be used instead. See its page for use cases.

Parameters:

colors
kleurenpallet van de grafiek, een lijst van kleuren door komma's gescheiden. De kleuren kunnen zijn: #rgb/#rrggbb/#aarrggbb of een Engelse CSS kleurennaam. Bij #aarrggbb geeft de aa het alpha channel aan, bijvoorbeeld FF=100% doorzichtig, 80=50% doorzichtig, etc.
hAnnotatonsLabel
toon horizontale annotatielabels bij annotatielijnen, bijvoorbeeld hAnnotatonsLabel = label1, label2, label3
hAnnotatonsLine
toon horizontale annotatielijnen bij specifieke waarden, bijvoorbeeld hAnnotatonsLine=4, 5, 6
height
hoogte van de grafiek in pixels, bij de meeste grafieken de hoogte van de Y-as
innerRadius
Alleen geldig voor een taartdiagram, de binnenste straal in pixels om een donut diagram te maken.
interpolate
Interpolatie methode voor lijn- en vlakdiagrammen. monotone is aanbevolen voor een monotone cubic interpolation. Op https://github.com/nyurik/vega/wiki/Marks#line staan de andere ondersteunde interpolatiemethoden.
legend
Toon legenda/legende. Dit werkt alleen bij meerdere datareeksen.
linewidth
Voor een lijndiagram: de dikte van de lijnen, een lijndikte van 0 resulteert in een spreidingsdiagram. Voor een taartdiagram: de ruimte tussen de taartpunten.
linewidths
Voor verschillende lijndiktes per datareeks. Een lijndikte van 0 in combinatie met "showSymbols" laat die lijn weg, toont slechts de punten, bijvoorbeeld linewidths=1, 0, 5, 0.2
showSymbols
voor lijngrafieken: toon een symbool op data punten. Een getal geeft de symboolgrootte aan in pixels, bijvoorbeeld showSymbols=3. showSymbols= geeft punten met een standaardgrootte van 2.5 pixel. Verschillende groottes zijn mogelijk per datareeks: showSymbols=1, 2, 3, 4
showValues
Voor een taartdiagram en een ongestapeld staafdiagram: Toon y waarden als tekst in de grafiek. De volgende parameters, gescheiden door komma's, definiëren hoe de tekst er uit ziet, bijvoorbeeld showValues = fontcolor:silver, fontsize:10, offset:10.
symbolsNoFill
symbolsNoFill = vul het symbool niet, tekent alleen de omtrek.
symbolsShape
de vorm van het symbool, mogelijke waarden: circle, x, square, cross, diamond, triangle_up, triangle_down, triangle_right, triangle_left. Elke data reeks kan een eigen symbool krijgen, gebruik door komma's gescheiden waarden, bijvoorbeeld: symbolsShape= circle, cross, square
symbolsStroke
Voor "x" symbol en "symbolsNoFill": de dikte van de lijn in pixels, standaard waarde is 2.5.
type
het soort diagram:
vAnnotatonsLabel
toon verticale annotatielabels bij annotatielijnen, bijvoorbeeld vAnnotatonsLabel = label1, label2, label3
vAnnotatonsLine
toon verticale annotatielijnen bij specifieke waardes, bijvoorbeeld vAnnotatonsLine=4, 5, 6
width
breedte van de grafiek in pixels, bij de meeste grafieken de lengte van de x-as


x
de x-waarden, gescheiden door komma's, x=a,b,c
xAxisAngle
draaiing van de x-as labels in graden, aanbevolen waarden: -45, +45, -90, +90
xAxisFormat
Formatteer de labels op de x-as.
Voor de formattering van numerieken zie https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#numbers, bijvoorbeeld
  • xAxisFormat=% voor percentages, -0.1=-10%, 0=0%, .25=25%, 1=100%, 1.5=150%. xAxisFormat=.1% geeft percentages met 1 cijfer achter de 'komma'.
  • xAxisFormat=03 alles 3 lang, met voorloopnullen
  • xAxisFormat=.2f 2 cijfers achter de 'komma'
  • xAxisFormat=d geheel getal
Noot: Het is nog niet mogelijk om getallen 'Europees' te formatteren als 583.231.475.923,00
Zie https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md voor datum/tijd.
xAxisMin, xAxisMax
voor lijn, spreidings en vlakdiagrammen: minimum en maximum waarden van de x-as. Met deze parameters kan x-as gespiegeld worden door min en max om te draaien. Zet de Max op de laagste waarde, de min op de hoogste.
xAxisTitle
Beschrijving van de variabele op de x-as
xGrid
toon verticale rasterlijnen voor x-as waarden.
xScaleType
het soort van schaal van de x-as.
xType
datatype van x-as waarden.


y
De y waarden van een enkele datareeks, gescheiden door komma's, bijvoorbeeld y=1,2,4,9
y1, y2, …
de y-waarden van meerdere datareeksen, bijvoorbeeld y1=1,2,4,9, y2=1,8,32,27. Bij een taartdiagram geeft y2 de straal van de taartpunten.
yAxisFormat
formatteer de labels op de y-as, de toegestane waarden zijn hetzelfde als bij xAxisFormat.
yAxisMin, and yAxisMax
voor lijn, spreidings en vlakdiagrammen: minimum en maximum waarden van de y-as. Met deze parameters kan y-as ondersteboven gezet worden door min en max om te draaien. Zet de Max op de laagste waarde, de min op de hoogste.
yAxisTitle
beschrijving van de variabele op de y-as
yGrid
toon horizontale rasterlijnen voor y-as waarden.
yScaleType
het soort van schaal op de y-as. Zie xScaleType voor mogelijke schalen.
yType
data type van y-as waarden,
y1Title, y2Title, …
beschrijving van de datareeksen in de legenda/legende.
formatjson
format JSON object for better legibility

Template wrappers

The functions mapWrapper and chartWrapper are wrappers to pass all parameters of the calling template to the respective map and chart functions.

Opmerking: In de voorvertoning bij het bewerken is de grafiek een canvas element, een Vectorafbeelding. Echter, na publiceren van de pagina wordt de grafiek een PNG bestand. {{#invoke:Graph|function_wrapper_name}}