Manuel - DataMatrix

Introduction

Le code Datamatrix fait partie de la famille des codes-barres en 2D. Il permet d'encoder beaucoup 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. Le niveau d'erreur est choisi automatiquement.
Il est possible de passer en mode ECI avec la fonction setAcceptECI().

Cette classe hérite de la classe BCGBarcode2D.

Exemple

Méthodes

Méthodes de BCGdatamatrix

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 { BCGdatamatrix } from '@barcode-bakery/barcode-datamatrix';

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

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

    // 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

  • 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é.
    Cependant, vous pouvez spécifier une valeur afin d'obtenir un code différent. Voici les valeurs possibles :
    - BCGdatamatrix.DATAMATRIX_SIZE_SMALLEST : Le code sera le plus petit possible
    - BCGdatamatrix.DATAMATRIX_SIZE_SQUARE : Le code sera un carré
    - BCGdatamatrix.DATAMATRIX_SIZE_RECTANGLE : Le code sera un rectangle
    La valeur par défaut est BCGdatamatrix.DATAMATRIX_SIZE_SQUARE.
  • getDatamatrixSize() — Retourne une taille à utiliser pour le code-barres
    Description
    Retourne la taille du Datamatrix.
    Retourne
    int[]
  • setDatamatrixSize(row, col) — Spécifie une taille à utiliser pour le code-barres
    Description
    Barcode Bakery générera le plus petit code-barres basé sur les informations que vous fournissez.
    Si vous souhaitez avoir une taille spécifique, vous pouvez la forcer avec cette méthode.
    Vous devez spécifier une taille valide ou cette méthode génèrera une exception.
    La valeur par défaut est -1.
  • getQuietZone() — Retourne si la zone muette sera dessinée
    Retourne
    bool - true si activé, false autrement
  • setQuietZone(quietZoneSize) — Spécifie de dessiner une zone muette autour du code-barres
    Description
    Retourne si la zone muette sera dessinée.
  • 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
    La valeur par défaut est false.
    Veuillez noter qu'il est possible d'utiliser ~F en tant que premier caractère de vos données, CEPENDANT il est possible que la sélection automatique d'encodage change le sens de votre code-barres en ne commençant pas vos données par un FNC1. C'est pourquoi nous vous recommandons d'utiliser la méthode setFNC1() et d'abandonner le premier caractère ~F de vos données.
  • getAcceptECI() — Retourne si les codes ECI sont acceptés
    Description
    Retourne si les codes ECI sont acceptés.
    Voyez aussi setAcceptECI() pour plus de détails.
    Retourne
    int - valeur en pixel
  • setAcceptECI(accept) — Spécifie d'accepter les codes ECI
    Description
    En mettant true à l'argument de cette méthode, les caractères antislash (ASCII 92 \) seront pris comme des caractères spéciaux. Voici les caractères spéciaux que vous pouvez écrire.
    - \\ : Écrit un simple antislash
    - \xxxxxx : Écrit le caractère ECI xxxxxx avec x pouvant varier de 0 à 9
    La valeur par défaut est false.
  • setStructuredAppend(snum, st, sid) — Spécifie que les données seront dispersées sur plusieurs codes-barres
    Description
    Les données du code Datamatrix 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 spécifie un identifiant à votre groupe de code-barres. Celui-ci doit être un nombre entre 1 et 64516 et il doit rester le même pour chaque code-barres.
    Il est possible d'encoder sur 16 codes-barres différents au maximum.
    Retourne
    bool - true en cas de succès, false en cas d'échec
  • setFNC1(fnc1Type) — Transforme votre code-barres en standard GS1 ou AIM
    Description
    Cette méthode transformera votre code-barres pour accepter les FNC1 pour être au standard GS1 ou au standard AIM.
    BCGdatamatrix.DATAMATRIX_FNC1_NONE : Le code ne suivra aucun standard.
    BCGdatamatrix.DATAMATRIX_FNC1_GS1 : Le code suivra le standard GS1. Séparez les identifiants GS1 par des ~F. N'oubliez pas d'activer setTilde().
    BCGdatamatrix.DATAMATRIX_FNC1_AIM : Le code suivra le standard AIM.
    La valeur par défaut est BCGdatamatrix.DATAMATRIX_FNC1_NONE.
  • getEncoding() — Récupère l'encodage forcé
    Description
    Récupère l'encodage forcé
    Voyez aussi setEncoding() pour plus de détails.
    Retourne
    int - constante définie à setEncoding()
  • setEncoding(encoding) — Spécifie un encodage spécifique
    Description
    Vous pouvez forcer l'encodage à être utilisé pour différentes raisons. Certains lecteurs ne sont pas capables de lire un encodage spécifique, alors vous pouvez forcer le mode ASCII.
    Notez que si vous forcez un encodage, vous n'obtiendrez pas un résultat efficace. De plus, certains caractères ne sont pas représentables dans certains encodages.
    Voyez la page information technique pour de plus amples informations à propos des encodages.
    - BCGdatamatrix.DATAMATRIX_ENCODING_UNKNOWN : Aucun encodage spécifique n'est sélectionné
    - BCGdatamatrix.DATAMATRIX_ENCODING_ASCII : ASCII et ASCII étendu (basse compression)
    - BCGdatamatrix.DATAMATRIX_ENCODING_C40 : Encodage C40 (majuscules)
    - BCGdatamatrix.DATAMATRIX_ENCODING_TEXT : Encodage TEXT (minuscules)
    - BCGdatamatrix.DATAMATRIX_ENCODING_X12 : Encodage X12 (majuscules et chiffres)
    - BCGdatamatrix.DATAMATRIX_ENCODING_EDIFACT : Encodage Edifact
    - BCGdatamatrix.DATAMATRIX_ENCODING_BASE256 : Encodage binaire
    La valeur par défaut est BCGdatamatrix.DATAMATRIX_ENCODING_UNKNOWN.
  • getMacro() — Récupère si le macro est écrit
    Description
    Récupère si le macro est écrit
    Voyez aussi setMacro() pour plus de détails.
    Retourne
    int - constante définie à setMacro()
  • setMacro(macro) — Spécifie de préfixer et de rajouter un suffixe à vos données
    Description
    Le macro a été défini pour permettre de rendre vos données et votre code-barres plus petit. Utilisez cette méthode pour préfixer et ajouter un suffixe à vos données lorsque votre code-barres est lu.
    - BCGdatamatrix.DATAMATRIX_MACRO_NONE : Vos données apparaîtront brutes. Aucun préfixe ni suffixe.
    - BCGdatamatrix.DATAMATRIX_MACRO_05 : Préfixe : [)>RS05GS - Suffixe : RSEoT
    - BCGdatamatrix.DATAMATRIX_MACRO_06 : Préfixe : [)>RS06GS - Suffixe : RSEoT
    La valeur par défaut est BCGdatamatrix.DATAMATRIX_MACRO_NONE.
  • 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.