开始使用
使用 API
使用WOPI
附加 API
更多信息

编辑器配置

描述

editorConfig 部分允许更改与编辑器界面有关的参数：打开模式（查看器或编辑器）、界面语言、附加按钮等）。

示例

example.com 是安装文档管理器和文档存储服务的服务器的名称。 请参阅工作原理部分，了解有关文档服务器服务客户端与服务器交互的更多信息。 







    





参数



    
        
        
        
        
    
    
        

            名称
            描述
            类型
            示例
        

    
    
        

            
            使用 data.actionLink 参数中的 onMakeActionLink 事件或 onRequestSendNotify 事件指定从 文档编辑服务 接收的数据，其中包含有关将滚动到的文档中的操作的信息。
            object
            ACTION_DATA
        

        

            
            指定 文档存储服务 的绝对 URL （必须由在自己的服务器上使用 ONLYOFFICE 文档服务器的软件集成商 实现）。
            string
            "https://example.com/url-to-callback.ashx"
        

        

            
            
                定义共同编辑模式（Fast 或 Strict）以及更改它的可能性。
                该对象具有以下参数：
                
    
                    
  • 
                        mode - 共同编辑模式（fast 或 strict）。 默认值为fast,
                        
    
                        类型：string，
                        
    
                        示例："fast";
                    
    • 
                    
  • 
                        change - 定义是否可以在编辑器界面中更改共同编辑模式。 默认值为 false，
                        
    
                        类型：boolean，
                        
    
                        示例：true。
                    
    • 
                

                
此参数用于应用共同编辑和查看模式

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

        

            
                
请注意，如果在编辑器界面中更改 mode 设置，它将存储在浏览器本地存储中，并将覆盖作为 editorConfig.coEditing.mode 参数发送的任何值。

            		
        

        

            
                
            
        

        

            
            
                定义将在其中创建并在创建后可用的文档的绝对 URL。
                如果未指定，将没有创建按钮。
                您可以使用 onRequestCreateNew 事件代替此字段。
            
            string
            "https://example.com/url-to-create-document/"
        

        

            
                
            
        

        

            
            
                定义编辑器界面语言（如果存在英语以外的其他语言）。
                使用两个字母（de、 ru、 it等）语言代码设置。
                默认值为 "en"。
            
            string
            "en"
        

        

            
                
请注意，要将编辑器界面翻译为葡萄牙语（葡萄牙）或中文（繁体，台湾）
                （这些语言是在7.2版中添加的），您需要分别使用四个字母的语言代码-pt-PT或zh-TW。
                两个字母pt语言代码设置葡萄牙语（巴西），zh代码指定汉语（中华人民共和国）。

            		
        

        

            
            
                定义默认测量单位。
                指定 us 或 ca 以设置英寸。
                默认值为 ""。
            
            string
            ""
        

        

            
                
请注意，设置 us 或 ca 值时，默认测量单位为英寸。

            		
        

        

            
            
                定义编辑器打开模式。
                可以是 view 以打开文档进行查看，也可以是 edit 以在编辑模式下打开文档，从而允许对文档数据进行更改。
                默认值为 "edit"。
            
            string
            "edit"
        

        

            
            在 打开最近.. 菜单选项中定义文档存在或不存在，其中可以设置以下文档参数：
                
    
                    
  • 
                        folder - 存储文档的文件夹（如果文档存储在根文件夹中，可以为空），
                        
    
                        类型：string，
                        
    
                        例如："Example Files";
                    
    • 
                    
  • 
                        title - 将在 Open Recent... 菜单选项中显示的文档标题，
                        
    
                        类型：string，
                        
    
                        例如：exampledocument1.docx；
                    
    • 
                    
  • 
                        Url - 存储它的文档的绝对 URL，
                        
    
                        类型：string，
                        
    
                        例如："https://example.com/exampledocument1.docx".
                    
    • 
                

            		
            object数组
            [
    {
        "folder": "Example Files",
        "title": "exampledocument1.docx",
        "url": "https://example.com/exampledocument1.docx"
    }
]
        

        

            
                
            
        

        

            
            
                定义货币和日期和时间的默认显示格式（仅在 电子表格编辑器 中）。
                使用四个字母（en-US、 fr-FR等）语言代码设置。
                对于默认值，采用 lang 参数，或者，如果没有与 lang 值对应的区域设置可用，则使用 en-US。
            
            string
            "en-US"
        

        

            
            在 新建... 菜单选项中定义模板是否存在，可以在其中设置以下文档参数：
                
    
                    
  • 
                        image - 模板图像的绝对 URL，
                        
    
                        类型：string，
                        
    
                        示例："https://example.com/exampletemplate1.png"；
                    
    • 
                    
  • 
                        title - 将在 Create New... 菜单选项中显示的模板标题，
                        
    
                        类型：string，
                        
    
                        示例："exampletemplate1.docx"；
                    
    • 
                    
  • 
                        url - 将在其中创建并在创建后可用的文档的绝对 URL，
                        
    
                        类型：string，
                        
    
                        示例："https://example.com/url-to-create-template1".
                    
    • 
                

            		
            object数组
            [
    {
        "image": "https://example.com/exampletemplate1.png",
        "title": "exampletemplate1.docx",
        "url": "https://example.com/url-to-create-template1"
    }
]
        

        

            
                
            
        

        

            
            定义当前查看或编辑文档的用户：
                
    
                    
  • 
                        firstname - 用户的名字。
                        自 4.2 版起已弃用，请改用 name，
                        
    
                        类型：string，
                        
    
                        例如："John"；
                    
    • 
                    
  • 
                        group - 用户所属的组，
                        
    
                        类型：string，
                        
    
                        例如："Group1"；
                    
    • 
                    
  • 
                        id - 用户的标识。
                        长度限制为 128 个符号。
                        
    
                        此信息被存储并用于区分共同作者, 在保存和突出显示历史记录（在 更改列表中）时指出最后更改的 作者，并根据用户数量计算有权访问许可证的用户。
                        
    
                        我们建议使用一些唯一的匿名哈希。
                        不要在此字段中使用敏感数据，例如姓名或电子邮件。
                        
    
                        类型：string，
                        
    
                        例如："78e1e841"；
                    
    • 
                    
  • 
                        image - 用户头像的路径,
                        
    
                        类型: string,
                        
    
                        例如: "https://example.com/url-to-user-avatar.png";
                    
    • 
                    
  • 
                        lastname - 用户的姓氏。
                        自 4.2 版起已弃用，请改用 name，
                        
    
                        类型：string，
                        
    
                        例如："Smith";
                    
    • 
                    
  • 
                        name - 用户的全名。
                        长度限制为 128 个符号。
                        从 4.2 版开始使用，
                        
    
                        类型：string，
                        
    
                        例如："John Smith"。
                    
    • 
                

            		
            object
            {
    "group": "Group1",
    "id": "78e1e841",
    "image": "https://example.com/url-to-user-avatar.png",
    "name": "John Smith"
}
        

    





* - 必填字段







                    

                

        

    

    

        

            

                

                    
                

                
© Ascensio System SIA 2024. All rights reserved