Skip to content

[add] header/footer config settings for pdf()/png() methods #58

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.

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 1 commit into from
Mar 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions docs/api/export/pdf_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ pdf(config?: object): void;
- `title` - (optional) the document name
- `pageNumber` - (optional) the current page number
- `totalPages` - (optional) the total number of pages in the document
- `header?: string` - (optional) an HTML template for the header in the exported file
- `footer?: string` - (optional) an HTML template for the footer in the exported file

### Example

Expand Down
6 changes: 4 additions & 2 deletions docs/api/export/png_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@ png(config?: object): void;
### Parameters

- `config` - (optional) an object with export settings. You can specify the following settings for export to PNG:
- `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/png/5.0.0`
- `name?: string` - the name of the exported file
- `url?: string` - (optional) 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/png/5.0.0`
- `name?: string` - (optional) the name of the exported file
- `header?: string` - (optional) an HTML template for the header in the exported file
- `footer?: string` - (optional) an HTML template for the footer in the exported file

### Example

Expand Down
Loading