Document Authoring

https://www.nutrient.io/api/document-authoring
Admin
Documentation for Document Authoring, a feature or product related to creating and managing...
Tokens:11,133
Snippets:44
Trust Score:9.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Document Authoring SDK via npm

Source: https://www.nutrient.io/api/document-authoring/index

This snippet shows how to install the Nutrient.io Document Authoring SDK using npm. Ensure you have Node.js and npm installed on your system.

```bash
npm install @nutrient-sdk/document-authoring
```

--------------------------------

### Initialize Document Authoring Editor

Source: https://www.nutrient.io/api/document-authoring/index

This example demonstrates how to initialize the Document Authoring editor in a web application. It requires a target DOM element with specific styling and uses the SDK to create a document from plain text.

```javascript
import DocAuth from '@nutrient-sdk/document-authoring';

const docAuthSystem = await DocAuth.createDocAuthSystem();

const editor = await docAuthSystem.createEditor(document.getElementById('editor'), {
	document: await docAuthSystem.createDocumentFromPlaintext('Hi there!'),
});
```

--------------------------------

### FontIndex Configuration Example

Source: https://www.nutrient.io/api/document-authoring/types/FontIndex

An example demonstrating how to configure the FontIndex object. It specifies the type as 'index', provides a URL to the font index file, and defines a function to load individual font files.

```JavaScript
{
  type: 'index',
  index: fetch('/fonts/font-index.json'),
  loadFn: (name) => fetch(`/fonts/${name}`)
}
```

--------------------------------

### Load Fonts using Font Index with FontConfig

Source: https://www.nutrient.io/api/document-authoring/types/FontConfig

This example demonstrates configuring PSPDFKit's Document Authoring to load fonts using a font index. It includes the default font index and a font index fetched from a JSON file, with a load function to dynamically fetch font files as needed.

```JavaScript
fonts: [
  DocAuth.defaultFontIndex,
  {
    type: 'index',
    index: fetch('/fonts/font-index.json'),
    loadFn: (name) => fetch(`/fonts/${name}`),
  },
]
```

--------------------------------

### Example Usage of FontFile

Source: https://www.nutrient.io/api/document-authoring/types/FontFile

This example demonstrates how to use the FontFile type alias to include a font file. It shows the structure required, including the type and the blob input, which in this case is obtained by fetching a font file.

```javascript
{ type:'file', blob: fetch('/fonts/awesome.ttf') }
```

--------------------------------

### Add Custom Fonts with FontConfig

Source: https://www.nutrient.io/api/document-authoring/types/FontConfig

This example shows how to configure PSPDFKit's Document Authoring to use custom fonts by providing font files directly. It includes the default font index along with two TTF font files fetched from specified URLs.

```JavaScript
fonts: [
  DocAuth.defaultFontIndex,
  { type: 'file', blob: fetch('/fonts/awesome.ttf') },
  { type: 'file', blob: fetch('/fonts/more-awesome.ttf') },
]
```

--------------------------------

### Create Document Authoring System Instance

Source: https://www.nutrient.io/api/document-authoring/functions/createDocAuthSystem

Initializes the Document Authoring system, preparing it for tasks such as creating editors, importing Word documents, or generating PDFs. This process includes loading JavaScript and WASM code and managing the font cache.

```javascript
createDocAuthSystem(options?: CreateDocAuthSystemOptions): Promise<DocAuthSystem>
```

--------------------------------

### Create Document Authoring System

Source: https://www.nutrient.io/api/document-authoring/modules

Initializes the Document Authoring system. This function is essential for setting up the core components needed for document manipulation and authoring within PSPDFKit.

```JavaScript
createDocAuthSystem(options: CreateDocAuthSystemOptions): DocAuthSystem;
```

--------------------------------

### Define Document Authoring System Options (TypeScript)

Source: https://www.nutrient.io/api/document-authoring/types/CreateDocAuthSystemOptions

Defines the `CreateDocAuthSystemOptions` type alias for configuring the PSPDFKit document authoring system. This includes optional parameters for license key, assets, and font configuration.

```TypeScript
type CreateDocAuthSystemOptions = {
    licenseKey?: string;
    assets?: Assets;
    fontConfig?: FontConfig;
}
```

--------------------------------

### docAuthSystem Method

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthEditor

Retrieves the DocAuthSystem instance that the editor is bound to. This provides access to the core document authoring system functionalities.

```typescript
docAuthSystem(): DocAuthSystem;
```

--------------------------------

### Type Alias: CreateDocumentFromPlaintextOptions

Source: https://www.nutrient.io/api/document-authoring/types/CreateDocumentFromPlaintextOptions

Defines the structure for options when creating a document from plain text. It allows specifying page size (either custom width/height or standard sizes like Letter, A4, A5, A6) and page margins (left, right, bottom, top, with optional header and footer margins).

```typescript
type CreateDocumentFromPlaintextOptions = {
    pageSize?:
        | {
            width: number;
            height: number;
        }
        | "Letter"
        | "A4"
        | "A5"
        | "A6";
    pageMargins?: {
        left: number;
        right: number;
        bottom: number;
        top: number;
        header?: number;
        footer?: number;
    };
}
```

--------------------------------

### Import DOCX Document with DocAuthSystem

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthSystem

Imports a DOCX document into the Document Authoring system. Optional import options can be provided.

```TypeScript
importDOCX(docx: BlobInput, options?: ImportDOCXOptions): Promise<DocAuthDocument>;
```

--------------------------------

### Create Document from Plaintext with DocAuthSystem

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthSystem

Creates a document from plain text, interpreting patterns for formatting like line breaks and paragraph separation. Special characters like '\n' and '\t' are handled.

```TypeScript
createDocumentFromPlaintext(text: string, options?: CreateDocumentFromPlaintextOptions): Promise<DocAuthDocument>;
```

--------------------------------

### Create Font Index CLI

Source: https://www.nutrient.io/api/document-authoring/types/FontIndex

This command-line utility helps in creating a font index from a directory of fonts. The generated index can then be used to efficiently load fonts into the Document Authoring system.

```Bash
npx document-authoring create-font-index --scan-directory path-to-fonts --write-to font-index.json
```

--------------------------------

### Type Alias UIOptions Configuration

Source: https://www.nutrient.io/api/document-authoring/types/UIOptions

Defines the configuration options for the user interface in PSPDFKit's Document Authoring. This includes settings for locale, units of measurement, and the ruler's visibility.

```TypeScript
type UIOptions = {
    locale?: Locale | "auto";
    unit?: Unit;
    ruler?: {
        enabled: boolean;
    };
}
```

--------------------------------

### CreateEditorOptions Type Alias

Source: https://www.nutrient.io/api/document-authoring/types/CreateEditorOptions

Defines the configuration options for creating a document editor. It allows specifying an initial document and customizing UI elements.

```TypeScript
type CreateEditorOptions = {
    document?: DocAuthDocument;
    ui?: UIOptions;
}
```

--------------------------------

### Load Document with DocAuthSystem

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthSystem

Loads a document into the Document Authoring system. The document can be provided as a JSON string or a JavaScript object.

```TypeScript
loadDocument(documentInput: DocAuthDocumentInput): Promise<DocAuthDocument>;
```

--------------------------------

### Create Editor with DocAuthSystem

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthSystem

Creates a document editor within a specified HTML element. The target element's CSS position must not be 'static' or unset; 'relative' is recommended.

```TypeScript
createEditor(target: HTMLElement, options?: CreateEditorOptions): Promise<DocAuthEditor>;
```

--------------------------------

### docAuthSystem Function

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthDocument

The `docAuthSystem` function within `DocAuthDocument` returns the `DocAuthSystem` instance to which the document is bound.

```TypeScript
docAuthSystem(): DocAuthSystem;
```

--------------------------------

### HTML Structure for Document Authoring Editor

Source: https://www.nutrient.io/api/document-authoring/index

This HTML snippet provides the necessary structure for the Document Authoring editor. It includes a `div` element that must have its CSS `position` property set to a value other than `static` (e.g., `relative`) to function correctly.

```html
<div id="editor" style="position: relative; width: 1024px; height: 600px;"></div>
```

--------------------------------

### Type Alias Assets - TypeScript

Source: https://www.nutrient.io/api/document-authoring/types/Assets

Defines the 'Assets' type for the Document Authoring API. It includes an optional 'base' property for specifying the asset path, allowing for CDN fetching or self-hosting.

```TypeScript
type Assets = { 
    base?: string; 
}
```

--------------------------------

### currentDocument Method

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthEditor

Retrieves a reference to the currently attached document. This allows access to the document's content and properties for further processing.

```typescript
currentDocument(): DocAuthDocument;
```

--------------------------------

### exportDOCX Function

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthDocument

The `exportDOCX` function within `DocAuthDocument` exports a snapshot of the current document as a DOCX file. It accepts optional `ExportDOCXOptions` and returns a Promise resolving to an `ArrayBuffer`.

```TypeScript
exportDOCX(options?: ExportDOCXOptions): Promise<ArrayBuffer>;
```

--------------------------------

### once Method - One-Time Event Listener

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthEditor

Adds an event listener that will be executed only once. After the specified event is emitted and the handler is called, the listener is automatically removed. This is useful for one-off initializations or checks.

```typescript
once(event: EventName, handler: (payload: EventPayload) => void): DocAuthEditor;
```

```javascript
editor.once('document.load', () => {  
  console.log('Document loaded for the first time');  
});
```

--------------------------------

### on Method - Event Listener

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthEditor

Adds an event listener to the editor. The provided handler function will be invoked every time the specified event is emitted. This is useful for reacting to document changes or load events.

```typescript
on(event: EventName, handler: (payload: EventPayload) => void): DocAuthEditor;
```

```javascript
// Get the latest document content  
editor.on('content.change', async () => console.log(await editor.currentDocument().saveDocument()));
```

--------------------------------

### BlobInput Type Alias Definition

Source: https://www.nutrient.io/api/document-authoring/types/BlobInput

Defines the BlobInput type alias, which specifies the acceptable input formats for document creation. It supports Promises that resolve to Response, Blob, or ArrayBuffer, as well as direct Response, Blob, or ArrayBuffer objects.

```TypeScript
type BlobInput:
    | Promise<Response | Blob | ArrayBuffer>
    | Response
    | Blob
    | ArrayBuffer
```

--------------------------------

### Destroy DocAuthSystem

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthSystem

Releases all resources held by the Document Authoring system. After calling this method, the system and any associated editors become unusable.

```TypeScript
destroy(): void;
```

--------------------------------

### DocAuthEditor Type Alias

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthEditor

Defines the DocAuthEditor interface, outlining its methods for document manipulation and event handling within the PSPDFKit Document Authoring system.

```typescript
type DocAuthEditor = {
    setCurrentDocument(doc: DocAuthDocument): void;
    currentDocument(): DocAuthDocument;
    destroy(): void;
    docAuthSystem(): DocAuthSystem;
    on(event: EventName, handler: (payload: EventPayload) => void): DocAuthEditor;
    off(event: EventName, handler?: (payload: EventPayload) => void): DocAuthEditor;
    once(event: EventName, handler: (payload: EventPayload) => void): DocAuthEditor;
}
```

--------------------------------

### setCurrentDocument Method

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthEditor

Attaches a provided DocAuthDocument to the editor. This method is crucial for loading and managing documents within the authoring environment.

```typescript
setCurrentDocument(doc: DocAuthDocument): void;
```

--------------------------------

### DocAuthDocument Type Alias

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthDocument

Defines the `DocAuthDocument` type, outlining methods for saving and exporting documents. It includes functions to save the document as a JavaScript object or a JSON string, export it to PDF or DOCX formats, and access the `DocAuthSystem`.

```TypeScript
type DocAuthDocument = {
    saveDocument(): Promise<object>;
    saveDocumentJSONString(): Promise<string>;
    exportPDF(options?: ExportPDFOptions): Promise<ArrayBuffer>;
    exportDOCX(options?: ExportDOCXOptions): Promise<ArrayBuffer>;
    docAuthSystem(): DocAuthSystem;
};
```

--------------------------------

### Variable defaultFontIndex - PSPDFKit Document Authoring

Source: https://www.nutrient.io/api/document-authoring/variables/defaultFontIndex-1

The `defaultFontIndex` is a constant variable provided by the PSPDFKit Document Authoring SDK. It represents the default set of fonts bundled with the SDK. For custom font configurations, refer to the `FontConfig` documentation.

```typescript
declare const defaultFontIndex: DefaultFontIndex;
```

--------------------------------

### exportPDF Function

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthDocument

The `exportPDF` function within `DocAuthDocument` exports a snapshot of the current document as a PDF file. It accepts optional `ExportPDFOptions` and returns a Promise resolving to an `ArrayBuffer`.

```TypeScript
exportPDF(options?: ExportPDFOptions): Promise<ArrayBuffer>;
```

--------------------------------

### DocAuthDocumentInput Type Alias

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthDocumentInput

Defines the `DocAuthDocumentInput` type, which specifies the acceptable formats for document authoring input. This includes strings (JSON format), objects (JavaScript representation), Blobs, Responses, or Promises resolving to these types.

```TypeScript
type DocAuthDocumentInput =
    | string
    | object
    | Blob
    | Response
    | Promise<
        | string
        | object
        | Blob
        | Response>;

```

--------------------------------

### Type Alias ExportDOCXOptions

Source: https://www.nutrient.io/api/document-authoring/types/ExportDOCXOptions

Defines the options available for exporting documents to DOCX format. It includes an optional `AbortSignal` to allow for the cancellation of the export process.

```TypeScript
type ExportDOCXOptions = {
    abortSignal?: AbortSignal;
}
```

--------------------------------

### Type Alias Unit in Document Authoring API

Source: https://www.nutrient.io/api/document-authoring/types/Unit

Defines the supported units for document formatting within the PSPDFKit Document Authoring API. These units are used to specify measurements and are referenced in UIOptions.

```TypeScript
type Unit = "cm" |
    "in" |
    "pt" |
    "pc" |
    "mm";
```

--------------------------------

### Type Alias ExportPDFOptions

Source: https://www.nutrient.io/api/document-authoring/types/ExportPDFOptions

Defines the options available for exporting a document to PDF. It includes an optional AbortSignal to cancel the operation and a boolean flag to enable PDF/A compliance.

```TypeScript
type ExportPDFOptions = {
    abortSignal?: AbortSignal;
    PDF_A?: boolean;
}
```

--------------------------------

### Type Alias: ImportDOCXOptions with AbortSignal

Source: https://www.nutrient.io/api/document-authoring/types/ImportDOCXOptions

Defines the ImportDOCXOptions type alias, which includes an optional AbortSignal. This signal can be used to cancel the document import process.

```TypeScript
type ImportDOCXOptions = {
    abortSignal?: AbortSignal;
}
```

--------------------------------

### destroy Method

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthEditor

Removes all DOM elements associated with the editor and releases its resources. It's important to note that this method does not release the underlying DocAuthSystem; a separate call to DocAuthSystem.destroy is required for a full teardown.

```typescript
destroy(): void;
```

--------------------------------

### saveDocument Function

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthDocument

The `saveDocument` function within `DocAuthDocument` returns the current document state as a JavaScript object. This object is suitable for persistence.

```TypeScript
saveDocument(): Promise<object>;
```

--------------------------------

### Define FontFile Type Alias

Source: https://www.nutrient.io/api/document-authoring/types/FontFile

The FontFile type alias is used to specify a single font file to be added to the system. It requires a 'type' property set to 'file' and a 'blob' property containing the font data.

```typescript
type FontFile = {
    type: "file";
    blob: BlobInput;
}
```

--------------------------------

### saveDocumentJSONString Function

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthDocument

The `saveDocumentJSONString` function within `DocAuthDocument` returns the current document state as a JSON string. This string is safe for persistence.

```TypeScript
saveDocumentJSONString(): Promise<string>;
```

--------------------------------

### Locale Type Alias Definition

Source: https://www.nutrient.io/api/document-authoring/types/Locale

Defines the Locale type alias for the PSPDFKit Document Authoring API. It specifies the supported language codes as 'en', 'fr', and 'de', corresponding to English, French, and German respectively.

```TypeScript
type Locale = "en" | "fr" | "de";
```

--------------------------------

### Type Alias: DefaultFontIndex

Source: https://www.nutrient.io/api/document-authoring/types/DefaultFontIndex

Defines the DefaultFontIndex type, which is the default font index included in the Document Authoring SDK. It is used in conjunction with FontConfig for font customization.

```TypeScript
type DefaultFontIndex = {
    type: "default-index";
}
```

--------------------------------

### off Method - Remove Event Listener

Source: https://www.nutrient.io/api/document-authoring/types/DocAuthEditor

Removes an event listener from the editor. If a specific handler is provided, only that listener is removed. If no handler is specified, all listeners for the given event are removed.

```typescript
off(event: EventName, handler?: (payload: EventPayload) => void): DocAuthEditor;
```

```javascript
// Remove specific handler  
editor.off('content.change', myHandler);  

// Remove all handlers for an event  
editor.off('content.change');
```
Tokens:
Raw