Het Grafiekmodel

Structuur

Het grafiekmodel definieert grafieken en diagramment. De grafieken zijn gebaseerd op Google Charts.

Een grafiekmodel met 1 grafiek ziet er als volgt uit:

<grafiekModel>
<grafiekgroep>
<grafiek>
<title>Titel van de grafiek</title>
<query>SQL-query van de data</query>
<filter>Optioneel filter</filter>
<type>Type grafiek, bijvoorbeeld ColumnChart (kolommen) of PieChart (taart)</type>
<total>boom|bomen</total>
<options>Titel van de grafiek</options>
<explanation>Optioneel een uitleg van de grafiek</explanation>
<source><![CDATA[Bron gegevens: <a href="https://data.gemeente.nl/" target="_new">Gemeente</a>]]></source>
</grafiek>
</grafiekgroep>
</grafiekModel>
 

Grafiekmodel

Het root-element in het model is <grafiekModel>,  voor kaartserver zijn voor het root-element geen specifieke attributen noodzakelijk..

 

Grafiekgroep

Op het tweede niveau staan <grafiekgroep>-elementen. Een grafiekgroep kent volgende subelementen:

<title> verplicht Titel van de grafiekgroep.
<display> optioneel Mogelijke waarden zijn 'visible' voor tonen en 'hidden' voor verbergen van de groep.
<model> optioneel Als hier de naam van het inspectiemodel staat, dan wordt groep alleen maar voor betreffend model getoond.
<deny> optioneel Een komma-gescheiden lijst met gebruikers of groepen (zie hieronder) die geen toegang tot deze grafiekgroep hebben. Een '*' geeft aan dat niemand toegang heeft.
<allow> optioneel Een komma-gescheiden lijst met gebruikers of groepen (zie hieronder) die toegang tot deze grafiekgroep hebben.  Een '*' geeft aan dat iedereen toegang heeft. 
Allow heeft voorrang op deny. Normaliter zal je dus eerst iedereen (of een groep) toegang met deny ontzeggen, om vervolgens met allow specifieke personen wél toegang te verlenen.

  

Grafiek

Op het derde niveau staan <grafiek>-elementen. Een grafiek kent volgende subelementen:

<title> verplicht Titel van de grafiek.
<display> optioneel Mogelijke waarden zijn 'visible' voor tonen en 'hidden' voor verbergen.
<model> optioneel Als hier de naam van het inspectiemodel staat, dan wordt grafiek alleen maar voor betreffend model getoond.
<deny> optioneel Een komma-gescheiden lijst met gebruikers of groepen (zie hieronder) die geen toegang tot deze grafiek hebben. Een '*' geeft aan dat niemand toegang heeft.
<allow> optioneel Een komma-gescheiden lijst met gebruikers of groepen (zie hieronder) die toegang tot deze grafiek hebben.  Een '*' geeft aan dat iedereen toegang heeft. 
Allow heeft voorrang op deny. Normaliter zal je dus eerst iedereen (of een groep) toegang met deny ontzeggen, om vervolgens met allow specifieke personen wél toegang te verlenen.
<query> verplicht SQL data query waarmee grafiek wordt gevuld.
<filter> optioneel Combinatie van een where-statement en SQL-query voor een filter. Bijvoorbeeld 'wijk = (select omschrijving from wijk)'. Het dropdown-menu wordt gevuld met de waarden uit 'select omschrijving from wijk'. In de data query wordt het laatste 'where' statement hierop aangevuld.
<type> verplicht

Type grafiek (zie voor voorbeeld Google Chart documentatie).

PieChart Taartdiagram.
ColumnChart Grafiek met verticale kolommen.
BarChart Grafiek met horizontale kolommen.
LineChart Lijndiagram.
ScatterChart Spreidingsdiagram
AreaChart Vlakdiagram.
SteppedAreaChart Vlakdiagram getrapt.
Timeline Tijdlijn. Tabel moet achtereenvolgens uit een waarde, een startdatum en een einddatum bestaan.
<total> optioneel Geeft achter de titel van de grafiek een totaal weer, in een eenheid zoals hier is opgegeven. Optioneel kan hiervoor met het scheidingsteken '|' een enkelvoud- en een meervoudsvorm worden meegegeven. Bijvoorbeeld 'boom|bomen'.
<options> optioneel

Extra opties om een grafiek verder vorm te geven. Gebruik om meerdere opties mee te geven een komma. Raadpleeg voor meer mogelijkheden Google Chart documentatie.

Titel horizontale as hAxis: {title: 'oppervlakte (m2)'}
Titel verticale as vAxis: {title: 'aantal bomen'}
Verberg legenda legend: {position: 'none'}
colors: ['red', 'lime', 'blue'] Definieert kleuren van de grafiek
pieHole: 0.4 Definieert een gat in een taartdiagram
isStacked: true Bij een meer-dimensionale grafiek wordt de grafiek getrapt weergegeven.
is3D: true Maakt van een PieChart een 3D DonutChard
isColumnvalue: true Plaatst in ColumnChart of BarChart het totaal in de kolom.
trendlines: { 0: {type: 'exponential'} } Teken in een spreidingsdiagram een trendlijn, type kan ook linear zijn.
<explanation> optioneel

Een toelichting die onder de grafiek staat.
<source> optioneel

Een eventuele bronvermelding van de gegevens.

 

Gereserveerde tekens

In xml mogen bepaalde tekens niet gebruikt worden. Hiervoor zijn volgende vervangingen beschikbaar:
 
> (groter dan) &gt;
< (kleiner dan) &lt;
& (ampersand) &amp;
' (apostrof) &apos;
" (aanhalingsteken) &quot;

 

In XML kunnen niet toegestane tekens ook als zogenaamde CDATA met tag <![CDATA[...]]> opgenomen worden. Bijvoorbeeld:

<![CDATA[Door het gebruik van een CDATA-tag zijn tekens als '<', '>' en '&' toegestaan]]>