Skip to content

Added x and y to the type on HTMLOptions #2893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 3, 2020
Merged

Added x and y to the type on HTMLOptions #2893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5dc9765
Added x and y to the type on HTMLOptions
aaron-russell Sep 1, 2020
c31095e
Updated documentation for html function
aaron-russell Sep 2, 2020
b834d38
Added missing comma
aaron-russell Sep 2, 2020
0ff566f
Added more html parameters to the docs
aaron-russell Sep 2, 2020
fbc9303
Removed enableLinks option from docs
aaron-russell Sep 2, 2020
2ab898b
Removed enableLinks and pageBreak from HTMLOptions
aaron-russell Sep 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion src/modules/html.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -969,14 +969,23 @@ import { globalObject } from "../libs/globalObject.js";
* @param {HTMLElement|string} source The source HTMLElement or a string containing HTML.
* @param {Object} [options] Collection of settings
* @param {function} [options.callback] The mandatory callback-function gets as first parameter the current jsPDF instance
* @param {number|array} [options.margin] Array of margins [left, bottom, right, top]
* @param {string} [options.filename] name of the file
* @param {HTMLOptionImage} [options.image] image settings when converting HTML to image
* @param {Html2CanvasOptions} [options.html2canvas] html2canvas options
* @param {jsPDF} [options.jsPDF] jsPDF instance
* @param {number} [options.x] x position on the PDF document
* @param {number} [options.y] y position on the PDF document
*
* @example
* var doc = new jsPDF();
*
* doc.html(document.body, {
* callback: function (doc) {
* doc.save();
* }
* },
* x: 10,
* y: 10
* });
*/
jsPDFAPI.html = function(src, options) {
Expand Down
11 changes: 2 additions & 9 deletions types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,22 +182,15 @@ declare module "jspdf" {
quality: number;
}

export interface HTMLOptionPageBreak {
mode?: "avoid-all" | "css" | "legacy" | ("avoid-all" | "css" | "legacy")[];
before?: string;
after?: string;
avoid?: string;
}

export interface HTMLOptions {
callback?: (doc: jsPDF) => void;
margin?: number | number[];
filename?: string;
enableLinks?: boolean;
pagebreak?: HTMLOptionPageBreak;
image?: HTMLOptionImage;
html2canvas?: Html2CanvasOptions;
jsPDF?: jsPDF;
x?: number;
y?: number;
}

//jsPDF plugin: viewerPreferences
Expand Down