Add more formats

[albertosouza]

Pimaco format table: #1 (comment)

Avaible formats are in file: https://github.com/albertosouza/print-tag/blob/master/lib/formats.js

[angelod1as]

@albertosouza I'd love to add more formats. I just need to understand better how do you measure cols and rols. Pimaco has a "printing parameters" word file that has a lot of info — like how many tags per line or page.

I want to use your amazing project but need to add a few new formats. Can you help me with that?

[albertosouza]

Hi @angelod1as , of course I can help.
You need to set each column (col), row and margins.
See some working formats in: https://github.com/albertosouza/print-tag/blob/master/lib/formats.js
Example:
Each col start: https://github.com/albertosouza/print-tag/blob/master/lib/formats.js#L4
Each row start: https://github.com/albertosouza/print-tag/blob/master/lib/formats.js#L10
Each tag size: https://github.com/albertosouza/print-tag/blob/master/lib/formats.js#L33
Paper size for this format: https://github.com/albertosouza/print-tag/blob/master/lib/formats.js#L38
Paper margins: https://github.com/albertosouza/print-tag/blob/master/lib/formats.js#L39

I know that is a lot of settings but this is usefull to make this module versatile and support any format.

[angelod1as]

Are the units in mm?

[albertosouza]

@angelod1as yes.
Product related to our* example: http://www.pimaco.com.br/produto/114/6187-carta-100-folhas

[albertosouza]

@angelod1as i changed the width and height configuration for pimaco_6081 format and added tests to pimaco 6081.
Can you check if https://github.com/albertosouza/print-tag/blob/master/test/results/6081.pdf is right result for pimaco 6081?

If is right i will publish this version in NPM.

[angelod1as]

@albertosouza I'm having a ROUGH month, will test ASAP.

[angelod1as]

@albertosouza I found a issue:

I tested my file using two printers. One of them printed the file perfectly. The other needed a -4mm offset on the top margin to be aligned.

So, I thought about a option that applies these 'adjustments' without needing to change the template.

The problem is that I just can't make it work. I'm not used with pdfkit.

Below is my version of the file. The changes I made are from lines 17 to 34.

(I don't know if this is the best way to showing you this, I'm new to this contribution thing)

var PDFDocument = require('pdfkit');
var formats = require('./formats');

/**
 * Print Ticket prototype
 *
 * @param {String} format format, required
 * @param {Object} opts   options ex: { count: 10 }
 */
function PrintTicket(format, opts) {
  if (!opts) opts = {};

  if (!formats[format]) throw new Error('Unavaible or invalid tag page format');

  this.format = formats[format];

  // applies printer adjusts
  if (opts && opts.adjust) {
    var margins = this.format.paperMargins;
    var ad = opts.adjust;
    this.format.paperMargins = {
      top: ad.top ? +(margins.top + ad.top).toFixed(1) : margins.top,
      right: ad.right ? +(margins.right + ad.right).toFixed(1) : margins.right,
      bottom: ad.bottom ? +(margins.bottom + ad.bottom).toFixed(1) : margins.bottom,
      left: ad.left ? +(margins.left + ad.left).toFixed(1) : margins.left
    }
  }

  // avoid negative margins from adjusts
  Object.keys(this.format.paperMargins).forEach((el) => {
    if (this.format.paperMargins[el] < 0) throw new Error(`Margins can\'t be negative. Check your adjusts or format: ${el} margin is: ${this.format.paperMargins[el]}`)
  })

  this.doc = new PDFDocument({
    size: this.format.paperSize,
    margins: this.format.paperMargins
  });
}

PrintTicket.prototype.i = 0;
PrintTicket.prototype.col = 0;
PrintTicket.prototype.row = 0;
PrintTicket.prototype.page = 1;
PrintTicket.prototype.currentTag = 0;

/**
 * Make all tickets
 *
 * @param  {Object} opts   { count: 10 }
 * @param  {Function} eachPrint function to run in every tag print
 * @param  {Function} doneAll   function to run after set all tags
 */
PrintTicket.prototype.makeTickets = function makeTickets(opts, eachPrint, doneAll) {
  this.eachPrint = eachPrint;

  this.makeOneTicket((opts.count || this.format.maxTagsInPage), eachPrint, doneAll);
}

PrintTicket.prototype.makeOneTicket = function makeOneTicket(count, eachPrint, done) {
  var self = this;

  eachPrint(this.i, this.format.cols[this.col], this.format.rows[this.row], this.format.tagSize, function doneOne() {

    var notIsLastPage = self.i < (count-1);

    self.nextTag(notIsLastPage);

    if (notIsLastPage) {

      self.i++;

      self.makeOneTicket(count, eachPrint, done);
    } else {
      done();
    }
  });
}

PrintTicket.prototype.nextTag = function nextTag (notIsLastPage) {
  this.col++;
  // set next col
  if (!this.format.cols[this.col]) {
    this.col = 0;
    // set next row if are in last col
    this.row++;
    if (!this.format.rows[this.row]) {
      this.row = 0;
    }
  }
  // calc next page
  this.currentTag++;

  if (notIsLastPage && this.currentTag >= this.format.maxTagsInPage) {
    this.page++;
    this.currentTag = 0;
    this.row = 0;
    this.col = 0;

    this.doc.addPage({
      size: this.format.paperSize,
      margins: this.format.paperMargins
    });
  }
}

module.exports = PrintTicket;

[albertosouza]

Hi @angelod1as "print each tag function" may "fix" printer pattern problems if need.

On readme.md example change the marginLeft value of each tag to the fixed value:

var pt = new PrintTicket('pimaco_6081');

pt.doc.pipe( fs.createWriteStream('test/results/output.pdf') );
pt.doc.fontSize(6);

pt.makeTickets({
  count: data.length
}, function onSetOneTag(i, marginLeft, marginTop, size, next) {
  var fixedMarginLeft = ( Number(marginLeft) - 4); // <--- important change to fix printer margin diference!
  // write something in tag area
  pt.doc.text(data[i].name, fixedMarginLeft,  marginTop, size); // <--- Reuse the variable
  // ticket box
  pt.doc.lineWidth(0.1);
  pt.doc.rect(fixedMarginLeft, marginTop, size.width, size.height).stroke(); // <--- And this line is usefull if ou need to print tag borders
  next();
}, function afterSetAllTags(){
  pt.doc.end();
});

pt.doc.on('end', function(){
  done();
});

[angelod1as]

I feel stupid.

I'll test again this weekend and post updates soon.

[angelod1as]

Worked like a charm. Ok to publish.

[albertosouza]

Thanks, new version published as v1.1.0

[luiza-avelino]

Como faço para adicionar um formato? Ainda sou iniciante na área, mas testei o formato A4355 em um projeto meu e está funcionando.

[albertosouza]

@luiza-avelino você pode fazer um fork, adicionar suas configurações para o formato A4355 no arquivo https://github.com/albertosouza/print-tag/blob/master/lib/formats.js e depois enviar um pull request