survey-pdf 1.9.29 → 1.9.32

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "survey-pdf",
-  "version": "1.9.29",
+  "version": "1.9.32",
   "description": "survey.pdf.js is a SurveyJS PDF Library. It is a easy way to export SurveyJS surveys to PDF. It uses JSON for survey metadata.",
   "keywords": [
     "Survey",

package/survey.pdf.d.ts

@@ -1,4 +1,4 @@
-/*Type definitions for SurveyJS PDF library v1.9.29
+/*Type definitions for SurveyJS PDF library v1.9.32
 Copyright (c) 2015-2022 Devsoft Baltic OÜ  - http://surveyjs.io/
 Definitions by: Devsoft Baltic OÜ <https://github.com/surveyjs/>
 */
@@ -214,25 +214,118 @@ export interface IMargin extends IMarginLR {
         bot?: number;
 }
 /**
-    * Declares a set of options for a SurveyPDF document.
+    * PDF document configuration. Pass it as the second argument to the `SurveyPDF` constructor:
+    *
+    * ```js
+    * const surveyPdf = new SurveyPDF.SurveyPDF(surveyJson, pdfDocOptions);
+    * ```
     */
 export interface IDocOptions {
+        /**
+            * Page orientation.
+            * Accepted values:
+            *
+            * - `"p"`- Portrait orientation (default).
+            * - `"l"` - Landscape orientation.
+            *
+            * @see format
+            */
         orientation?: 'p' | 'l';
+        /**
+            * Page format.
+            * Accepted values:
+            *
+            * - `"a0"` - `"a10"` (`"a4"` is default)
+            * - `"b0"` - `"b10"`
+            * - `"c0"` - `"c10"`
+            * - `"dl"`
+            * - `"letter"`
+            * - `"government-letter"`
+            * - `"legal"`
+            * - `"junior-legal"`
+            * - `"ledger"`
+            * - `"tabloid"`
+            * - `"credit-card"`
+            * - Array<Number> - custom page size in millimeters, for example, `[210.0, 297.0]`.
+            *
+            * @see orientation
+            */
         format?: string | number[];
+        /**
+            * Font size in points.
+            *
+            * @see fontName
+            */
         fontSize?: number;
+        /**
+            * Font name.
+            * Accepted values:
+            *
+            * - `"Helvetica"` (default)
+            * - `"Courier"`
+            * - `"Times"`
+            * - `"Symbol"`
+            * - `"ZapfDingbats"`
+            * - `"Segoe"` (requires [additional configuration](https://surveyjs.io/Documentation/Pdf-Export?id=Customization-ChangeFonts))
+            * - [Custom font name](https://surveyjs.io/Documentation/Pdf-Export?id=Customization-ChangeFonts#use-custom-font)
+            *
+            * @see fontSize
+            */
         fontName?: string;
         base64Normal?: string;
         base64Bold?: string;
         useCustomFontInHtml?: boolean;
+        /**
+            * Page margins. Set this property to an object with the following fields: `top`, `bottom`, `left`, `right`.
+            */
         margins?: IMargin;
         commercial?: boolean;
+        /**
+            * Removes watermarks from the exported document.
+            * **IMPORTANT**: You can enable this property only if you have a SurveyJS PDF Export commercial license. It is illegal to enable this property without a license.
+            */
         haveCommercialLicense?: boolean;
+        /**
+            * Specifies how to render [HTML questions](https://surveyjs.io/Documentation/Library?id=questionhtmlmodel) into PDF.
+            * Accepted values:
+            *
+            * - `"standard"` - Render HTML questions as selectable text.
+            * - `"image"` - Render HTML questions as images.
+            * - `"auto"` (default) - Select between the `"standard"` and `"image"` modes automatically based on the HTML content.
+            *
+            * You can override this property for an individual HTML question. Set the question's `renderAs` property to `"standard"` or `"image"` in the survey JSON definition.
+            */
         htmlRenderAs?: IHTMLRenderType;
+        /**
+            * Specifies how to render [Matrix](https://surveyjs.io/Documentation/Library?id=questionmatrixmodel), [Matrix Dropdown](https://surveyjs.io/Documentation/Library?id=questionmatrixdropdownmodel), and [Matrix Dynamic](https://surveyjs.io/Documentation/Library?id=questionmatrixdynamicmodel) questions into PDF.
+            * Accepted values:
+            *
+            * - `"list"` - Render matrix-like questions as lists.
+            * - `"auto"` (default) - Render matrix-like questions as tables if they fit into the available space. Otherwise, render the questions as lists.
+            *
+            * You can override this property for an individual matrix-like question. Set the question's `renderAs` property to `"list"` in the survey JSON definition.
+            */
         matrixRenderAs?: 'auto' | 'list';
         booleanRenderAs?: 'default' | 'radiogroup';
+        /**
+            * Specifies how to render read-only questions.
+            * Accepted values:
+            *
+            * - `"text"` - Render read-only questions as plain text and custom primitives.
+            * - `"acroform"` - Use Acrobat Forms (AcroForms) to render questions that support them. Other questions are rendered in `"text"` mode.
+            * - `"auto"` (default) - Prefer the `"text"` mode but use `"acroform"` for File question type and links.
+            */
         readonlyRenderAs?: 'auto' | 'text' | 'acroform';
         textFieldRenderAs?: 'singleLine' | 'multiLine';
+        /**
+            * Specifies whether to compress the PDF document.
+            * Compressed documents do not support [custom fonts](https://surveyjs.io/Documentation/Pdf-Export?id=Customization-ChangeFonts#use-custom-font).
+            */
         compress?: boolean;
+        /**
+            * Specifies whether to apply the [imageFit](https://surveyjs.io/Documentation/Library?id=questionimagemodel#imageFit) property to exported [Image](https://surveyjs.io/Documentation/Library?id=questionimagemodel) questions.
+            * If you enable the `applyImageFit` property, the quality of images may be lower because they pass through several conversions. If `applyImageFit` is disabled, exported images fill the entire container and do not preserve their aspect ratio, but their quality remains the same because they are exported as is.
+            */
         applyImageFit?: boolean;
 }
 /**

package/survey.pdf.fonts.js

@@ -1,5 +1,5 @@
 /*!
- * surveyjs - SurveyJS PDF library v1.9.29
+ * surveyjs - SurveyJS PDF library v1.9.32
  * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - http://surveyjs.io/
  * License: MIT (http://www.opensource.org/licenses/mit-license.php)
  */

package/survey.pdf.fonts.min.js

@@ -1,5 +1,5 @@
 /*!
- * surveyjs - SurveyJS PDF library v1.9.29
+ * surveyjs - SurveyJS PDF library v1.9.32
  * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - http://surveyjs.io/
  * License: MIT (http://www.opensource.org/licenses/mit-license.php)
  */