ExportPdfConverterOptionsV2

typedef

The HTML to PDF converter options for V2 of the converter API.

Properties

base_url?: string
disable_compression?: boolean
document?: object
document.margins?: object
document.margins.bottom?: string
document.margins.enable_mirror_margins?: boolean
document.margins.left?: string
document.margins.right?: string
document.margins.top?: string
document.orientation?: 'portrait' | 'landscape'
document.size?: ExportPdfPageFormat | object
document.size.height: string
document.size.width: string
extra_http_headers?: ExportPdfConverterExtraHttpHeaders
footers?: object
footers.default?: ExportPdfSectionDefinitionV2
footers.even?: ExportPdfSectionDefinitionV2
footers.first?: ExportPdfSectionDefinitionV2
footers.odd?: ExportPdfSectionDefinitionV2
headers?: object
headers.default?: ExportPdfSectionDefinitionV2
headers.even?: ExportPdfSectionDefinitionV2
headers.first?: ExportPdfSectionDefinitionV2
headers.odd?: ExportPdfSectionDefinitionV2
merge_fields?: object
merge_fields.data: Record<string, string>
merge_fields.prefix: string
merge_fields.suffix: string
metadata?: object
metadata.author?: string
metadata.custom_fields?: Record<string, string>
metadata.keywords?: Array<string>
metadata.subject?: string
metadata.title?: string
rendering?: object
rendering.wait_for_network?: boolean
rendering.wait_for_selector?: string
rendering.wait_time?: number
security?: object
security.owner_password: string
signature?: object
signature.certificate: string
signature.certificate_password: string
signature.location?: string
signature.reason?: string

Value

object

ExportPdfConverterOptionsV2

Properties

base_url?: string

disable_compression?: boolean

document?: object

document.margins?: object

document.margins.bottom?: string

document.margins.enable_mirror_margins?: boolean

document.margins.left?: string

document.margins.right?: string

document.margins.top?: string

document.orientation?: 'portrait' | 'landscape'

document.size?: ExportPdfPageFormat | object

document.size.height: string

document.size.width: string

extra_http_headers?: ExportPdfConverterExtraHttpHeaders

footers?: object

footers.default?: ExportPdfSectionDefinitionV2

footers.even?: ExportPdfSectionDefinitionV2

footers.first?: ExportPdfSectionDefinitionV2

footers.odd?: ExportPdfSectionDefinitionV2

headers?: object

headers.default?: ExportPdfSectionDefinitionV2

headers.even?: ExportPdfSectionDefinitionV2

headers.first?: ExportPdfSectionDefinitionV2

headers.odd?: ExportPdfSectionDefinitionV2

merge_fields?: object

merge_fields.data: Record<string, string>

merge_fields.prefix: string

merge_fields.suffix: string

metadata?: object

metadata.author?: string

metadata.custom_fields?: Record<string, string>

metadata.keywords?: Array<string>

metadata.subject?: string

metadata.title?: string

rendering?: object

rendering.wait_for_network?: boolean

rendering.wait_for_selector?: string

rendering.wait_time?: number

security?: object

security.owner_password: string

signature?: object

signature.certificate: string

signature.certificate_password: string

signature.location?: string

signature.reason?: string

Value

`base_url?: string`

`disable_compression?: boolean`

`document?: object`

`document.margins?: object`

`document.margins.bottom?: string`

`document.margins.enable_mirror_margins?: boolean`

`document.margins.left?: string`

`document.margins.right?: string`

`document.margins.top?: string`

`document.orientation?: 'portrait' | 'landscape'`

`document.size?: ExportPdfPageFormat | object`

`document.size.height: string`

`document.size.width: string`

`extra_http_headers?: ExportPdfConverterExtraHttpHeaders`

`footers?: object`

`footers.default?: ExportPdfSectionDefinitionV2`

`footers.even?: ExportPdfSectionDefinitionV2`

`footers.first?: ExportPdfSectionDefinitionV2`

`footers.odd?: ExportPdfSectionDefinitionV2`

`headers?: object`

`headers.default?: ExportPdfSectionDefinitionV2`

`headers.even?: ExportPdfSectionDefinitionV2`

`headers.first?: ExportPdfSectionDefinitionV2`

`headers.odd?: ExportPdfSectionDefinitionV2`

`merge_fields?: object`

`merge_fields.data: Record<string, string>`

`merge_fields.prefix: string`

`merge_fields.suffix: string`

`metadata?: object`

`metadata.author?: string`

`metadata.custom_fields?: Record<string, string>`

`metadata.keywords?: Array<string>`

`metadata.subject?: string`

`metadata.title?: string`

`rendering?: object`

`rendering.wait_for_network?: boolean`

`rendering.wait_for_selector?: string`

`rendering.wait_time?: number`

`security?: object`

`security.owner_password: string`

`signature?: object`

`signature.certificate: string`

`signature.certificate_password: string`

`signature.location?: string`

`signature.reason?: string`