Quelltext der Seite Mitglieder:Lua/Modul/Graph/de

{{LuaModuleDoc}}

<onlyinclude>
{{#if:{{{1|}}}||Modul mit Hilfsfunktionen für die [[Hilfe:Graph|Graph]]-Erweiterung.

== Funktionen für Vorlagen ==
=== <span style="font-family:monospace; font-size:1.3em;">map</span> ===
Erstellt ein JSON-Objekt für <code><nowiki><graph></nowiki></code> zur Darstellung einer politischen Karte mit farbigen Markierungen. Im Artikelnamensraum sollte die Vorlage {{Vorlage|Graph:Map}} genutzt werden. Siehe dort auch für Anwendungsbeispiele.

Karten finden sich unter [[Spezial:Präfixindex/Modul:Graph/]] (beispielsweise [[Modul:Graph/WorldMap-iso2.json|WorldMap-iso2.json]] mit allen Staatsgrenzen) und weitere sollten, daher ebenfalls unter Modul:Graph/ angelegt werden.

'''Parameter:'''
}}{{#ifeq:{{{1|map}}}|map|
* '''basemap:''' gibt an, welche Basiskarte verwendet werden soll. Die Kartendefinition muss im [https://github.com/mbostock/topojson/wiki TopoJSON]-Format erfolgen, dann auf Wikipedia abgelegt werden, wo sie fortan zur Verfügung für dieses Modul steht. Karten im Standardverzeichnis [[Spezial:Präfixindex/Modul:Graph/]] wie [[Modul:Graph/WorldMap-iso2.json|WorldMap-iso2.json]] sollten nur mit ihrem Namen referenziert und der Präfix „Modul:Graph/“ der Portierbarkeit wegen weggelassen werden. Daneben werden auch URLs akzeptiert, z.&nbsp;B. wenn Karten von anderen Wikipedia-Sprachversionen genutzt werden sollen (die Angabe sollte hierbei als <code>//en.wikipedia.org/w/index.php?title=''Mapname''&action=raw</code> erfolgen, d.&nbsp;h. protokollrelativ ohne http/s am Anfang und mit action=raw, um ausschließlich den Seiteninhalt zuzurückzugeben). URLs auf Karten von externen Websites sollten aus Gründen der Stabilität, Performanz und Sicherheit nicht genutzt werden bzw. würden von der Software oder dem Browser vermutlich geblockt werden.
* '''scale:''' Skalierungsfaktor der Karte (Standard: 100)
* '''projection:''' Methode der [[Kartenprojektion]]. Mögliche Werte dafür siehe unter https://github.com/mbostock/d3/wiki/Geo-Projections. Der Standardwert ist <code>equirectangular</code> für eine [[Rektangularprojektion]] (Plattkarte).
* '''IDs der geografischen Objekte:''' Diese Parameter hängen von der genutzten Basiskarte ab. In der vorher genannten Beispielkarte sind dies zweistellige [[ISO-Ländercode]]s (bei dieser ist jedoch zu beachten, dass für Gebiete, die nicht von der ISO-3166-1 abgedeckt sind, folgende IDs zu verwenden sind: "KOSOVO", "NORTHERN_CYPRUS", "SOMALILAND"). Der Wert kann entweder eine Farbangabe sein oder eine Zahl, falls den einzelnen geografischen Objekten Daten zugeordnet werden sollen: <code>DE=lightblue</code> würde auf der Karte Deutschland hellblau färben, <code>DE=80.6</code> würde Deutschland den Wert 80.6 (hier die Bevölkerungszahl in Millionen) zuordnen. Die konkrete Färbung ergibt sich dann aus den folgenden Parametern.
** '''colorScale:''' zu verwendende Farbpalette. Das Format ist eine kommagetrennte Liste von Farbwerten. Die Farbwerte müssen entweder im Format <code>#rgb</code>/<code>#rrggbb</code> oder mit einem [[Webfarbe#Benannte Farben|CSS-Farbnamen]] erfolgen. Statt einer Liste können auch die eingebauten Farbpaletten [https://github.com/mbostock/d3/wiki/Ordinal-Scales#categorical-colors <span style="font-family:monospace; font-size:1.3em;">category10</span> und <span style="font-family:monospace; font-size:1.3em;">category20</span>] genutzt werden.
** '''scaleType:''' mögliche Werte <code>linear</code> für eine lineare Abbildung zwischen den Datenwerten und der Farbskala, <code>log</code> für eine logarithmische, <code>pow</code> für eine exponentielle (der Exponent kann dahintergesetzt werden, z.&nbsp;B. <code>pow 0.5</code>), <code>sqrt</code> und <code>quantize</code> für eine quantisierte Skala, d.&nbsp;h. die Werte werden in so viele Klassen eingeteilt, wie die Palette Farben hat, und diese dann genutzt.
** '''domainMin:''' Skalenminimum, d. h. Datenwerte unter dem Minimum werden diesem zugeordnet
** '''domainMax:''' Skalenmaximum, d. h. Datenwerte über dem Maximum werden diesem zugeordnet
** '''legend:''' Farblegende anzeigen (funktioniert nicht bei <code>quantize</code>)
* '''defaultValue:''' Standardwert für unmarkierte geografische Objekte. Wenn die Datenwerte Farben sind, ist der Standandwert <code>silver</code>, bei Zahlen 0.
}}{{#if:{{{1|}}}||
* '''formatjson:''' JSON-Objekt für bessere Lesbarkeit formatieren

=== <span style="font-family:monospace; font-size:1.3em;">chart</span> ===
Erstellt ein JSON-Objekt für <code><nowiki><graph></nowiki></code> zur Darstellung von Diagrammen. Im Artikelnamensraum sollte die Vorlage {{Vorlage|Graph:Chart}} genutzt werden. Siehe dort auch für Anwendungsbeispiele.

'''Parameter:'''
}}{{#ifeq:{{{1|chart}}}|chart|
* '''width:''' Breite des Diagramms
* '''height:''' Höhe des Diagramms
* '''type:''' Diagrammtyp: <code>line</code> für [[Liniendiagramm]]e, <code>area</code> für [[Flächendiagramm]]e, <code>rect</code> für [[Säulendiagramm]]e und <code>pie</code> für [[Kreisdiagramm]]e (Tortendiagramme). Mit dem Präfix <code>stacked</code> (z.&nbsp;B. <code>stackedarea</code>) können mehrere Serien gestapelt werden.
* '''interpolate:''' [[Interpolation (Mathematik)|Interpolations]]-Methode für Linien- und Flächendiagramme. Empfohlen ist <code>monotone</code> – weitere Werte lassen sich https://github.com/vega/vega/wiki/Marks#area entnehmen.
* '''colors:''' Farbpalette des Diagramms als kommagetrennte Liste von Farbwerten. Farbwerte werden im Format <code>#rgb</code>/<code>#rrggbb</code>/<code>#aarrggbb</code> oder mit einem [[Webfarbe#Benannte Farben|CSS-Farbnamen]] angegeben. Bei <code>#aarrggbb</code> bezeichnet <code>aa</code> den [[Alphakanal]], d.&nbsp;h. FF=100% Deckkraft, 80=50% Deckkraft/halbdurchsichtig, usw. (Die Standardpalette ist [https://github.com/mbostock/d3/wiki/Ordinal-Scales#categorical-colors <span style="font-family:monospace; font-size:1.3em;">category10.</span>])
* '''xAxisTitle''' und '''yAxisTitle:''' Beschriftung der X- und Y-Achse
* '''xAxisMin, xAxisMax, yAxisMin''' und '''yAxisMax:''' ändert den Start- und Endwert der X- bzw. Y-Achse
* '''xAxisFormat''' und '''yAxisFormat:''' ändert die Formatierungen der Achsenbezeichnungen. Um beispielsweise Prozentzahlen auszugeben kann das Format <code>%</code> genutzt werden (https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#numbers für Zahlen und https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md für Zeitangaben).
* '''xAxisAngle:''' Dreht die x-Achsenbezeichnungen um den angegebenen Winkel. Sinnvolle Werte sind: -45, +45, -90, +90
* '''xType''' und '''yType:''' Datentypen der Werte, z. B. <code>integer</code> für Ganzzahlen, <code>number</code> für reelle Zahlen, <code>date</code> für Datumsangaben (z.&nbsp;B. im Format <code>JJJJ/MM/TT</code>) und <code>string</code> für beliebige Ordinalwerte.
* '''x:''' X-Werte als kommagetrennte Liste
* '''y''' bzw. '''y1, y2,''' …: Y-Werte von einer bzw. mehreren Datenreihen. Bei Kreisdiagrammen gibt <code>y2</code> die Radien der entsprechenden Kreisstücke an.
* '''legend:''' Legende mit angegebenen Legendentitel anzeigen (funktioniert nur bei mehreren Datenreihen)
* '''y1Title, y2Title,''' …: Bezeichnung der jeweiligen Datenreihe in der Legende
* '''linewidth:''' Liniendicke bei Liniendiagrammen bzw. Abstand zwischen den Kreisstücken bei Kreisdiagrammen
* '''showValues:''' gibt die Y-Werte zusätzlich als Text aus. (Wird momentan nur von (nicht gestapelten) Säulen- und Kreisdiagrammen unterstützt.) Die Ausgabe kann über folgende Parameter konfiguriert werden die angegeben werden als <code>Name1:Wert1, Name2:Wert2</code>:
** '''format:''' formatiert die Werteausgabe gemäß https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#numbers für Zahlen und https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md für Zeitangaben
** '''fontcolor:''' Textfarbe
** '''fontsize:''' Textgröße
** '''offset:''' verschiebt den Text gemäß dem angegebenen Offset. Bei Säulen- und Kreisdiagramme (mit <code>midangle</code>-Winkelwert) gibt dies auch an, ob der Text inner- oder außerhalb der Diagrammgrafiken geschrieben wird.
** '''angle''' (nur Kreisdiagramme): Winkel in Grad oder <code>midangle</code> (Standard) für dynamischen Winkel basierend auf dem Winkel des Kreisstücks.
* '''innerRadius:''' innerer Radius, um aus einem Kreisdiagramm ein ''Ringdiagramm'' zu erzeugen.
}}{{#if:{{{1|}}}||
* '''formatjson:''' JSON-Objekt für bessere Lesbarkeit formatieren

=== Vorlagenwrapper ===
Die Funktionen <code>mapWrapper</code> und <code>chartWrapper</code> dienen lediglich dazu, alle Parameter einer aufrufenden Vorlage an die entsprechenden Funktionen <code>map</code> und <code>chart</code> durchzureichen, so dass die Vorlage selbst keine Parameterzuordnung vornehmen muss.
}}

'''Hinweis:''' In der Vorschau erzeugt die Graph-Funktion ein [[Canvas (HTML-Element)|Canvas]]-Element mit einer Vektorgrafik. Beim Abspeichern wird daraus jedoch eine [[Portable Network Graphics|PNG]]-Datei erzeugt.
<includeonly>{{Kasten|1=
<!-- * Zur Dokumentation siehe oben den Link „Deutsch“. -->
* Der nachstehende Abschnitt wird automatisch in jede Dokumentation zur Vorlagenprogrammierung eingebunden.
}}</includeonly></onlyinclude>