`$barcode.encode`¶

Description¶

Encode une donnée textuelle sous forme de code barres ou de QR-code

Syntaxe¶

$barcode.encode( text , width , height [ , options ] )

Paramètres¶

text string

Texte à encoder

width number

Largeur de l'image à produire en pixels

height number

Hauteur de l'image à produire en pixels

options map

Options d'encodage. Les options reconnues sont:

format string: Format de code barres ou de qr-code. Les valeurs possibles sont EAN13 (ou EAN_13), UPCA (ou UPC_A), QRCODE (ou QR_CODE), CODE39 (ou CODE_39), CODE128 (ou CODE_128), ITF ou PDF417 (ou PDF_417). Le format par défaut est QRCODE.
type string: Type d'image à fournir en output. Les valeurs possibles de l'option sont png, jpg, svg, text. La valeur par défaut est png. Le type text sert surtout au debug. Il représente le code en texte, avec des espaces et des carrés noirs "█".
out string: Type d'output attendu. Les valeurs de l'option possibles sont file (la méthode retournera un fichier pré-généré dans le dossier de travail) ou text (la méthode retourne le flux de données en résultat - cela peut poser problème dans le cas des types png ou jpg). Par défaut, le format est file
inclProperties boolean: Flag true/false indiquant si la réponse doit inclure les propriétés de l'image générée. Si le flag est activé, la valeur de retour de la méthode sera une map contenant la sortie standard (valeur litérale ou file en fonction du paramètre out) + des propriétés décrivant les dimensions de l'image, le padding, etc. Le flag est par défaut à false.
margin number: Taille de la marge à ajouter (en pixels). La marge par défaut est de 0. À noter qu'une marge variable peut toutefois être appliquée en fonction de la taille du QR-code généré.
correction string: Niveau de codes correcteurs à intégrer au qr-code. Les niveaux supportés sont H (~30% de correction), Q (~25% de correction}, M (~15% de correction) et L (~7% de correction).
charset string: Charset du texte à reprendre dans le qr-code
svgPathOnly boolean: Demande à la méthode de retourner le path svg, sans les entêtes xml (uniquement si le fichier de sortie est un svg)
delPadding boolean: Demande à la méthode d'éliminer le padding (actuellement, uniquement si le fichier de sortie est un svg). L'option est par défaut à true.

Retour¶

La valeur de retour dépend du type d'image demandé dans les paramètres.

Exemple¶

$barcode.encode(str, 256, 256, { type: "svg", out: "text", correction: "M" });

$barcode.encode¶