Documentation

- | ## Class Axis La classe Axis permet de manipuler des axes. Un axe permet à un utilisateur de répérer les points et leurs valeurs sur un graphique. De nombreuses méthodes de la classe Axis ne sont pas documentées, car elles ne sont utilisées qu'en interne par Artichow. Néanmoins, si vous développez Artichow, vous aurez besoin de ces méthodes. N'hésitez donc pas à parcourir le code source de cette classe. Retourner voir la liste de toutes les classes ## Méthodes et propriétés public Label $title public Label $label public Line $line protected bool $auto public __construct(float $min, float $max) public auto(bool $auto) public true isAuto() public hide(bool $hide := TRUE) public addTick(string $name, Tick $tick) public Tick tick(string $name) public deleteTick(string $name) public hideTicks(bool $hide := TRUE) public setTickStyle(int $style) public reverseTickStyle() public setTickInterval(int $interval) public setNumberByTick(string $to, string $from, float $number) public setLabelInterval(int $interval) public setLabelNumber(int $number) public int getLabelNumber() public setLabelPrecision(int $precision) public setLabelText(array $texts) public setTitleAlignment(int $alignment) public setTitlePosition(float $postion) public setColor(Color $color) public setPadding(int $left, int $right) public Side getPadding() ## Documentation public Label $title Représente le titre de l'axe. Remonter public Label $label Représente les étiquettes qui portent les valeurs affichées sur l'axe. Remonter public Line $line Représente la ligne de l'axe. Vous pouvez modifier le style et l'épaisseur de cette ligne, pas ses coordonnées. Remonter protected bool $auto Précise si la gestion de l'axe doit être automatique ou non. Remonter public __construct(float $min, float $max) Déclare un nouvel axe. Les variables $min et $max représentent respectivement la valeurs minimales et maximales associées à l'axe. Par exemple, choisir $min = -12 et $max = 42 signifie tout simplement que l'axe ira de -12 à 42. Remonter public auto(bool $auto) Active/désactive la gestion automatique de l'axe. La gestion automatique est automatiquement désactivée en cas d'appel aux méthodes suivantes : Axis::setLabelNumber(), Axis::setLabelInterval(), Axis::setLabelPrecision() et Axis::setLabelText(). Lorsqu'un axe est sous gestion automatique, l'échelle est le nombre de valeurs à afficher sur l'axe sont automatiquement calculés. Remonter public true isAuto() Retourne TRUE si l'axe est gérée automatiquement, FALSE sinon. Remonter public hide(bool $hide := TRUE) Cache ou non l'axe. Le paramètre $hide est par défaut à TRUE (ce qui signifie que l'axe ne sera pas dessiné). S'il est mis à FALSE, l'axe sera dessiné. Remonter public addTick(string $name, Tick $tick) Associe un objet Tick $tick à l'axe. Cet objet sera reconnu par le nom $name au sein de la classe Axis. Remonter public Tick tick(string $name) Récupère un objet Tick en fonction de son nom. Cet objet doit avoir été précédemment ajouté avec la méthode Axis::addTick(). Remonter public deleteTick(string $name) Supprime l'objet Tick de nom $name associé à l'axe. Pour pouvoir être supprimé, cet objet doit avoir été précédemment ajouté avec la méthode Axis::addTick(). Remonter public hideTicks(bool $hide := TRUE) Cache ou non tous les ticks qui ont été associés à cet axe. Voir aussi : Axis::addTick() Remonter public setTickStyle(int $style) Change le style de tous les ticks associés à l'axe pour $style. Voir aussi : Tick::setStyle() Remonter public reverseTickStyle() Inverse le style de tous les ticks associés à l'axe pour $style. Si les ticks étaient tournés vers l'extérieur, ils seront désormais tournés vers l'intérieur. Et vice-versa. Voir aussi : Tick::setStyle() Remonter public setTickInterval(int $interval) Change l'intervalle d'affichage de tous les ticks associés à l'axe pour $interval. Cette méthode permet d'espacer l'affichage des ticks par rapport aux valeurs de l'axe. Voir aussi : Tick::setStyle() Remonter public setNumberByTick(string $to, string $from, float $number) Cette méthode permet de modifier la fréquence d'affichage d'un objet Tick par rapport à un autre. $to représente l'objet dont la fréquence d'affichage doit être modifiée et $from l'objet auquel on se réfère. A chaque fois qu'un tick $from sera affiché, on affichera $number ticks $to. Si $number vaut 2, cela signifie que deux ticks $to seront affichés pour un tick $from. Cette méthode prend tout son sens donc le cadre des Plot par exemple :
      <?php

      require_once 'LinePlot.class.php';

      $graph = new Graph(400, 400);

      $plot = new LinePlot(array(1, 2, 3));

      // Pour chaque tick major affiché,
      // on affichera 10 ticks minor
      $plot->xAxis->setNumberByTick('minor', 'major', 10);

      $graph->add($plot);
      $graph->draw();

      ?>
Cela donne 10 ticks mineurs par tick majeur : Remonter public setLabelInterval(int $interval) Change l'intervalle d'affichage des étiquettes sur l'axe pour $interval. Par défaut, cet intervalle est égal à 1. Remonter public setLabelNumber(int $number) Change le nombre d'étiquettes à afficher sur l'axe pour $number. Remonter public int getLabelNumber() Retourne le nombre d'étiquettes qui seront affichées sur l'axe. Remonter public setLabelPrecision(int $precision) Change la précision des valeurs affichées sur chaque étiquette de l'axe. $number représente le nombre de chiffres après la virgule qui doivent être affiché. Par défaut, $precision vaut 0. Voir aussi : Axis::setLabelText() Label::setCallbackFunction() Remonter public setLabelText(array $texts) Cette méthode permet d'afficher des valeurs arbitraires plutôt que des valeurs numériques sur les étiquettes de l'axe. $texts est un tableau comportant autant d'entrées que d'étiquettes et qui contient les nouvelles valeurs à afficher. Voir aussi : Axis::setLabelPrecision() Label::setCallbackFunction() Remonter public setTitleAlignment(int $alignment) Change l'alignement du titre de l'axe sur l'axe. Les valeurs possibles sont Label::LEFT, Label::RIGHT, Label::TOP et Label::BOTTOM. Remonter public setTitlePosition(float $postion) Change la position du titre sur l'axe. $position est une fraction de la taille de l'axe. Par exemple, si $position est placé à 0.5, le titre sera affiché au milieu de l'axe. Si $position vaut 0.25, alors le titre sera affiché sur le premier quart de l'axe. Pour aligner le titre par rapport à cette position, utilisez la méthode Axis::setTitleAlignment(). Voir aussi : Axis::setTitleAlignment() Remonter public setColor(Color $color) Change la couleur de l'axe et de son titre pour $color. Remonter public setPadding(int $left, int $right) Change l'espace interne à gauche et à droite de l'axe. Gauche et droite n'ont de sens que pour les axes verticaux. Pour les axes plus horizontaux, préférez haut à gauche et bas à droite. Remonter public Side getPadding() Retourne l'espace interne associé à l'axe. Remonter |