survey-pdf 2.0.6 → 2.0.8

package/survey.pdf.min.js.LICENSE.txt

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

package/typings/doc_controller.d.ts

@@ -91,8 +91,9 @@ export interface IDocOptions {
      * - `"ledger"`
      * - `"tabloid"`
      * - `"credit-card"`
-     * - Array<number> - custom page size in millimeters, for example, `[210, 297]`.
+     * - `[width, height]` - Custom page size in millimeters, for example, `[210, 297]`.
      *
+     * [View Demo](https://surveyjs.io/pdf-generator/examples/save-completed-forms-as-pdf-files/ (linkStyle))
      * @see orientation
      */
     format?: string | number[];
@@ -114,7 +115,7 @@ export interface IDocOptions {
      * - `"Times"`
      * - `"Symbol"`
      * - `"ZapfDingbats"`
-     * - [Custom font name](https://surveyjs.io/Documentation/Pdf-Export?id=Customization-ChangeFonts#use-custom-font)
+     * - [Custom font name](https://surveyjs.io/pdf-generator/documentation/customize-pdf-form-settings#custom-fonts)
      *
      * [View Demo](https://surveyjs.io/pdf-generator/examples/change-font-in-pdf-form/ (linkStyle))
      * @see fontSize
@@ -132,7 +133,11 @@ export interface IDocOptions {
      */
     useCustomFontInHtml?: boolean;
     /**
-     * Page margins. Set this property to an object with the following fields: `top`, `bot`, `left`, `right`.
+     * Page margins.
+     *
+     * Set this property to an object with the following fields: `top`, `bot`, `left`, `right`.
+     *
+     * [View Demo](https://surveyjs.io/pdf-generator/examples/save-completed-forms-as-pdf-files/ (linkStyle))
      */
     margins?: IMargin;
     /**
@@ -144,6 +149,8 @@ export interface IDocOptions {
      * - `"image"` - Render HTML questions as images.
      * - `"auto"` (default) - Select between the `"standard"` and `"image"` modes automatically based on the HTML content.
      *
+     * [View Demo](https://surveyjs.io/pdf-generator/examples/split-html-image-across-pages/ (linkStyle))
+     *
      * You can override this property for an individual HTML question. Set the question's `renderAs` property to `"standard"` or `"image"` in the survey JSON schema.
      * @see useCustomFontInHtml
      */
@@ -245,9 +252,9 @@ export declare class DocOptions implements IDocOptions {
     get tagboxSelectedChoicesOnly(): boolean;
 }
 /**
- * The `DocController` object includes an API that allows you to configure the resulting PDF document. You can access this object within functions that handle the `SurveyPDF`'s [`onRender...`](https://surveyjs.io/pdf-generator/documentation/api-reference/surveypdf#onRenderFooter) events.
+ * The `DocController` object includes an API that allows you to configure main PDF document properties (font, margins, page width and height).
  *
- * [View Demo](https://surveyjs.io/pdf-generator/examples/how-to-use-adorners-in-pdf-forms/ (linkStyle))
+ * [View Demo](https://surveyjs.io/pdf-generator/examples/change-font-in-pdf-form/ (linkStyle))
  */
 export declare class DocController extends DocOptions {
     private _doc;
@@ -263,6 +270,14 @@ export declare class DocController extends DocOptions {
             bolditalic: string;
         };
     };
+    /**
+     * Adds a custom font to the PDF Generator.
+     *
+     * [View Demo](https://surveyjs.io/pdf-generator/examples/change-font-in-pdf-form/ (linkStyle))
+     * @param fontName A custom name that you will use to apply the custom font.
+     * @param base64 The custom font as a Base64-encoded string. To encode your font to Base64, obtain it as a TTF file and use any TTF-to-Base64 online converter.
+     * @param fontStyle The style of the custom font: `"normal"`, `"bold"`, `"italic"`, or `"bolditalic"`.
+     */
     static addFont(fontName: string, base64: string, fontStyle: 'normal' | 'bold' | 'italic' | 'bolditalic'): void;
     get doc(): any;
     get helperDoc(): any;

package/typings/event_handler/draw_canvas.d.ts

@@ -122,11 +122,15 @@ export declare class DrawCanvas {
     private alignRect;
     /**
      * Draws a piece of text within the drawing area.
+     *
+     * [View Demo](https://surveyjs.io/pdf-generator/examples/customize-header-and-footer-of-pdf-form/ (linkStyle))
      * @param textOptions An [`IDrawTextOptions`](https://surveyjs.io/pdf-generator/documentation/api-reference/idrawtextoptions) object that configures the drawing.
      */
     drawText(textOptions: IDrawTextOptions): void;
     /**
      * Draws an image within the drawing area.
+     *
+     * [View Demo](https://surveyjs.io/pdf-generator/examples/customize-header-and-footer-of-pdf-form/ (linkStyle))
      * @param imageOptions An [`IDrawImageOptions`](https://surveyjs.io/pdf-generator/documentation/api-reference/idrawimageoptions) object that configures drawing.
      */
     drawImage(imageOptions: IDrawImageOptions): Promise<void>;

package/typings/survey.d.ts

@@ -136,8 +136,9 @@ export declare class SurveyPDF extends SurveyModel {
     private correctBricksPosition;
     protected renderSurvey(controller: DocController): Promise<void>;
     /**
-     * An asynchronous method that starts download of the generated PDF file in the web browser.
+     * An asynchronous method that starts the download of the generated PDF file in the web browser.
      *
+     * [View Demo](https://surveyjs.io/pdf-generator/examples/save-completed-forms-as-pdf-files/ (linkStyle))
      * @param fileName *(Optional)* A file name with the ".pdf" extension. Default value: `"survey_result.pdf"`.
      */
     save(fileName?: string): Promise<any>;