关于

类型: boolean

定义关于菜单按钮显示还是隐藏。默认值为true。

示例:true

features.spellcheck.change

类型: boolean

定义拼写检查器设置是否显示拼写检查器设置在所有编辑器中可用。

:::请注意features对象的其他字段可用于标准品牌，并在此处中描述。只有features.spellcheck.change字段需要额外付款。 :::

示例:true

字体

类型: object

定义界面元素（按钮、选项卡等）的字体。

示例:

const font = {
  name: "Arial",
  size: "11px",
}

font.name

类型: string

字体名称。

示例:"Arial"

font.size

类型: string

字体大小。

示例:"11px"

布局

类型: object

定义用户可用于隐藏界面元素但不完全禁用功能的参数（例如，如果此功能可从其他元素（如关联菜单）或通过热键获得）。

示例:

const layout = {
  header: {
    editMode: true,
    save: true,
    user: true,
    users: true,
  },
  leftMenu: {
    mode: true,
    navigation: true,
    spellcheck: true,
  },
  rightMenu: {
    mode: true,
  },
  statusBar: {
    actionStatus: true,
    docLang: true,
    textLang: true,
  },
  toolbar: {
    collaboration: {
      mailmerge: true,
    },
    draw: true,
    file: {
      close: true,
      info: true,
      save: true,
      settings: true,
    },
    home: {},
    layout: true,
    plugins: true,
    protect: true,
    references: true,
    save: true,
    view: {
      navigation: true,
    },
  },
}

layout.header

类型: object

定义编辑器标题设置。

示例:

const header = {
  editMode: true,
  save: true,
  user: true,
  users: true,
}

layout.header.editMode

类型: boolean

定义是否在标题中显示用于切换编辑器模式的按钮。默认值为true。

示例:true

layout.header.save

类型: boolean

定义编辑器标题中的保存按钮是显示还是隐藏。默认值为true。请注意，当compactHeader参数设置为false时，将使用此设置。

示例:true

layout.header.user

Type: boolean

定义编辑器标题栏中带有用户头像/姓名首字母的图标是否显示或隐藏。默认值为true。

示例:true

layout.header.users

类型: boolean

定义是否显示或隐藏带有编辑用户的按钮。默认值为true。

示例:true

layout.leftMenu

定义左侧菜单设置。如果此参数是布尔值，则它指定左侧菜单是显示还是隐藏。默认值为true。

类型: object | boolean

示例:

const leftMenu = {
  mode: true,
  navigation: true,
  spellcheck: true,
}

layout.leftMenu.mode

类型: boolean

定义左侧面板可见性的初始值 - 显示或隐藏。它用于视图选项卡上的左侧面板菜单选项。默认值为true。

示例:true

layout.leftMenu.navigation

类型: boolean

定义导航按钮是显示还是隐藏。默认值为true。此参数仅适用于文档编辑器。

示例:true

layout.leftMenu.spellcheck

类型: boolean

定义拼写检查按钮是显示还是隐藏。默认值为true。此参数仅适用于电子表格编辑器。

示例:true

layout.rightMenu

类型: object | boolean

定义右侧菜单设置。 如果此参数为布尔值，则指定是否显示或隐藏右侧菜单。默认值为true。

示例:

const rightMenu = {
  mode: true,
}

layout.rightMenu.mode

类型: boolean

定义右侧面板可见性的初始值 - 显示或隐藏。它用于视图选项卡上的右侧面板菜单选项。默认值为true。

示例:true

layout.statusBar

类型: object | boolean

定义状态栏设置。如果此参数是布尔值，则指定是显示还是隐藏状态栏。默认值为true。

示例:

const statusBar = {
  actionStatus: true,
  docLang: true,
  textLang: true,
}

layout.statusBar.actionStatus

类型: boolean

定义动作状态是显示还是隐藏。默认值为true。

示例:true

layout.statusBar.docLang

类型: boolean

定义是显示还是隐藏用于选择文档语言的按钮。默认值为true。此参数仅适用于文档编辑器和演示文稿编辑器。

示例:true

layout.statusBar.textLang

类型: boolean

定义用于选择文本语言的按钮是显示还是隐藏。默认值为true。此参数仅适用于文档编辑器和演示文稿编辑器。

示例:true

layout.toolbar类型: object | boolean

定义工具栏设置。如果此参数是布尔值，则指定是显示还是隐藏工具栏。默认值为true。

示例:

const toolbar = {
  collaboration: {
    mailmerge: true,
  },
  draw: true,
  file: {
    close: true,
    info: true,
    save: true,
    settings: true,
  },
  home: {},
  layout: true,
  plugins: true,
  protect: true,
  references: true,
  save: true,
  view: {
    navigation: true,
  },
}

layout.toolbar.collaboration

类型: object | boolean

定义Collaboration选项卡设置。如果此参数是布尔值，则指定是否显示或隐藏Collaboration选项卡。默认值为true。

示例:

const collaboration = {
  mailmerge: true,
}

layout.toolbar.collaboration.mailmerge

类型: boolean

定义选择邮件合并基础的按钮是否显示或隐藏。默认值为true。

示例:true

layout.toolbar.draw

类型: boolean

定义是否显示或隐藏绘图选项卡。默认值为true。

示例:true

layout.toolbar.file

类型: object | boolean

定义文件选项卡设置。如果此参数是布尔值，则指定是显示还是隐藏文件选项卡。默认值为true。

示例:

const file = {
  close: true,
  info: true,
  save: true,
  settings: true,
}

layout.toolbar.file.close

类型: boolean

定义关闭菜单选项是显示还是隐藏。默认值为true。

示例:true

layout.toolbar.file.info

类型: boolean

定义是显示还是隐藏文档信息选项。默认值为true。

示例:true

layout.toolbar.file.save

类型: boolean

定义保存选项是显示还是隐藏。默认值为true。

示例:true

layout.toolbar.file.settings

类型: boolean

定义是显示还是隐藏高级设置选项。默认值为true。

示例:true

layout.toolbar.home

类型: object

定义主页选项卡设置。无法隐藏此选项卡。

示例:{}

layout.toolbar.home.mailmerge

类型: boolean

定义是否显示或隐藏用于选择邮件合并基础的按钮。此参数已弃用，请改用toolbar.collaboration.mailmerge参数。

示例:true

layout.toolbar.layout

类型: boolean

定义布局选项卡是显示还是隐藏。此参数仅适用于文档编辑器和电子表格编辑器。默认值为true。

示例:true

layout.toolbar.plugins

类型: boolean

定义插件选项卡是显示还是隐藏。默认值为true。

示例:true

layout.toolbar.protect

类型: boolean

定义保护选项卡是显示还是隐藏。默认值为true。

示例:true

layout.toolbar.references

类型: boolean

定义是显示还是隐藏参考选项卡。此参数仅适用于文档编辑器。默认值为true。

示例:true

layout.toolbar.save

类型: boolean

定义工具栏上的保存按钮是显示还是隐藏。默认值为true。请注意，当compactHeader参数设置为true时，将使用此设置。

示例:true

layout.toolbar.view

类型: object | boolean

定义视图选项卡设置。如果此参数是布尔值，则指定是显示还是隐藏视图选项卡。默认值为true。

示例:

const view = {
  navigation: true,
}

layout.toolbar.view.navigation

类型: boolean

定义导航按钮是显示还是隐藏。默认值为true。此参数仅适用于文档编辑器。

示例:true

leftMenu

类型: boolean

定义左侧菜单面板是显示还是隐藏。默认值为true。

Deprecated

请使用布局。改为layout.leftMenu参数。

示例:true

loaderLogo

类型: string

定义加载文档时将显示的图像徽标的路径（对于此文件没有特别的建议，但最好使用透明背景的.png格式）。当在编辑器中显示时，图像将按比例调整到160像素的高度。

示例:https://example.com/loader-logo.png

loaderName

类型: string

定义加载文档时将显示的文本。

示例:"正在加载文档，请稍候…"

rightMenu

类型: boolean

定义右菜单面板是显示还是隐藏。默认值为true。

Deprecated

请改用layout.rightMenu参数。

示例:true

statusBar

类型: boolean

定义状态栏是显示还是隐藏。默认值为true。

Deprecated

请改用layout.statusBar参数。

示例:true

toolbar

类型: boolean

定义顶部工具栏是显示还是隐藏。默认值为true。

Deprecated

请改用layout.toolbar参数。

示例:true

综合示例

const config = {
  editorConfig: {
    customization: {
      about: true,
      features: {
        spellcheck: {
          change: true,
        },
      },
      font: {
        name: "Arial",
        size: "11px",
      },
      layout: {
        header: {
          editMode: true,
          save: true,
          user: true,
          users: true,
        },
        leftMenu: {
          mode: true,
          navigation: true,
          spellcheck: true,
        },
        rightMenu: {
          mode: true,
        },
        statusBar: {
          actionStatus: true,
          docLang: true,
          textLang: true,
        },
        toolbar: {
          collaboration: {
            mailmerge: true,
          },
          draw: true,
          file: {
            close: true,
            info: true,
            save: true,
            settings: true,
          },
          home: {},
          layout: true,
          plugins: true,
          protect: true,
          references: true,
          save: true,
          view: {
            navigation: true,
          },
        },
      },
      loaderLogo: "https://example.com/loader-logo.png",
      loaderName: "The document is loading, please wait...",
    },
  },
};

const docEditor = new KlinDocsAPI.DocEditor("placeholder", config);