Перейти к основному содержимому
Версия: Next

Interface: PdfDocumentApi

API для работы с PDF файлом в режиме просмотра.

Специализированный интерфейс для работы с PDF документами в режиме просмотра.

ВАЖНО: Несмотря на то, что интерфейс наследует API от DocumentApi он реализует его частично.

Позволяет только управлять масштабом отображаемого документа.

Remarks​

Иерархия интерфейсов:

DocumentApi (базовый интерфейс)
  ├── TextDocumentApi (текстовые документы)
  ├── SpreadsheetDocumentApi (таблицы)
  ├── PresentationDocumentApi (презентации)
  └── PdfDocumentApi (PDF-просмотр) ← текущий интерфейс

Реализуемый функционал от DocumentApi:

  • DocumentApi.zoom — масштабирование отображаемого документа.

Example​

Определение типа документа и работа с ним

const docApi = editorApi.document;

if (docApi.type === 'pdf') {
    // TypeScript типизирует docApi как PdfDocumentApi
    // Теперь доступны методы управлением масштабом документа
    docApi.zoom.zoomIn();
    ...
}

Extends​

Properties​

type​

type: pdf

Тип документа: PDF.

Используется для runtime проверки типа документа.

Remarks​

Это свойство переопределяет базовый type из DocumentApi и явно указывает, что это PDF документ.

Значение:

  • Всегда равно 'pdf'
  • Используется для типизации в TypeScript (type guards)
  • Позволяет разными методами работать с разными типами документов

Example​

if (editorApi.document.type === 'pdf') {
    // Здесь editorApi.document гарантированно PdfDocumentApi
    await editorApi.document.zoom.zoomIn();
}

zoom​

zoom: ZoomApi

API управления масштабированием (zoom) документа.

Позволяет устанавливать, получать и контролировать уровень масштаба документа. Может использоваться для оптимизации просмотра под разные размеры экрана.

Remarks​

Типичные операции:

  • Получить текущий масштаб: zoom.getZoomLevel()
  • Установить масштаб: zoom.setZoomLevel(150) (процент)

See​

ZoomApi — полное описание методов управления масштабом

Example​

// Получить текущий масштаб
const zoom = await editorApi.document.zoom.getZoomLevel();
console.log('Масштаб:', zoom + '%');

// Установить масштаб 150%
await editorApi.document.zoom.setZoomLevel(150);

Inherited from​

DocumentApi.zoom