topic exportPdf documentSize clarification in Integration, Extension & APIs

exportPdf documentSize clarification

dselgo_eidex — Sat, 16 Nov 2024 06:47:25 GMT

Hello, I am trying to use the exportPdf method defined here. My question is about the documentSize parameter. The documentation says that you can provide one of the given strings or provide a custom size. However, it is not documented what this ObjectMetricSize is supposed to be. Furthermore, there is another parameter called objectSize which uses an ObjectPixelSize without documenting what it should be.

My assumption is that both are objects with height and width properties, but I can't say for sure.

Can anyone add any clarification?

Re: exportPdf documentSize clarification

fos — Wed, 23 Jan 2019 09:34:49 GMT

Hi,

Yes, you are correct. They are both objects with height and width properties:

		/**
		 * @typedef ObjectMetricSize {object} - Describes the size, in millimeters (mm), of a 2D object.
		 * @property {number} height - Object height in millimeters (mm).
		 * @property {number} width - Object width in millimeters (mm).
		 */

		/**
		 * @typedef ObjectPixelSize {object} - Describes the size, in pixels, of a 2D object.
		 * @property {number} height - Object height in pixels.
		 * @property {number} width - Object width in pixels.
		 */

Thanks for reporting this.

Re: exportPdf documentSize clarification

dselgo_eidex — Thu, 24 Jan 2019 19:08:21 GMT

Thanks for the clarification. I did notice something else though while testing. The strings that you can provide for documentSize don't seem to have any effect (or I'm doing something wrong). Curiously though, when I provide a document size (even just the A3 size), it does create the correct document size. I've attached images showing the settings that I am passing to exportPdf and the generated pdf.

Re: exportPdf documentSize clarification

dselgo_eidex — Thu, 24 Jan 2019 19:08:44 GMT

And the PDFs

Re: exportPdf documentSize clarification

fos — Fri, 25 Jan 2019 15:32:48 GMT

It looks like there is a slight mismatch between the docs and the code here. It should work if you use lower case strings in the documentSize parameter:

vis.exportPdf({ documentSize: 'a3' }).then(console.log);

Re: exportPdf documentSize clarification

dselgo_eidex — Fri, 25 Jan 2019 15:36:41 GMT

Ah, that makes sense. Thanks