Описание
Раздел кастомизации позволяет настроить интерфейс редактора так, чтобы он был похож на другие ваши продукты (если они есть), а также изменить наличие или отсутствие дополнительных кнопок, ссылок, изменить логотипы и информацию о владельце редактора.
Параметры
| Название | Описание | Тип | Пример |
|---|---|---|---|
| anonymous | Добавляет запрос на анонимное имя:
| object | { «request»: true, «label»: «Guest» } |
| autosave | Определяет, включена или отключена опция меню Автосохранение. Если установлено значение false, можно выбрать только режим совместного редактирования Strict, так как Fast не работает без автосохранения. Значение по умолчанию true. | логический | true |
Важно В случае изменения этого параметра в интерфейсе редактора он будет сохранен в локальном хранилище браузера и перезапишет любые значения, отправленные в качестве параметра editorConfig.customization.autosave. | |||
| chat | Определяет, отображается ли кнопка меню Чата или скрыта. Обратите внимание, что если вы скроете кнопку чата, соответствующий функционал чата также будет отключен. Значение по умолчанию true. Устарело с версии 7.1, вместо этого используйте параметр document.permissions.chat | логический | true |
| commentAuthorOnly | Определяет, может ли пользователь редактировать и удалять только свои комментарии. Значение по умолчанию false. Устарело, начиная с версии 6.3. Вместо этого используйте поля document.permissions.editCommentAuthorOnly и ddocument.permissions.deleteCommentAuthorOnly | логический | true |
| comments | Определяет, отображается ли кнопка меню «Комментарии» или скрыта. Обратите внимание, что если вы скроете кнопку «Комментарии», соответствующий функционал комментирования будет доступен только для просмотра, добавление и редактирование комментариев будет недоступно. Значение по умолчанию true. | логический | true |
| compactHeader | Определяет, будут ли кнопки дополнительных действий отображаться в верхней части заголовка окна редактора рядом с логотипом (false) или на панели инструментов (true), делая заголовок более компактным. Значение по умолчанию false. | логический | false |
| compactToolbar | Определяет, является ли отображаемый тип верхней панели инструментов полной (false) или компактной (true). Значение по умолчанию false. | логический | false |
Важно В случае изменения этого параметра в интерфейсе редактора он будет сохранен в локальном хранилище браузера и перезапишет любые значения, отправленные в качестве параметра editorConfig.customization.compactToolbar. | |||
| compatibleFeatures | Определяет использование функций, совместимых только с форматом OOXML. Например, не используйте комментарии ко всему документу. Значение по умолчанию false. | логический | false |
| customer* | Содержит информацию, которая будет отображаться в разделе «О редакторе» и видна всем пользователям редактора. Объект имеет следующие параметры:
| object | { «address»: «My City, 123a-45», «info»: «Some additional information», «logo»: «https://example.com/logo-big.png», «logoDark»: «https://example.com/dark-logo-big.png», «mail»: «john@example.com», «name»: «John Smith and Co.», «phone»: «123456789», «www»: «example.com» } |
| features | Определяет параметры, которые пользователь может отключить или кастомизировать, если это возможно.:
| объект | { «spellcheck»: { «mode»: true } } |
Важно В случае изменения настройки проверки орфографии в интерфейсе редактора она будет сохранена в локальном хранилище браузера и перезапишет любые значения, отправленные в качестве параметра editorConfig.customization.features.spellcheck. | |||
| feedback | Определяет настройки для кнопки меню «Обратная связь и поддержка». Может быть логическим (просто отображает или скрывает кнопку меню «Обратная связь и поддержка») или объектом. В случае типа объекта доступны следующие параметры:
Значение по умолчанию false. | логический или объект | true |
| forcesave | Добавляет запрос на принудительное сохранение файла в обработчик обратного вызова при сохранении документа в службе редактирования документов (например, при нажатии кнопки «Сохранить» и т. д.). Значение по умолчанию false. | логический | false |
Важно В случае изменения этого параметра в интерфейсе редактора он будет сохранен в локальном хранилище браузера и перезапишет любые значения, отправленные в качестве параметра editorConfig.customization.forcesave. | |||
| goback | Определяет настройки для кнопки меню «Открыть местоположение файла» и кнопки в верхнем правом углу. Объект имеет следующие параметры:
| логический или объект | true |
| help | Определяет, отображается ли кнопка меню «Справка» или скрыта. Значение по умолчанию true | логический | true |
| hideNotes | Определяет, будет ли отображаться панель заметок при первой загрузки. Значение по умолчанию false. Данный параметр доступен только для редактирования презентации. | логический | false |
Важно В случае изменения этого параметра в интерфейсе редактора он будет сохранен в локальном хранилище браузера и перезапишет любые значения, отправленные в качестве параметра editorConfig.customization.hideNote | |||
| hideRightMenu | Определяет, отображается ли правое меню при первой загрузке или скрыто. Значение по умолчанию false | логический | false |
Важно В случае изменения этого параметра в интерфейсе редактора он будет сохранен в локальном хранилище браузера и перезапишет любые значения, отправленные в качестве параметра editorConfig.customization.hideRightMenu. | |||
| hideRulers | Определяет, будут ли линейки редактора отображаться или будут скрыты.Этот параметр доступен для редакторов документов и презентаций. Значение по умолчанию — false для редактора документов и true для презентаций. | логический | false |
| logo* | Изменяет файл изображения в верхнем левом углу заголовка редактора. Рекомендуемая высота изображения — 20 пикселей. Объект имеет следующие параметры:
| объект | |
| macros | Определяет, будут ли автоматически запускаться макросы документа при открытии редактора. Значение по умолчанию true. Значение false скрывает настройки макроса от пользователя. | логический | true |
| macrosMode | Определяет режим запуска макросов при включенном автозапуске. Может принимать следующие значения:
Значение по умолчанию warn. | строковый | warn |
Важно В случае изменения этого параметра в интерфейсе редактора он будет сохранен в локальном хранилище браузера и перезапишет любые значения, отправленные в качестве параметра editorConfig.customization.macrosMode. | |||
| mentionShare | Определяет подсказку, описывающую событие после упоминания в комментарии. Если true, подсказка указывает, что пользователь получит уведомление и доступ к документу. Если false, подсказка указывает, что пользователь получит только уведомление об упоминании. Значение по умолчанию true. | логический | true |
Важно Это будет доступно только для комментариев, если установлено событие onRequestSendNotify | |||
| plugins | Определяет, будут ли плагины запущены и доступны. Значение по умолчанию true. | логический | true |
| review | Содержит информацию о режиме просмотра. Объект имеет следующие параметры:
| объект | { «hideReviewDisplay»: false, «showReviewChanges»: false, «reviewDisplay»: «original», «trackChanges»: true, «hoverMode»: false } |
Уточнение Параметры showReviewChanges, reviewDisplay, trackChanges устарели, начиная с версии 7.0. Вместо этого используйте параметр обзора. Важно В случае изменения этого параметра в интерфейсе редактора он будет сохранен в локальном хранилище браузера и перезапишет любые значения, отправленные в качестве параметров editorConfig.customization.review.hoverMode и editorConfig.customization.review.reviewDisplay. | |||
| reviewDisplay | Определяет режим редактирования просмотра в редакторе документов. Этот параметр может принимать следующие значения:
The default value is original for viewer and markupfor editor. | строковый | original |
Уточнение Устарело с версии 7.0. Вместо этого используйте параметр review.reviewDisplay. Важно В случае изменения этого параметра в интерфейсе редактора он будет сохранен в локальном хранилище браузера и перезапишет любые значения, отправленные в качестве параметра editorConfig.customization.reviewDisplay. | |||
| showReviewChanges | Определяет, будет ли панель просмотра изменений автоматически отображаться или скрываться при загрузке редактора. Значение по умолчанию false. | логический | false |
Уточнение Устарело с версии 7.0. Вместо этого используйте параметр review.showReviewChanges | |||
| spellcheck | Определяет, будет ли проверка орфографии автоматически включаться или выключаться при загрузке редактора. Проверка орфографии будет доступна только для редактора документов и редактора презентаций. Значение по умолчанию true. | логический | true |
Уточнение Устарело с версии 7.1. Вместо этого используйте параметр features.spellcheck Важно В случае изменения этого параметра в интерфейсе редактора он будет сохранен в локальном хранилище браузера и перезапишет любые значения, отправленные в качестве параметра editorConfig.customization.spellcheck. | |||
| toolbarHideFileName | Определяет, будет ли заголовок документа отображаться на верхней панели инструментов (false) или скрыт (true). Значение по умолчанию false. | логический | false |
Важно Этот параметр используется, когда для параметров compactHeader и toolbarNoTabs установлено значение true. | |||
| toolbarNoTabs | Определяет, будут ли верхние вкладки панели инструментов отображаться отчетливо (false) или будут выделены только для того, чтобы увидеть, какая из них выбрана (true). Значение по умолчанию false. | логический | false |
| trackChanges | Определяет, будет ли документ открыт в режиме редактирования (true) или нет (false) независимо от параметра document.permissions.review (режим просмотра изменяется только для текущего пользователя). Если параметр не определен, используется значение document.permissions.review (для всех пользователей документа). | логический | true |
Уточнение Устарело с версии 7.0. Вместо этого используйте параметр review.trackChanges | |||
| uiTheme | Определяет настройки темы редактора. Его можно установить двумя способами:
Первый вариант имеет более высокий приоритет. Помимо доступных тем редактора, пользователь также может настроить/кастомизировать свои собственные цветовые темы для интерфейса приложения. | строковый | theme-dark |
Важно В случае изменения этого параметра в интерфейсе редактора он будет сохранен в локальном хранилище браузера и перезапишет любые значения, отправленные в качестве параметра editorConfig.customization.uiTheme. | |||
| unit | Определяет единицы измерения, используемые на линейке и в диалоговых окнах. Может принимать следующие значения:
Значения по умолчанию сантиметры (cm). | строковый | cm |
Важно В случае изменения этого параметра в интерфейсе редактора он будет сохранен в локальном хранилище браузера и перезапишет любые значения, отправленные в качестве параметра editorConfig.customization.unit. | |||
| zoom | Определяет значение масштабирования отображения документа, измеряемое в процентах. Может принимать значения больше 0. Для текстовых документов и презентаций этот параметр можно установить на -1 (опция подгонки документа под страницу) или до -2 (подгонка ширины страницы документа под страницу редактора). Значение по умолчанию — 100. | целое число | 100 |
Важно В случае изменения этого параметра в интерфейсе редактора он будет сохранен в локальном хранилище браузера и перезапишет любые значения, отправленные в качестве параметра editorConfig.customization.zoom. | |||
* — доступно для редактирования только для Р7 Developer Edition.
И связанных пунктов:
- logo*
- customer*
Пример
var docEditor = new DocsAPI.DocEditor("placeholder", {
"editorConfig": {
"customization": {
"anonymous": {
"request": true,
"label": "Guest"
},
"comments": true,
"compactHeader": false,
"compactToolbar": false,
"compatibleFeatures": false,
"customer": {
"address": "My City, 123a-45",
"info": "Some additional information",
"logo": "https://example.com/logo-big.png",
"logoDark": "https://example.com/dark-logo-big.png",
"mail": "john@example.com",
"name": "John Smith and Co.",
"phone": "123456789",
"www": "example.com"
},
"features": {
"spellcheck": {
"mode": true,
}
},
"feedback": {
"url": "https://example.com",
"visible": true
},
"forcesave": false,
"goback": {
"blank": true,
"requestClose": false,
"text": "Open file location",
"url": "https://example.com"
},
"help": true,
"hideNotes": false,
"hideRightMenu": false,
"hideRulers": false,
"logo": {
"image": "https://example.com/logo.png",
"imageDark": "https://example.com/dark-logo.png",
"url": "https://www.Р7.com"
},
"macros": true,
"macrosMode": "warn",
"mentionShare": true,
"plugins": true,
"review": {
"hideReviewDisplay": false,
"showReviewChanges": false,
"reviewDisplay": "original",
"trackChanges": true,
"hoverMode": false
},
"toolbarHideFileName": false,
"toolbarNoTabs": false,
"uiTheme": "theme-dark",
"unit": "cm",
"zoom": 100
},
...
},
...
});
Где example.com — это имя сервера, на котором установлены менеджер документов и служба хранения документов. Дополнительные сведения о взаимодействии клиент-сервер службы Сервера документов см. в разделе Как это работает.
Конфигурация редактора
Описание
Раздел editorConfig позволяет изменить параметры, относящиеся к интерфейсу редактора: режим открытия (просмотр или редактор), язык интерфейса, дополнительные кнопки и т. д.):
- Режим;
- Редактирование;
- Пользователь;
- Кастомизация.
Здесь вы можете увидеть как влияют на внешний вид некоторые настройки.
Управление слоями layout:
- Файл;
- Вид;
- Макет;
- Ссылки;
- Совместная работа;
- Рисование;
- Защита;
- Плагин.
Config.js
Скопируйте ниже HTML код как пример для вашего редактора:
var docEditor = new DocsAPI.DocEditor("placeholder", {
"editorConfig": {
"actionLink": "ACTION_DATA",
"createUrl": "URL",
"user": "user",
"lang": "ru",
"mode": "edit",
"customization": {
"layout": {
"toolbar": {
"file": { // menu file
close: false / true, // close menu button
settings: false / true, // advanced settings
info: false / true // document info
save: false/true // save button
} / false / true,
"view": true,
"layout": true,
"references": true,
"collaboration": true,
"draw": true,
"protect": true,
"plugins": true,
},
},
"anonymous": {
"request": false,
"label": "Guest"
},
"uiTheme": "theme-classic-light",
"zoom": 80
}
,
...
},
...
});
