summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/sparkline.mdwn
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2010-10-14 13:38:35 +0200
committerJonas Smedegaard <dr@jones.dk>2010-10-14 13:38:35 +0200
commitdef01959f8b76178d393a39ecd2c5af9be20b31f (patch)
treeed9b5b062671c30e55fe691625fc7ddcb31fee1f /ikiwiki/directive/sparkline.mdwn
Sync with ikiwiki 3.20100926.HEADmasterikiwiki
Diffstat (limited to 'ikiwiki/directive/sparkline.mdwn')
-rw-r--r--ikiwiki/directive/sparkline.mdwn58
1 files changed, 58 insertions, 0 deletions
diff --git a/ikiwiki/directive/sparkline.mdwn b/ikiwiki/directive/sparkline.mdwn
new file mode 100644
index 0000000..a6edb6a
--- /dev/null
+++ b/ikiwiki/directive/sparkline.mdwn
@@ -0,0 +1,58 @@
+La directive `sparkline` est fournie par le module d'extension [[!iki
+plugins/sparkline desc=sparkline]].
+
+Cette directive permet d'embarquer des lignes-étincelles (*sparklines*) ou
+mini graphiques dans les pages d'un wiki. Une ligne-étincelle est un mini
+graphique, simple et proche d'un mot, affichable au fil du texte.
+
+# Exemples
+
+ \[[!sparkline 1 3 5 -3 10 0 width=40 height=16
+ featurepoint="4,-3,red,3" featurepoint="5,10,green,3"]]
+
+Cet exemple affiche un mini graphique de plusieurs points. Sa largeur est de
+40 pixels et sa hauteur, 16 pixels. Le *haut* est désigné par un point vert
+et le *bas* par un point rouge.
+
+ \[[!sparkline 1 -1(red) 1 -1(red) 1 1 1 -1(red) -1(red) style=bar barwidth=2
+ barspacing=1 height=13]]
+
+Cet exemple plus complexe engendre un histogramme. La largeur des barres est
+de 2 pixels avec une séparation de 1 pixel et la hauteur du graphique est de
+13 pixels. La largeur de l'histogramme est déterminée automatiquement. Les
+points dont la valeur est négative sont en rouge, au lieu de noir, valeur
+par défaut.
+
+# Usage
+
+Le format des points de données est "x,y" ou simplement "y" si la valeur "x"
+n'importe pas. On peut aussi ajouter un paramètre "(color)" pour spécifier
+la couleur d'une barre.
+
+Les paramètres suivants sont reconnus. La plupart d'entre eux sont les mêmes
+que ceux de la bibliothèque sparkline sous-jacente et sont documentés avec
+plus de précisions dans [son wiki](http://sparkline.wikispaces.com/usage).
+
+* `style` - soit "line" (valeur par défaut) ou "bar".
+* `width` - largeur du graphique en pixels. Nécessaire seulement pour les
+ graphiques ligne.
+* `height` - Hauteur du graphique en pixels. La valeur par défaut est 16.
+* `barwidth` - Largeur des barres dans un histogramme. La valeur par défaut
+ est 1 pixel.
+* `barspacing` - Espacement entre les barres dans un histogramme. La valeur
+ par défaut est 1 pixel.
+* `ymin`, `ymax` - Valeurs minimum et maximum pour l'axe des Y. Elles sont
+ normalement calculées automatiquement mais on peut vouloir les préciser
+ pour obtenir les mêmes valeurs pour plusieurs graphiques apparentés.
+* `featurepoint` - Ajoute un cercle sur un graphique ligne, avec un texte
+ facultatif. On peut ainsi mettre en évidence certains points
+ significatifs.
+
+ La valeur est une liste de paramètres, séparés par des virgules, spécifiant
+ le point à cercler : valeur X, valeur Y, couleur, diamètre du cercle, texte (facultatif),
+ et position du texte (facultatif). Exemple : `featurepoint="3,5,blue,3"`.
+
+ Les valeurs disponibles pour la position du texte sont : "top", "right", "bottom"
+ et "left".
+
+[[!meta robots="noindex, follow"]]