Interface IPdfSdk

Interface representing the PDF SDK static methods. This interface is used for typing the sdk field in IPdfEditorResult.

interface IPdfSdk {
    initialize(
        options: IInitializeData | (() => Promise<IInitializeData>),
    ): Promise<void>;
    listSystemFonts(): Promise<IFontMini[]>;
    openBlankDocument(data?: ICreateNewDocumentData): Promise<IDocumentModel>;
    openDocument(options: IOpenDocumentOptions): Promise<IDocumentModel>;
    registerUserFonts(fonts: IUserFontData): Promise<void>;
}

Index

Methods

initialize listSystemFonts openBlankDocument openDocument registerUserFonts

Methods

initialize

initialize(
options: IInitializeData | (() => Promise<IInitializeData>),
): Promise<void>
Initializes the PDF SDK with the provided configuration. Must be called before any other SDK operations when using PdfSdk directly; operations requested while initialization is in flight wait for it to settle. Accepts an async factory so heavy option lookup can run under that waiting guarantee. Not needed when using the sdk from PdfEditor() result as it's already initialized.
Parameters
- options: IInitializeData | (() => Promise<IInitializeData>)
Returns Promise<void>
- Defined in sdk/index.ts:106

listSystemFonts

listSystemFonts(): Promise<IFontMini[]>
Retrieves all system fonts available for use in PDF documents.

Returns Promise<IFontMini[]>
- Defined in sdk/index.ts:118

openBlankDocument

openBlankDocument(data?: ICreateNewDocumentData): Promise<IDocumentModel>
Creates and opens a new blank PDF document.
Parameters
- Optionaldata: ICreateNewDocumentData
Returns Promise<IDocumentModel>
- Defined in sdk/index.ts:114

openDocument

openDocument(options: IOpenDocumentOptions): Promise<IDocumentModel>
Opens an existing PDF document from a file.
Parameters
- options: IOpenDocumentOptions
Returns Promise<IDocumentModel>
- Defined in sdk/index.ts:110

registerUserFonts

registerUserFonts(fonts: IUserFontData): Promise<void>
Registers user-provided fonts for use in PDF documents.
Parameters
- fonts: IUserFontData
Returns Promise<void>
- Defined in sdk/index.ts:122