Methods

After initializing document editor you will get the object that can be used to call the methods.

var docEditor = new DocsAPI.DocEditor("placeholder", config);

Methods and their description:

  • createConnector* - create the connector to interact with text documents, spreadsheets, presentations, and fillable forms from the outside.

    docEditor.createConnector();
    
  • denyEditingRights - deny editing. This method can be called when you want to make the document editing unavailable.

    docEditor.denyEditingRights(message);
    
    Parameter Description Type Presence
    message Defines the text messages for dialog. string optional
  • destroyEditor - destroy docEditor object. This method can be called when you want to reinit document editor with another configurations. Used since version 4.3.

    docEditor.destroyEditor();
    
  • downloadAs - download the edited file. This method can be called only when the existence of the onDownloadAs events. Document editing service asynchronously creates a document and triggers the onDownloadAs event with a link in parameter.

    docEditor.downloadAs(format);
    
    Parameter Description Type Presence
    format Defines the format in which a file will be downloaded. All the possible formats you can find in the conversion tables. But you cannot download a file in the image formats such as bmp, gif, jpg, png. If this parameter is undefined, the file will be downloaded in the OOXML format according to the file type. string optional
    Please note that conversion from the djvu, pdf, xps formats are not available. The original format will be downloaded.
  • insertImage - insert an image into the file. Starting from version 7.0, this method allows a user to insert several images. The images array is used to do it. This method must be called after the onRequestInsertImage events.

    docEditor.insertImage({
        "c": "add",
        "images": [
            {
                "fileType": "png",
                "url": "https://example.com/url-to-example-image1.png"
            },
            {
                "fileType": "png",
                "url": "https://example.com/url-to-example-image2.png"
            },
            ...
        ],
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjIjoiYWRkIiwiaW1hZ2VzIjpbeyJmaWxlVHlwZSI6InBuZyIsInVybCI6Imh0dHBzOi8vZXhhbXBsZS5jb20vdXJsLXRvLWV4YW1wbGUtaW1hZ2UxLnBuZyJ9LHsiZmlsZVR5cGUiOiJwbmciLCJ1cmwiOiJodHRwczovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWltYWdlMi5wbmcifV19.JfSa__qPeY3MjUgdkJDjdfJWBgvCmEdLfFzjd3WgeUA"
    });
    

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

    Parameter Description Type Presence
    c Defines a type of image insertion from the event. Can be: add, change, fill, watermark, slide. The default value is "add". string required
    fileType Defines a type of the image to be inserted into the file. Can be: bmp, gif, jpe, jpeg, jpg, png. Deprecated since version 7.0, please use the images.fileType parameter instead. string required
    images Defines an array of images to be inserted. array of objects required
    images.fileType Defines a type of the image to be inserted into the file. Can be: bmp, gif, jpe, jpeg, jpg, png. string required
    images.url Defines an absolute URL where the source image is stored. Be sure to add a token when using local links. string required
    token Defines the encrypted signature added to the parameter in the form of a token. string optional
    url Defines an absolute URL where the source image is stored. Be sure to add a token when using local links. Otherwise, an error will occur. Deprecated since version 7.0, please use the images.url parameter instead. string required

    Prior to version 7.0, this method allowed to insert only one image and had the following parameters:

    docEditor.insertImage({
        "c": "add",
        "fileType": "png",
        "url": "https://example.com/url-to-example-image.png"
    });
    

    Please note that this structure is deprecated and will not be supported by the next editors versions. Please use a new one.

  • refreshHistory - show the document version history. This method must be called after the onRequestHistory events.

    docEditor.refreshHistory({
        "currentVersion": 2,
        "history": [
            {
                "created": "2010-07-06 10:13 AM",
                "key": "af86C7e71Ca8",
                "user": {
                    "id": "F89d8069ba2b",
                    "name": "Kate Cage"
                },
                "version": 1
            },
            {
                "created": "2010-07-07 3:46 PM",
                "key": "Khirz6zTPdfd7",
                "user": {
                    "id": "78e1e841",
                    "name": "John Smith"
                },
                "version": 2
            },
            ...
        ],
    });
    

    If after editing and saving the document the history with the object changes and server version is returned, send the object changes in the changes parameter and the server version in the serverVersion parameter.

    docEditor.refreshHistory({
        "currentVersion": 2,
        "history": [
            {
                "created": "2010-07-06 10:13 AM",
                "key": "af86C7e71Ca8",
                "user": {
                    "id": "F89d8069ba2b",
                    "name": "Kate Cage"
                },
                "version": 1
            },
            {
                "changes": changes,
                "created": "2010-07-07 3:46 PM",
                "key": "Khirz6zTPdfd7",
                "serverVersion": serverVersion,
                "user": {
                    "id": "78e1e841",
                    "name": "John Smith"
                },
                "version": 2
            },
            ...
        ],
    });
    

    Where changes is the changes from the history object returned after saving the document.

    Where serverVersion is the serverVersion from the history object returned after saving the document.

    Show an error message explaining why the version history cannot be displayed:

    docEditor.refreshHistory({
        "error": "Exception",
    });
    
    Parameter Description Type Presence
    currentVersion Defines the current document version number. integer required
    error Defines the error message text. string optional
    history Defines the array with the document versions. array required
    history.changes Defines the changes from the history object returned after saving the document. object optional
    history.created Defines the document version creation date. string required
    history.key Defines the unique document identifier used by the service to recognize the document. string required
    history.serverVersion Defines the current server version number. If the changes parameter is sent, then the serverVersion parameter is required to be sent as well. integer optional
    history.user Defines the user who is the author of the document version. object optional
    history.user.id Defines the identifier of the user who is the author of the document version. string optional
    history.user.name Defines the name of the user who is the author of the document version. string optional
    history.version Defines the document version number. integer required
  • requestClose - request to close the editor. It is recommended to call this method before the destroyEditor method to check if there is some unsaved data in the editor or not. If the unsaved data exists, then the dialog box will be displayed to ask the user whether they want to continue editing or close the editor losing all the unsaved data. If the Close option will be chosen, then the onRequestClose event will be called.

    docEditor.requestClose();
    
  • setActionLink - set the link to the document which contains a bookmark. This method must be called after the onMakeActionLink event. The software integrator must process the ACTION_DATA received from the document editing service to set the link. The link is created by the software integrators who use ONLYOFFICE Document Server in their document manager.

    docEditor.setActionLink(link);
    
    Parameter Description Type Presence
    link Defines the link which allows scrolling to the bookmark position in the document. string required
  • setFavorite - change the Favorite icon state. This method must be called after the onMetaChange event.

    docEditor.setFavorite(favorite);
    
    Parameter Description Type Presence
    favorite Defines if the Favorite icon is highlighted (true) or not (false). boolean true
  • setHistoryData - send the link to the document for viewing the version history. This method must be called after the onRequestHistoryData events.

    docEditor.setHistoryData({
        "fileType": "docx",
        "key": "Khirz6zTPdfd7",
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6ImRvY3giLCJrZXkiOiJLaGlyejZ6VFBkZmQ3IiwidXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS91cmwtdG8tZXhhbXBsZS1kb2N1bWVudC5kb2N4IiwidmVyc2lvbiI6Mn0.iRcdHve235L5K1e29SmUBkuHcxb63WHRko51WMJlmS0",
        "url": "https://example.com/url-to-example-document.docx",
        "version": 2
    });
    

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

    If after editing and saving the document the changesurl link to the file with changes data is returned, download the file by this link and send the file URL in the changesUrl parameter. The absolute URL address of the document previous version must be sent in the previous.url parameter.

    docEditor.setHistoryData({
        "changesUrl": "https://example.com/url-to-changes.zip",
        "fileType": "docx",
        "key": "Khirz6zTPdfd7",
        "previous": {
            "fileType": "docx",
            "key": "af86C7e71Ca8",
            "url": "https://example.com/url-to-the-previous-version-of-the-document.docx"
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjaGFuZ2VzVXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS91cmwtdG8tY2hhbmdlcy56aXAiLCJmaWxlVHlwZSI6ImRvY3giLCJrZXkiOiJLaGlyejZ6VFBkZmQ3IiwicHJldmlvdXMiOnsiZmlsZVR5cGUiOiJkb2N4Iiwia2V5IjoiYWY4NkM3ZTcxQ2E4IiwidXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS91cmwtdG8tdGhlLXByZXZpb3VzLXZlcnNpb24tb2YtdGhlLWRvY3VtZW50LmRvY3gifSwidXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS91cmwtdG8tZXhhbXBsZS1kb2N1bWVudC5kb2N4IiwidmVyc2lvbiI6Mn0.ril3Ol3rvYne3g0dG8TdKCiwJ7-7kkYGc6-XWMvp8FU",
        "url": "https://example.com/url-to-example-document.docx",
        "version": 2
    });
    

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

    Send an error message explaining why the document version cannot be displayed:

    docEditor.setHistoryData({
        "error": "Exception",
        "version": 2
    });
    
    Parameter Description Type Presence
    changesUrl Defines the url address of the file with the document changes data, which can be downloaded by the changesurl link from the JSON object returned after saving the document. The request for file is signed with a token which is checked by the Document Server. string optional
    error Defines the error message text. string optional
    fileType Defines an extension of the document specified with the url parameter. string optional
    key Defines the document identifier used to unambiguously identify the document file. string required
    previous Defines the object of the previous version of the document if changesUrl address was returned after saving the document. object optional
    previous.fileType Defines an extension of the document specified with the previous.url parameter. string optional
    previous.key Defines the document identifier of the previous version of the document. string required
    previous.url Defines the url address of the previous version of the document. string required
    token Defines the encrypted signature added to the parameter in the form of a token. string optional
    url Defines the url address of the current document version. Can be downloaded by the url link from the JSON object returned after saving the document. Be sure to add a token when using local links. Otherwise, an error will occur. string required
    version Defines the document version number. integer required
  • setMailMergeRecipients - insert recipient data for mail merge into the file. This method must be called after the onRequestMailMergeRecipients event. Deprecated since version 7.5, please use setRequestedSpreadsheet instead.

    docEditor.setMailMergeRecipients({
        "fileType": "xlsx",
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6Inhsc3giLCJ1cmwiOiJodHRwczovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLXJlY2lwaWVudHMueGxzeCJ9.P3TjOyX1Tv3xAVRAc8qtNb-uFLD6FH_WErag_rbI6nQ",
        "url": "https://example.com/url-to-example-recipients.xlsx"
    });
    

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

    Parameter Description Type Presence
    fileType Defines the type of spreadsheet for mail merge in the file. Can be: csv, fods, ods, ots, xls, xlsm, xlsx, xlt, xltm, xltx. string required
    token Defines the encrypted signature added to the parameter in the form of a token. string optional
    url Defines the absolute URL where the source data is stored. Be sure to add a token when using local links. Otherwise, an error will occur. string required
  • setReferenceData - refresh data by a link to a file which is specified with the referenceData, path, or link parameters. This method must be called after the onRequestReferenceData event.

    Please note that this method is executed only when the user has permissions to the file from which the data is taken.
    docEditor.setReferenceData({
        "fileType": "xlsx",
        "path": "sample.xlsx",
        "referenceData": {
            "fileKey": "BCFA2CED",
            "instanceId": "https://example.com",
            "key": "Khirz6zTPdfd7"
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6Inhsc3giLCJwYXRoIjoic2FtcGxlLnhsc3giLCJyZWZlcmVuY2VEYXRhIjp7ImZpbGVLZXkiOiJCQ0ZBMkNFRCIsImluc3RhbmNlSWQiOiJodHRwczovL2V4YW1wbGUuY29tIn0sInVybCI6Imh0dHBzOi8vZXhhbXBsZS5jb20vdXJsLXRvLWV4YW1wbGUtZG9jdW1lbnQueGxzeCJ9.UXosmM-E_Cu9j9QGSlcj9FEoSu5m-zCS4b6FxO_2k7w",
        "url": "https://example.com/url-to-example-document.xlsx"
    });
    

    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.

    Show an error message explaining if any error occurred:

    docEditor.setReferenceData({
        "error": "Exception",
    });
    
    Parameter Description Type Presence
    error Defines the error message text. string optional
    fileType Defines an extension of the document specified with the url parameter. string optional
    path Defines the file name or relative path for the formula editor. It is used to identify a file when the onRequestReferenceData event is executed. string required
    referenceData Defines an object that is generated by the integrator to uniquely identify a file in its system. This data must be the same as in the document.referenceData config parameter:
    • fileKey - the unique document identifier used by the service to get a link to the file. It must not be changed when the document is edited and saved (i.e. it is not equal to the document.key parameter),
      type: string,
      example: "BCFA2CED";
    • instanceId - the unique system identifier. If the data was copied from a file on one system, and inserted into a file on another, then pasting by link will not be available and there will be no corresponding button in the context menu,
      type: string,
      example: "https://example.com";
    • key - defines the unique document identifier used by the service to take the data from the co-editing session. In case the known key is sent, the document will be taken from the cache. Every time the document is edited and saved, the key must be generated anew. The document url can be used as the key but without the special characters and the length is limited to 128 symbols.
      type: string,
      example: "Khirz6zTPdfd7".
    object optional
    token Defines the encrypted signature added to the parameter in the form of a token. string optional
    url Defines the URL address to download the current file. string required
  • setReferenceSource - change a source of the external data. This method can be called after the onRequestReferenceSource event.

    Please note that this method is executed only when the user has permissions to the file from which the data is taken.
    docEditor.setReferenceSource({
        "fileType": "xlsx",
        "path": "sample.xlsx",
        "referenceData": {
            "fileKey": "BCFA2CED",
            "instanceId": "https://example.com",
            "key": "Khirz6zTPdfd7"
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6Inhsc3giLCJwYXRoIjoic2FtcGxlLnhsc3giLCJyZWZlcmVuY2VEYXRhIjp7ImZpbGVLZXkiOiJCQ0ZBMkNFRCIsImluc3RhbmNlSWQiOiJodHRwczovL2V4YW1wbGUuY29tIn0sInVybCI6Imh0dHBzOi8vZXhhbXBsZS5jb20vdXJsLXRvLWV4YW1wbGUtZG9jdW1lbnQueGxzeCJ9.UXosmM-E_Cu9j9QGSlcj9FEoSu5m-zCS4b6FxO_2k7w",
        "url": "https://example.com/url-to-example-document.xlsx"
    });
    

    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.

    Show an error message explaining if any error occurred:

    docEditor.setReferenceSource({
        "error": "Exception",
    });
    
    Parameter Description Type Presence
    error Defines the error message text. string optional
    fileType Defines an extension of the document specified with the url parameter. string optional
    path Defines the file name or relative path for the formula editor. It is used to identify a file when the onRequestReferenceSource event is executed. string required
    referenceData Defines an object that is generated by the integrator to uniquely identify a file in its system. This data must be the same as in the document.referenceData config parameter:
    • fileKey - the unique document identifier used by the service to get a link to the file. It must not be changed when the document is edited and saved (i.e. it is not equal to the document.key parameter),
      type: string,
      example: "BCFA2CED";
    • instanceId - the unique system identifier. If the data was copied from a file on one system, and inserted into a file on another, then pasting by link will not be available and there will be no corresponding button in the context menu,
      type: string,
      example: "https://example.com";
    • key - defines the unique document identifier used by the service to take the data from the co-editing session. In case the known key is sent, the document will be taken from the cache. Every time the document is edited and saved, the key must be generated anew. The document url can be used as the key but without the special characters and the length is limited to 128 symbols.
      type: string,
      example: "Khirz6zTPdfd7".
    object optional
    token Defines the encrypted signature added to the parameter in the form of a token. string optional
    url Defines the URL address to download the current file. string required
  • setRequestedDocument** - select a document for comparing or combining. This method must be called after the onRequestSelectDocument event.

    docEditor.setRequestedDocument({
        "c": "compare",
        "fileType": "docx",
        "url": "https://example.com/url-to-example-document.docx",
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6ImRvY3giLCJ1cmwiOiJodHRwczovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWRvY3VtZW50LmRvY3gifQ.t8660n_GmxJIppxcwkr_mUxmXYtE8cg-jF2cTLMtuk8"
    });
    

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

    Parameter Description Type Presence
    c Defines a type of document selection from the event. Can be: compare, combine. The default value is "compare". string required
    fileType Defines a type of the document to be selected. Can be: doc, docm, docx, dot, dotm, dotx, epub, fodt, odt, ott, rtf, wps. string required
    token Defines the encrypted signature added to the parameter in the form of a token. string optional
    url Defines the absolute URL where the source document is stored. Be sure to add a token when using local links. Otherwise, an error will occur. string required
  • setRequestedSpreadsheet - insert recipient data for mail merge into the file. This method must be called after the onRequestSelectSpreadsheet event.

    docEditor.setRequestedSpreadsheet({
        "c": "mailmerge";
        "fileType": "xlsx",
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6Inhsc3giLCJ1cmwiOiJodHRwczovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLXJlY2lwaWVudHMueGxzeCJ9.P3TjOyX1Tv3xAVRAc8qtNb-uFLD6FH_WErag_rbI6nQ",
        "url": "https://example.com/url-to-example-recipients.xlsx"
    });
    

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

    Parameter Description Type Presence
    c Defines a type of spreadsheet selection from the event. Can be mailmerge. string required
    fileType Defines the type of spreadsheet for mail merge in the file. Can be: csv, fods, ods, ots, xls, xlsm, xlsx, xlt, xltm, xltx. string required
    token Defines the encrypted signature added to the parameter in the form of a token. string optional
    url Defines the absolute URL where the source data is stored. Be sure to add a token when using local links. Otherwise, an error will occur. string required
  • setRevisedFile** - select a document for comparing. This method must be called after the onRequestCompareFile events. Deprecated since version 7.5, please use setRequestedDocument instead.

    docEditor.setRevisedFile({
        "fileType": "docx",
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6ImRvY3giLCJ1cmwiOiJodHRwczovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWRvY3VtZW50LmRvY3gifQ.t8660n_GmxJIppxcwkr_mUxmXYtE8cg-jF2cTLMtuk8",
        "url": "https://example.com/url-to-example-document.docx"
    });
    

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

    Parameter Description Type Presence
    fileType Defines the type of document for comparing. Can be: doc, docm, docx, dot, dotm, dotx, epub, fodt, odt, ott, rtf, wps. string required
    token Defines the encrypted signature added to the parameter in the form of a token. string optional
    url Defines the absolute URL where the source document is stored. Be sure to add a token when using local links. Otherwise, an error will occur. string required
  • setSharingSettings - update the information about the settings which allow to share the document with other users. This method can be called after the onRequestSharingSettings events.

    docEditor.setSharingSettings({
        "sharingSettings": [
            {
                "permissions": "Full Access",
                "user": "John Smith"
            },
            {
                "isLink": true,
                "permissions": "Read Only",
                "user": "External link"
            }
        ]
    });
    
    Parameter Description Type Presence
    sharingSettings Defines the settings which allow sharing the document with other users. array of object optional
    sharingSettings.permissions Defines the access rights for the user with the name above. string optional
    sharingSettings.user Defines the name of the user with whom the document will be shared. string optional
  • setUsers - set a list of users to mention in the comments, grant the access rights to edit the specific sheet ranges, or set the user avatars. This method must be called after the onRequestUsers events.

    docEditor.setUsers({
        "c": "protect",
        "users": [
            {
                "email": "john@example.com",
                "id": "78e1e841",
                "image": "https://example.com/url-to-user-avatar1.png",
                "name": "John Smith"
            },
            {
                "email": "kate@example.com",
                "id": "F89d8069ba2b",
                "image": "https://example.com/url-to-user-avatar2.png",
                "name": "Kate Cage"
            },
            ...
        ]
    });
    

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

    Parameter Description Type Presence
    c Defines the operation type from the onRequestUsers event. It can take one of the following values - mention, protect, or info. The default value is mention. string required
    users Defines the list of the users. array of strings optional
    users.email Defines the email address of the user. This field is only used when the c parameter is mention. string required
    users.id Defines the identification of the user. This field is only used when the c parameter is protect. string required
    users.image Defines the path to the user avatar. This field is only used when the c parameter is info. string required
    users.name Defines the full name of the user. string required
  • showMessage - display a tooltip with a message. This method can be called only after the onAppReady events.

    docEditor.showMessage(message);
    
    Parameter Description Type Presence
    message Defines the message text. string required
    Please note that displaying a tooltip with a message is not supported in the embedded platform type.
* - available for editing only for ONLYOFFICE Developer Edition ** - available only for ONLYOFFICE Enterprise Edition and ONLYOFFICE Developer Edition