Skip to content

Token syntax

yurislav edited this page Oct 13, 2022 · 2 revisions

Formátovanie textu

  1. Zoznam podporovaných tokenov
  2. Syntax
    1. text token
    2. barcode token
    3. logo token
    4. qr token
    5. pageBreak token

Niektoré premenné okrem bežného textu podporujú aj vkladanie blokov, ktoré sú v závislosti od typu bloku dynamicky nahrádzané.

Ide napríklad o:

  • dodatočný popis položky dokladu (receiptitem.description)
  • hlavičku dokladu (receipt.headerText)
  • pätu dokladu (receipt.footerText)
  • nefiskálny doklad

Takýto blok ďalej označujeme ako token.

Zoznam podporovaných tokenov

Identifikátor Názov Popis
text Formátovanie textu Umožňuje formátovač text a horizontálne ho zarovnávať
barcode čiarový kód Nie je podporované v PDF tlačiarni.
logo Grafické logo Nie je podporované v PDF tlačiarni.
qr QR kód
pageBreak zlom strany V prípade papierového dokladu ide o spustenie nožníc. V prípade PDF alebo e-dokladu nastáva zlom strany a obsaho dokumentu pokračuje na novej strane.

Syntax

Upozornenie:

V príkladoch nižšie sú v rámci lepšej čitateľnosti použité symboly <...>, ktoré je potrebné v reálnom kóde nahradiť ich ASCII hodnotami:

  • <LF> - nahraďte znakom s ASCII hodnotou \u000a (0x0A)
  • <CR> - nahraďte znakom s ASCII hodnotou \u000d (0x0D)
  • <SUB> - nahraďte znakom s ASCII hodnotou \u001a (0x1A)
  • <RS> - nahraďte znakom s ASCII hodnotou \u001e (0x1E)
  • <US> - nahraďte znakom s ASCII hodnotou \u001f (0x1F)

Token je párovo (na začiatku aj na konci) ohraničený znakom <SUB> (teda znak s hodnotou \u001a).

Napríklad: <SUB> ... <SUB> (teda \u001a...\u001a)

Obsah tokenu pozostáva z

  • povinného identifikátora
  • voliteľného zoznamu parametrov

Každý parameter pozostáva z kľúča a nepovinnej hodnoty.

Pred každým parametrom je umiestnený oddeľovač - symbol <RS>.

Kľúč a hodnota parametra je oddelená symbolom <US>.

Príklad: <SUB>identifikator<RS>kluc1<US>hodnota1<RS>kluc2<US>hodnota2<SUB>

text token

Slúži pre vytlačenie formátovaného textu.

Poznámka: Text je tlačený vo forme separátneho riadku (alebo viacero riadkov) - enter je pridávaný automaticky. Nie je teda potrebné uvádzať symboly \r\n pre nový riadok.

Parametre:

  • content: obsah textu. Povinný parameter.

  • alignment: horizontálne zarovnanie textu. Nepovinný parameter. Povolené hodnoty:

    • 0 alebo left: Text bude zarovnaný vľavo. Toto je predvolená hodnota.
    • 1 alebo center: Text bude zarovnaný na stred.
    • 2 alebo right: Text bude zarovnaný vpravo.
  • format: formátovanie textu. Nepovinný parameter. Hodnoty je možné kombinovať pomocou matematického operátora | (operácia OR). Povolené hodnoty:

    • 0: Bez formátovania. Toto je predvolená hodnota.
    • 1: Hrubé písmo.
    • 2: Podčiarknuté písmo.
    • 4: Dvojitá šírka.
    • 8: Dvojitá výška.
    • 16: Invertovaná tlač (výmena farby textu a pozadia).

Príklad: <SUB>text<RS>content<US>This text is bold and underlined.<RS>format<US>3<RS>alignment<US>center<SUB>

barcode token

Slúži pre vytlačenie čiarového kódu.

Uporoznrnie:

barcode token je momentálne podporovaný iba pri tlačiarni papierových dokladov - pos.

Parametre:

  • type: typ čiarového kódu. Povinný parameter. Povolené hodnoty:

    • ean8
    • ean13
    • code128
    • code39
    • code93
  • content: obsah čiarového kódu. Povinný parameter. Pri kóde typu EAN8 je očakávaných 7 až 8 číslic, pri EAN13 12 až 13 číslic.

  • hriPosition: Pozícia čitateľného textu. Nepovinný parameter. Povolené hodnoty:

    • 0 alebo none: Text nebude viditeľný. Toto je predvolená hodnota.
    • 1 alebo above: Text bude viditeľný nad čiarovým kódom.
    • 2 alebo below: Text bude viditeľný pod čiarovým kódom.
    • 3 alebo both: Text bude viditeľný nad aj pod čiarovým kódom.
  • height: Vertikálna výška čiarového kódu v bodoch. Nepovinný parameter. Predvolenú hodnotu určuje samotná tlačiareň.

  • elementWidth: Horizontálna šírka elementu čiarového kódu. Nepovinný paremeter. Čím nižšie číslo, tým viac znakov sa zmestí do čiarového kódu. Staršie modely tlačiarní nemusia podporovať najnižšie hodnoty (1 a 2). Predvolená hodnota je 3. Povolené hodnoty:

    • 1 alebo ultraThin: elementy majú šírku 0.141 mm resp. 0.423 mm.
    • 2 alebo thin: elementy majú šírku 0.282 mm resp. 0.706 mm.
    • 3 alebo semithin: elementy majú šírku 0.423 mm resp. 1.129 mm.
    • 4 alebo normal: elementy majú šírku 0.564 mm resp. 1.411 mm.
    • 5 alebo semithick: elementy majú šírku 0.706 mm resp. 1.834 mm.
    • 6 alebo thick: elementy majú šírku 0.847 mm resp. 2.258 mm.

Príklad: <SUB>barcode<RS>content<US>1234567<RS>type<US>ean8<SUB>

logo token

Slúži pre vytlačenie loga uloženého v pamäti tlačiarne.

Uporoznrnie:

barcode token je momentálne podporovaný iba pri tlačiarni papierových dokladov - pos.

Parametre:

  • address: číslo adresy, na ktorej je logo v tlačiarni uložené. Nepovinný parameter. Ak nie je adresa uvedená, použitá je hodnota 1.

  • size: veľkosť loga. Nepovinný parameter. Ak nie je veľkosť uvedená, použitá je hodnota normal. Povolené hodnoty:

    • 0 alebo normal: Pôvodná veľkosť. Toto je predvolená hodnota.
    • 1 alebo doublewidth: Dvojnásobná šírka.
    • 2 alebo doubleheight: Dvojnásobná výška.
    • 3 alebo quadruple: Dvojnásobná šírka aj výška.
  • alignment: horizontálne zarovnanie loga. Nepovinný parameter. Ak nie je zarovnanie uvedené, použitá je hodnota center. Povolené hodnoty:

    • 0 alebo left: Text bude zarovnaný vľavo.
    • 1 alebo center: Text bude zarovnaný na stred. Toto je predvolená hodnota.
    • 2 alebo right: Text bude zarovnaný vpravo.

Príklad: <SUB>logo<RS>address<US>1<RS>size<US>quadruple<RS>alignment<US>center<SUB>

qr token

Slúži pre vytlačenie QR kódu

Parametre:

  • content: obsah QR kódu.

Príklad: <SUB>qr<RS>content<US>https://www.ninedigit.sk<SUB>

pageBreak token

Vytvorí zlom strany.

V prípade elektronického (PDF) dokladu pokračuje obsah dokladu na novom liste. V prípade papierového dokladu je príkaz vyhodnotený spustením nožníc tlačiarne.

Uporoznrnie:

Token pageBreak je možné použiť iba na konci dokladu, alebo v rámci nefiskálneho dokladu. V opačnom prípade je ignorovaný (napríklad v popise položky alebo v hlavičke dokladu).

Parametre:

Tento token neobsahuje žiadne parametre.

Príklad: <SUB>pagebreak<SUB>

Clone this wiki locally