• Post category:Редактор
  • Запись изменена:24.01.2024

Editor config

Описание
Раздел editorConfig позволяет изменить параметры, относящиеся к интерфейсу редактора: режим открытия (просмотрщик или редактор), язык интерфейса, дополнительные кнопки и т.д.).
  • actionLink
  • callbackUrl
  • coEditing
  • createUrl
  • lang
  • location
  • mode
  • recent
  • region
  • templates
  • user
Параметры
НазваниеОписаниеТипПример
Задает данные, полученные от службы редактирования документов с помощью события onMakeActionLink или события onRequestSendNotify в параметре data.actionLink, которое содержит информацию о действии в документе, до которого будет выполняться прокрутка.объект
Указывает абсолютный URL-адрес службы хранения документов (которая должна осуществляться интеграторами программного обеспечения, которые используют Р7 Document Server на своем собственном сервере).строковый«https://example.com/url-to-callback.ashx»
Defines the co-editing mode (Fast or Strict) and the possibility to change it. The object has the following parameters: Определяет режим совместного редактирования (Быстрый или Строгий) и возможность его изменения. Объект имеет следующие параметры:

  • режим — режим совместного редактирования (быстрый или строгий). Значение по умолчанию — быстрый,
    тип: строковый,
    пример: «fast»;
  • изменение — определяет, можно ли изменить режим совместного редактирования в интерфейсе редактора или нет. Значение по умолчанию true,
    тип: логический,
    пример: true.

Этот параметр используется для применения режимов совместного-редактирования и просмотра.

объект
Обратите внимание, что в случае изменения настройки режима в интерфейсе редактора, он будет сохранен в локальном хранилище браузера и перезапишет любые значения, отправленные в качестве параметра editorConfig.coEditing.mode.
Редактор
Определяет абсолютный URL-адрес документа, где он будет создан и доступен после создания. Если не указать, кнопки создания не будет. Вместо этого поля можно использовать событие onRequestCreateNewevent.строковый«https://example.com/url-to-create-document/»
Редактор
Определяет язык интерфейса редактора (если присутствуют другие языки, кроме английского). Устанавливается с помощью двухбуквенных (de, ru, it и т.д.) языковых кодов. Значение по умолчанию — «en».строковый«en»
Пожалуйста, обратите внимание, что для перевода интерфейса редактора на португальский (Португалия) или китайский (традиционный, Тайвань) (эти языки были добавлены в версии 7.2) необходимо использовать четырехбуквенные коды языков — pt-PT или zh-TW соответственно. Двухбуквенный код ptlanguage задает португальский (Бразилия), а код zh указывает китайский (Китайская Народная Республика).
Определяет единицы измерения по умолчанию. Укажите us или ca, чтобы установить дюймы. Значение по умолчанию — «».строковый«»
Обратите внимание, что при установке значений us или ca единицами измерения по умолчанию являются дюймы.
Определяет режим открытия редактора. Можно либо просмотреть, чтобы открыть документ для просмотра, либо изменить, чтобы открыть документ в режиме редактирования, позволяющем применить изменения к данным документа. Значение по умолчанию — «редактировать».строковый«edit»
Определяет наличие или отсутствие документов в пункте меню Открыть недавние…, где можно установить следующие параметры документа:

  • папка — папка, в которой хранится документ (может быть пустой, если документ хранится в корневой папке),
    тип: строковый,
    пример: «Example Files»;
  • заголовок-  название документа, которое будет отображаться в пункте меню «Открыть недавние…»,
    тип: строковый,
    пример: «exampledocument1.docx»;
  • url — абсолютный URL-адрес документа, в котором он хранится,
    тип: строковый,
    пример: «https://example.com/exampledocument1.docx».
массив объектов
Редактор
Определяет формат отображения валюты, даты и времени по умолчанию (только в редакторе электронных таблиц). Устанавливается с использованием четырехбуквенного кода языка (en-US, fr-FR и т. д.). В качестве значения по умолчанию берется параметр lang или, если региональный параметр, соответствующий значению lang, недоступен, используется en-US.стоковый«en-US»
Определяет наличие или отсутствие шаблонов в пункте меню Создать новый…, где могут быть заданы следующие параметры документа:

  • изображение — абсолютный URL-адрес изображения для шаблона,
    тип: строковый,
    пример: «https://example.com/exampletemplate1.png»;
  • название — заголовок шаблона, который будет отображаться в пункте меню «Создать новый…»,
    тип: строковый,
    пример: «exampletemplate1.docx»;
  • url — абсолютный URL-адрес документа, в котором он будет создан и доступен после создания,
    тип: строковый,
    пример: «https://example.com/url-to-create-template1».
массив объектов
Редактор
Определяет пользователя, который в данный момент просматривает или редактирует документ:

  • имя — имя пользователя. Устарело, начиная с версии 4.2, вместо этого используйте имя,
    тип: строковый,
    пример: «John»;
  • группа — группа, к которой принадлежит пользователь,
    тип: строковый,
    пример: «Group1»;
  • id — идентификацию пользователя. Длина ограничена 128 символами. Эта информация хранится и используется для различения соавторов, указания автором  последних изменений при сохранении и выделении истории (в списке изменений), а также подсчета пользователей с доступом к лицензии исходя из количества пользователей.
    Мы рекомендуем использовать какой-нибудь уникальный анонимный хэш. Не используйте в этом поле конфиденциальные данные, такие как имя или адрес электронной почты.
    тип: строковый,
    пример: «78e1e841»;
  • фамилия — фамилия пользователя. Устарело, начиная с версии 4.2, вместо этого используйте имя.
    тип: строковый,
    пример: «Smith»;
  • имя -полное имя пользователя. Длина ограничена 128 символами. Используется с версии 4.2,
    тип: строковый,
    пример: «John Smith».
объект

* — обязательное поле

Пример
var docEditor = new DocsAPI.DocEditor("placeholder", {
    "editorConfig": {
        "actionLink": ACTION_DATA,
        "callbackUrl": "https://example.com/url-to-callback.ashx",
        "coEditing": {
            "mode": "fast",
            "change": true
        },
        "createUrl": "https://example.com/url-to-create-document/",
        "lang": "en",
        "location": "",
        "mode": "edit",
        "recent": [
            {
                "folder": "Example Files",
                "title": "exampledocument1.docx",
                "url": "https://example.com/exampledocument1.docx"
            },
            {
                "folder": "Example Files",
                "title": "exampledocument2.docx",
                "url": "https://example.com/exampledocument2.docx"
            },
            ...
        ],
        "region": "en-US",
        "templates": [
            {
                "image": "https://example.com/exampletemplate1.png",
                "title": "exampletemplate1.docx",
                "url": "https://example.com/url-to-create-template1"
            },
            {
                "image": "https://example.com/exampletemplate2.png",
                "title": "exampletemplate2.docx",
                "url": "https://example.com/url-to-create-template2"
            },
            ...
        ],
        "user": {
            "group": "Group1",
            "id": "78e1e841",
            "name": "John Smith"
        }
    },
    ...
});

Где example.com — это имя сервера, на котором установлены менеджер документов и служба хранения документов. Дополнительные сведения о взаимодействии клиент-сервер службы Сервера документов см. в разделе Как это работает .