Notes de bas de page et de fin

Ajoutez des notes aux documents traditionnels paginés. Une note de bas de page apparaît sur la page de sa référence ; une note de fin suit les paramètres du document. Cette API ne prend pas en charge les documents modernes.

Installation

Ajoutez ces plugins à un éditeur Docs avec une licence configurée. Chargez les styles et les ressources de la langue de l’éditeur.

UniverDocsAdvancedPreset inclut déjà ces deux plugins. Si vous utilisez ce preset, ne les enregistrez pas une seconde fois.

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

npm install @univerjs-pro/docs-reference @univerjs-pro/docs-reference-ui

yarn add @univerjs-pro/docs-reference @univerjs-pro/docs-reference-ui

bun add @univerjs-pro/docs-reference @univerjs-pro/docs-reference-ui

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

Insérer et gérer les notes

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

L’offset est une position UTF-16 du corps principal, jetons structurels compris. L’insertion renvoie null si la position ou le contenu est invalide, si les droits manquent ou si le document est moderne. Sinon, elle renvoie un ID stable. La référence et le contenu participent à la même mutation d’annulation et de collaboration.

Lisez les notes avec getFootnotes() / getEndnotes() et supprimez-les avec deleteFootnote(noteId) / deleteEndnote(noteId). setFootnoteSettings() et setEndnoteSettings() règlent la numérotation et le placement ; null réinitialise les paramètres explicites. Conservez l’ID retourné pour accéder au contenu : le numéro affiché peut changer après pagination.