Skip to content

Commit a986cd1

Browse files
author
Victory
committed
[fix] indents
1 parent ddffe2d commit a986cd1

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

docs/api/export/pdf_method.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -23,31 +23,31 @@ pdf(config?: object): void;
2323
### Parameters
2424

2525
- `config` - (optional) an object with export settings. You can specify the following settings for export to PDF:
26-
- `url: string` - the url of the service that executes export and returns an exported file. This setting is optional, you should use it only if you need to specify the path to your local export service. The default value is `https://export.dhtmlx.com/diagram/2.0.0/pdf`
27-
- `name: string` - the name of the exported file
28-
- `header: string` - specifies the header that will be added to the resulted PDF file. You can use any HTML here
29-
- `footer: string` - specifies the footer that will be added to the resulted PDF file. You can use any HTML here
30-
- `pdf: object` - the options object. It can have the following properties:
31-
- `scale: number` - the scale of the webpage rendering, **1** by default
32-
- `displayHeaderFooter: boolean` - displays header and footer, **false** by default
33-
- `headerTemplate: string` - an HTML template for the print header. It should be valid HTML markup with following classes used to inject printing values into them:
34-
- `date` - formatted print date
35-
- `title` - document title
36-
- `url` - document location
37-
- `pageNumber` - current page number
38-
- `totalPages` - total pages in the document
39-
- `footerTemplate: string` - an HTML template for the print footer. Should use the same format as the headerTemplate
40-
- `printBackground: boolean` - print background graphics, **false** by default
41-
- `landscape: boolean` - paper orientation, **false** by default
42-
- `pageRanges: string` - paper ranges to print, e.g., '1-5, 8, 11-13'. By default it is set to an empty string, which means print all pages
43-
- `format: string` - paper format. If set, takes priority over width or height options. **'Letter'** by default
44-
- `width: string` - paper width, accepts values labeled with units
45-
- `height: string` - paper height, accepts values labeled with units
46-
- `margin: object` - paper margins, none by default
47-
- `top: string` - top margin, accepts values labeled with units
48-
- `right: string` - right margin, accepts values labeled with units
49-
- `bottom: string` - bottom margin, accepts values labeled with units
50-
- `left: string` - left margin, accepts values labeled with units
26+
- `url: string` - the url of the service that executes export and returns an exported file. This setting is optional, you should use it only if you need to specify the path to your local export service. The default value is `https://export.dhtmlx.com/diagram/2.0.0/pdf`
27+
- `name: string` - the name of the exported file
28+
- `header: string` - specifies the header that will be added to the resulted PDF file. You can use any HTML here
29+
- `footer: string` - specifies the footer that will be added to the resulted PDF file. You can use any HTML here
30+
- `pdf: object` - the options object. It can have the following properties:
31+
- `scale: number` - the scale of the webpage rendering, **1** by default
32+
- `displayHeaderFooter: boolean` - displays header and footer, **false** by default
33+
- `headerTemplate: string` - an HTML template for the print header. It should be valid HTML markup with following classes used to inject printing values into them:
34+
- `date` - formatted print date
35+
- `title` - document title
36+
- `url` - document location
37+
- `pageNumber` - current page number
38+
- `totalPages` - total pages in the document
39+
- `footerTemplate: string` - an HTML template for the print footer. Should use the same format as the headerTemplate
40+
- `printBackground: boolean` - print background graphics, **false** by default
41+
- `landscape: boolean` - paper orientation, **false** by default
42+
- `pageRanges: string` - paper ranges to print, e.g., '1-5, 8, 11-13'. By default it is set to an empty string, which means print all pages
43+
- `format: string` - paper format. If set, takes priority over width or height options. **'Letter'** by default
44+
- `width: string` - paper width, accepts values labeled with units
45+
- `height: string` - paper height, accepts values labeled with units
46+
- `margin: object` - paper margins, none by default
47+
- `top: string` - top margin, accepts values labeled with units
48+
- `right: string` - right margin, accepts values labeled with units
49+
- `bottom: string` - bottom margin, accepts values labeled with units
50+
- `left: string` - left margin, accepts values labeled with units
5151

5252
### Example
5353

0 commit comments

Comments
 (0)