Interface DocumentScope

API to access information about and communicate with the current document.

since: 13.2

Hierarchy

DocumentScope

Index

Properties

field

Methods

Properties

field

field: FieldScope

API for the current field of the current document.

since: 13.2

Methods

get

get(): Promise<DocumentProperties>

- Defined in api.ts:319
since

13.2

Returns Promise<DocumentProperties>

A Promise that resolves with DocumentProperties of the current document.

navigate

navigate(path: string): Promise<void>

- Defined in api.ts:327
Navigates a document path in the content perspective.

since

14.2

Parameters
- path: string
Returns Promise<void>

A Promise that resolves when the document is opened.

open

open(id: string): Promise<void>

- Defined in api.ts:335
Opens a document by id in the content perspective.

since

14.2

Parameters
- id: string
  
  The document id.
Returns Promise<void>

A Promise that resolves when the document is opened.