SurveyPDF

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
  An object that you can use to draw text and images in the page footer.

View Demo

Type:

EventAsync<SurveyPDF, DrawCanvas>

Implemented in:

SurveyPDF

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
  An object that you can use to draw text and images in the page header.

View Demo

Type:

EventAsync<SurveyPDF, DrawCanvas>

Implemented in:

SurveyPDF

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
  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[]
  An array of bricks used to render the element.

• options.controller: 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

Type:

EventAsync<SurveyPDF, AdornersPageOptions>

Implemented in:

SurveyPDF

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
  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[]
  An array of bricks used to render the element.

• options.controller: 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

Type:

EventAsync<SurveyPDF, AdornersPanelOptions>

Implemented in:

SurveyPDF

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
  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[]
  An array of bricks used to render the element.

• options.controller: 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

Type:

EventAsync<SurveyPDF, AdornersOptions>

Implemented in:

SurveyPDF

An asynchronous method that allows you to get PDF content in different formats.

View Demo

Type:

{ (): Promise<string>; (type: "arraybuffer"): Promise<ArrayBuffer>; (type: "blob"): Promise<Blob>; (type: "bloburl"): Promise<URL>; (type: "dataurlstring"): Promise<...>; }

Parameters:

type, type: string

Implemented in:

SurveyPDF

An asynchronous method that starts to download the generated PDF file in the web browser.

View Demo

Type:

(fileName?: string) => Promise<any>

Parameters:

fileName, type: string ,

(Optional) A file name with the ".pdf" extension. Default value: "survey_result.pdf".

Implemented in:

SurveyPDF