Class Graph

La classe Graph permet de générer des graphiques, de les mettre éventuellement en cache et d'afficher le temps de génération de l'image. Il est possible de dessiner plusieurs composants sur une image de type Graph.

Méthodes et propriétés

Documentation

  • const int DRAW_RETURN := 1
    Pour retourner le graphique après du dessin.
    Voir aussi :
  • const int DRAW_DISPLAY := 2
    Pour afficher le graphique après du dessin.
    Voir aussi :
  • protected string $name := NULL
    Nom du graphique. Peut être laissé à NULL pour ne donner aucun nom au graphique.
  • protected int $timeout := 0
    Peut prendre comme valeur 0 pour ne pas utiliser la mise en cache, ou spécifier un timestamp comme date d'expiration de l'image dans le cache.
  • protected bool $timing := FALSE
    Activer l'affichage du temps de génération de l'image ?
  • protected array $labels
    Une liste de Label qui seront affichés sur le graphique.
  • public Label $title
    Permet de donner un titre au graphique.
  • public __construct(int $width := NULL, int $height := NULL, string $name := NULL, string $timeout := 0)
    Construit une image de largeur $width et de hauteur $height au nom $name (ce nom peut être laissé à NULL) et qui expirera dans le cache au timestamp $timeout. Si vous ne souhaitez pas utiliser le cache, vous pouvez laisser ce timestamp à 0. $name ne représente pas le titre du graphique, c'est uniquement un moyen d'identification pour le cache.
  • public bool deleteFromCache(string $name)
    Supprime manuellement l'image au nom $name du cache. Cette méthode retourne TRUE si une image a été effectivement supprimée, FALSE sinon.
  • public deleteAllCache()
    Supprime toutes les images mises en cache par Artichow.
  • public setTiming(bool $timing)
    Active/désactive l'affichage du temps de génération de l'image sur l'image elle-même.
  • public add(Component $component)
    Ajoute un composant à dessiner sur l'image.
  • public addLabel(Label $label, int $x, int $y)
    Ajoute une étiquette $label aux positions $x et $y. Les nouvelles positions $x et $y représentent une fraction des largeur et hauteur du graphique.
  • public addAbsLabel(Label $label, Point $point)
    Ajoute une étiquette $label en position absolue sur le graphique aux coordonnées X et Y spécifiées par le point $point. Le point (0, 0) se situe sur le coin haut-gauche du graphique.
  • public mixed draw(string $mode := Graph::DRAW_DISPLAY)
    Créé et affiche l'image à l'utilisateur. Tous les composants précédemment ajoutés avec add() sont dessinés sur l'image. Cette méthode appelle successivement create(), drawComponent() autant de fois que de composants ont été ajoutés et send().
    • string $mode := Graph::DRAW_DISPLAY
      • Disponible depuis Artichow 1.0.8
    • string $file := NULL
      • Supprimé à partir d'Artichow 1.0.8
      Si vous souhaitez enregistrer l'image dans un fichier plutôt qu'à l'écran, indiquez un nom de fichier destination pour le paramètre $file. Ce paramètre est optionnel, et si il n'est pas rempli, alors l'image sera affichée à l'écran.