自定义部分允许自定义编辑器界面，使其看起来像您的其他产品（如果有），并更改是否出现附加按钮、链接、更改徽标和编辑器所有者详细信息。

在此页面上，您将找到 KLINOFFICE 可用的自定义参数。

匿名

类型: object

添加对匿名名称的请求：

示例:

const anonymous = {
  request: true,
  label: "Guest",
}

anonymous.request

类型: boolean

定义是否发送请求。默认值为true。

示例:true

anonymous.label

类型: string

添加到用户名的后缀。默认值为Guest。

示例:"Guest"

自动保存

类型: boolean

定义自动保存菜单选项是启用还是禁用。如果设置为false，则只能选择Strict共同编辑模式，因为Fast在没有自动保存的情况下不起作用。默认值为true。

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

示例:true

聊天

类型: boolean

定义聊天菜单按钮是显示还是隐藏。请注意，如果您隐藏聊天按钮，相应的聊天功能也将被禁用。默认值为true。

Deprecated

请改用document.permissions.chat参数。

示例:true

关闭

类型: object

定义用于关闭编辑器的关闭按钮的设置。

示例:

const close = {
  visible: true,
  text: "Close file",
}

close.visible

类型: boolean

定义用于关闭编辑器的关闭按钮是显示还是隐藏。默认值为true。

示例:true

close.text

类型: string

定义编辑器标题中按钮的工具提示文本或移动编辑器中的菜单项文本以及 Web 编辑器的File菜单中的按钮的工具提示文本。

:::请注意，仅当设置了onRequestClose事件时，该参数才可用。如果未声明该事件且未指定close参数，则不会显示关闭按钮。

请注意，此参数也适用于移动编辑器。 :::

示例:"关闭文件"

commentAuthorOnly

类型: boolean

定义用户是否只能编辑和删除他的评论。默认值为false。

Deprecated

请改用document.permissions.editCommentAuthorOnly和document.permissions.deleteCommentAuthorOnly字段。

示例:true

评论

类型: boolean

定义注释菜单按钮是显示还是隐藏。请注意，如果您隐藏评论按钮，则相应的评论功能将仅供查看，无法添加和编辑评论。默认值为true。

示例:true

compactHeader

类型: boolean

定义附加操作按钮是显示在编辑器窗口标题的上部靠近徽标 (false) 还是显示在工具栏 (true) 中，使标题更紧凑。默认值为false。

示例:false

compactToolbar

类型: boolean

定义显示的顶部工具栏类型是完整的 (false) 还是紧凑的 (true)。默认值为false。从 8.3 版开始，此设置也适用于查看器。查看模式的默认值为true。

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

示例:false

compatibleFeatures

类型: boolean

定义仅与 OOXML 格式兼容的功能的使用。例如，不要对整个文档使用注释。默认值为false。

示例:false

功能

类型: object

如果可能，定义用户可以禁用或自定义的参数：

示例:

const features = {
  featuresTips: true,
  roles: true,
  spellcheck: {
    mode: true,
  },
  tabBackground: {
    mode: "header",
    change: true,
  },
  tabStyle: {
    mode: "fill",
    change: true,
  },
}

features.featuresTips

类型: boolean

定义在首次加载时，关于编辑器新功能的提示框是显示还是隐藏。默认值为true。

示例:true

features.roles

类型: boolean

定义是否在 pdf 表单中禁用角色设置。如果该参数等于false，则隐藏角色管理器，并禁用代表特定角色查看表单。在这种情况下，表单选项卡上的管理角色和查看表单按钮以及右侧面板中用于设置字段角色的下拉列表将不会显示。默认值为true。

:::请注意，此参数仅适用于 KLINOFFICE 文档开发者版的编辑。 :::

示例:true

features.spellcheck

类型: object | boolean

定义在加载编辑器时拼写检查器是自动打开还是关闭。如果此参数为布尔值，则将其设置为初始拼写检查值，并且不会隐藏拼写检查设置。默认值为true。

示例:true

features.spellcheck.mode

类型: boolean

定义在加载编辑器时拼写检查器是自动打开还是关闭。此参数仅适用于文档编辑器和演示文稿编辑器。

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

示例:true

features.tabBackground

类型: object | string

定义顶部工具栏选项卡的背景。如果此参数是字符串值（header或toolbar），则将其设置为初始选项卡背景值，并且不会隐藏选项卡背景设置。默认值为header。

示例:"header"

features.tabBackground.mode

类型: string

定义顶部工具栏选项卡的背景是否与标题背景（header）或工具栏背景（toolbar*）匹配。默认值为header。首次打开编辑器时使用此值。

示例:"header"

features.tabBackground.change

类型: boolean

定义选项卡背景设置是否显示在文件 -> 高级设置中。此设置在所有编辑器类型中都可用。

示例:true

features.tabStyle

类型: object | string

定义顶部工具栏选项卡的样式。如果此参数是字符串值（fill或line），则将其设置为初始选项卡样式值，并且选项卡样式设置不会被隐藏。默认值为fill。

示例:"fill"

features.tabStyle.mode

类型: string

定义顶部工具栏选项卡是否清晰显示（fill）或仅突出显示以查看选择了哪个选项卡（line）。默认值为fill。此值在编辑器首次打开时使用。

示例:"fill"

features.tabStyle.change

类型: boolean

定义选项卡样式设置是否显示在文件 -> 高级设置中。此设置在所有编辑器类型中都可用。

示例:true

反馈和支持feedback

类型: boolean | object

定义反馈和支持菜单按钮的设置。可以是布尔值（仅显示或隐藏反馈和支持菜单按钮）或对象。

默认值为false。

:::请注意，此参数也适用于移动编辑器。 :::

示例:true

feedback.url

类型: string

单击反馈和支持菜单按钮时将打开的网站绝对URL。

示例:https://example.com

feedback.visible

类型: boolean

显示或隐藏反馈和支持菜单按钮。

示例:true

forcesave

类型: boolean

在文档编辑服务中保存文档时（例如单击保存按钮等），将文件强制保存请求添加到callback handler。默认值为false。

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

示例:false

forceWesternFontSize

Type: boolean

定义在简体中文界面中使用西文字号（true）还是中文字号（false）。默认值为 false。

示例:false

goback

类型: object

定义打开文件位置菜单按钮和右上角按钮的设置。

:::请注意，请注意，此参数也适用于移动编辑器。 :::

示例:

const goback = {
  blank: true,
  text: "Open file location",
  url: "https://example.com",
}

goback.blank

类型: boolean

单击打开文件位置按钮时，在新浏览器选项卡/窗口（如果值设置为true）或当前选项卡（如果值设置为false）中打开网站。默认值为true。

示例:true

goback.requestClose

类型: boolean

定义如果单击打开文件位置按钮，将调用events.onRequestClose事件而不是打开浏览器选项卡或窗口。

Deprecated

自 8.1 版起已弃用。请使用close参数代替。

示例:false

goback.text

类型: string

打开文件位置菜单按钮和右上角按钮显示的文本（也就是说，不是转到文档）。

示例:"打开文件位置"

goback.url

类型: string

单击打开文件位置菜单按钮时将打开的网站绝对 URL。

示例:https://example.com

帮助

类型: boolean

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

:::请注意，请注意，此参数也适用于移动编辑器。 :::

示例:true

hideNotes

类型: boolean

定义注释面板在首次加载时是显示还是隐藏。默认值为false。此参数仅适用于演示文稿编辑器。

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

示例:false

hideRightMenu

类型: boolean

定义第一次加载时是否显示或隐藏右侧菜单。默认值为true。

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

示例:true

hideRulers

类型: boolean

定义编辑器标尺是显示还是隐藏。此参数可用于文档和演示文稿编辑器。文档编辑器的默认值为false，演示文稿的默认值为true。

示例:false

integrationMode

类型: string

定义将编辑器嵌入网页的模式。embed值禁止在加载编辑器框架时滚动到编辑器框架，因为焦点未被捕获。

示例:"embed"

logo

类型: object

更改编辑器标题左上角的图像文件。推荐的图像高度为 20 像素。

:::请注意，此参数仅适用于 KLINOFFICE 文档开发者版的编辑。

请注意，此参数也适用于移动编辑器。 :::

示例:

const logo = {
  image: "https://example.com/logo.png",
  imageDark: "https://example.com/dark-logo.png",
  imageLight: "https://example.com/light-logo.png",
  url: "https://example.com",
  visible: true,
}

logo.image

类型: string

用于在通用工作模式（即所有编辑器的查看和编辑模式）或嵌入模式（请参阅配置部分以了解如何定义嵌入文档类型）中显示的图像文件的路径。图片必须具有以下尺寸：300x20.

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

logo.imageDark

类型: string

用于深色标题的图像文件的路径（例如，在深色主题中或带有彩色标题的主题中）。图像必须具有以下尺寸：300x20。

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

logo.imageLight

类型: string

用于浅色标题的图像文件的路径（例如，在灰色主题中）。图像必须具有以下尺寸：300x20。

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

logo.imageEmbedded

类型: string

用于以嵌入模式显示的图像文件的路径（请参阅配置部分以了解如何定义嵌入文档类型）。图片必须具有以下尺寸：248x40。

Deprecated

自 7.0 版起已弃用，请改用图像字段。

示例:https://example.com/logo_em.png

logo.url

类型: string

当有人单击徽标图像时将使用的绝对 URL（可用于访问您的网站等）。保留为空字符串或null以使徽标不可点击。

示例:https://example.com

logo.visible

类型: boolean

显示或隐藏徽标。默认值为true。

示例:true

macros

类型: boolean

定义编辑器打开时是否自动运行文档宏。默认值为 true。

false 值将完全禁用宏——无法运行、添加或编辑宏。“宏”按钮也会在“视图”选项卡中隐藏。

示例:true

macrosMode

类型: string

定义启用自动开始时的宏运行模式。可以取以下值：

disable
- 不自动运行所有宏；
enable
- 自动运行所有宏；
warn
- 对运行宏发出警告并请求运行它们的权限。

默认值为warn。

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

请注意，此参数也适用于移动编辑器。 :::

示例:"warn"

mentionShare

类型: boolean

定义在评论中提及后描述事件的提示。如果为true，则提示表示用户将收到通知并访问文档。如果为false，则提示表示用户将仅收到提及通知。默认值为true。

:::请注意，如果设置了onRequestSendNotify事件，它将仅可用于评论。 :::

示例:true

mobile

类型: object

定义移动文档编辑器设置。

:::请注意，此参数仅适用于移动编辑器。 :::

示例:

const mobile = {
  forceView: true,
  info: false,
  standardView: false,
}

mobile.forceView

类型: boolean

定义在移动文档编辑器中启动时是否启用查看模式。

示例:true

mobile.info

类型: boolean

定义在移动文档编辑器中是否显示或隐藏文档信息按钮。

示例:false

mobile.standardView

类型: boolean

定义编辑器是否在标准视图而不是移动视图中打开。

示例:false

mobileForceView

类型: boolean

定义移动文档编辑器在启动时是否以查看/编辑模式打开。默认值为true。

:::请注意，请注意，此参数仅适用于移动编辑器。 :::

Deprecated

请改用mobile参数。

示例:true

插件

类型: boolean

定义插件是否将启动并可用。默认值为true。

示例:true

pointerMode

类型: string

定义在查看器中加载演示文稿编辑器时的指针模式（select或hand）。默认值为select。

示例:"select"

审阅

类型: object

包含有关审阅模式的信息。

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

showReviewChanges,reviewDisplay,trackChanges参数自 7.0 版起已弃用。请改用review参数。 :::

示例:

const review = {
  hideReviewDisplay: false,
  showReviewChanges: false,
  reviewDisplay: "original",
  trackChanges: true,
  hoverMode: false,
}

review.hideReviewDisplay

类型: boolean

定义显示模式按钮是在协作选项卡上显示还是隐藏。

示例:false

review.hoverMode

类型: boolean

定义审阅显示模式：通过将鼠标悬停在更改上来在工具提示中显示审阅（true），或通过单击更改来在气球中显示审阅（false）。

示例:false

review.reviewDisplay

类型: string

定义打开文档进行查看时将使用的审阅编辑模式。如果模式设置为view，它将仅对文档编辑器可用。

markup
- 显示文档，并突出显示建议的更改；
simple
- 显示文档并突出显示建议的更改，但气球已关闭；
final
- 显示文档并应用了所有建议的更改；
original
- 显示原始文档，没有建议的更改。

默认值为original。

示例:"original"

review.showReviewChanges

类型: boolean

定义在加载编辑器时是否自动显示或隐藏审阅更改面板。默认值为false。

示例:false

review.trackChanges

类型: boolean

无论document.permissions.review参数如何，定义是否以审阅编辑模式 (true) 打开文档 (false) （审阅模式仅针对当前用户更改）。如果参数未定义，则使用document.permissions.review值（对于所有文档用户）。

示例:true

reviewDisplay

类型: string

定义文档编辑器中的审阅编辑模式。此参数可以采用以下值：

markup
- 显示文档并突出显示建议的更改；
simple
- 显示文档并突出显示建议的更改，但气球已关闭；
final
- 显示文档并应用所有建议的更改；
original
- 显示原始文档，没有建议的更改。

查看器的默认值是original, 编辑器的默认值是markup。

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

Deprecated

请改用review.reviewDisplay参数。

示例:"original"

showHorizontalScroll

类型: boolean

定义在加载电子表格编辑器时是否自动显示或隐藏水平滚动条。默认值为true.

示例:true

showReviewChanges

类型: boolean

定义在加载编辑器时是否自动显示或隐藏审阅更改面板。默认值为false。

Deprecated

请改用review.showReviewChanges参数。

示例:false

showVerticalScroll

类型: boolean

定义在加载电子表格编辑器时是否自动显示或隐藏垂直滚动条。默认值为true.

示例:true

slidePlayerBackground

类型: string

定义演示文稿编辑器中幻灯片的背景颜色。可以以 HEX、RGB 或 RGBA 格式表示。例如，#ff0000、rgb(255, 0, 0)、rgba(255, 0, 0, 0.5)。

示例:"#000000"

spellcheck

类型: boolean

定义在加载编辑器时拼写检查器是自动打开还是关闭。拼写检查器仅适用于文档编辑器和演示文稿编辑器。默认值为true。

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

Deprecated

请改用features.spellcheck参数。

示例:true

submitForm

类型: object | boolean

定义完成并提交按钮设置。如果此参数是布尔值，则指定完成并提交按钮将在顶部工具栏上显示还是隐藏。按钮仅适用于pdf格式。默认值为true。

示例:true

submitForm.visible

类型: boolean

定义顶部工具栏上是否显示或隐藏Complete & Submit按钮。按钮仅适用于pdf格式。默认值为true。

示例:true

submitForm.resultMessage

类型: string

定义表单提交后显示的消息。可用的值如下：

""
- 不显示消息；
null / undefined
- 显示默认消息；
"text"
- 显示用户指定的任何文本。

示例:"text"

suggestFeature

Type: boolean

定义Suggest a Feature菜单按钮是否显示或隐藏。默认值为true。

示例:true

toolbarHideFileName

类型: boolean

定义文档标题在顶部工具栏上是可见的 (false) 还是隐藏的 (true)。默认值为false。

:::请注意，当compactHeader和toolbarNoTabs参数设置为true时使用此设置。 :::

::该参数适用于移动端编辑器。 :::

示例:false

toolbarNoTabs

类型: boolean

定义顶部工具栏选项卡是清晰显示 (false) 还是仅突出显示以查看选择了哪个 (true)。默认值为false。

Deprecated

请使用editorConfig.customization.features.tabStyle参数（设置为line）和editorConfig.customization.features.tabBackground参数（等于toolbar）。

示例:false

trackChanges

类型: boolean

无论document.permissions.review参数如何，定义是(true)否(false)以审阅编辑模式打开文档（仅针对当前用户更改审阅模式）。如果参数是未定义，则使用document.permissions.review值（对于所有文档用户）。

Deprecated

请改用review.trackChanges参数。

示例:true

uiTheme

类型: string

定义编辑器主题设置。可以通过两种方式设置：

theme id
- 用户通过其 id 设置主题参数（ theme-light , theme-classic-light , theme-dark , theme-contrast-dark ），
default theme
- 将设置默认的深色或浅色主题值（ default-dark ， default-light ）。默认的浅色主题是 theme-classic-light 。

第一个选项具有更高的优先级。

除了可用的编辑器主题外，用户还可以为应用程序界面自定义自己的颜色主题。

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

示例:"theme-dark"

单元

类型: string

定义标尺和对话框中使用的测量单位。可以取以下值：

cm
- 厘米;
pt
- 点;
inch
- 英寸。

默认值为厘米 (cm)。

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

示例:"cm"

wordHeadingsColor

类型: string

从版本 8.3 开始，定义文档编辑器中默认标题样式的十六进制颜色。

示例:"#00ff00"

zoom

类型: integer

定义以百分比测量的文档显示缩放值。可以取大于0的值。对于文本文档和演示文稿，可以将此参数设置为-1（使文档适合页面选项）或-2（使文档页面宽度适合编辑器页面）。默认值为100。

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

示例:100

示例

const config = {
  editorConfig: {
    customization: {
      anonymous: {
        request: true,
        label: "Guest",
      },
      autosave: true,
      close: {
        visible: true,
        text: "Close file",
      },
      comments: true,
      compactHeader: false,
      compactToolbar: false,
      compatibleFeatures: false,
      customer: {
        address: "My City, 123a-45",
        info: "Some additional information",
        logo: "https://example.com/logo-big.png",
        logoDark: "https://example.com/dark-logo-big.png",
        mail: "john@example.com",
        name: "John Smith and Co.",
        phone: "123456789",
        www: "example.com",
      },
      features: {
        featuresTips: true,
        roles: true,
        spellcheck: {
          mode: true,
        },
        tabBackground: {
          mode: "header",
          change: true,
        },
        tabStyle: {
          mode: "fill",
          change: true,
        },
      },
      feedback: {
        url: "https://example.com",
        visible: true,
      },
      forcesave: false,
      forceWesternFontSize: false,
      goback: {
        blank: true,
        text: "Open file location",
        url: "https://example.com",
      },
      help: true,
      hideNotes: false,
      hideRightMenu: true,
      hideRulers: false,
      integrationMode: "embed",
      logo: {
        image: "https://example.com/logo.png",
        imageDark: "https://example.com/dark-logo.png",
        imageLight: "https://example.com/light-logo.png",
        url: "https://example.com",
        visible: true,
      },
      macros: true,
      macrosMode: "warn",
      mentionShare: true,
      mobile: {
        forceView: true,
        info: false,
        standardView: false,
      },
      plugins: true,
      pointerMode: "select",
      review: {
        hideReviewDisplay: false,
        showReviewChanges: false,
        reviewDisplay: "original",
        trackChanges: true,
        hoverMode: false,
      },
      showHorizontalScroll: true,
      showVerticalScroll: true,
      slidePlayerBackground: "#000000",
      submitForm: {
        visible: true,
        resultMessage: "text",
      },
      suggestFeature: true,
      toolbarHideFileName: false,
      uiTheme: "theme-dark",
      unit: "cm",
      wordHeadingsColor: "#00ff00",
      zoom: 100,
    },
  },
};

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

results matching ""

No results matching ""