Type Definitions
options
编辑器配置参数
Type:
- Object
Example
{
"base": "", //编辑器引用的基础路径。如果使用<script>标签引用，一般情况下，会自动计算引用路径，此处保持为空，就可以。
//当使用模块化ESModule 或 CommonJS引用时, 需要将base设置为 doceditor/public目录的部署路径。
"id": "documenteditor", //编辑器标识
"name": "", //编辑器名称
"readonly": false, //是否只读
"lp": "zh-cn", //语言，目前只有zh-cn 和 en
"mobile": false, //是否时移动端展现，
"defaultValue": { //编辑器数据默认值
"copies": "", //份数
"secret": "", //密级
"priority": "", //紧急度
"redHeader": "文件红头", //文件红头，允许html
"fileno": "[文号]", //文号
"signerTitle": "签发人：", //签发人标题
"signer": "[签发人]", //签发人，允许文本数组
"subject": "[文件标题]", //文件标题
"mainSend": "[主送单位：]", //主送单位
"filetext": "[请在此处编辑正文内容]", //正文
"attachmentTitle": "附件：", //附件说明标题
"attachment": "", //附件说明列表，允许数组
"issuanceUnit": "[发文机关]", //发文机关
"issuanceDate": "[成文日期]", //成文日期
"annotation": "", //附注
"copytoTitle": "抄送：", //抄送标题
"copyto": "[抄送]", //抄送
"copyto2Title": "发：",
"copyto2": "[发]",
"editionUnit": "[印发机关]", //印发机关
"editionDate": "[印发日期]", //印发日期
"meetingAttendTitle": "出席：",
"meetingLeaveTitle": "请假：",
"meetingSitTitle": "列席：",
"meetingAttend": "", //会议出席
"meetingLeave": "", //会议请假
"meetingSit": "", //会议列席
"meetingRecord": "" //会议记录
},
"documentTempleteType": "sys", //公文模板类型，取值 "sys"或 "cus"; sys 标识系统内置模板，documentTempleteName字段生效； cus 表示自定义模板，documentTempleteUrl字段生效
"documentTempleteName": "standard", //内置模板名称，见 src/editor/templete.json, 模板取值：
//standard (标准公文类); meeting (纪要通报类); party-meeting (党委纪要类); letter (函类); command (命令类); party(党委纪委类); combine(联合发文类); empty (空模板（仅正文）)
"documentTempleteUrl" : "", //自定义模板url路径
"allowEdit": "y", //是否允许编辑 "y" 或 "n" 或 "s" 表示根据脚本确定
"allowPrint": "y", //是否允许打印 "y" 或 "n" 或 "s" 表示根据脚本确定
"allowHistory": "y", //是否允许查看痕迹 "y" 或 "n" 或 "s" 表示根据脚本确定
"allowEditScript": null, //判断是否允许编辑的脚本（allowEdit为"s"时有效），一个返回boolean型的function，或者是 {"code": "return true"}，这样的代码片段
"allowPrintScript": null, //判断是否允许打印的脚本（allowPrint"s"时有效），一个返回boolean型的function，或者是 {"code": "return true"}，这样的代码片段
"allowHistoryScript": null, //判断是否允许查看痕迹的脚本（allowHistory"s"时有效），一个返回boolean型的function，或者是 {"code": "return true"}，这样的代码片段
"canScale": true, //是否允许缩放 true 或 false
"fullWidth": true, //自动将半角空格转换为全角 true 或 false
"textIndent": true, //段落首行自动缩进 true 或 false
"canFullScreen": true, //是否允许全屏 true 或 false
"toWordSeal": true, //转换word时，是否显示图片章 true 或 false
"firstPageNumber": true, //转换word,第一页是否显示页码 true 或 false
"wordConversionEncryption": false, //转换word,是否启用文档保护 true 或 false
"copiesSecretPriorityShow": "y", //份号、密级、紧急度是否显示 "y" 或 "n"
"copiesShow": "a", //份号是否显示 "y":显示; "n":不显示; "a":自动（有值就显示，否则隐藏）; "s": 根据脚本确定(脚本返回true显示，否则隐藏)
"copiesShowScript": null, //通过脚本判断份号是否显示（copiesShow为"s"时有效），一个返回boolean型的function，或者是 {"code": "return true"}，这样的代码片段
"copiesValueType": "data", //份号数据绑定类型，"data":绑定表单上的一个可输入字段（copiesValueData）； "script"：通过脚本绑定值（redHeaderValueScript）
"copiesValueData": "", //份号数据绑定的表单字段选择器，如"#subject",表示id为subject的dom元素。
"copiesValueScript": null, //通过脚本绑定数据，copiesValueType为“script”时生效。一个function，或者是 {"code": "return '数据'"}，这样的代码片段
... //所有公文元素都有这五个字段，他们的含义都是一样的，可以看src/editor/options.json文件
"subjectEdit" : "y", //份号是否允许编辑 "y"、"n" 或 "s": 根据脚本确定(脚本返回true可编辑，否则不可编辑)
"subjectEditScript": null, //通过脚本判断标题是否可编辑（subjectEdit"s"时有效），一个返回boolean型的function，或者是 {"code": "return true"}，这样的代码片段
"subjectFontFamily": "方正小标宋简体", //标题字体
"customFields": { //模板中自定义元素数据绑定，这个样例的意思是将自定义元素layout_opinions与表单字段#opinions的只绑定
"layout_opinions" : "#opinions" //模板元素设置class为“doc_layout”,并增加属性“data-doc-layout='xxxx'”就是一个名为xxxx的自定义元素
}, //这个例子中，模板中应该有一个类似 <div class='doc_layout' data-doc-layout='layout_opinions'></div> 这样的元素
"ckeditConfigOptions" //ckeditor编辑器配置参数，一个返回Object类型的function，或者是 {"code": "return {}"}，这样的代码片段
"recordScale": false, //是否记录用户设置的缩放比例，下次打开时以这个比例显示
"autoScale": "auto", //是否自动调整比例。当屏幕足够大，显示100%，当屏幕不足以显示100%比例时，自动将宽度缩小到展现文档内容
"fullScreenDom": null, //全屏时参照的dom对象，为空时就是document.body
"user": { //当前用户名称
"name": "测试"
},
"activity": { //当前活动名称
"name": "核稿"
},
"processInfo": {}, //文档或流程相关的扩展信息
"docId": "" //当前文档的唯一标识，一般情况下是流程实例的id
}