survey-pdf 2.0.0-rc.2 → 2.0.0-rc.4

package/typings/pdf_render/pdf_coloredbrick.d.ts

@@ -0,0 +1,9 @@
+import { IRect, DocController } from '../doc_controller';
+import { PdfBrick } from './pdf_brick';
+export declare class ColoredBrick extends PdfBrick {
+    private color;
+    private renderWidth?;
+    private renderHeight?;
+    constructor(controller: DocController, rect: IRect, color: string, renderWidth?: number, renderHeight?: number);
+    renderInteractive(): Promise<void>;
+}

package/typings/pdf_render/pdf_comment.d.ts

@@ -0,0 +1,8 @@
+import { IQuestion } from 'survey-core';
+import { IRect, DocController } from '../doc_controller';
+import { TextBoxBrick } from './pdf_textbox';
+export declare class CommentBrick extends TextBoxBrick {
+    protected controller: DocController;
+    constructor(question: IQuestion, controller: DocController, rect: IRect, isQuestion: boolean, index?: number);
+    protected shouldRenderFlatBorders(): boolean;
+}

package/typings/pdf_render/pdf_composite.d.ts

@@ -0,0 +1,26 @@
+import { IPdfBrick, TranslateXFunction } from './pdf_brick';
+export declare class CompositeBrick implements IPdfBrick {
+    private bricks;
+    private _xLeft;
+    private _xRight;
+    private _yTop;
+    private _yBot;
+    isPageBreak: boolean;
+    constructor(...bricks: IPdfBrick[]);
+    get xLeft(): number;
+    set xLeft(xLeft: number);
+    get xRight(): number;
+    set xRight(xRight: number);
+    get yTop(): number;
+    set yTop(yTop: number);
+    get yBot(): number;
+    set yBot(yBot: number);
+    private shift;
+    get width(): number;
+    get height(): number;
+    render(): Promise<void>;
+    get isEmpty(): boolean;
+    addBrick(...bricks: IPdfBrick[]): void;
+    unfold(): IPdfBrick[];
+    translateX(func: TranslateXFunction): void;
+}

package/typings/pdf_render/pdf_custom.d.ts

@@ -0,0 +1,8 @@
+import { PdfBrick } from './pdf_brick';
+import { DocController, IRect } from '../doc_controller';
+import { IQuestion } from 'survey-core';
+export declare class CustomBrick extends PdfBrick {
+    private renderFunc;
+    constructor(question: IQuestion, controller: DocController, renderFunc: (doc: any, question: any, xLeft: number, yTop: number) => IRect);
+    renderInteractive(): Promise<void>;
+}

package/typings/pdf_render/pdf_description.d.ts

@@ -0,0 +1,6 @@
+import { IQuestion } from 'survey-core';
+import { IRect, DocController } from '../doc_controller';
+import { TextBrick } from './pdf_text';
+export declare class DescriptionBrick extends TextBrick {
+    constructor(question: IQuestion, controller: DocController, rect: IRect, text: string);
+}

package/typings/pdf_render/pdf_dropdown.d.ts

@@ -0,0 +1,11 @@
+import { IQuestion, QuestionDropdownModel } from 'survey-core';
+import { IRect, DocController } from '../doc_controller';
+import { PdfBrick } from './pdf_brick';
+export declare class DropdownBrick extends PdfBrick {
+    protected controller: DocController;
+    protected question: QuestionDropdownModel;
+    protected isQuestion: boolean;
+    protected isMultiline: boolean;
+    constructor(question: IQuestion, controller: DocController, rect: IRect);
+    renderInteractive(): Promise<void>;
+}

package/typings/pdf_render/pdf_empty.d.ts

@@ -0,0 +1,9 @@
+import { PdfBrick } from './pdf_brick';
+import { DocController, IRect } from '../doc_controller';
+export declare class EmptyBrick extends PdfBrick {
+    protected controller: DocController;
+    private isBorderVisible;
+    constructor(rect: IRect, controller?: DocController, isBorderVisible?: boolean);
+    private resizeBorder;
+    renderInteractive(): Promise<void>;
+}

package/typings/pdf_render/pdf_html.d.ts

@@ -0,0 +1,9 @@
+import { IQuestion } from 'survey-core';
+import { PdfBrick } from './pdf_brick';
+import { IRect, DocController } from '../doc_controller';
+export declare class HTMLBrick extends PdfBrick {
+    protected html: string;
+    private margins;
+    constructor(question: IQuestion, controller: DocController, rect: IRect, html: string, isImage?: boolean);
+    renderInteractive(): Promise<void>;
+}

package/typings/pdf_render/pdf_image.d.ts

@@ -0,0 +1,11 @@
+import { IQuestion } from 'survey-core';
+import { PdfBrick } from './pdf_brick';
+import { DocController } from '../doc_controller';
+import { IPoint } from '../entries/pdf';
+export declare class ImageBrick extends PdfBrick {
+    protected image: string;
+    protected originalWidth: number;
+    protected originalHeight: number;
+    constructor(question: IQuestion, controller: DocController, image: string, point: IPoint, originalWidth: number, originalHeight: number);
+    renderInteractive(): Promise<void>;
+}

package/typings/pdf_render/pdf_link.d.ts

@@ -0,0 +1,9 @@
+import { TextBrick } from './pdf_text';
+export declare class LinkBrick extends TextBrick {
+    protected link: string;
+    private static readonly SCALE_FACTOR_MAGIC;
+    static readonly COLOR: string;
+    constructor(textFlat: TextBrick, link: string);
+    renderInteractive(): Promise<void>;
+    renderReadOnly(): Promise<void>;
+}

package/typings/pdf_render/pdf_radioitem.d.ts

@@ -0,0 +1,34 @@
+import { IQuestion, ItemValue } from 'survey-core';
+import { IRect, DocController } from '../doc_controller';
+import { PdfBrick } from './pdf_brick';
+export interface IRadiogroupWrapContext {
+    question: IQuestion;
+    readOnly: boolean;
+}
+export declare class RadioGroupWrap {
+    name: string;
+    private controller;
+    private context;
+    private _radioGroup;
+    constructor(name: string, controller: DocController, context: IRadiogroupWrapContext);
+    addToPdf(color: string): void;
+    get radioGroup(): any;
+    get readOnly(): boolean;
+}
+export interface IRadioGroupItemBrickContext {
+    question: IQuestion;
+    checked: boolean;
+    index: number;
+    item: ItemValue;
+}
+export declare class RadioItemBrick extends PdfBrick {
+    private context;
+    private radioGroupWrap;
+    private static readonly RADIOMARKER_READONLY_SYMBOL;
+    private static readonly RADIOMARKER_READONLY_FONT;
+    static readonly RADIOMARKER_READONLY_FONT_SIZE_SCALE: number;
+    constructor(controller: DocController, rect: IRect, context: IRadioGroupItemBrickContext, radioGroupWrap: RadioGroupWrap);
+    protected getShouldRenderReadOnly(): boolean;
+    renderInteractive(): Promise<void>;
+    renderReadOnly(): Promise<void>;
+}

package/typings/pdf_render/pdf_rankingitem.d.ts

@@ -0,0 +1,9 @@
+import { IQuestion, QuestionRankingModel } from 'survey-core';
+import { IRect, DocController } from '../doc_controller';
+import { PdfBrick } from './pdf_brick';
+export declare class RankingItemBrick extends PdfBrick {
+    protected mark: string;
+    protected question: QuestionRankingModel;
+    constructor(question: IQuestion, controller: DocController, rect: IRect, mark: string);
+    renderInteractive(): Promise<void>;
+}

package/typings/pdf_render/pdf_rowline.d.ts

@@ -0,0 +1,17 @@
+import { IRect, DocController } from '../doc_controller';
+import { IPdfBrick, TranslateXFunction } from './pdf_brick';
+export declare class RowlineBrick implements IPdfBrick {
+    protected controller: DocController;
+    color: string;
+    xLeft: number;
+    xRight: number;
+    yTop: number;
+    yBot: number;
+    isPageBreak: boolean;
+    constructor(controller: DocController, rect: IRect, color: string);
+    get width(): number;
+    get height(): number;
+    render(): Promise<void>;
+    unfold(): IPdfBrick[];
+    translateX(_: TranslateXFunction): void;
+}

package/typings/pdf_render/pdf_text.d.ts

@@ -0,0 +1,11 @@
+import { IQuestion } from 'survey-core';
+import { IPoint, IRect, DocController } from '../doc_controller';
+import { PdfBrick } from './pdf_brick';
+export declare class TextBrick extends PdfBrick {
+    protected text: string;
+    protected align: any;
+    constructor(question: IQuestion, controller: DocController, rect: IRect, text: string);
+    private escapeText;
+    renderInteractive(): Promise<void>;
+    protected alignPoint(rect: IRect): IPoint;
+}

package/typings/pdf_render/pdf_textbold.d.ts

@@ -0,0 +1,7 @@
+import { IQuestion } from 'survey-core';
+import { IRect, DocController } from '../doc_controller';
+import { TextBrick } from './pdf_text';
+export declare class TextBoldBrick extends TextBrick {
+    constructor(question: IQuestion, controller: DocController, rect: IRect, text: string);
+    renderInteractive(): Promise<void>;
+}

package/typings/pdf_render/pdf_textbox.d.ts

@@ -0,0 +1,8 @@
+import { IQuestion } from 'survey-core';
+import { IRect, DocController } from '../doc_controller';
+import { TextFieldBrick } from './pdf_textfield';
+export declare class TextBoxBrick extends TextFieldBrick {
+    protected isQuestion: boolean;
+    protected isMultiline: boolean;
+    constructor(question: IQuestion, controller: DocController, rect: IRect, isQuestion?: boolean, isMultiline?: boolean, index?: number);
+}

package/typings/pdf_render/pdf_textfield.d.ts

@@ -0,0 +1,28 @@
+import { IQuestion, QuestionTextModel } from 'survey-core';
+import { IRect, DocController } from '../doc_controller';
+import { IPdfBrick, PdfBrick, TranslateXFunction } from './pdf_brick';
+export declare class TextFieldBrick extends PdfBrick {
+    protected isQuestion: boolean;
+    protected fieldName: string;
+    protected value: string;
+    protected placeholder: string;
+    isReadOnly: boolean;
+    protected isMultiline: boolean;
+    protected inputType: string;
+    protected question: QuestionTextModel;
+    constructor(question: IQuestion, controller: DocController, rect: IRect, isQuestion: boolean, fieldName: string, value: string, placeholder: string, isReadOnly: boolean, isMultiline: boolean, inputType: string);
+    private renderColorQuestion;
+    renderInteractive(): Promise<void>;
+    protected shouldRenderFlatBorders(): boolean;
+    protected getShouldRenderReadOnly(): boolean;
+    private _textBrick;
+    get textBrick(): IPdfBrick;
+    set textBrick(val: IPdfBrick);
+    renderReadOnly(): Promise<void>;
+    unfold(): IPdfBrick[];
+    translateX(func: TranslateXFunction): void;
+    protected setXLeft(val: number): void;
+    protected setXRight(val: number): void;
+    protected setYTop(val: number): void;
+    protected setYBottom(val: number): void;
+}

package/typings/pdf_render/pdf_titlepanel.d.ts

@@ -0,0 +1,8 @@
+import { IQuestion, QuestionTextModel } from 'survey-core';
+import { IRect, DocController } from '../doc_controller';
+import { TextBoldBrick } from './pdf_textbold';
+export declare class TitlePanelBrick extends TextBoldBrick {
+    protected question: QuestionTextModel;
+    constructor(question: IQuestion, controller: DocController, rect: IRect, text: string);
+    renderInteractive(): Promise<void>;
+}

package/typings/survey.d.ts

@@ -0,0 +1,152 @@
+import { SurveyModel, EventBase } from 'survey-core';
+import { IDocOptions, DocController } from './doc_controller';
+import { EventAsync } from './event_handler/event_handler';
+import { DrawCanvas } from './event_handler/draw_canvas';
+import { AdornersOptions, AdornersPanelOptions, AdornersPageOptions } from './event_handler/adorners';
+/**
+ * The `SurveyPDF` object enables you to export your surveys and forms to PDF documents.
+ *
+ * [View Demo](https://surveyjs.io/pdf-generator/examples/ (linkStyle))
+ */
+export declare class SurveyPDF extends SurveyModel {
+    private static currentlySaving;
+    private static saveQueue;
+    options: IDocOptions;
+    constructor(jsonObject: any, options?: IDocOptions);
+    get haveCommercialLicense(): boolean;
+    set haveCommercialLicense(val: boolean);
+    /**
+     * An event that is raised when SurveyJS PDF Generator renders a page header. Handle this event to customize the header.
+     *
+     * Parameters:
+     *
+     * - `sender`: `SurveyPDF`\
+     * A SurveyPDF instance that raised the event.
+     *
+     * - `canvas`: [`DrawCanvas`](https://surveyjs.io/pdf-generator/documentation/api-reference/drawcanvas)\
+     * An object that you can use to draw text and images in the page header.
+     *
+     * [View Demo](https://surveyjs.io/pdf-generator/examples/customize-header-and-footer-of-pdf-form/ (linkStyle))
+     */
+    onRenderHeader: EventAsync<SurveyPDF, DrawCanvas>;
+    /**
+     * An event that is raised when SurveyJS PDF Generator renders a page footer. Handle this event to customize the footer.
+     *
+     * Parameters:
+     *
+     * - `sender`: `SurveyPDF`\
+     * A SurveyPDF instance that raised the event.
+     *
+     * - `canvas`: [`DrawCanvas`](https://surveyjs.io/pdf-generator/documentation/api-reference/drawcanvas)\
+     * An object that you can use to draw text and images in the page footer.
+     *
+     * [View Demo](https://surveyjs.io/pdf-generator/examples/customize-header-and-footer-of-pdf-form/ (linkStyle))
+     */
+    onRenderFooter: EventAsync<SurveyPDF, DrawCanvas>;
+    /**
+     * An event that is raised when SurveyJS PDF Generator renders a survey question. Handle this event to customize question rendering.
+     *
+     * Parameters:
+     *
+     * - `sender`: `SurveyPDF`\
+     * A SurveyPDF instance that raised the event.
+     *
+     * - `options.question`: [`Question`](https://surveyjs.io/form-library/documentation/api-reference/question)\
+     * A survey question that is being rendered.
+     *
+     * - `options.point`: `IPoint`\
+     * An object with coordinates of the top-left corner of the element being rendered. This object contains the following properties: `{ xLeft: number, yTop: number }`.
+     *
+     * - `options.bricks`: [`PdfBrick[]`](https://surveyjs.io/pdf-generator/documentation/api-reference/pdfbrick)\
+     * An array of [bricks](https://surveyjs.io/pdf-generator/documentation/customize-survey-question-rendering-in-pdf-form#custom-rendering) used to render the element.
+     *
+     * - `options.controller`: [`DocController`](https://surveyjs.io/pdf-generator/documentation/api-reference/doccontroller)\
+     * An object that provides access to main PDF document properties (font, margins, page width and height) and allows you to modify them.
+     *
+     * - `options.repository`: `FlatRepository`\
+     * A repository with classes that render elements to PDF. Use its `create` method if you need to create a new instance of a rendering class.
+     *
+     * [View Demo](https://surveyjs.io/pdf-generator/examples/how-to-use-adorners-in-pdf-forms/ (linkStyle))
+     */
+    onRenderQuestion: EventAsync<SurveyPDF, AdornersOptions>;
+    /**
+     * An event that is raised when SurveyJS PDF Generator renders a panel. Handle this event to customize panel rendering.
+     *
+     * Parameters:
+     *
+     * - `sender`: `SurveyPDF`\
+     * A SurveyPDF instance that raised the event.
+     *
+     * - `options.panel`: [`PanelModel`](https://surveyjs.io/form-library/documentation/api-reference/panel-model)\
+     * A panel that is being rendered.
+     *
+     * - `options.point`: `IPoint`\
+     * An object with coordinates of the top-left corner of the element being rendered. This object contains the following properties: `{ xLeft: number, yTop: number }`.
+     *
+     * - `options.bricks`: [`PdfBrick[]`](https://surveyjs.io/pdf-generator/documentation/api-reference/pdfbrick)\
+     * An array of [bricks](https://surveyjs.io/pdf-generator/documentation/customize-survey-question-rendering-in-pdf-form#custom-rendering) used to render the element.
+     *
+     * - `options.controller`: [`DocController`](https://surveyjs.io/pdf-generator/documentation/api-reference/doccontroller)\
+     * An object that provides access to main PDF document properties (font, margins, page width and height) and allows you to modify them.
+     *
+     * - `options.repository`: `FlatRepository`\
+     * A repository with classes that render elements to PDF. Use its `create` method if you need to create a new instance of a rendering class.
+     *
+     * [View Demo](https://surveyjs.io/pdf-generator/examples/how-to-use-adorners-in-pdf-forms/ (linkStyle))
+     */
+    onRenderPanel: EventAsync<SurveyPDF, AdornersPanelOptions>;
+    /**
+     * An event that is raised when SurveyJS PDF Generator renders a page. Handle this event to customize page rendering.
+     *
+     * Parameters:
+     *
+     * - `sender`: `SurveyPDF`\
+     * A SurveyPDF instance that raised the event.
+     *
+     * - `options.page`: [`PageModel`](https://surveyjs.io/form-library/documentation/api-reference/page-model)\
+     * A page that is being rendered.
+     *
+     * - `options.point`: `IPoint`\
+     * An object with coordinates of the top-left corner of the element being rendered. This object contains the following properties: `{ xLeft: number, yTop: number }`.
+     *
+     * - `options.bricks`: [`PdfBrick[]`](https://surveyjs.io/pdf-generator/documentation/api-reference/pdfbrick)\
+     * An array of [bricks](https://surveyjs.io/pdf-generator/documentation/customize-survey-question-rendering-in-pdf-form#custom-rendering) used to render the element.
+     *
+     * - `options.controller`: [`DocController`](https://surveyjs.io/pdf-generator/documentation/api-reference/doccontroller)\
+     * An object that provides access to main PDF document properties (font, margins, page width and height) and allows you to modify them.
+     *
+     * - `options.repository`: `FlatRepository`\
+     * A repository with classes that render elements to PDF. Use its `create` method if you need to create a new instance of a rendering class.
+     *
+     * [View Demo](https://surveyjs.io/pdf-generator/examples/how-to-use-adorners-in-pdf-forms/ (linkStyle))
+     */
+    onRenderPage: EventAsync<SurveyPDF, AdornersPageOptions>;
+    onDocControllerCreated: EventBase<SurveyPDF, {
+        controller: DocController;
+    }>;
+    onRenderCheckItemAcroform: EventAsync<SurveyPDF, any>;
+    onRenderRadioGroupWrapAcroform: EventAsync<SurveyPDF, any>;
+    onRenderRadioItemAcroform: EventAsync<SurveyPDF, any>;
+    private waitForQuestionIsReady;
+    private waitForCoreIsReady;
+    getUpdatedCheckItemAcroformOptions(options: any): void;
+    getUpdatedRadioGroupWrapOptions(options: any): void;
+    getUpdatedRadioItemAcroformOptions(options: any): void;
+    private correctBricksPosition;
+    protected renderSurvey(controller: DocController): Promise<void>;
+    /**
+     * An asynchronous method that starts download of the generated PDF file in the web browser.
+     *
+     * @param fileName *(Optional)* A file name with the ".pdf" extension. Default value: `"survey_result.pdf"`.
+     */
+    save(fileName?: string): Promise<any>;
+    /**
+     * An asynchronous method that allows you to get PDF content in different formats.
+     *
+     * [View Demo](https://surveyjs.io/pdf-generator/examples/convert-pdf-form-blob-base64-raw-pdf-javascript/ (linkStyle))
+     *
+     * @param type *(Optional)* One of `"blob"`, `"bloburl"`, `"dataurlstring"`. Do not specify this parameter if you want to get raw PDF content as a string value.
+     *
+     */
+    raw(type?: string): Promise<string>;
+}