Editor config

Description

The editorConfig section allows to change the parameters pertaining to the editor interface: opening mode (viewer or editor), interface language, additional buttons, etc.).

Parameters
Name Description Type Example
Specifies the data received from the document editing service using the onMakeActionLink event or the onRequestSendNotify event in data.actionLink parameter, which contains the information about the action in the document that will be scrolled to. object
Specifies absolute URL to the document storage service (which must be implemented by the software integrators who use ONLYOFFICE Document Server on their own server). string "https://example.com/url-to-callback.ashx"
Defines the absolute URL of the document where it will be created and available after creation. If not specified, there will be no creation button. Instead of this field, you can use the onRequestCreateNew event. string "https://example.com/url-to-create-document/"
Defines the editor interface language (if some other languages other than English are present). Is set using the two letter (de, ru, it, etc.) language codes. The default value is "en". string "en"
Defines the default measurement units. Specify us or ca to set inches. The default value is "". string ""
Please note that when us or ca values are set, the default measurement units are inches.
Defines the editor opening mode. Can be either view to open the document for viewing, or edit to open the document in the editing mode allowing to apply changes to the document data. The default value is "edit". string "edit"
Defines the presence or absence of the documents in the Open Recent... menu option where the following document parameters can be set:
  • folder - the folder where the document is stored (can be empty in case the document is stored in the root folder),
    type: string,
    example: "Example Files";
  • title - the document title that will be displayed in the Open Recent... menu option,
    type: string,
    example: "exampledocument1.docx";
  • url - the absolute URL to the document where it is stored,
    type: string,
    example: "https://example.com/exampledocument1.docx".
array of object
Defines the default display format for currency and date and time (in the Spreadsheet Editor only). Is set using the four letter (en-US, fr-FR, etc.) language codes. For the default value the lang parameter is taken, or, if no regional setting corresponding to the lang value is available, en-US is used. string "en-US"
Defines the presence or absence of the templates in the From Template section for the Create New... menu option where the following document parameters can be set:
  • image - the absolute URL to the image for template,
    type: string,
    example: "https://example.com/exampletemplate1.png";
  • title - the template title that will be displayed in the From Template section for the Create New... menu option,
    type: string,
    example: "exampletemplate1.docx";
  • url - the absolute URL to the document where it will be created and available after creation,
    type: string,
    example: "https://example.com/url-to-create-template1".
array of object
Defines the user currently viewing or editing the document:
  • firstname - the first name of the user. Deprecated since version 4.2, please use name instead,
    type: string,
    example: "John";
  • group - the group the user belongs to,
    type: string,
    example: "Group1";
  • id - the identification of the user. The length is limited to 128 symbols.
    This information is stored and used to distinguish co-authors, indicate the author of the last changes when saving and highlighting history (in the list of changes), and count users with access for a license based on the number of users.
    We recommend using some unique anonymized hash. Do not use sensitive data, like name or email for this field.
    type: string,
    example: "78e1e841";
  • lastname - the last name of the user. Deprecated since version 4.2, please use name instead,
    type: string,
    example: "Smith";
  • name - the full name of the user. The length is limited to 128 symbols. Used since version 4.2,
    type: string,
    example: "John Smith".
object
* - required field
Example
var docEditor = new DocsAPI.DocEditor("placeholder", {
    "editorConfig": {
        "actionLink": ACTION_DATA,
        "callbackUrl": "https://example.com/url-to-callback.ashx",
        "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"
        }
    },
    ...
});

Where the example.com is the name of the server where document manager and document storage service are installed. See the How it works section to find out more on Document Server service client-server interactions.