Get Started
Usage API
Using WOPI
Additional API
More information

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.).

Example

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 ONLYOFFICE Docs service client-server interactions.

Config.js
Copy When you copy, you get the HTML code for the whole example. 

    
  





    




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
            ACTION_DATA
        

        

            
            Specifies absolute URL to the document storage service (which must be implemented by the software integrators who use ONLYOFFICE Docs on their own server).
            string
            "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:
                
    
                    
  • 
                        mode - the co-editing mode (fast or strict). The default value is fast,
                        
    
                        type: string,
                        
    
                        example:  "fast";
                    
    • 
                    
  • 
                        change - defines if the co-editing mode can be changed in the editor interface or not. The default value is true,
                        
    
                        type: boolean,
                        
    
                        example:  true.
                    
    • 
                

                
This parameter is used to apply the co-editing and viewing modes.

            		
            object
            {
    "mode": "fast",
    "change": true
}
        

        

            
                
Please note that in case mode setting is changed in the editor interface, it will be stored in the browser local storage and will overwrite any values sent as the editorConfig.coEditing.mode parameter.

            		
        

        

            
                
            
        

        

            
            
                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"
        

        

            
                
Please note that to translate the editor interface into Portuguese (Portugal) or Chinese (Traditional, Taiwan)
                (these languages were added in version 7.2), you need to use the four letter language codes - pt-PT or zh-TW, respectively.
                The two letter pt language code sets Portuguese (Brazil) and the zh code specifies Chinese (People's Republic of China).

            		
        

        

            
            
                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
            [
    {
        "folder": "Example Files",
        "title": "exampledocument1.docx",
        "url": "https://example.com/exampledocument1.docx"
    }
]
        

        

            
                
            
        

        

            
            
                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 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 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
            [
    {
        "image": "https://example.com/exampletemplate1.png",
        "title": "exampletemplate1.docx",
        "url": "https://example.com/url-to-create-template1"
    }
]
        

        

            
                
            
        

        

            
            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";
                    
    • 
                    
  • 
                        image - the path to the user's avatar,
                        
    
                        type: string,
                        
    
                        example: "https://example.com/url-to-user-avatar.png";
                    
    • 
                    
  • 
                        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
            {
    "group": "Group1",
    "id": "78e1e841",
    "image": "https://example.com/url-to-user-avatar.png",
    "name": "John Smith"
}
        

        

            
                
Please note that the request to the user's avatar is sent without authorization because the avatar URL is inserted into the HTML of the editor frame.
                Moreover, the CORS problem may occur. In this case, use the avatar in the base64 format. For example, "data:image/png,base64,*****".

            		
        

        

            
                
Please note that if you are subscribed to the onRequestUsers event
                and send an avatar using the setUsers method, the user.image field in the initialization config
                is not required. We especially don't recommend to specify this parameter if the avatar is sent in the base64 format and the initialization config is signed with JWT.
                In this case, the token will be too long.

            		
        

    





* - required field







                    

                

        

    

    

        

            

                

                    
                

                
© Ascensio System SIA 2024. All rights reserved