Skip to content

ConvertOptions

Defined in: src/core/converter/facade.ts:27

  • ConvertDocxOptions

readonly optional attachments?: readonly AttachedFile[]

Defined in: src/layout/styled-layout.ts:187

StyledRenderOptions.attachments


readonly optional charts?: ReadonlyMap<string, Chart>

Defined in: src/layout/styled-layout.ts:152

StyledRenderOptions.charts


readonly optional embeddedFonts?: ReadonlyMap<string, FontRegistry>

Defined in: src/layout/styled-layout.ts:137

StyledRenderOptions.embeddedFonts


readonly optional embedSource?: boolean

Defined in: src/word/docx-to-pdf.ts:25

ConvertDocxOptions.embedSource


readonly optional fontBytes?: Uint8Array<ArrayBufferLike>

Defined in: src/word/docx-to-pdf.ts:15

ConvertDocxOptions.fontBytes


readonly optional fontFamily?: string

Defined in: src/word/docx-to-pdf.ts:19

ConvertDocxOptions.fontFamily


readonly optional fontFetch?: FetchLike

Defined in: src/word/docx-to-pdf.ts:21

ConvertDocxOptions.fontFetch


readonly optional fontProviders?: readonly FontProvider[]

Defined in: src/core/converter/facade.ts:43

Font resolution chain (ir-design §8). When set (and no caller fonts), the facade resolves the default font set through these providers — e.g. [localFontProvider(), remoteFontProvider()] — and reports a ‘substituted’ loss when anything below a caller/embedded answer wins. Local Font Access stays strictly opt-in via this option (it can trigger a permission prompt), which is why nothing wires it in by default.


readonly optional fonts?: FontBytesByVariant

Defined in: src/word/docx-to-pdf.ts:16

ConvertDocxOptions.fonts


readonly optional headersFooters?: ReadonlyMap<string, readonly BodyElement[]>

Defined in: src/layout/styled-layout.ts:147

StyledRenderOptions.headersFooters


readonly optional hyphenator?: Hyphenator

Defined in: src/layout/styled-layout.ts:162

StyledRenderOptions.hyphenator


readonly optional info?: DocumentInfo

Defined in: src/layout/styled-layout.ts:165

StyledRenderOptions.info


readonly optional language?: string

Defined in: src/layout/styled-layout.ts:182

StyledRenderOptions.language


readonly optional marginBottom?: number

Defined in: src/layout/styled-layout.ts:158

StyledRenderOptions.marginBottom


readonly optional marginLeft?: number

Defined in: src/layout/styled-layout.ts:155

StyledRenderOptions.marginLeft


readonly optional marginRight?: number

Defined in: src/layout/styled-layout.ts:156

StyledRenderOptions.marginRight


readonly optional marginTop?: number

Defined in: src/layout/styled-layout.ts:157

StyledRenderOptions.marginTop


readonly optional numbering?: Numbering

Defined in: src/layout/styled-layout.ts:139

StyledRenderOptions.numbering


readonly optional pageHeight?: number

Defined in: src/layout/styled-layout.ts:154

StyledRenderOptions.pageHeight


readonly optional pageWidth?: number

Defined in: src/layout/styled-layout.ts:153

StyledRenderOptions.pageWidth


readonly optional pdfA?: PdfALevel

Defined in: src/layout/styled-layout.ts:173

StyledRenderOptions.pdfA


readonly optional registriesByFamily?: ReadonlyMap<FamilyKey, FontRegistry>

Defined in: src/layout/styled-layout.ts:133

StyledRenderOptions.registriesByFamily


readonly optional resources?: ResourceStore

Defined in: src/layout/styled-layout.ts:149

StyledRenderOptions.resources


readonly optional section?: SectionProperties

Defined in: src/layout/styled-layout.ts:142

StyledRenderOptions.section


readonly optional sections?: readonly Section[]

Defined in: src/layout/styled-layout.ts:146

StyledRenderOptions.sections


readonly optional signature?: SignatureOptions

Defined in: src/word/docx-to-pdf.ts:28

ConvertDocxOptions.signature


readonly optional signaturePlaceholder?: SignaturePlaceholder

Defined in: src/layout/styled-layout.ts:191

StyledRenderOptions.signaturePlaceholder


readonly optional strict?: boolean

Defined in: src/core/converter/facade.ts:34

Strict mode (handoff v1 §5): throw ConversionLossError on the first recorded loss instead of returning it in the report.


readonly optional tagged?: boolean

Defined in: src/layout/styled-layout.ts:178

StyledRenderOptions.tagged


readonly optional to?: "pdf" | "svg"

Defined in: src/core/converter/facade.ts:29

Target format: ‘pdf’ (default) or ‘svg’ (page-stack preview).