註腳與章節附註

支援 Headless

在傳統分頁文件中插入註腳與章節附註。註腳排版於參照所在頁面，章節附註依文件設定放置。此 API 不支援現代文件。

外掛模式

安裝

Shell
pnpm add @univerjs-pro/docs-reference @univerjs-pro/docs-reference-ui

使用

將以下外掛加入已設定授權的 Docs 編輯器，並載入 UI 樣式及符合編輯器語言的資源。

TypeScript
import { UniverDocsReferencePlugin } from '@univerjs-pro/docs-reference'import { UniverDocsReferenceUIPlugin } from '@univerjs-pro/docs-reference-ui'import ReferenceLocale from '@univerjs-pro/docs-reference-ui/locale/zh-TW'import { LocaleType } from '@univerjs/core'import '@univerjs-pro/docs-reference/facade'import '@univerjs-pro/docs-reference-ui/lib/index.css'univerAPI.loadLocales(LocaleType.ZH_TW, ReferenceLocale)univer.registerPlugin(UniverDocsReferencePlugin)univer.registerPlugin(UniverDocsReferenceUIPlugin)

預設模式

安裝

Shell
pnpm add @univerjs/presets @univerjs/preset-docs-core @univerjs/preset-docs-drawing @univerjs/preset-docs-advanced

使用

UniverDocsAdvancedPreset 已包含這兩個外掛，使用該 preset 時不必再次註冊。

搭配使用核心、繪圖與進階預設，並合併各預設的語言資源。用戶端授權設定請參閱使用授權。

TypeScript
import { UniverDocsAdvancedPreset } from '@univerjs/preset-docs-advanced'import AdvancedLocale from '@univerjs/preset-docs-advanced/locales/zh-TW'import { UniverDocsCorePreset } from '@univerjs/preset-docs-core'import CoreLocale from '@univerjs/preset-docs-core/locales/zh-TW'import { UniverDocsDrawingPreset } from '@univerjs/preset-docs-drawing'import DrawingLocale from '@univerjs/preset-docs-drawing/locales/zh-TW'import { createUniver, LocaleType, mergeLocales } from '@univerjs/presets'import '@univerjs/preset-docs-core/lib/index.css'import '@univerjs/preset-docs-drawing/lib/index.css'import '@univerjs/preset-docs-advanced/lib/index.css'const { univerAPI } = createUniver({  locale: LocaleType.ZH_TW,  locales: {    [LocaleType.ZH_TW]: mergeLocales(CoreLocale, DrawingLocale, AdvancedLocale),  },  presets: [    UniverDocsCorePreset({ container: 'app' }),    UniverDocsDrawingPreset(),    UniverDocsAdvancedPreset(),  ],})

插入與管理附註

TypeScript
const document = univerAPI.getActiveDocument()if (document) {  const noteId = document.insertFootnote(0)  if (noteId) console.log(document.getParagraphs(noteId))  console.log(document.getFootnotes(), document.getEndnotes())}

位移是正文中的 UTF-16 位置，包含結構標記。位置或內容無效、缺少編輯權限，或使用現代文件時，插入會回傳 null；成功時回傳穩定的附註 ID。參照與附註內容使用同一次復原及協同 mutation。

以 getFootnotes() / getEndnotes() 讀取，以 deleteFootnote(noteId) / deleteEndnote(noteId) 刪除。setFootnoteSettings() 與 setEndnoteSettings() 設定編號及位置，傳入 null 可重設明確設定。請保存回傳的附註 ID 以定位內容；顯示編號可能因重新分頁而改變。

你覺得這篇文檔如何？

© 2026 DreamNum Co., Ltd.