Manuel - Aztec

Introduction

Le code Aztec fait partie de la famille des codes-barres en 2D. Il permet d'encoder une grande quantité d'information en un seul code-barres.
Tous les caractères ASCII de 0 à 255 sont supportés. La taille du code sera déterminée en fonction du nombre de données entrées ainsi que du niveau d'erreur choisi.
Il est possible de passer en mode ECI avec la fonction setTilde().

Cette classe hérite de la classe BCGBarcode2D.

Exemple

Méthodes

Méthodes de BCGaztec

Méthodes de BCGBarcode2D

Méthodes de BCGBarcode

Exemple de Code

'use strict';

import { createServer } from 'http';
import { BCGColor, BCGDrawing } from '@barcode-bakery/barcode-common';
import { BCGaztec } from '@barcode-bakery/barcode-aztec';

http.createServer(function (request, response) {
    var colorBlack = new BCGColor(0, 0, 0);
    var colorWhite = new BCGColor(255, 255, 255);

    // Barcode Part
    var code = new BCGaztec();
    code.setScale(2); // Resolution
    code.setForegroundColor(colorBlack); // Color of bars
    code.setBackgroundColor(colorWhite); // Color of spaces
    code.parse('Aztec');

    // Drawing Part
    var drawing = new BCGDrawing(code, colorWhite);
    drawing.toBuffer(BCGDrawing.ImageFormat.Png, function (err, buffer) {
        response.writeHead(200, { "Content-Type": "image/png" });
        response.end(buffer);
    });
}).listen(8124);

Explications des Méthodes

  • getErrorLevel() — Retourne le niveau d'erreur du code-barres
    Description
    Le pourcentage de correction d'erreur.
    Retourne
    int - valeur entre 0 et 99
  • setErrorLevel(level) — Fixe le niveau d'erreur du code-barres
    Description
    Le pourcentage de correction d'erreur défini avant de dessiner le code-barres.
    Le niveau donné doit être entre 5 et 99.
    La valeur par défaut est 23.
  • getSize() — Retourne la taille du code-barres
    Description
    Retourne le code pour la taille du code-barres final.
    Voyez aussi setSize() pour plus de détails.
    Retourne
    int - constante définie à setSize()
  • setSize(value) — Fixe la taille du code-barres
    Description
    La taille du code-barres finale sera décidée automatiquement dépendamment du nombre de données que vous avez spécifié ainsi que le pourcentage de correction d'erreur.
    Cependant, vous pouvez spécifier une valeur afin d'obtenir un code différent. Voici les valeurs possibles :
    - BCGaztec.AZTEC_SIZE_SMALLEST : Le code sera le plus petit possible
    - BCGaztec.AZTEC_SIZE_COMPACT : Le code essaiera d'être compact s'il le peut
    - BCGaztec.AZTEC_SIZE_FULL : Le code sera en mode full (avec la grille de référence)
    La valeur par défaut est BCGaztec.AZTEC_SIZE_SMALLEST.
  • setStructuredAppend(snum, st, sname) — Spécifie que les données seront dispersées sur plusieurs codes-barres
    Description
    Les données du code Aztec peuvent être séparées sur plusieurs codes-barres.
    Le premier argument est le numéro du code-barres (commençant par 1), le deuxième argument est le nombre total de codes-barres que vous avez. Le dernier argument est optionnel, il spécifie un identifiant à votre groupe de code-barres. Celui-ci doit rester le même pour chaque code-barres.
    Il est possible d'encoder sur 26 codes-barres différents au maximum.
    Retourne
    bool - true en cas de succès, false en cas d'échec
  • getTilde() — Retourne si le comportement du caractère ~ est modifié
    Description
    Retourne si le comportement du caractère ~ est modifié.
    Voyez aussi setTilde() pour plus de détails.
    Retourne
    bool - true si activé, false autrement
  • setTilde(accept) — Modifie le fonctionnement du caractère tilde ~
    Description
    En mettant true à l'argument de cette méthode, les caractères tilde (ASCII 126 ~) seront pris comme des caractères spéciaux. Voici les caractères spéciaux que vous pouvez écrire.
    - ~~ : Écrit un simple tilde
    - ~F : Écrit le caractère FNC1
    - ~Exxxxxx : Écrit le caractère ECI xxxxxx avec x pouvant varier de 0 à 9
    La valeur par défaut est false.
  • getRune() — Retourne le numéro du Rune qui sera dessiné
    Description
    Retourne le numéro du Rune qui sera dessiné.
    Retourne
    int - numéro du Rune ou false si aucun Rune ne sera dessiné
  • setRune(runeNumber) — Spécifie de dessiner un Rune
    Description
    À l'appel de la fonction draw(), le numéro du Rune runeNumber sera dessiné à l'écran. Les Runes sont des symboles spéciaux.
    Le numéro Rune doit être spécifié entre 0 et 255.
    La valeur par défaut est -1.
  • setScaleX(scaleX) — Spécifie la résolution du codes-barres en X
    Description
    La largeur en pixel d'un module.
    La valeur par défaut est 1.
    Notez que cette méthode est protégée (protected).
  • setScaleY(scaleY) — Spécifie la résolution du codes-barres en Y
    Description
    La hauteur en pixel d'un module.
    La valeur par défaut est 1.
    Notez que cette méthode est protégée (protected).
  • parse(text) — Analyse un message text pour dessiner par la suite
    Description
    Les données que vous passez à l'argument text doivent être supportées par le type de code-barres que vous utilisez.
    Référez-vous à l'introduction de chaque code-barres pour obtenir plus d'informations comment utiliser cette méthode pour chaque type de code-barres.
  • draw(image) — Dessine le code-barres sur l'image image
    Description
    La valeur de l'argument image doit être une image ressource. La taille de l'image peut être définie avec la valeur reçue de getDimension().
  • getDimension(width, height) — Retourne un tableau concernant la taille de l'image requise
    Description
    Retourne un tableau dont le premier index est la largeur de l'image et le deuxième index est la hauteur de l'image.
    Les arguments sont utilisés pour spécifier le point de départ du dessin. Ils devraient être 0.
    La classe BCGDrawing utilise cette fonction pour créer la ressource d'image.
    Retourne
    array(int, int) - [0] étant la largeur, [1] étant la hauteur
  • getScale() — Retourne la résolution du code-barres
    Description
    Retourne la taille du code-barres. La valeur correspond à la "plus petite" unité exprimée en pixel.
    Retourne
    int - valeur en pixels
  • setScale(scale) — Fixe la résolution du code-barres
    Description
    Le code-barres sera x fois plus grand. Un pixel sera alors de taille x par x.
  • getForegroundColor() — Retourne la couleur des barres
    Description
    Retourne la couleur des barres du code-barres.
    Retourne
  • setForegroundColor(color) — Fixe la couleur des barres
    Description
    La couleur des barres du code-barres. Par défaut, la couleur est noire. L'argument peut être soit une classe BCGColor ou n'importe quel autre argument que la classe BCGColor peut accepter à son constructeur.
  • getBackgroundColor() — Retourne la couleur des espaces
    Description
    Retourne la couleur des espaces du code-barres.
    Retourne
  • setBackgroundColor(color) — Fixe la couleur des espaces
    Description
    La couleur des espaces du code-barres. Par défaut, la couleur est blanche. L'argument peut être soit une classe BCGColor ou n'importe quel autre argument que la classe BCGColor peut accepter à son constructeur.
  • setColor(foregroundColor, backgroundColor) — Fixe la couleur des barres et des espaces
    Description
    Une méthode plus rapide pour fixer la couleur de premier plan et de l'arrière-plan. Référez-vous à setForegroundColor() et setBackgroundColor().
  • getOffsetX() — Retourne le décalage en X
    Description
    Retourne le décalage en X en pixel. Cette valeur n'est pas multipliée par la résolution.
    Retourne
    int - valeur en pixels
  • setOffsetX(value) — Spécifie le décalage en X
    Description
    Spécifie le décalage en X du code-barres en pixel multiplié par la résolution. La taille requise retournée par getDimension() sera modifiée en conséquence.
  • getOffsetY() — Retourne le décalage en Y
    Description
    Retourne le décalage en Y en pixel. Cette valeur n'est pas multipliée par la résolution.
    Retourne
    int - valeur en pixels
  • setOffsetY(value) — Spécifie le décalage en Y
    Description
    Spécifie le décalage en Y du code-barres en pixel multiplié par la résolution. La taille requise retournée par getDimension() sera modifiée en conséquence.
  • addLabel(label) — Ajoute un texte qui accompagne le dessin
    Description
    Ajoute un objet BCGLabel au dessin.
  • removeLabel(label) — Supprime un texte qui accompagne le dessin
    Description
    Supprime un objet BCGLabel spécifique du graphique.
  • clearLabels() — Supprime les textes qui accompagnent le dessin
    Description
    Supprime tous les objets BCGLabel du dessin.