diff --git a/README.md b/README.md index 94a11d85..b2517556 100644 --- a/README.md +++ b/README.md @@ -1 +1,52 @@ # Univer Documentation + +This is the official documentation site for [Univer](https://github.com/dream-num/univer), built with [Next.js](https://nextjs.org/) and [Fumadocs](https://fumadocs.vercel.app/). + +## Prerequisites + +- [Node.js](https://nodejs.org/) >= 20.9 +- [pnpm](https://pnpm.io/) >= 10 + +## Local Development + +Install dependencies: + +```bash +pnpm install +``` + +Start the development server: + +```bash +pnpm dev +``` + +The site will be available at `http://localhost:3030`. + +Build for production: + +```bash +pnpm build +``` + +## Project Structure + +``` +├── app/ # Next.js application routes and layouts +├── components/ # React components for the documentation site +├── content/ # Documentation content (MDX) +│ ├── blog/ # Blog posts +│ ├── guides/ # User guides (docs, sheets, slides, pro, recipes, skills) +│ ├── icons/ # Icons reference +│ └── reference/ # API reference +├── examples/ # Framework integration examples (React, Vue, Angular, Astro) +├── lib/ # Utility libraries +├── public/ # Static assets +└── scripts/ # Build and automation scripts +``` + +## Contributing + +We welcome contributions to the documentation. Please ensure your changes follow the existing style and conventions. Run `pnpm lint` and `pnpm typecheck` before submitting. + +For more information about contributing to Univer, see the [main repository](https://github.com/dream-num/univer). diff --git a/content/guides/docs/features/core/index.ja-JP.mdx b/content/guides/docs/features/core/index.ja-JP.mdx index f3c7242f..ff27633c 100644 --- a/content/guides/docs/features/core/index.ja-JP.mdx +++ b/content/guides/docs/features/core/index.ja-JP.mdx @@ -110,7 +110,7 @@ interface CreateUniverParameter { } ``` -参考：[`createUniver`](/reference/methods/create-univer) +参考：[`createUniver`(https://docs.univer.ai/reference/methods/create-univer) #### @univerjs/preset-docs-core @@ -159,7 +159,7 @@ UniverSheetsCorePreset({ ここでの `'sheet.command.set-range-bold'` と `'sheet.command.set-range-italic'` はコマンド名で、該当メニュー項目を指します。 -参考：[@univerjs/preset-docs-core](/reference/packages/presets/univerjs/preset-docs-core) +参考：[@univerjs/preset-docs-core(https://docs.univer.ai/reference/packages/presets/univerjs/preset-docs-core) ## プラグインモード diff --git a/content/guides/docs/features/core/index.mdx b/content/guides/docs/features/core/index.mdx index 0acee69c..dd09b565 100644 --- a/content/guides/docs/features/core/index.mdx +++ b/content/guides/docs/features/core/index.mdx @@ -110,7 +110,7 @@ interface CreateUniverParameter { } ``` -Reference: [`createUniver`](/reference/methods/create-univer) +Reference: [`createUniver`(https://docs.univer.ai/reference/methods/create-univer) #### @univerjs/preset-docs-core @@ -159,7 +159,7 @@ UniverSheetsCorePreset({ Here, `'sheet.command.set-range-bold'` and `'sheet.command.set-range-italic'` are the names of the commands, indicating the corresponding menu items. -Reference: [@univerjs/preset-docs-core](/reference/packages/presets/univerjs/preset-docs-core) +Reference: [@univerjs/preset-docs-core(https://docs.univer.ai/reference/packages/presets/univerjs/preset-docs-core) ## Plugin Mode @@ -231,19 +231,19 @@ interface UniverParameter { } ``` -Reference: [`Univer`](/reference/classes/univer) +Reference: [`Univer`(https://docs.univer.ai/reference/classes/univer) #### @univerjs/engine-render This plugin is the rendering engine of Univer, responsible for rendering, scrollbars, cursor, and selection rendering. It provides the `UniverRenderEnginePlugin`. -Reference: [@univerjs/engine-render](/reference/packages/plugins/univerjs/engine-render) +Reference: [@univerjs/engine-render(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-render) #### @univerjs/engine-formula This plugin is the formula engine of Univer, responsible for calculating and processing formulas. It provides the `UniverFormulaEnginePlugin`. -Reference: [@univerjs/engine-formula](/reference/packages/plugins/univerjs/engine-formula) +Reference: [@univerjs/engine-formula(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-formula) #### @univerjs/design @@ -296,16 +296,16 @@ univer.registerPlugin(UniverSheetsUIPlugin, { Here, `'sheet.command.set-range-bold'` and `'sheet.command.set-range-italic'` are the names of the commands, indicating the corresponding menu items. -Reference: [@univerjs/ui](/reference/packages/plugins/univerjs/ui) +Reference: [@univerjs/ui(https://docs.univer.ai/reference/packages/plugins/univerjs/ui) #### @univerjs/docs This plugin is the core plugin of Univer Docs. It provides the `UniverDocsPlugin`. -Reference: [@univerjs/docs](/reference/packages/plugins/univerjs/docs) +Reference: [@univerjs/docs(https://docs.univer.ai/reference/packages/plugins/univerjs/docs) #### @univerjs/docs-ui This plugin is the UI plugin of Univer Docs, which includes UI components and interactions for the document editor. It provides the `UniverDocsUIPlugin`. -Reference: [@univerjs/docs-ui](/reference/packages/plugins/univerjs/docs-ui) +Reference: [@univerjs/docs-ui(https://docs.univer.ai/reference/packages/plugins/univerjs/docs-ui) diff --git a/content/guides/docs/features/core/index.zh-CN.mdx b/content/guides/docs/features/core/index.zh-CN.mdx index b00e9370..2828ddea 100644 --- a/content/guides/docs/features/core/index.zh-CN.mdx +++ b/content/guides/docs/features/core/index.zh-CN.mdx @@ -110,7 +110,7 @@ interface CreateUniverParameter { } ``` -参考：[`createUniver`](/reference/methods/create-univer) +参考：[`createUniver`(https://docs.univer.ai/reference/methods/create-univer) #### @univerjs/preset-docs-core @@ -159,7 +159,7 @@ UniverDocsCorePreset({ 这里的 `'sheet.command.set-range-bold'` 和 `'sheet.command.set-range-italic'` 是命令的名称，表示对应的菜单项。 -参考：[@univerjs/preset-docs-core](/reference/packages/presets/univerjs/preset-docs-core) +参考：[@univerjs/preset-docs-core(https://docs.univer.ai/reference/packages/presets/univerjs/preset-docs-core) ## 插件模式 @@ -231,19 +231,19 @@ interface UniverParameter { } ``` -参考：[`Univer`](/reference/classes/univer) +参考：[`Univer`(https://docs.univer.ai/reference/classes/univer) #### @univerjs/engine-render 本插件是 Univer 的渲染引擎，负责渲染、滚动条、光标和选区等的绘制。其提供了 `UniverRenderEnginePlugin` 插件。 -参考：[@univerjs/engine-render](/reference/packages/plugins/univerjs/engine-render) +参考：[@univerjs/engine-render(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-render) #### @univerjs/engine-formula 本插件是 Univer 的公式引擎，负责公式的计算和处理。其提供了 `UniverFormulaEnginePlugin` 插件。 -参考：[@univerjs/engine-formula](/reference/packages/plugins/univerjs/engine-formula) +参考：[@univerjs/engine-formula(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-formula) #### @univerjs/design @@ -296,16 +296,16 @@ univer.registerPlugin(UniverSheetsUIPlugin, { 这里的 `'sheet.command.set-range-bold'` 和 `'sheet.command.set-range-italic'` 是命令的名称，表示对应的菜单项。 -参考：[@univerjs/ui](/reference/packages/plugins/univerjs/ui) +参考：[@univerjs/ui(https://docs.univer.ai/reference/packages/plugins/univerjs/ui) #### @univerjs/docs 本插件是 Univer Docs 的核心插件。其提供了 `UniverDocsPlugin` 插件。 -参考：[@univerjs/docs](/reference/packages/plugins/univerjs/docs) +参考：[@univerjs/docs(https://docs.univer.ai/reference/packages/plugins/univerjs/docs) #### @univerjs/docs-ui 本插件是 Univer Docs 的 UI 插件，包含了文档编辑器的 UI 组件和交互。其提供了 `UniverDocsUIPlugin` 插件。 -参考：[@univerjs/docs-ui](/reference/packages/plugins/univerjs/docs-ui) +参考：[@univerjs/docs-ui(https://docs.univer.ai/reference/packages/plugins/univerjs/docs-ui) diff --git a/content/guides/docs/features/core/index.zh-TW.mdx b/content/guides/docs/features/core/index.zh-TW.mdx index 843fa898..c9bca110 100644 --- a/content/guides/docs/features/core/index.zh-TW.mdx +++ b/content/guides/docs/features/core/index.zh-TW.mdx @@ -110,7 +110,7 @@ interface CreateUniverParameter { } ``` -參考：[`createUniver`](/reference/methods/create-univer) +參考：[`createUniver`(https://docs.univer.ai/reference/methods/create-univer) #### @univerjs/preset-docs-core @@ -159,7 +159,7 @@ UniverDocsCorePreset({ 這裡的 `'sheet.command.set-range-bold'` 和 `'sheet.command.set-range-italic'` 是命令的名稱，表示對應的菜單項。 -參考：[@univerjs/preset-docs-core](/reference/packages/presets/univerjs/preset-docs-core) +參考：[@univerjs/preset-docs-core(https://docs.univer.ai/reference/packages/presets/univerjs/preset-docs-core) ## 外掛模式 @@ -231,19 +231,19 @@ interface UniverParameter { } ``` -參考：[`Univer`](/reference/classes/univer) +參考：[`Univer`(https://docs.univer.ai/reference/classes/univer) #### @univerjs/engine-render 本外掛是 Univer 的渲染引擎，負責渲染、滾動條、游標和選區等的繪製。其提供了 `UniverRenderEnginePlugin` 外掛。 -參考：[@univerjs/engine-render](/reference/packages/plugins/univerjs/engine-render) +參考：[@univerjs/engine-render(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-render) #### @univerjs/engine-formula 本外掛是 Univer 的公式引擎，負責公式的計算和處理。其提供了 `UniverFormulaEnginePlugin` 外掛。 -參考：[@univerjs/engine-formula](/reference/packages/plugins/univerjs/engine-formula) +參考：[@univerjs/engine-formula(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-formula) #### @univerjs/design @@ -296,16 +296,16 @@ univer.registerPlugin(UniverSheetsUIPlugin, { 這裡的 `'sheet.command.set-range-bold'` 和 `'sheet.command.set-range-italic'` 是命令的名稱，表示對應的菜單項。 -參考：[@univerjs/ui](/reference/packages/plugins/univerjs/ui) +參考：[@univerjs/ui(https://docs.univer.ai/reference/packages/plugins/univerjs/ui) #### @univerjs/docs 本外掛是 Univer Docs 的核心外掛。其提供了 `UniverDocsPlugin` 外掛。 -參考：[@univerjs/docs](/reference/packages/plugins/univerjs/docs) +參考：[@univerjs/docs(https://docs.univer.ai/reference/packages/plugins/univerjs/docs) #### @univerjs/docs-ui 本外掛是 Univer Docs 的 UI 外掛，包含了文件編輯器的 UI 組件和交互。其提供了 `UniverDocsUIPlugin` 外掛。 -參考：[@univerjs/docs-ui](/reference/packages/plugins/univerjs/docs-ui) +參考：[@univerjs/docs-ui(https://docs.univer.ai/reference/packages/plugins/univerjs/docs-ui) diff --git a/content/guides/docs/features/import-export.ja-JP.mdx b/content/guides/docs/features/import-export.ja-JP.mdx index ee27fb36..d3085dd4 100644 --- a/content/guides/docs/features/import-export.ja-JP.mdx +++ b/content/guides/docs/features/import-export.ja-JP.mdx @@ -204,7 +204,7 @@ url.searchParams.set('unit', unitId) url.searchParams.set('type', '1') // 1 は UniverInstanceType.UNIVER_DOC を表す window.location.href = url.toString() -// または API: univerAPI.loadServerUnit(unitId, 1) を呼び出す。パラメータは https://reference.univer.ai/en-US/classes/FUniver#loadserverunit を参照 +// または API: univerAPI.loadServerUnit(unitId, 1) を呼び出す。パラメータは /reference/facade/univer#loadserverunit を参照 ``` #### `.docx` をインポートして `IDocumentData` を取得 diff --git a/content/guides/docs/features/import-export.mdx b/content/guides/docs/features/import-export.mdx index 057c11f8..8a8d6773 100644 --- a/content/guides/docs/features/import-export.mdx +++ b/content/guides/docs/features/import-export.mdx @@ -204,7 +204,7 @@ url.searchParams.set('unit', unitId) url.searchParams.set('type', '1') // The meaning of 1 is UniverInstanceType.UNIVER_DOC window.location.href = url.toString() -// Or call the API: univerAPI.loadServerUnit(unitId, 1) to load the document, refer to https://reference.univer.ai/en-US/classes/FUniver#loadserverunit for specific parameters +// Or call the API: univerAPI.loadServerUnit(unitId, 1) to load the document, refer to /reference/facade/univer#loadserverunit for specific parameters ``` #### Import `.docx` file and get `IDocumentData` diff --git a/content/guides/docs/features/import-export.zh-CN.mdx b/content/guides/docs/features/import-export.zh-CN.mdx index 39d30c58..7971aab2 100644 --- a/content/guides/docs/features/import-export.zh-CN.mdx +++ b/content/guides/docs/features/import-export.zh-CN.mdx @@ -202,7 +202,7 @@ url.searchParams.set('unit', unitId) url.searchParams.set('type', '1') // 1 的意思是 String(UniverInstanceType.UNIVER_DOC) window.location.href = url.toString() -// 或者调用API: univerAPI.loadServerUnit(unitId, 1) 加载文档，具体参数参考 https://reference.univer.ai/zh-CN/classes/FUniver#loadserverunit +// 或者调用API: univerAPI.loadServerUnit(unitId, 1) 加载文档，具体参数参考 /reference/facade/univer#loadserverunit ``` #### 导入 `.docx` 文件并获取 `IDocumentData` diff --git a/content/guides/docs/features/import-export.zh-TW.mdx b/content/guides/docs/features/import-export.zh-TW.mdx index bcee99b7..0964e918 100644 --- a/content/guides/docs/features/import-export.zh-TW.mdx +++ b/content/guides/docs/features/import-export.zh-TW.mdx @@ -202,7 +202,7 @@ url.searchParams.set('unit', unitId) url.searchParams.set('type', '1') // 1 的意思是 String(UniverInstanceType.UNIVER_DOC) window.location.href = url.toString() -// 或者呼叫API: univerAPI.loadServerUnit(unitId, 1) 載入文件，具體參數參考 https://reference.univer.ai/zh-TW/classes/FUniver#loadserverunit +// 或者呼叫API: univerAPI.loadServerUnit(unitId, 1) 載入文件，具體參數參考 /reference/facade/univer#loadserverunit ``` #### 匯入 `.docx` 檔案並獲取 `IDocumentData` diff --git a/content/guides/docs/features/watermark.ja-JP.mdx b/content/guides/docs/features/watermark.ja-JP.mdx index 26dfb9f1..f3f802c4 100644 --- a/content/guides/docs/features/watermark.ja-JP.mdx +++ b/content/guides/docs/features/watermark.ja-JP.mdx @@ -84,7 +84,7 @@ univer.registerPlugin(UniverWatermarkPlugin, { // [!code ++] ウォーターマーク機能の中核実装を提供するプラグインです。テキスト/画像のウォーターマークを追加でき、外観や挙動を細かく設定できます。`UniverWatermarkPlugin` を提供します。 -参考：[@univerjs/watermark](/reference/packages/plugins/univerjs/watermark) +参考：[@univerjs/watermark(https://docs.univer.ai/reference/packages/plugins/univerjs/watermark) ## Facade API diff --git a/content/guides/docs/features/watermark.mdx b/content/guides/docs/features/watermark.mdx index b8559ade..6b74be1e 100644 --- a/content/guides/docs/features/watermark.mdx +++ b/content/guides/docs/features/watermark.mdx @@ -84,7 +84,7 @@ univer.registerPlugin(UniverWatermarkPlugin, { // [!code ++] This plugin provides the core implementation of watermark functionality. It allows developers to add text or image watermarks to applications and offers various configuration options to customize the appearance and behavior of the watermark. It provides the `UniverWatermarkPlugin` plugin. -Reference: [@univerjs/watermark](/reference/packages/plugins/univerjs/watermark) +Reference: [@univerjs/watermark(https://docs.univer.ai/reference/packages/plugins/univerjs/watermark) ## Facade API diff --git a/content/guides/docs/features/watermark.zh-CN.mdx b/content/guides/docs/features/watermark.zh-CN.mdx index 12244316..018f618b 100644 --- a/content/guides/docs/features/watermark.zh-CN.mdx +++ b/content/guides/docs/features/watermark.zh-CN.mdx @@ -84,7 +84,7 @@ univer.registerPlugin(UniverWatermarkPlugin, { // [!code ++] 本插件提供了水印功能的核心实现。它允许开发者在应用中添加文本或图片水印，并提供多种配置选项来定制水印的外观和行为。其提供了 `UniverWatermarkPlugin` 插件。 -参考：[@univerjs/watermark](/reference/packages/plugins/univerjs/watermark) +参考：[@univerjs/watermark(https://docs.univer.ai/reference/packages/plugins/univerjs/watermark) ## Facade API diff --git a/content/guides/docs/features/watermark.zh-TW.mdx b/content/guides/docs/features/watermark.zh-TW.mdx index 75b65d8a..90bdee89 100644 --- a/content/guides/docs/features/watermark.zh-TW.mdx +++ b/content/guides/docs/features/watermark.zh-TW.mdx @@ -84,7 +84,7 @@ univer.registerPlugin(UniverWatermarkPlugin, { // [!code ++] 本外掛提供了水印功能的核心實現。它允許開發者在應用中新增文字或圖片水印，並提供多種配置選項來客製化水印的外觀和行為。其提供了 `UniverWatermarkPlugin` 外掛。 -參考：[@univerjs/watermark](/reference/packages/plugins/univerjs/watermark) +參考：[@univerjs/watermark(https://docs.univer.ai/reference/packages/plugins/univerjs/watermark) ## Facade API diff --git a/content/guides/docs/getting-started/installation/index.ja-JP.mdx b/content/guides/docs/getting-started/installation/index.ja-JP.mdx index 44ea2e14..17bb2dec 100644 --- a/content/guides/docs/getting-started/installation/index.ja-JP.mdx +++ b/content/guides/docs/getting-started/installation/index.ja-JP.mdx @@ -90,7 +90,7 @@ univerAPI.createUniverDoc({}) プリセットに含まれないプラグインや独自プラグインを使う場合は `plugins` に登録します。Univer インスタンスを取得した後に `univer.registerPlugin` で登録することもできます。 - `createUniver` の詳細は [API Reference / createUniver](/reference/methods/create-univer) を参照してください。 + `createUniver` の詳細は [API Reference / createUniver](https://docs.univer.ai/reference/methods/create-univer) を参照してください。 ### CDN で Univer を使う @@ -262,9 +262,9 @@ npm install @univerjs/@alpha # Alpha 版 npm install @univerjs/@beta # Beta 版 ``` -alpha / beta 版で問題が発生した場合は、[Github Issues](https://github.com/dream-num/univer/issues) や [Discord コミュニティ](https://discord.gg/XPGnMBmpd6) などで報告してください。 +alpha / beta 版で問題が発生した場合は、[GitHub Issues](https://github.com/dream-num/univer/issues) や [Discord コミュニティ](https://discord.gg/XPGnMBmpd6) などで報告してください。 -先行体験をお楽しみください！ +これらの早期リリースについてのフィードバックを歓迎します。 ## 次のステップ diff --git a/content/guides/docs/getting-started/installation/index.mdx b/content/guides/docs/getting-started/installation/index.mdx index 738250dc..a36e7cc3 100644 --- a/content/guides/docs/getting-started/installation/index.mdx +++ b/content/guides/docs/getting-started/installation/index.mdx @@ -41,7 +41,7 @@ npm install @univerjs/presets @univerjs/preset-docs-core If your build tool does not support the `exports` field in package.json (common in Webpack 4), you need to manually change the mapped paths to the actual paths. -With the following code, you can start an Univer Docs application: +With the following code, you can start a Univer Docs application: ```typescript import { UniverDocsCorePreset } from '@univerjs/preset-docs-core' @@ -90,7 +90,7 @@ Some properties of the configuration object are as follows: When you use a plugin that is not included in any preset package or you implement your own plugin, you can register these plugins through the `plugins` property. You can also choose to register plugins using the `univer.registerPlugin` method after obtaining the Univer instance. - You can find more detailed information about the `createUniver` method in the [API Reference / createUniver](/reference/methods/create-univer). + You can find more detailed information about the `createUniver` method in the [API Reference / createUniver](https://docs.univer.ai/reference/methods/create-univer). ### Import from CDN @@ -112,7 +112,7 @@ We use React to develop the view (this does not affect your use of Univer in Vue - If you are using npm, make sure you are using npm@7 or higher. This is because npm@3 ~ npm@6 will not correctly install `peerDependencies`[^1]. - If you are using pnpm, make sure you are using pnpm@8 or higher. If you are using pnpm@6 ~ pnpm@7, you can try configuring `auto-install-peers=true` [^2] to resolve dependency installation issues. - - If you are using yarn, you need to manually install the missing `peerDependencies`[^3], but don't worry, the installation commands below already include these dependencies. + - If you are using yarn, you need to manually install the missing `peerDependencies`[^3], the installation commands below already include these dependencies. @@ -162,7 +162,7 @@ We use React to develop the view (this does not affect your use of Univer in Vue ``` - If you need to use the Facade API, you can import the relevant facade packages here. This is optional (I believe you will need them 😀): + If you need to use the Facade API, you can import the relevant facade packages here. This is optional, but recommended: ```typescript import '@univerjs/engine-formula/facade' @@ -210,7 +210,7 @@ We use React to develop the view (this does not affect your use of Univer in Vue You can register a plugin using the `univer.registerPlugin(Plugin, options)` method, where `Plugin` is the plugin to be registered, and `options` are optional configuration items, as each plugin may have different configuration items. -Of course, you can also pass an array to register multiple plugins at once. This is very useful for scenarios where you need to manage plugins centrally. +You can also pass an array to register multiple plugins at once. This is useful for scenarios where you need to manage plugins centrally. ```typescript univer.registerPlugin([ @@ -262,9 +262,9 @@ npm install @univerjs/@alpha # Alpha version npm install @univerjs/@beta # Beta version ``` -If you encounter any issues or have any feedback while using alpha / beta versions, please report them to the Univer development team through appropriate channels, such as [Github Issues](https://github.com/dream-num/univer/issues) or the [Discord channels](https://discord.gg/XPGnMBmpd6). +If you encounter any issues or have any feedback while using alpha / beta versions, please report them to the Univer development team through appropriate channels, such as [GitHub Issues](https://github.com/dream-num/univer/issues) or the [Discord channels](https://discord.gg/XPGnMBmpd6). -Happy early access experimentation! +We welcome your feedback on these early releases. ## Next Steps diff --git a/content/guides/docs/getting-started/installation/index.zh-CN.mdx b/content/guides/docs/getting-started/installation/index.zh-CN.mdx index 7557f3c7..42a89542 100644 --- a/content/guides/docs/getting-started/installation/index.zh-CN.mdx +++ b/content/guides/docs/getting-started/installation/index.zh-CN.mdx @@ -75,7 +75,7 @@ univerAPI.createUniverDoc({}) 当你使用了一个未包含在任何预设包中的插件或者你自己实现了一个插件时，可以通过 `plugins` 属性来注册这些插件。也可以选择在获得 Univer 实例后通过 `univer.registerPlugin` 方法来注册插件。 - 你可以在 [API Reference / createUniver](/reference/methods/create-univer) 找到更多关于 `createUniver` 方法的详细信息。 + 你可以在 [API Reference / createUniver](https://docs.univer.ai/reference/methods/create-univer) 找到更多关于 `createUniver` 方法的详细信息。 ### 通过 CDN 使用 Univer @@ -97,7 +97,7 @@ Univer 使用了 React 开发视图（当然这并不影响你在 Vue 或者 Ang - 如果你正在使用 npm，请确保使用的版本为 npm@7 及以上。这是因为 npm@3 ~ npm@6 并不会正确地安装 `peerDependencies`[^1]。 - 如果你正在使用 pnpm，请确保使用的版本为 pnpm@8 及以上。如果你正在使用 pnpm@6 ~ pnpm@7，可以尝试配置 `auto-install-peers=true` [^2]来解决依赖安装问题。 - - 如果你正在使用 yarn，你需要手动安装缺失的 `peerDependencies`[^3]，不过别担心，下面的安装命令中已经包含了这些依赖。 + - 如果你正在使用 yarn，你需要手动安装缺失的 `peerDependencies`[^3]，下面的安装命令中已经包含了这些依赖。 @@ -147,7 +147,7 @@ Univer 使用了 React 开发视图（当然这并不影响你在 Vue 或者 Ang ``` - 如果你需要使用 Facade API，你可以在这里引入相关的 facade 包，这是可选的（我相信你会需要它们 😀）： + 如果你需要使用 Facade API，你可以在这里引入相关的 facade 包，这是可选的，但建议引入： ```typescript import '@univerjs/engine-formula/facade' @@ -195,7 +195,7 @@ Univer 使用了 React 开发视图（当然这并不影响你在 Vue 或者 Ang 你可以通过 `univer.registerPlugin(Plugin, options)` 的方式来注册插件，其中 `Plugin` 是要注册的插件，`options` 是可选的配置项，每个插件可能有不同的配置项。 -当然你可以可以通过传入一个数组来一次性注册多个插件。这对于需要集中管理插件的场景非常有用。 +你也可以通过传入一个数组来一次性注册多个插件。这对于需要集中管理插件的场景非常有用。 ```typescript univer.registerPlugin([ @@ -247,9 +247,9 @@ npm install @univerjs/@alpha # Alpha 版本 npm install @univerjs/@beta # Beta 版本 ``` -如果你在使用 alpha / beta 版本时遇到任何问题或者有任何反馈，请通过适当的渠道向 Univer 开发团队报告，比如 [Github Issues](https://github.com/dream-num/univer/issues) 或者 [Discord 社区](https://discord.gg/XPGnMBmpd6)。 +如果你在使用 alpha / beta 版本时遇到任何问题或者有任何反馈，请通过适当的渠道向 Univer 开发团队报告，比如 [GitHub Issues](https://github.com/dream-num/univer/issues) 或者 [Discord 社区](https://discord.gg/XPGnMBmpd6)。 -祝你在抢先体验中玩得愉快！ +我们欢迎你对于这些早期版本的反馈。 ## 下一步 diff --git a/content/guides/docs/getting-started/installation/index.zh-TW.mdx b/content/guides/docs/getting-started/installation/index.zh-TW.mdx index c9ab53fa..fb93e0bc 100644 --- a/content/guides/docs/getting-started/installation/index.zh-TW.mdx +++ b/content/guides/docs/getting-started/installation/index.zh-TW.mdx @@ -90,7 +90,7 @@ univerAPI.createUniverDoc({}) 當你使用了一個未包含在任何預設包中的外掛或者你自己實現了一個外掛時，可以透過 `plugins` 屬性來註冊這些外掛。也可以選擇在獲得 Univer 例項後透過 `univer.registerPlugin` 方法來註冊外掛。 - 你可以在 [API Reference / createUniver](/reference/methods/create-univer) 找到更多關於 `createUniver` 方法的詳細資訊。 + 你可以在 [API Reference / createUniver](https://docs.univer.ai/reference/methods/create-univer) 找到更多關於 `createUniver` 方法的詳細資訊。 ### 透過 CDN 使用 Univer @@ -112,7 +112,7 @@ Univer 使用了 React 開發檢視（當然這並不影響你在 Vue 或者 Ang - 如果你正在使用 npm，請確保使用的版本為 npm@7 及以上。這是因為 npm@3 ~ npm@6 並不會正確地安裝 `peerDependencies`[^1]。 - 如果你正在使用 pnpm，請確保使用的版本為 pnpm@8 及以上。如果你正在使用 pnpm@6 ~ pnpm@7，可以嘗試配置 `auto-install-peers=true` [^2]來解決依賴安裝問題。 - - 如果你正在使用 yarn，你需要手動安裝缺失的 `peerDependencies`[^3]，不過別擔心，下面的安裝命令中已經包含了這些依賴。 + - 如果你正在使用 yarn，你需要手動安裝缺失的 `peerDependencies`[^3]，下面的安裝命令中已經包含了這些依賴。 @@ -162,7 +162,7 @@ Univer 使用了 React 開發檢視（當然這並不影響你在 Vue 或者 Ang ``` - 如果你需要使用 Facade API，你可以在這裡引入相關的 facade 包，這是可選的（我相信你會需要它們 😀）： + 如果你需要使用 Facade API，你可以在這裡引入相關的 facade 包，這是可選的，但建議引入： ```typescript import '@univerjs/engine-formula/facade' @@ -210,7 +210,7 @@ Univer 使用了 React 開發檢視（當然這並不影響你在 Vue 或者 Ang 你可以透過 `univer.registerPlugin(Plugin, options)` 的方式來註冊外掛，其中 `Plugin` 是要註冊的外掛，`options` 是可選的配置項，每個外掛可能有不同的配置項。 -當然你可以可以透過傳入一個陣列來一次性註冊多個外掛。這對於需要集中管理外掛的場景非常有用。 +你也可以透過傳入一個陣列來一次性註冊多個外掛。這對於需要集中管理外掛的場景非常有用。 ```typescript univer.registerPlugin([ @@ -262,9 +262,9 @@ npm install @univerjs/@alpha # Alpha 版本 npm install @univerjs/@beta # Beta 版本 ``` -如果你在使用 alpha / beta 版本時遇到任何問題或者有任何反饋，請透過適當的渠道向 Univer 開發團隊報告，比如 [Github Issues](https://github.com/dream-num/univer/issues) 或者 [Discord 社群](https://discord.gg/XPGnMBmpd6)。 +如果你在使用 alpha / beta 版本時遇到任何問題或者有任何反饋，請透過適當的渠道向 Univer 開發團隊報告，比如 [GitHub Issues](https://github.com/dream-num/univer/issues) 或者 [Discord 社群](https://discord.gg/XPGnMBmpd6)。 -祝你在搶先體驗中玩得愉快！ +我們歡迎你對於這些早期版本的反饋。 ## 下一步 diff --git a/content/guides/docs/getting-started/quickstart.ja-JP.mdx b/content/guides/docs/getting-started/quickstart.ja-JP.mdx index 9f0dde1a..86ab7569 100644 --- a/content/guides/docs/getting-started/quickstart.ja-JP.mdx +++ b/content/guides/docs/getting-started/quickstart.ja-JP.mdx @@ -102,7 +102,7 @@ Univer ではデータの変更はすべてコマンド経由で行われます Facade API は現在も継続的に改善中です。要望や提案があれば GitHub で issue を立ててください。 -簡単さには代償もあります。より高度なカスタマイズが必要な場合は、Univer のアーキテクチャを理解した上で、より低レベルのコマンドやモジュールの API を利用してください。 +Facade API は低レベルの詳細を抽象化しています。一般的なタスクは簡素化されますが、複雑な機能を実装するには、Univer のアーキテクチャを理解した上で、より低レベルのコマンドやモジュールの API を利用する必要がある場合があります。 #### 関連リンク diff --git a/content/guides/docs/getting-started/quickstart.mdx b/content/guides/docs/getting-started/quickstart.mdx index b81fdd21..e0080291 100644 --- a/content/guides/docs/getting-started/quickstart.mdx +++ b/content/guides/docs/getting-started/quickstart.mdx @@ -100,9 +100,9 @@ If you want to modify document data through commands, please refer to [How to Fi Due to the high complexity of office applications, Univer's architecture is also very complex. To make it easier for developers to use Univer, we provide the Facade API, which is a wrapper for Univer's first-party plugins, providing simpler interfaces that make it easier for developers to use Univer. -We are improving the Facade API. Stay tuned for more updates. If you have any questions or requirements, please submit an issue on GitHub. +The Facade API is actively being improved. If you have any questions or requirements, please submit an issue on GitHub. -Of course, everything comes with a price. The Facade API is a high-level API that abstracts the underlying details. If you need to implement some complex features, you may need to understand Univer's architecture and use the low-level API directly. +The Facade API is a high-level API that abstracts the underlying details. While it simplifies common tasks, complex features may require understanding Univer's architecture and using the low-level API directly. #### Related Links diff --git a/content/guides/docs/getting-started/quickstart.zh-CN.mdx b/content/guides/docs/getting-started/quickstart.zh-CN.mdx index cfa46d78..ab88e336 100644 --- a/content/guides/docs/getting-started/quickstart.zh-CN.mdx +++ b/content/guides/docs/getting-started/quickstart.zh-CN.mdx @@ -61,7 +61,7 @@ Univer 的功能均由插件提供，插件是 Univer 的基本组成单元， 目前 Facade API 在不断完善中，如果你有任何建议或者需求，欢迎在 GitHub 上提 issue。 -当然，简单性是有代价的，如果你需要更高级的自定义能力，就需要在了解 Univer 架构的基础上使用更加底层的命令和模块所暴露的 API。 +Facade API 是对底层细节的抽象，虽然它简化了常见任务，但实现复杂功能时可能需要你了解 Univer 的架构并直接使用底层 API。 #### 相关链接 diff --git a/content/guides/docs/getting-started/quickstart.zh-TW.mdx b/content/guides/docs/getting-started/quickstart.zh-TW.mdx index 379eac6b..59294abc 100644 --- a/content/guides/docs/getting-started/quickstart.zh-TW.mdx +++ b/content/guides/docs/getting-started/quickstart.zh-TW.mdx @@ -102,7 +102,7 @@ Univer 的功能均由外掛提供，外掛是 Univer 的基本組成單元， 目前 Facade API 在不斷完善中，如果你有任何建議或者需求，歡迎在 GitHub 上提 issue。 -當然，簡單性是有代價的，如果你需要更高階的自訂能力，就需要在瞭解 Univer 架構的基礎上使用更加底層的命令和模組所暴露的 API。 +Facade API 是對底層細節的抽象，雖然它簡化了常見任務，但實現複雜功能時可能需要你了解 Univer 的架構並直接使用底層 API。 #### 相關連結 diff --git a/content/guides/recipes/architecture/formula.zh-CN.mdx b/content/guides/recipes/architecture/formula.zh-CN.mdx index 2a4df51f..c61ec326 100644 --- a/content/guides/recipes/architecture/formula.zh-CN.mdx +++ b/content/guides/recipes/architecture/formula.zh-CN.mdx @@ -31,7 +31,7 @@ title: 公式引擎架构设计 ![formulaModelRef](./formula/formula-model-ref.png) -此外还对数组公式、数公式范围的数据进行管理。 +此外还对数组公式、数组公式范围的数据进行管理。 代码见 [formula-data.model.ts](https://github.com/dream-num/univer/blob/dev/packages/engine-formula/src/models/formula-data.model.ts)。 diff --git a/content/guides/recipes/practices/find-the-command-id.mdx b/content/guides/recipes/practices/find-the-command-id.mdx index f884ecb3..f46feb7b 100644 --- a/content/guides/recipes/practices/find-the-command-id.mdx +++ b/content/guides/recipes/practices/find-the-command-id.mdx @@ -18,7 +18,7 @@ console.log(SetRangeUnderlineCommand.id) ## Enable logging -When creating an Univer instance, you can set the log level through the `logLevel` parameter. There are 5 log levels: +When creating a Univer instance, you can set the log level through the `logLevel` parameter. There are 5 log levels: - `LogLevel.SILENT`: No logs are output - `LogLevel.ERROR`: Only error logs are output diff --git a/content/guides/recipes/tutorials/custom-canvas.mdx b/content/guides/recipes/tutorials/custom-canvas.mdx index d8710e65..08415a95 100644 --- a/content/guides/recipes/tutorials/custom-canvas.mdx +++ b/content/guides/recipes/tutorials/custom-canvas.mdx @@ -8,9 +8,9 @@ Univer provides an extension mechanism that allows you to customize the renderin The rendering of some Univer elements, such as borders and backgrounds, is accomplished using an extension mechanism. Facade has built-in common extension registration API: -- Middle content area: [`registerSheetMainExtension`](https://reference.univer.ai/zh-CN/classes/FUniver#registersheetmainextension) -- Row header: [`registerSheetRowHeaderExtension`](https://reference.univer.ai/zh-CN/classes/FUniver#registersheetrowheaderextension) -- Column header: [`registerSheetColumnHeaderExtension`](https://reference.univer.ai/zh-CN/classes/FUniver#registersheetcolumnheaderextension) +- Middle content area: [`registerSheetMainExtension`](https://docs.univer.ai/reference/facade/univer#registersheetmainextension) +- Row header: [`registerSheetRowHeaderExtension`](https://docs.univer.ai/reference/facade/univer#registersheetrowheaderextension) +- Column header: [`registerSheetColumnHeaderExtension`](https://docs.univer.ai/reference/facade/univer#registersheetcolumnheaderextension) By inheriting `SheetExtension` and providing a unique key, zIndex, and drawing logic, a sheet rendering extension can be implemented as follows: diff --git a/content/guides/recipes/tutorials/custom-canvas.zh-CN.mdx b/content/guides/recipes/tutorials/custom-canvas.zh-CN.mdx index 4bb49cf3..c775cea5 100644 --- a/content/guides/recipes/tutorials/custom-canvas.zh-CN.mdx +++ b/content/guides/recipes/tutorials/custom-canvas.zh-CN.mdx @@ -8,9 +8,9 @@ Univer 提供了一套扩展机制，可以让你在电子表格中自定义绘 Univer 部分元素的渲染，如边框和背景，就是使用扩展机制来完成的。Facade 内置了常用扩展注册 API： -- 中间内容区域：[`registerSheetMainExtension`](https://reference.univer.ai/zh-CN/classes/FUniver#registersheetmainextension) -- 行标题：[`registerSheetRowHeaderExtension`](https://reference.univer.ai/zh-CN/classes/FUniver#registersheetrowheaderextension) -- 列标题：[`registerSheetColumnHeaderExtension`](https://reference.univer.ai/zh-CN/classes/FUniver#registersheetcolumnheaderextension) +- 中间内容区域：[`registerSheetMainExtension`](https://docs.univer.ai/reference/facade/univer#registersheetmainextension) +- 行标题：[`registerSheetRowHeaderExtension`](https://docs.univer.ai/reference/facade/univer#registersheetrowheaderextension) +- 列标题：[`registerSheetColumnHeaderExtension`](https://docs.univer.ai/reference/facade/univer#registersheetcolumnheaderextension) 继承 `SheetExtension` 后，提供唯一键值、层级、绘制逻辑就能实现一个 Sheet 渲染扩展。如下： diff --git a/content/guides/recipes/tutorials/custom-command.mdx b/content/guides/recipes/tutorials/custom-command.mdx index 7dbd9c34..571adc8f 100644 --- a/content/guides/recipes/tutorials/custom-command.mdx +++ b/content/guides/recipes/tutorials/custom-command.mdx @@ -287,17 +287,17 @@ export interface ISheetClipboardHook { * Properties that would be appended to the td element. * * @deprecated should be merged with `onCopyCellContent` to `onCopyCell` - * @param row row of the the copied cell - * @param col col of the the copied cell - * @param rowSpan row span of the the copied cell - * @param colSpan col span of the the copied cell + * @param row row of the copied cell + * @param col col of the copied cell + * @param rowSpan row span of the copied cell + * @param colSpan col span of the copied cell * @return content */ onCopyCellStyle?: (row: number, col: number, rowSpan?: number, colSpan?: number) => IClipboardPropertyItem | null /** * Properties that would be appended to the tr element. - * @param row each row of the the copied range + * @param row each row of the copied range * @return content */ onCopyRow?: (row: number) => IClipboardPropertyItem | null diff --git a/content/guides/recipes/tutorials/custom-formula.mdx b/content/guides/recipes/tutorials/custom-formula.mdx index 70215d55..6973c768 100644 --- a/content/guides/recipes/tutorials/custom-formula.mdx +++ b/content/guides/recipes/tutorials/custom-formula.mdx @@ -14,7 +14,7 @@ You can create a new `custom-function.ts` file to specifically place custom form 1. Define formula name - First, give the formula a name. We require that it cannot be repeated with the name of the existing formula. The existing formula is mainly from [Office Excel](https://support.microsoft.com/en-us/office/excel-functions-by-category-5f91f4e9-7b42-46d2-9bd1-63f26a86c0eb) refer to. + First, give the formula a name. It must not conflict with existing formula names. Most existing formulas come from [Office Excel](https://support.microsoft.com/en-us/office/excel-functions-by-category-5f91f4e9-7b42-46d2-9bd1-63f26a86c0eb). We collect multiple custom formulas in an enumeration. @@ -60,7 +60,7 @@ You can create a new `custom-function.ts` file to specifically place custom form }, } - export const functionEnUS = { + export const functionZhCN = { formulaCustom: { CUSTOMSUM: { description: '将单个值、单元格引用或是区域相加，或者将三者的组合相加。', @@ -68,7 +68,7 @@ You can create a new `custom-function.ts` file to specifically place custom form links: [ { title: '教学', - url: 'https://support.microsoft.com/en-US/office/sum-%E5%87%BD%E6%95%B0-043e1c7d-7726-4e80-8f32-07b23e057f89', + url: 'https://support.microsoft.com/zh-cn/office/sum-%E5%87%BD%E6%95%B0-043e1c7d-7726-4e80-8f32-07b23e057f89', }, ], functionParameter: { @@ -572,7 +572,7 @@ Univer's goal is to be compatible with all Excel and Google Sheets formulas, and ### How to Claim the Formula -1. From [Office Excel functions](https://support.microsoft.com/en-us/office/excel-functions-by-category-5f91f4e9-7b42-46d2-9bd1-63f26a86c0eb) or [Google Sheets function list](https://support.google.com/docs/table/25273), first find a formula you are interested in and check whether it has not been implemented in Univer and no one has claimed it in Github issues. +1. From [Office Excel functions](https://support.microsoft.com/en-us/office/excel-functions-by-category-5f91f4e9-7b42-46d2-9bd1-63f26a86c0eb) or [Google Sheets function list](https://support.google.com/docs/table/25273), first find a formula you are interested in and check whether it has not been implemented in Univer and no one has claimed it in GitHub issues. 2. Create a [Feature request issue](https://github.com/dream-num/univer/issues/new/choose) for each formula. Comment under the mark `@yourself: I can solve it`, example [\[Feature\] Math Formula LET](https://github.com/dream-num/univer/issues/1835). 3. Wait for the maintainer's comment and confirmation before starting development. @@ -641,7 +641,7 @@ To implement a formula, you need to add formula description, internationalizatio - Use the English names of function parameters as the `key` for translation, e.g., `SUMIF`. Generally, do not modify unless there is an error. - Extract the `description` from the content, as some Excel descriptions are lengthy and need simplification. - `abstract` and `links` generally do not need modification. - - `aliasFunctionName` is optional; most formulas do not need to be filled (or can be set for aliases in specific countries). Currently, there is no documentation for formula aliases. Currently I have found a function translation plug-in that may provide similar functions [Excel Functions Translator](https://support.microsoft.com/en-us/office/excel-functions-translator-f262d0c0-991c-485b-89b6-32cc8d326889) + - `aliasFunctionName` is optional; most formulas do not need to be filled (or can be set for aliases in specific countries). Currently, there is no documentation for formula aliases. Currently I have found a function translation plugin that may provide similar functions [Excel Functions Translator](https://support.microsoft.com/en-us/office/excel-functions-translator-f262d0c0-991c-485b-89b6-32cc8d326889) - `functionParameter` needs a name for each parameter. We recommend varying names based on the parameter's meaning, e.g., use `number` for a numeric parameter (if there is only one) or `number1`, `number2` for multiple numeric parameters. Use `range` for a range, `criteria` for conditions, and `sumRange` for the sum range, use `camelCase`. For specific parameter content, the English format of `name` uses the underlined format `sum_range`, other languages use the translated text, and `detail` uses all translations. - Some Chinese translations in the Office function documentation are machine-translated and may be unclear. Modify as needed. For example, - `单元格参考` (Cell Reference) should be translated as `单元格引用`. diff --git a/content/guides/recipes/tutorials/custom-formula.zh-CN.mdx b/content/guides/recipes/tutorials/custom-formula.zh-CN.mdx index ae60a479..a3d84069 100644 --- a/content/guides/recipes/tutorials/custom-formula.zh-CN.mdx +++ b/content/guides/recipes/tutorials/custom-formula.zh-CN.mdx @@ -572,7 +572,7 @@ Univer 目标是兼容所有 Excel 和 Google Sheets 的公式，我们希望大 ### 如何认领公式 -1. 从 [Office Excel 函数列表](https://support.microsoft.com/zh-cn/office/excel-%E5%87%BD%E6%95%B0-%E6%8C%89%E7%B1%BB%E5%88%AB%E5%88%97%E5%87%BA-5f91f4e9-7b42-46d2-9bd1-63f26a86c0eb) 或者 [Google Sheets 函数列表](https://support.google.com/docs/table/25273?hl=zh-Hans)，先找一个你感兴趣的公式，查看是否还没有在 Univer 中实现，并且 Github issues 中没有人认领。 +1. 从 [Office Excel 函数列表](https://support.microsoft.com/zh-cn/office/excel-%E5%87%BD%E6%95%B0-%E6%8C%89%E7%B1%BB%E5%88%AB%E5%88%97%E5%87%BA-5f91f4e9-7b42-46d2-9bd1-63f26a86c0eb) 或者 [Google Sheets 函数列表](https://support.google.com/docs/table/25273?hl=zh-Hans)，先找一个你感兴趣的公式，查看是否还没有在 Univer 中实现，并且 GitHub issues 中没有人认领。 2. 每个公式创建一个 [Feature request issue](https://github.com/dream-num/univer/issues/new/choose)。 comment 标记下 `@自己 : I can solve it`，示例 [\[Feature\] Math Formula LET](https://github.com/dream-num/univer/issues/1835)。 3. 等待管理员评论确认后，开始开发。 diff --git a/content/guides/shared/features/core/general-api.ja-JP.mdx b/content/guides/shared/features/core/general-api.ja-JP.mdx index c36136a5..80fc9634 100644 --- a/content/guides/shared/features/core/general-api.ja-JP.mdx +++ b/content/guides/shared/features/core/general-api.ja-JP.mdx @@ -120,7 +120,7 @@ Univer は、スプレッドシートでのさまざまな変更をリスニン ### イベントカテゴリ -完全なイベントリスト: https://reference.univer.ai/en-US/classes/FEventName#properties +完全なイベントリスト: /reference/facade/events#properties 1. **クリップボードイベント** - `BeforeClipboardChange`: クリップボード内容変更前にトリガー、`params.cancel = true` で変更を阻止可能 @@ -377,7 +377,7 @@ univerAPI.onCommandExecuted((command, options) => { Facade API を使用して、現在の Univer インスタンスにカスタム数式を迅速かつ簡単に登録できます。 -以下のケースに示すように、[`registerFunction`](https://reference.univer.ai/en-US/classes/FFormula#registerfunction) を使用して、`CUSTOMSUM` 数式に必要なアルゴリズム、名前、説明を数式プラグインに一度に登録します。実行後、数式を使用できます。任意の空白セルに `=CUSTOMSUM` と入力すると、プロンプトが表示されます。 +以下のケースに示すように、[`registerFunction`](https://docs.univer.ai/reference/facade/formula#registerfunction) を使用して、`CUSTOMSUM` 数式に必要なアルゴリズム、名前、説明を数式プラグインに一度に登録します。実行後、数式を使用できます。任意の空白セルに `=CUSTOMSUM` と入力すると、プロンプトが表示されます。 ```typescript // 登録された数式はラムダ関数をサポート diff --git a/content/guides/shared/features/core/general-api.mdx b/content/guides/shared/features/core/general-api.mdx index 4c443de2..12fb1ad6 100644 --- a/content/guides/shared/features/core/general-api.mdx +++ b/content/guides/shared/features/core/general-api.mdx @@ -120,7 +120,7 @@ Univer provides a comprehensive event system that allows you to listen to and re ### Event Categories -Full event list: https://reference.univer.ai/en-US/classes/FEventName#properties +Full event list: /reference/facade/events#properties 1. **Clipboard Events** - `BeforeClipboardChange`: Triggered before clipboard content changes, can prevent change by setting `params.cancel = true` @@ -377,7 +377,7 @@ Note: Make sure there is a unitID when starting Univer. If the unitID is not spe Using Facade API, you can quickly and easily register custom formulas in the current Univer instance. -As shown in the following case, use [`registerFunction`](https://reference.univer.ai/en-US/classes/FFormula#registerfunction) to register the algorithm, name, and description required by a `CUSTOMSUM` formula into the formula plugin at one time. After execution, the formula can be used. Enter `=CUSTOMSUM` in any blank cell to see the prompt. +As shown in the following case, use [`registerFunction`](https://docs.univer.ai/reference/facade/formula#registerfunction) to register the algorithm, name, and description required by a `CUSTOMSUM` formula into the formula plugin at one time. After execution, the formula can be used. Enter `=CUSTOMSUM` in any blank cell to see the prompt. ```typescript // Registered formulas support lambda functions @@ -524,7 +524,7 @@ Note - Multiple languages can be set under `locales`. For naming rules, please refer to [LocaleType](https://reference.univer.ai/en-US/globals#localetype). Translations for multiple formulas can be added under `functionList`. For detailed field descriptions, please refer to the [How to add formulas in Formula Engine](/guides/sheets/advanced/custom-formula#how-to-add-formulas-in-formula-engine) section. - If you want to reuse the algorithm provided by the formula system and enhance the capability of the formula algorithm, you can register a custom formula through plug-in configuration. For detailed tutorials, please refer to [Custom Formula](/guides/recipes/tutorials/custom-formula). + If you want to reuse the algorithm provided by the formula system and enhance the capability of the formula algorithm, you can register a custom formula through plugin configuration. For detailed tutorials, please refer to [Custom Formula](/guides/recipes/tutorials/custom-formula). ## Enum API diff --git a/content/guides/shared/features/core/general-api.zh-CN.mdx b/content/guides/shared/features/core/general-api.zh-CN.mdx index 2f2af7d5..f3b0c28c 100644 --- a/content/guides/shared/features/core/general-api.zh-CN.mdx +++ b/content/guides/shared/features/core/general-api.zh-CN.mdx @@ -120,7 +120,7 @@ Univer 提供了一个完整的事件系统，允许你监听和响应电子表 ### 事件类别 -完整事件列表请参考：https://reference.univer.ai/zh-CN/classes/FEventName#%E5%B1%9E%E6%80%A7 +完整事件列表请参考：/reference/facade/events#%E5%B1%9E%E6%80%A7 1. **剪贴板事件** - `BeforeClipboardChange`: 在剪贴板内容改变前触发，可以通过设置 `params.cancel = true` 来阻止改变 @@ -257,7 +257,7 @@ await univerAPI.redo() ## 系统剪切板 -使用 [`FUniver.copy()`](https://reference.univer.ai/zh-CN/classes/FUniver#copy) 和 [`FUniver.paste()`](https://reference.univer.ai/zh-CN/classes/FUniver#paste) 方法可以读取和写入系统剪贴板。 +使用 [`FUniver.copy()`](https://docs.univer.ai/reference/facade/univer#copy) 和 [`FUniver.paste()`](https://docs.univer.ai/reference/facade/univer#paste) 方法可以读取和写入系统剪贴板。 复制与粘贴依赖浏览器原生 API ，当[环境条件或者权限](https://developer.mozilla.org/zh-CN/docs/Web/API/Clipboard/writeText)不满足时复制与粘贴功能将无法工作。 @@ -377,7 +377,7 @@ univerAPI.onCommandExecuted((command, options) => { 使用 Facade API，可以方便快速的在当前 Univer 实例中注册自定义公式。 -如下案例所示，使用 [`registerFunction`](https://reference.univer.ai/zh-CN/classes/FFormula#registerfunction) 将一个 `CUSTOMSUM` 公式所需要的算法、名称、描述一次性注册到公式插件，执行之后就可以使用公式了。在任一空白单元格输入 `=CUSTOMSUM` 可以看到提示。 +如下案例所示，使用 [`registerFunction`](https://docs.univer.ai/reference/facade/formula#registerfunction) 将一个 `CUSTOMSUM` 公式所需要的算法、名称、描述一次性注册到公式插件，执行之后就可以使用公式了。在任一空白单元格输入 `=CUSTOMSUM` 可以看到提示。 ```typescript // 注册公式支持 lambda 函数 diff --git a/content/guides/shared/features/core/general-api.zh-TW.mdx b/content/guides/shared/features/core/general-api.zh-TW.mdx index cb510ac6..d0e79744 100644 --- a/content/guides/shared/features/core/general-api.zh-TW.mdx +++ b/content/guides/shared/features/core/general-api.zh-TW.mdx @@ -120,7 +120,7 @@ Univer 提供了一個完整的事件系統，允許你監聽和響應電子試 ### 事件類別 -完整事件列表請參考：https://reference.univer.ai/zh-CN/classes/FEventName#%E5%B1%9E%E6%80%A7 +完整事件列表請參考：/reference/facade/events#%E5%B1%9E%E6%80%A7 1. **剪貼板事件** - `BeforeClipboardChange`: 在剪貼板內容改變前觸發，可以通過設定 `params.cancel = true` 來阻止改變 @@ -257,7 +257,7 @@ await univerAPI.redo() ## 系統剪貼板 -使用 [`FUniver.copy()`](https://reference.univer.ai/zh-CN/classes/FUniver#copy) 和 [`FUniver.paste()`](https://reference.univer.ai/zh-CN/classes/FUniver#paste) 方法可以讀取和寫入系統剪貼板。 +使用 [`FUniver.copy()`](https://docs.univer.ai/reference/facade/univer#copy) 和 [`FUniver.paste()`](https://docs.univer.ai/reference/facade/univer#paste) 方法可以讀取和寫入系統剪貼板。 複製與貼上依賴瀏覽器原生 API ，當[環境條件或者權限](https://developer.mozilla.org/zh-CN/docs/Web/API/Clipboard/writeText)不滿足時複製與貼上功能將無法工作。 @@ -377,7 +377,7 @@ univerAPI.onCommandExecuted((command, options) => { 使用 Facade API，可以方便快速地在當前 Univer 實例中註冊自訂公式。 -如下案例所示，使用 [`registerFunction`](https://reference.univer.ai/zh-CN/classes/FFormula#registerfunction) 將一個 `CUSTOMSUM` 公式所需的演算法、名稱、描述一次性註冊到公式插件，執行之後就可以使用公式了。在任一空白儲存格輸入 `=CUSTOMSUM` 可以看到提示。 +如下案例所示，使用 [`registerFunction`](https://docs.univer.ai/reference/facade/formula#registerfunction) 將一個 `CUSTOMSUM` 公式所需的演算法、名稱、描述一次性註冊到公式插件，執行之後就可以使用公式了。在任一空白儲存格輸入 `=CUSTOMSUM` 可以看到提示。 ```typescript // 註冊公式支援 lambda 函數 diff --git a/content/guides/shared/ui/components.ja-JP.mdx b/content/guides/shared/ui/components.ja-JP.mdx index f395d54a..7cfdd6cb 100644 --- a/content/guides/shared/ui/components.ja-JP.mdx +++ b/content/guides/shared/ui/components.ja-JP.mdx @@ -262,7 +262,7 @@ const sidebar = univerAPI.openSidebar({ sidebar.dispose() ``` -参照：[`univerAPI.openSidebar`](/reference/facade/open-sidebar) +参照：[`univerAPI.openSidebar`](https://docs.univer.ai/reference/facade/open-sidebar) #### ダイアログで @@ -293,4 +293,4 @@ const dialog = univerAPI.openDialog({ dialog.dispose() ``` -参照：[`univerAPI.openDialog`](/reference/facade/open-dialog) +参照：[`univerAPI.openDialog`](https://docs.univer.ai/reference/facade/open-dialog) diff --git a/content/guides/shared/ui/components.mdx b/content/guides/shared/ui/components.mdx index 0ec87d6e..e1ced54a 100644 --- a/content/guides/shared/ui/components.mdx +++ b/content/guides/shared/ui/components.mdx @@ -262,7 +262,7 @@ const sidebar = univerAPI.openSidebar({ sidebar.dispose() ``` -Reference: [`univerAPI.openSidebar`](/reference/facade/open-sidebar) +Reference: [`univerAPI.openSidebar`](https://docs.univer.ai/reference/facade/open-sidebar) #### In a Dialog @@ -293,4 +293,4 @@ const dialog = univerAPI.openDialog({ dialog.dispose() ``` -Reference: [`univerAPI.openDialog`](/reference/facade/open-dialog) +Reference: [`univerAPI.openDialog`](https://docs.univer.ai/reference/facade/open-dialog) diff --git a/content/guides/shared/ui/components.zh-CN.mdx b/content/guides/shared/ui/components.zh-CN.mdx index ffbf67e3..b0bab1d0 100644 --- a/content/guides/shared/ui/components.zh-CN.mdx +++ b/content/guides/shared/ui/components.zh-CN.mdx @@ -262,7 +262,7 @@ const sidebar = univerAPI.openSidebar({ sidebar.dispose() ``` -参考： [`univerAPI.openSidebar`](/reference/facade/open-sidebar) +参考： [`univerAPI.openSidebar`](https://docs.univer.ai/reference/facade/open-sidebar) #### 在对话框中使用 @@ -293,4 +293,4 @@ const dialog = univerAPI.openDialog({ dialog.dispose() ``` -参考： [`univerAPI.openDialog`](/reference/facade/open-dialog) +参考： [`univerAPI.openDialog`](https://docs.univer.ai/reference/facade/open-dialog) diff --git a/content/guides/shared/ui/components.zh-TW.mdx b/content/guides/shared/ui/components.zh-TW.mdx index a528cae7..9c04f36a 100644 --- a/content/guides/shared/ui/components.zh-TW.mdx +++ b/content/guides/shared/ui/components.zh-TW.mdx @@ -262,7 +262,7 @@ const sidebar = univerAPI.openSidebar({ sidebar.dispose() ``` -參考： [`univerAPI.openSidebar`](/reference/facade/open-sidebar) +參考： [`univerAPI.openSidebar`](https://docs.univer.ai/reference/facade/open-sidebar) #### 在對話框中使用 @@ -293,4 +293,4 @@ const dialog = univerAPI.openDialog({ dialog.dispose() ``` -參考： [`univerAPI.openDialog`](/reference/facade/open-dialog) +參考： [`univerAPI.openDialog`](https://docs.univer.ai/reference/facade/open-dialog) diff --git a/content/guides/shared/ui/themes.ja-JP.mdx b/content/guides/shared/ui/themes.ja-JP.mdx index 6070318d..a0851fba 100644 --- a/content/guides/shared/ui/themes.ja-JP.mdx +++ b/content/guides/shared/ui/themes.ja-JP.mdx @@ -48,7 +48,7 @@ const univer = new Univer({ ## テーマのカスタマイズ -`Theme` インターフェースに準拠するオブジェクトを作成することで、テーマをカスタマイズできます。デフォルトテーマ変数の定義方法を理解するには、[このドキュメント](/reference/types/theme) を参照してください。 +`Theme` インターフェースに準拠するオブジェクトを作成することで、テーマをカスタマイズできます。デフォルトテーマ変数の定義方法を理解するには、[このドキュメント(https://docs.univer.ai/reference/types/theme) を参照してください。 ```typescript title="custom-theme.ts" import type { Theme } from '@univerjs/presets' diff --git a/content/guides/shared/ui/themes.mdx b/content/guides/shared/ui/themes.mdx index 1a630eff..9892b57d 100644 --- a/content/guides/shared/ui/themes.mdx +++ b/content/guides/shared/ui/themes.mdx @@ -48,7 +48,7 @@ const univer = new Univer({ ## Customizing Themes -You can customize themes by creating an object that conforms to the `Theme` interface. Refer to [this documentation](/reference/types/theme) to understand how the default theme variables are defined. +You can customize themes by creating an object that conforms to the `Theme` interface. Refer to [this documentation(https://docs.univer.ai/reference/types/theme) to understand how the default theme variables are defined. ```typescript title="custom-theme.ts" import type { Theme } from '@univerjs/presets' diff --git a/content/guides/shared/ui/themes.zh-CN.mdx b/content/guides/shared/ui/themes.zh-CN.mdx index a426e834..ff84d3eb 100644 --- a/content/guides/shared/ui/themes.zh-CN.mdx +++ b/content/guides/shared/ui/themes.zh-CN.mdx @@ -48,7 +48,7 @@ const univer = new Univer({ ## 自定义主题 -只要创建一个符合 `Theme` 接口的对象，就可以自定义主题。请参考[这里](/reference/types/theme)来了解默认主题的变量是如何定义的。 +只要创建一个符合 `Theme` 接口的对象，就可以自定义主题。请参考[这里(https://docs.univer.ai/reference/types/theme)来了解默认主题的变量是如何定义的。 ```typescript title="custom-theme.ts" import type { Theme } from '@univerjs/presets' diff --git a/content/guides/shared/ui/themes.zh-TW.mdx b/content/guides/shared/ui/themes.zh-TW.mdx index 8916124b..70b5a4c7 100644 --- a/content/guides/shared/ui/themes.zh-TW.mdx +++ b/content/guides/shared/ui/themes.zh-TW.mdx @@ -48,7 +48,7 @@ const univer = new Univer({ ## 自訂主題 -只需建立一個符合 `Theme` 介面的物件，即可自訂主題。請參考[這裡](/reference/types/theme)來了解預設主題的變數是如何定義的。 +只需建立一個符合 `Theme` 介面的物件，即可自訂主題。請參考[這裡(https://docs.univer.ai/reference/types/theme)來了解預設主題的變數是如何定義的。 ```typescript title="custom-theme.ts" import type { Theme } from '@univerjs/presets' diff --git a/content/guides/sheets/features/charts.ja-JP.mdx b/content/guides/sheets/features/charts.ja-JP.mdx index 549543f9..f0ba2b8f 100644 --- a/content/guides/sheets/features/charts.ja-JP.mdx +++ b/content/guides/sheets/features/charts.ja-JP.mdx @@ -164,9 +164,9 @@ import '@univerjs-pro/sheets-chart/facade' ### チャートの挿入 -[`FWorksheet.newChart()`](https://reference.univer.ai/en-US/classes/FWorksheet#newchart) メソッドはチャート ビルダーを作成し、`FChartBuilderBase` のインスタンスを返します。メソッド チェーンでチャートの各種プロパティを設定できます。 +[`FWorksheet.newChart()`](https://docs.univer.ai/reference/facade/worksheet#newchart) メソッドはチャート ビルダーを作成し、`FChartBuilderBase` のインスタンスを返します。メソッド チェーンでチャートの各種プロパティを設定できます。 -その後、`build()` を呼び出して `IChartBuilderInfo` オブジェクトを生成し、[`FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertchart) メソッドでワークシートにチャートを挿入します。 +その後、`build()` を呼び出して `IChartBuilderInfo` オブジェクトを生成し、[`FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#insertchart) メソッドでワークシートにチャートを挿入します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -185,7 +185,7 @@ const chartInfo = fWorksheet.newChart() await fWorksheet.insertChart(chartInfo) ``` -[`FChartBuilderBase`](https://reference.univer.ai/en-US/classes/FChartBuilderBase) の主なメンバー メソッドは次のとおりです。 +[`FChartBuilderBase`](https://docs.univer.ai/reference/facade/chart) の主なメンバー メソッドは次のとおりです。 | メソッド | 説明 | | ------ | ----------- | @@ -392,7 +392,7 @@ const chartBuilder = fWorkSheet.newChart() .setChartType(univerAPI.Enum.ChartType.Column) ``` -- [LineChartBuilder](https://reference.univer.ai/en-US/classes/LineChartBuilder) +- [LineChartBuilder](https://docs.univer.ai/reference/facade/chart) | メソッド | 説明 | | ------ | ----------- | @@ -402,7 +402,7 @@ const chartBuilder = fWorkSheet.newChart() | setDataPointSize | データ点のサイズを設定 | | build | チャート挿入/更新用のビルダー情報を生成 | -- [PieChartBuilder](https://reference.univer.ai/en-US/classes/PieChartBuilder) +- [PieChartBuilder](https://docs.univer.ai/reference/facade/chart) | メソッド | 説明 | | ------ | ----------- | @@ -414,7 +414,7 @@ const chartBuilder = fWorkSheet.newChart() | setShowLabelLine | ラベル ラインを表示 | | build | チャート挿入/更新用のビルダー情報を生成 | -- [RadarChartBuilder](https://reference.univer.ai/en-US/classes/RadarChartBuilder) +- [RadarChartBuilder](https://docs.univer.ai/reference/facade/chart) | メソッド | 説明 | | ------ | ----------- | @@ -424,7 +424,7 @@ const chartBuilder = fWorkSheet.newChart() ### チャートの取得 -[`FWorksheet.getCharts()`](https://reference.univer.ai/en-US/classes/FWorksheet#getcharts) メソッドは、現在のワークシートにあるすべてのチャートを取得し、`FChart` オブジェクトの配列を返します。 +[`FWorksheet.getCharts()`](https://docs.univer.ai/reference/facade/worksheet#getcharts) メソッドは、現在のワークシートにあるすべてのチャートを取得し、`FChart` オブジェクトの配列を返します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -434,7 +434,7 @@ const fWorksheet = fWorkbook.getActiveSheet() const charts = fWorksheet.getCharts() ``` -[`FChart`](https://reference.univer.ai/en-US/classes/FChart) の主なメンバー メソッドは次のとおりです。 +[`FChart`](https://docs.univer.ai/reference/facade/chart) の主なメンバー メソッドは次のとおりです。 | メソッド | 説明 | | --- | --- | @@ -445,7 +445,7 @@ const charts = fWorksheet.getCharts() ### チャートの更新 -[`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)`](https://reference.univer.ai/en-US/classes/FWorksheet#updatechart) メソッドはチャートを更新します。`IChartBuilderInfo` オブジェクトを渡してチャートの設定を更新します。 +[`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#updatechart) メソッドはチャートを更新します。`IChartBuilderInfo` オブジェクトを渡してチャートの設定を更新します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -475,7 +475,7 @@ setTimeout(() => { ### チャートの削除 -[`FWorksheet.removeChart(chart: FChart)`](https://reference.univer.ai/en-US/classes/FWorksheet#removechart) メソッドはチャートを削除します。`FChart` オブジェクトを渡して指定のチャートを削除します。 +[`FWorksheet.removeChart(chart: FChart)`](https://docs.univer.ai/reference/facade/worksheet#removechart) メソッドはチャートを削除します。`FChart` オブジェクトを渡して指定のチャートを削除します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -502,7 +502,7 @@ setTimeout(async () => { ### チャート テーマ -[`FChartBuilderBase.registerChartTheme(themeName: string, theme: IEchartTheme)`](https://reference.univer.ai/en-US/classes/FWorksheet#registercharttheme) メソッドはチャート テーマを登録します。テーマ名とテーマ オブジェクトを渡してカスタム テーマを登録します。 +[`FChartBuilderBase.registerChartTheme(themeName: string, theme: IEchartTheme)`](https://docs.univer.ai/reference/facade/worksheet#registercharttheme) メソッドはチャート テーマを登録します。テーマ名とテーマ オブジェクトを渡してカスタム テーマを登録します。 Univer のチャートは ECharts ライブラリをベースに実装されています。そのため、ECharts の[テーマ ビルダー ツール](https://echarts.apache.org/en/theme-builder.html)でカスタム テーマを作成できます。 このサイトでテーマを作成し、設定ファイルとしてダウンロードしてください。以下の API を使ってカスタム テーマを適用できます。 diff --git a/content/guides/sheets/features/charts.mdx b/content/guides/sheets/features/charts.mdx index 0c7b2a18..cfdde2ae 100644 --- a/content/guides/sheets/features/charts.mdx +++ b/content/guides/sheets/features/charts.mdx @@ -25,7 +25,7 @@ icon: '#pro/ChartPie' }} /> -Charts are an important tool for data visualization, helping users to understand and analyze data more intuitively. In Univer Sheets, the chart feature provides various types of charts, including bar charts, line charts, pie charts, etc. Users can choose the appropriate chart type to display data according to their needs. +Charts are an important tool for data visualization, helping users understand and analyze data more intuitively. In Univer Sheets, the chart feature provides various types of charts, including bar charts, line charts, pie charts, etc. Users can choose the appropriate chart type to display data according to their needs. @@ -164,9 +164,9 @@ import '@univerjs-pro/sheets-chart/facade' ### Insert Chart -[`FWorksheet.newChart()`](https://reference.univer.ai/en-US/classes/FWorksheet#newchart) method is used to create a chart builder, returning an instance of `FChartBuilderBase`. You can chain method calls to set various properties of the chart. +[`FWorksheet.newChart()`](https://docs.univer.ai/reference/facade/worksheet#newchart) method is used to create a chart builder, returning an instance of `FChartBuilderBase`. You can chain method calls to set various properties of the chart. -Then call `build()` to generate an `IChartBuilderInfo` object, and use the [`FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertchart) method to insert the chart into the worksheet. +Then call `build()` to generate an `IChartBuilderInfo` object, and use the [`FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#insertchart) method to insert the chart into the worksheet. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -185,7 +185,7 @@ const chartInfo = fWorksheet.newChart() await fWorksheet.insertChart(chartInfo) ``` -Here are some member methods on [`FChartBuilderBase`](https://reference.univer.ai/en-US/classes/FChartBuilderBase): +Here are some member methods on [`FChartBuilderBase`](https://docs.univer.ai/reference/facade/chart): | Method | Description | | ------ | ----------- | @@ -392,7 +392,7 @@ const chartBuilder = fWorkSheet.newChart() .setChartType(univerAPI.Enum.ChartType.Column) ``` -- [LineChartBuilder](https://reference.univer.ai/en-US/classes/LineChartBuilder) +- [LineChartBuilder](https://docs.univer.ai/reference/facade/chart) | Method | Description | | ------ | ----------- | @@ -402,7 +402,7 @@ const chartBuilder = fWorkSheet.newChart() | setDataPointSize | Set the data point size | | build | Generate builder info for inserting/updating the chart | -- [PieChartBuilder](https://reference.univer.ai/en-US/classes/PieChartBuilder) +- [PieChartBuilder](https://docs.univer.ai/reference/facade/chart) | Method | Description | | ------ | ----------- | @@ -414,7 +414,7 @@ const chartBuilder = fWorkSheet.newChart() | setShowLabelLine | Show label lines | | build | Generate builder info for inserting/updating the chart | -- [RadarChartBuilder](https://reference.univer.ai/en-US/classes/RadarChartBuilder) +- [RadarChartBuilder](https://docs.univer.ai/reference/facade/chart) | Method | Description | | ------ | ----------- | @@ -424,7 +424,7 @@ const chartBuilder = fWorkSheet.newChart() ### Get Charts -[`FWorksheet.getCharts()`](https://reference.univer.ai/en-US/classes/FWorksheet#getcharts) method is used to get all charts in the current worksheet, returning an array of `FChart` objects. +[`FWorksheet.getCharts()`](https://docs.univer.ai/reference/facade/worksheet#getcharts) method is used to get all charts in the current worksheet, returning an array of `FChart` objects. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -434,7 +434,7 @@ const fWorksheet = fWorkbook.getActiveSheet() const charts = fWorksheet.getCharts() ``` -Here are some member methods on [`FChart`](https://reference.univer.ai/en-US/classes/FChart): +Here are some member methods on [`FChart`](https://docs.univer.ai/reference/facade/chart): | Method | Description | | --- | --- | @@ -445,7 +445,7 @@ Here are some member methods on [`FChart`](https://reference.univer.ai/en-US/cla ### Update Chart -The [`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)`](https://reference.univer.ai/en-US/classes/FWorksheet#updatechart) method is used to update the chart, passing in an `IChartBuilderInfo` object to update the chart configuration. +The [`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#updatechart) method is used to update the chart, passing in an `IChartBuilderInfo` object to update the chart configuration. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -475,7 +475,7 @@ setTimeout(() => { ### Remove Chart -The [`FWorksheet.removeChart(chart: FChart)`](https://reference.univer.ai/en-US/classes/FWorksheet#removechart) method is used to remove a chart, passing in an `FChart` object to remove the specified chart. +The [`FWorksheet.removeChart(chart: FChart)`](https://docs.univer.ai/reference/facade/worksheet#removechart) method is used to remove a chart, passing in an `FChart` object to remove the specified chart. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -502,7 +502,7 @@ setTimeout(async () => { ### Chart Theme -The [`FChartBuilderBase.registerChartTheme(themeName: string, theme: IEchartTheme)`](https://reference.univer.ai/en-US/classes/FWorksheet#registercharttheme) method is used to register a chart theme, passing in a theme name and theme object to register a custom theme. +The [`FChartBuilderBase.registerChartTheme(themeName: string, theme: IEchartTheme)`](https://docs.univer.ai/reference/facade/worksheet#registercharttheme) method is used to register a chart theme, passing in a theme name and theme object to register a custom theme. Univer chart is implemented based on the echarts library, so you can use the echart theme [builder tool to create your custom theme](https://echarts.apache.org/en/theme-builder.html). You can create your own theme on this website and download it as a configuration file. Use the following API to use your custom theme: diff --git a/content/guides/sheets/features/charts.zh-CN.mdx b/content/guides/sheets/features/charts.zh-CN.mdx index f8bd586f..93d80f7a 100644 --- a/content/guides/sheets/features/charts.zh-CN.mdx +++ b/content/guides/sheets/features/charts.zh-CN.mdx @@ -164,9 +164,9 @@ import '@univerjs-pro/sheets-chart/facade' ### 插入图表 -[`FWorksheet.newChart()`](https://reference.univer.ai/zh-CN/classes/FWorksheet#newchart) 方法用于创建一个图表构建器，返回一个 `FChartBuilderBase` 实例，你可以通过链式调用方法来设置图表的各种属性。 +[`FWorksheet.newChart()`](https://docs.univer.ai/reference/facade/worksheet#newchart) 方法用于创建一个图表构建器，返回一个 `FChartBuilderBase` 实例，你可以通过链式调用方法来设置图表的各种属性。 -然后调用 `build()` 生成 `IChartBuilderInfo` 对象，通过 [`FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#insertchart) 方法将图表插入到表格中。 +然后调用 `build()` 生成 `IChartBuilderInfo` 对象，通过 [`FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#insertchart) 方法将图表插入到表格中。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -185,7 +185,7 @@ const chartInfo = fWorksheet.newChart() await fWorksheet.insertChart(chartInfo) ``` -以下是 [`FChartBuilderBase`](https://reference.univer.ai/zh-CN/classes/FChartBuilderBase) 上的一些成员方法： +以下是 [`FChartBuilderBase`](https://docs.univer.ai/reference/facade/chart) 上的一些成员方法： | 方法 | 描述 | | --- | --- | @@ -392,7 +392,7 @@ const chartBuilder = fWorkSheet.newChart() .setChartType(univerAPI.Enum.ChartType.Column) ``` -- [LineChartBuilder](https://reference.univer.ai/zh-CN/classes/LineChartBuilder) +- [LineChartBuilder](https://docs.univer.ai/reference/facade/chart) | 方法 | 描述 | | --- | --- | @@ -402,7 +402,7 @@ const chartBuilder = fWorkSheet.newChart() | setDataPointSize | 设置数据点大小 | | build | 生成 builder info，用于插入/更新图表 | -- [PieChartBuilder](https://reference.univer.ai/zh-CN/classes/PieChartBuilder) +- [PieChartBuilder](https://docs.univer.ai/reference/facade/chart) | 方法 | 描述 | | --- | --- | @@ -414,7 +414,7 @@ const chartBuilder = fWorkSheet.newChart() | setShowLabelLine | 显示标签线 | | build | 生成 builder info，用于插入/更新图表 | -- [RadarChartBuilder](https://reference.univer.ai/zh-CN/classes/RadarChartBuilder) +- [RadarChartBuilder](https://docs.univer.ai/reference/facade/chart) | 方法 | 描述 | | --- | --- | @@ -424,7 +424,7 @@ const chartBuilder = fWorkSheet.newChart() ### 获取图表 -[`FWorksheet.getCharts()`](https://reference.univer.ai/zh-CN/classes/FWorksheet#getcharts) 方法用于获取当前工作表中的所有图表，返回一个 `FChart[]` 数组。 +[`FWorksheet.getCharts()`](https://docs.univer.ai/reference/facade/worksheet#getcharts) 方法用于获取当前工作表中的所有图表，返回一个 `FChart[]` 数组。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -434,7 +434,7 @@ const fWorksheet = fWorkbook.getActiveSheet() const charts = fWorksheet.getCharts() ``` -以下是 [`FChart`](https://reference.univer.ai/zh-CN/classes/FChart) 上的一些成员方法： +以下是 [`FChart`](https://docs.univer.ai/reference/facade/chart) 上的一些成员方法： | 方法 | 描述 | | --- | --- | @@ -445,7 +445,7 @@ const charts = fWorksheet.getCharts() ### 更新图表 -[`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#updatechart) 方法用于更新图表，传入一个 `IChartBuilderInfo` 对象，用于更新图表的配置。 +[`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#updatechart) 方法用于更新图表，传入一个 `IChartBuilderInfo` 对象，用于更新图表的配置。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -475,7 +475,7 @@ setTimeout(() => { ### 删除图表 -[`FWorksheet.removeChart(chart: FChart)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#removechart) 方法用于删除图表，传入一个 `FChart` 对象，用于删除指定的图表。 +[`FWorksheet.removeChart(chart: FChart)`](https://docs.univer.ai/reference/facade/worksheet#removechart) 方法用于删除图表，传入一个 `FChart` 对象，用于删除指定的图表。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -502,7 +502,7 @@ setTimeout(async () => { ### 图表主题 -[`FWorksheet.registerChartTheme(themeName: string, theme: IEchartTheme)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#registercharttheme) 方法用于注册图表主题，传入一个主题名称和主题对象，用于注册自定义主题。 +[`FWorksheet.registerChartTheme(themeName: string, theme: IEchartTheme)`](https://docs.univer.ai/reference/facade/worksheet#registercharttheme) 方法用于注册图表主题，传入一个主题名称和主题对象，用于注册自定义主题。 Univer chart 是基于 echarts 的图表库实现的，因此可以借助 echart 的主题构建工具来构建你的[自定制主题](https://echarts.apache.org/zh/theme-builder.html)。 你可以在该网站构建你自己的主题并下载成为配置文件，使用以下 API 来使用你的自定义主题： diff --git a/content/guides/sheets/features/charts.zh-TW.mdx b/content/guides/sheets/features/charts.zh-TW.mdx index 1cd92779..df0ab7b4 100644 --- a/content/guides/sheets/features/charts.zh-TW.mdx +++ b/content/guides/sheets/features/charts.zh-TW.mdx @@ -164,9 +164,9 @@ import '@univerjs-pro/sheets-chart/facade' ### 插入圖表 -[`FWorksheet.newChart()`](https://reference.univer.ai/zh-TW/classes/FWorksheet#newchart) 方法用於建立一個圖表建構器，回傳一個 `FChartBuilderBase` 實例，你可以透過鏈式呼叫方法來設定圖表的各種屬性。 +[`FWorksheet.newChart()`](https://docs.univer.ai/reference/facade/worksheet#newchart) 方法用於建立一個圖表建構器，回傳一個 `FChartBuilderBase` 實例，你可以透過鏈式呼叫方法來設定圖表的各種屬性。 -然後呼叫 `build()` 產生 `IChartBuilderInfo` 物件，透過 [`FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#insertchart) 方法將圖表插入到表格中。 +然後呼叫 `build()` 產生 `IChartBuilderInfo` 物件，透過 [`FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#insertchart) 方法將圖表插入到表格中。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -185,7 +185,7 @@ const chartInfo = fWorksheet.newChart() await fWorksheet.insertChart(chartInfo) ``` -以下是 [`FChartBuilderBase`](https://reference.univer.ai/zh-TW/classes/FChartBuilderBase) 上的一些成員方法： +以下是 [`FChartBuilderBase`](https://docs.univer.ai/reference/facade/chart) 上的一些成員方法： | 方法 | 描述 | | --- | --- | @@ -392,7 +392,7 @@ const chartBuilder = fWorkSheet.newChart() .setChartType(univerAPI.Enum.ChartType.Column) ``` -- [LineChartBuilder](https://reference.univer.ai/zh-TW/classes/LineChartBuilder) +- [LineChartBuilder](https://docs.univer.ai/reference/facade/chart) | 方法 | 描述 | | --- | --- | @@ -402,7 +402,7 @@ const chartBuilder = fWorkSheet.newChart() | setDataPointSize | 設定資料點大小 | | build | 產生 builder info，用於插入/更新圖表 | -- [PieChartBuilder](https://reference.univer.ai/zh-TW/classes/PieChartBuilder) +- [PieChartBuilder](https://docs.univer.ai/reference/facade/chart) | 方法 | 描述 | | --- | --- | @@ -414,7 +414,7 @@ const chartBuilder = fWorkSheet.newChart() | setShowLabelLine | 顯示標籤線 | | build | 產生 builder info，用於插入/更新圖表 | -- [RadarChartBuilder](https://reference.univer.ai/zh-TW/classes/RadarChartBuilder) +- [RadarChartBuilder](https://docs.univer.ai/reference/facade/chart) | 方法 | 描述 | | --- | --- | @@ -424,7 +424,7 @@ const chartBuilder = fWorkSheet.newChart() ### 獲取圖表 -[`FWorksheet.getCharts()`](https://reference.univer.ai/zh-TW/classes/FWorksheet#getcharts) 方法用於獲取目前工作表中的所有圖表，回傳一個 `FChart[]` 陣列。 +[`FWorksheet.getCharts()`](https://docs.univer.ai/reference/facade/worksheet#getcharts) 方法用於獲取目前工作表中的所有圖表，回傳一個 `FChart[]` 陣列。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -434,7 +434,7 @@ const fWorksheet = fWorkbook.getActiveSheet() const charts = fWorksheet.getCharts() ``` -以下是 [`FChart`](https://reference.univer.ai/zh-TW/classes/FChart) 上的一些成員方法： +以下是 [`FChart`](https://docs.univer.ai/reference/facade/chart) 上的一些成員方法： | 方法 | 描述 | | --- | --- | @@ -445,7 +445,7 @@ const charts = fWorksheet.getCharts() ### 更新圖表 -[`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#updatechart) 方法用於更新圖表，傳入一個 `IChartBuilderInfo` 物件，用於更新圖表的配置。 +[`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#updatechart) 方法用於更新圖表，傳入一個 `IChartBuilderInfo` 物件，用於更新圖表的配置。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -475,7 +475,7 @@ setTimeout(() => { ### 刪除圖表 -[`FWorksheet.removeChart(chart: FChart)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#removechart) 方法用於刪除圖表，傳入一個 `FChart` 物件，用於刪除指定的圖表。 +[`FWorksheet.removeChart(chart: FChart)`](https://docs.univer.ai/reference/facade/worksheet#removechart) 方法用於刪除圖表，傳入一個 `FChart` 物件，用於刪除指定的圖表。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -502,7 +502,7 @@ setTimeout(async () => { ### 圖表主題 -[`FWorksheet.registerChartTheme(themeName: string, theme: IEchartTheme)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#registercharttheme) 方法用於註冊圖表主題，傳入一個主題名稱和主題物件，用於註冊自訂主題。 +[`FWorksheet.registerChartTheme(themeName: string, theme: IEchartTheme)`](https://docs.univer.ai/reference/facade/worksheet#registercharttheme) 方法用於註冊圖表主題，傳入一個主題名稱和主題物件，用於註冊自訂主題。 Univer chart 是基於 echarts 的圖表庫實作的，因此可以借助 echart 的主題建構工具來建構你的[自訂主題](https://echarts.apache.org/zh/theme-builder.html)。 你可以在該網站建構你自己的主題並下載成為配置檔案，使用以下 API 來使用你的自訂主題： diff --git a/content/guides/sheets/features/comments.ja-JP.mdx b/content/guides/sheets/features/comments.ja-JP.mdx index f9b806c6..3df51aa2 100644 --- a/content/guides/sheets/features/comments.ja-JP.mdx +++ b/content/guides/sheets/features/comments.ja-JP.mdx @@ -153,7 +153,7 @@ import '@univerjs/sheets-thread-comment/facade' `univerAPI.newTheadComment()` を使ってコメントビルダーを作成できます。これは `FTheadCommentBuilder` のインスタンスを返し、チェーンで各種プロパティを設定できます。 -以下は [`FTheadCommentBuilder`](https://reference.univer.ai/en-US/classes/FTheadCommentBuilder) の主なメソッドです: +以下は [`FTheadCommentBuilder`](https://docs.univer.ai/reference/facade/thread-comment) の主なメソッドです: | メソッド | 説明 | | ---- | ---- | @@ -187,7 +187,7 @@ const result = await cell.addCommentAsync(commentBuilder) - `FRange.getComment()`: 範囲の左上セルのコメントを取得します - `FRange.getComments()`: 範囲内のすべてのコメントを取得します -以下は [`FThreadComment`](https://reference.univer.ai/en-US/classes/FThreadComment) の主なメソッドです: +以下は [`FThreadComment`](https://docs.univer.ai/reference/facade/thread-comment) の主なメソッドです: | メソッド | 説明 | | ---- | ---- | @@ -299,7 +299,7 @@ setTimeout(async () => { ### Event Listeners -Complete event type definitions can be found in [Events](https://reference.univer.ai/en-US/classes/FEventName). +Complete event type definitions can be found in [Events](https://docs.univer.ai/reference/facade/events). コメントモジュールは、コメントの追加・更新・削除・解決状態の変更を監視するためのイベント群を提供します。すべてのイベントは `univerAPI.addEvent()` で購読できます。 diff --git a/content/guides/sheets/features/comments.mdx b/content/guides/sheets/features/comments.mdx index cfca8e52..7091c0d0 100644 --- a/content/guides/sheets/features/comments.mdx +++ b/content/guides/sheets/features/comments.mdx @@ -153,7 +153,7 @@ import '@univerjs/sheets-thread-comment/facade' You can create a new comment builder using `univerAPI.newTheadComment()`, which returns an instance of `FTheadCommentBuilder`. You can chain methods to set various properties of the comment. -The following are some member methods of [`FTheadCommentBuilder`](https://reference.univer.ai/en-US/classes/FTheadCommentBuilder): +The following are some member methods of [`FTheadCommentBuilder`](https://docs.univer.ai/reference/facade/thread-comment): | Method | Description | | ---- | ---- | @@ -187,7 +187,7 @@ You can retrieve comments using the following methods, which return an instance - `FRange.getComment()`: Get the comment of the top-left cell in the range - `FRange.getComments()`: Get all comments in the range -The following are some member methods of [`FThreadComment`](https://reference.univer.ai/en-US/classes/FThreadComment): +The following are some member methods of [`FThreadComment`](https://docs.univer.ai/reference/facade/thread-comment): | Method | Description | | ---- | ---- | @@ -299,7 +299,7 @@ setTimeout(async () => { ### Event Listeners -Complete event type definitions can be found in [Events](https://reference.univer.ai/en-US/classes/FEventName). +Complete event type definitions can be found in [Events](https://docs.univer.ai/reference/facade/events). The comment module provides a series of events to listen for comment additions, updates, deletions, and resolution status changes. All events can be listened to using `univerAPI.addEvent()`. diff --git a/content/guides/sheets/features/comments.zh-CN.mdx b/content/guides/sheets/features/comments.zh-CN.mdx index 1278f1e7..e50428df 100644 --- a/content/guides/sheets/features/comments.zh-CN.mdx +++ b/content/guides/sheets/features/comments.zh-CN.mdx @@ -153,7 +153,7 @@ import '@univerjs/sheets-thread-comment/facade' `univerAPI.newTheadComment()` 创建一个新的评论构建器，返回一个 `FTheadCommentBuilder` 实例，可以通过链式调用生成评论。 -以下是 [`FTheadCommentBuilder`](https://reference.univer.ai/zh-CN/classes/FTheadCommentBuilder) 上的一些成员方法： +以下是 [`FTheadCommentBuilder`](https://docs.univer.ai/reference/facade/thread-comment) 上的一些成员方法： | 方法 | 描述 | | ---- | ---- | @@ -187,7 +187,7 @@ const result = await cell.addCommentAsync(commentBuilder) - `FRange.getComment()`: 获取范围左上角单元格的评论 - `FRange.getComments()`: 获取范围内所有单元格的评论 -以下是 [`FThreadComment`](https://reference.univer.ai/zh-CN/classes/FThreadComment) 上的一些成员方法： +以下是 [`FThreadComment`](https://docs.univer.ai/reference/facade/thread-comment) 上的一些成员方法： | 方法 | 描述 | | ---- | ---- | @@ -299,7 +299,7 @@ setTimeout(async () => { ### 事件监听 -完整事件类型定义，请查看 [Events](https://reference.univer.ai/zh-CN/classes/FEventName)。 +完整事件类型定义，请查看 [Events](https://docs.univer.ai/reference/facade/events)。 评论模块提供了一系列事件用于监听评论的添加、更新、删除和解决状态变更。所有事件都可以通过 `univerAPI.addEvent()` 进行监听。 diff --git a/content/guides/sheets/features/comments.zh-TW.mdx b/content/guides/sheets/features/comments.zh-TW.mdx index 9a65305b..f80b26b9 100644 --- a/content/guides/sheets/features/comments.zh-TW.mdx +++ b/content/guides/sheets/features/comments.zh-TW.mdx @@ -153,7 +153,7 @@ import '@univerjs/sheets-thread-comment/facade' `univerAPI.newTheadComment()` 建立一個新的評論構建器，返回一個 `FTheadCommentBuilder` 例項，可以透過鏈式呼叫生成評論。 -以下是 [`FTheadCommentBuilder`](https://reference.univer.ai/zh-TW/classes/FTheadCommentBuilder) 上的一些成員方法： +以下是 [`FTheadCommentBuilder`](https://docs.univer.ai/reference/facade/thread-comment) 上的一些成員方法： | 方法 | 描述 | | ---- | ---- | @@ -187,7 +187,7 @@ const result = await cell.addCommentAsync(commentBuilder) - `FRange.getComment()`: 獲取範圍左上角單元格的評論 - `FRange.getComments()`: 獲取範圍內所有單元格的評論 -以下是 [`FThreadComment`](https://reference.univer.ai/zh-TW/classes/FThreadComment) 上的一些成員方法： +以下是 [`FThreadComment`](https://docs.univer.ai/reference/facade/thread-comment) 上的一些成員方法： | 方法 | 描述 | | ---- | ---- | @@ -299,7 +299,7 @@ setTimeout(async () => { ### 事件監聽 -完整事件型別定義，請檢視 [Events](https://reference.univer.ai/zh-TW/classes/FEventName)。 +完整事件型別定義，請檢視 [Events](https://docs.univer.ai/reference/facade/events)。 評論模組提供了一系列事件用於監聽評論的新增、更新、刪除和解決狀態變更。所有事件都可以透過 `univerAPI.addEvent()` 進行監聽。 diff --git a/content/guides/sheets/features/conditional-formatting.ja-JP.mdx b/content/guides/sheets/features/conditional-formatting.ja-JP.mdx index e2a2881d..966479ff 100644 --- a/content/guides/sheets/features/conditional-formatting.ja-JP.mdx +++ b/content/guides/sheets/features/conditional-formatting.ja-JP.mdx @@ -114,13 +114,16 @@ import '@univerjs/sheets-conditional-formatting/facade' ### 条件付き書式ルールの作成 -[`FWorksheet.newConditionalFormattingRule()`](https://reference.univer.ai/en-US/classes/FWorksheet#newconditionalformattingrule) は条件付き書式ビルダーを生成し、`FConditionalFormattingBuilder` インスタンスを返します。返されたビルダーをメソッドチェーンで操作して条件付き書式ルールを作成できます。 +[`FWorksheet.newConditionalFormattingRule()`](https://docs.univer.ai/reference/facade/worksheet#newconditionalformattingrule) は条件付き書式ビルダーを生成し、`FConditionalFormattingBuilder` インスタンスを返します。返されたビルダーをメソッドチェーンで操作して条件付き書式ルールを作成できます。 -以下は [`FConditionalFormattingBuilder`](https://reference.univer.ai/en-US/classes/FConditionalFormattingBuilder) のメソッドの一部です: +以下は [`FConditionalFormattingBuilder`](https://docs.univer.ai/reference/facade/conditional-formatting) のメソッドの一部です: | Method | Description | | ---- | ---- | | build | 条件付き書式ルールを構築します | +| copy | 現在のビルダーを深くクローンします | +| createCfId | 条件付き書式 ID を作成します | +| getRanges | 現在の条件付き書式の範囲を取得します | | setRanges | 条件付き書式ルールの対象範囲を設定します | | setAverage | 平均値に基づく条件付き書式を設定します | | setUniqueValues | 一意の値に対する条件付き書式を設定します | diff --git a/content/guides/sheets/features/conditional-formatting.mdx b/content/guides/sheets/features/conditional-formatting.mdx index a339cd52..92d89cae 100644 --- a/content/guides/sheets/features/conditional-formatting.mdx +++ b/content/guides/sheets/features/conditional-formatting.mdx @@ -24,7 +24,7 @@ icon: ALargeSmall }} /> -Conditional formatting allows users to automatically change the format of cells based on specific conditions, highlighting important data or trends. It supports various conditions and formatting options, helping users to understand data more intuitively. +Conditional formatting allows users to automatically change the format of cells based on specific conditions, highlighting important data or trends. It supports various conditions and formatting options, helping users understand data more intuitively. ## Preset Mode @@ -114,13 +114,16 @@ import '@univerjs/sheets-conditional-formatting/facade' ### Create Conditional Formatting Rules -[`FWorksheet.newConditionalFormattingRule()`](https://reference.univer.ai/en-US/classes/FWorksheet#newconditionalformattingrule) creates a conditional formatting builder, returning an instance of `FConditionalFormattingBuilder`, which can be used to generate conditional formatting rules through method chaining. +[`FWorksheet.newConditionalFormattingRule()`](https://docs.univer.ai/reference/facade/worksheet#newconditionalformattingrule) creates a conditional formatting builder, returning an instance of `FConditionalFormattingBuilder`, which can be used to generate conditional formatting rules through method chaining. -Here are some member methods of [`FConditionalFormattingBuilder`](https://reference.univer.ai/en-US/classes/FConditionalFormattingBuilder): +Here are some member methods of [`FConditionalFormattingBuilder`](https://docs.univer.ai/reference/facade/conditional-formatting): | Method | Description | | ---- | ---- | | build | Builds the conditional formatting rule | +| copy | Deep clone a current builder | +| createCfId | Create a conditional format ID | +| getRanges | Gets the scope of the current conditional format | | setRanges | Sets the range of the conditional formatting rule | | setAverage | Sets the average value conditional formatting rule | | setUniqueValues | Sets the unique value conditional formatting rule | diff --git a/content/guides/sheets/features/conditional-formatting.zh-CN.mdx b/content/guides/sheets/features/conditional-formatting.zh-CN.mdx index 43798ed8..4418dc0f 100644 --- a/content/guides/sheets/features/conditional-formatting.zh-CN.mdx +++ b/content/guides/sheets/features/conditional-formatting.zh-CN.mdx @@ -114,13 +114,16 @@ import '@univerjs/sheets-conditional-formatting/facade' ### 创建条件格式规则 -[`FWorksheet.newConditionalFormattingRule()`](https://reference.univer.ai/zh-CN/classes/FWorksheet#newconditionalformattingrule) 创建一个条件格式构建器，返回一个 `FConditionalFormattingBuilder` 实例，可以通过链式调用生成条件格式规则。 +[`FWorksheet.newConditionalFormattingRule()`](https://docs.univer.ai/reference/facade/worksheet#newconditionalformattingrule) 创建一个条件格式构建器，返回一个 `FConditionalFormattingBuilder` 实例，可以通过链式调用生成条件格式规则。 -以下是 [`FConditionalFormattingBuilder`](https://reference.univer.ai/zh-CN/classes/FConditionalFormattingBuilder) 上的一些成员方法： +以下是 [`FConditionalFormattingBuilder`](https://docs.univer.ai/reference/facade/conditional-formatting) 上的一些成员方法： | 方法 | 描述 | | ---- | ---- | | build | 构建条件格式规则 | +| copy | 深拷贝当前构建器 | +| createCfId | 创建条件格式 ID | +| getRanges | 获取当前条件格式的范围 | | setRanges | 设置条件格式规则应用的范围 | | setAverage | 设置平均值条件格式规则 | | setUniqueValues | 设置唯一值条件格式规则 | diff --git a/content/guides/sheets/features/conditional-formatting.zh-TW.mdx b/content/guides/sheets/features/conditional-formatting.zh-TW.mdx index d3887e10..c76d092e 100644 --- a/content/guides/sheets/features/conditional-formatting.zh-TW.mdx +++ b/content/guides/sheets/features/conditional-formatting.zh-TW.mdx @@ -114,13 +114,16 @@ import '@univerjs/sheets-conditional-formatting/facade' ### 建立條件格式規則 -[`FWorksheet.newConditionalFormattingRule()`](https://reference.univer.ai/zh-TW/classes/FWorksheet#newconditionalformattingrule) 建立一個條件格式構建器，返回一個 `FConditionalFormattingBuilder` 例項，可以透過鏈式呼叫生成條件格式規則。 +[`FWorksheet.newConditionalFormattingRule()`](https://docs.univer.ai/reference/facade/worksheet#newconditionalformattingrule) 建立一個條件格式構建器，返回一個 `FConditionalFormattingBuilder` 例項，可以透過鏈式呼叫生成條件格式規則。 -以下是 [`FConditionalFormattingBuilder`](https://reference.univer.ai/zh-TW/classes/FConditionalFormattingBuilder) 上的一些成員方法： +以下是 [`FConditionalFormattingBuilder`](https://docs.univer.ai/reference/facade/conditional-formatting) 上的一些成員方法： | 方法 | 描述 | | ---- | ---- | | build | 構建條件格式規則 | +| copy | 深拷貝目前構建器 | +| createCfId | 建立條件格式 ID | +| getRanges | 取得目前條件格式的範圍 | | setRanges | 設定條件格式規則應用的範圍 | | setAverage | 設定平均值條件格式規則 | | setUniqueValues | 設定唯一值條件格式規則 | diff --git a/content/guides/sheets/features/core/defined-names.ja-JP.mdx b/content/guides/sheets/features/core/defined-names.ja-JP.mdx index fc5cfec5..97dc87ba 100644 --- a/content/guides/sheets/features/core/defined-names.ja-JP.mdx +++ b/content/guides/sheets/features/core/defined-names.ja-JP.mdx @@ -35,7 +35,7 @@ Defined Names（定義名）は、セル・セル範囲・数式に対して任 `FWorkbook.newDefinedNameBuilder` は定義名ビルダーを生成し、`FDefinedNameBuilder` インスタンスを返します。メソッドチェーンで `ISetDefinedNameMutationParam` オブジェクトを構築し、定義名を挿入できます。 -[`FDefinedNameBuilder`](https://reference.univer.ai/en-US/classes/FDefinedNameBuilder) の主なメンバー: +[`FDefinedNameBuilder`](https://docs.univer.ai/reference/facade/defined-name) の主なメンバー: | メソッド | 説明 | | ---- | ---- | @@ -47,7 +47,7 @@ Defined Names（定義名）は、セル・セル範囲・数式に対して任 | setScopeToWorksheet | 特定ワークシート限定スコープに設定 | | setScopeToWorkbook | ブック全体スコープに設定 | -[`FWorkbook.insertDefinedNameBuilder()`](https://reference.univer.ai/en-US/classes/FWorkbook#insertdefinednamebuilder) はブック全体で利用可能な定義名を作成します。 +[`FWorkbook.insertDefinedNameBuilder()`](https://docs.univer.ai/reference/facade/workbook#insertdefinednamebuilder) はブック全体で利用可能な定義名を作成します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -59,7 +59,7 @@ const definedNameParam = fWorkbook.newDefinedNameBuilder() fWorkbook.insertDefinedNameBuilder(definedNameParam) ``` -[`FWorkbook.insertDefinedName()`](https://reference.univer.ai/en-US/classes/FWorkbook#insertdefinedname) で簡易作成も可能です。 +[`FWorkbook.insertDefinedName()`](https://docs.univer.ai/reference/facade/workbook#insertdefinedname) で簡易作成も可能です。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -67,11 +67,11 @@ fWorkbook.insertDefinedName('MyDefinedName', 'Sheet1!$A$1') ``` その他: -- [`FWorksheet.insertDefinedName()`](https://reference.univer.ai/en-US/classes/FWorksheet#insertdefinedname): 特定ワークシートのみ有効な定義名を作成。 +- [`FWorksheet.insertDefinedName()`](https://docs.univer.ai/reference/facade/worksheet#insertdefinedname): 特定ワークシートのみ有効な定義名を作成。 ### 定義名の取得 -[`FWorkbook.getDefinedName()`](https://reference.univer.ai/en-US/classes/FWorkbook#getdefinedname) はブック内の特定定義名を取得し、`FDefinedName` インスタンスを返します。 +[`FWorkbook.getDefinedName()`](https://docs.univer.ai/reference/facade/workbook#getdefinedname) はブック内の特定定義名を取得し、`FDefinedName` インスタンスを返します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -84,12 +84,12 @@ if (definedName) { ``` その他: -- [`FWorkbook.getDefinedNames()`](https://reference.univer.ai/en-US/classes/FWorkbook#getdefinednames): ブック内すべての定義名配列 (`FDefinedName[]`) を取得。 -- [`FWorksheet.getDefinedNames()`](https://reference.univer.ai/en-US/classes/FWorksheet#getdefinednames): そのワークシートで利用可能な定義名配列を取得。 +- [`FWorkbook.getDefinedNames()`](https://docs.univer.ai/reference/facade/workbook#getdefinednames): ブック内すべての定義名配列 (`FDefinedName[]`) を取得。 +- [`FWorksheet.getDefinedNames()`](https://docs.univer.ai/reference/facade/worksheet#getdefinednames): そのワークシートで利用可能な定義名配列を取得。 ### 定義名の変更 -[`FWorkbook.updateDefinedNameBuilder()`](https://reference.univer.ai/en-US/classes/FWorkbook#updatedefinednamebuilder) は既存定義名を変更します。 +[`FWorkbook.updateDefinedNameBuilder()`](https://docs.univer.ai/reference/facade/workbook#updatedefinednamebuilder) は既存定義名を変更します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -106,7 +106,7 @@ if (definedName) { } ``` -[`FDefinedName`](https://reference.univer.ai/en-US/classes/FDefinedName) インスタンスから直接更新も可能です。 +[`FDefinedName`](https://docs.univer.ai/reference/facade/defined-name) インスタンスから直接更新も可能です。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -122,14 +122,14 @@ if (definedName) { ### 定義名の削除 -[`FWorkbook.deleteDefinedName()`](https://reference.univer.ai/en-US/classes/FWorkbook#deletedefinedname) で定義名を削除します。 +[`FWorkbook.deleteDefinedName()`](https://docs.univer.ai/reference/facade/workbook#deletedefinedname) で定義名を削除します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() fWorkbook.deleteDefinedName('MyDefinedName') ``` -取得済みの [`FDefinedName`](https://reference.univer.ai/en-US/classes/FDefinedName) インスタンスから直接削除することも可能です。 +取得済みの [`FDefinedName`](https://docs.univer.ai/reference/facade/defined-name) インスタンスから直接削除することも可能です。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() diff --git a/content/guides/sheets/features/core/defined-names.mdx b/content/guides/sheets/features/core/defined-names.mdx index be920458..d7b66528 100644 --- a/content/guides/sheets/features/core/defined-names.mdx +++ b/content/guides/sheets/features/core/defined-names.mdx @@ -35,7 +35,7 @@ Complete Facade API type definitions can be found in the [Facade API](https://re `FWorkbook.newDefinedNameBuilder()` creates a defined name builder, returning an `FDefinedNameBuilder` instance. You can use method chaining to generate an `ISetDefinedNameMutationParam` object for creating defined names. -Following are some member methods of [`FDefinedNameBuilder`](https://reference.univer.ai/en-US/classes/FDefinedNameBuilder): +Following are some member methods of [`FDefinedNameBuilder`](https://docs.univer.ai/reference/facade/defined-name): | Method | Description | | ---- | ---- | @@ -47,7 +47,7 @@ Following are some member methods of [`FDefinedNameBuilder`](https://reference.u | setScopeToWorksheet | Sets the defined name to be available for a specific worksheet | | setScopeToWorkbook | Sets the defined name to be available for the entire workbook | -[`FWorkbook.insertDefinedNameBuilder()`](https://reference.univer.ai/en-US/classes/FWorkbook#insertdefinednamebuilder) method can be used to create a defined name that is available for the entire workbook. +[`FWorkbook.insertDefinedNameBuilder()`](https://docs.univer.ai/reference/facade/workbook#insertdefinednamebuilder) method can be used to create a defined name that is available for the entire workbook. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -59,7 +59,7 @@ const definedNameParam = fWorkbook.newDefinedNameBuilder() fWorkbook.insertDefinedNameBuilder(definedNameParam) ``` -[`FWorkbook.insertDefinedName()`](https://reference.univer.ai/en-US/classes/FWorkbook#insertdefinedname) method can be used to quickly create a defined name. +[`FWorkbook.insertDefinedName()`](https://docs.univer.ai/reference/facade/workbook#insertdefinedname) method can be used to quickly create a defined name. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -67,11 +67,11 @@ fWorkbook.insertDefinedName('MyDefinedName', 'Sheet1!$A$1') ``` Other methods: -- [`FWorksheet.insertDefinedName()`](https://reference.univer.ai/en-US/classes/FWorksheet#insertdefinedname): Creates a defined name that is available for a specific worksheet. +- [`FWorksheet.insertDefinedName()`](https://docs.univer.ai/reference/facade/worksheet#insertdefinedname): Creates a defined name that is available for a specific worksheet. ### Get Defined Names -[`FWorkbook.getDefinedName()`](https://reference.univer.ai/en-US/classes/FWorkbook#getdefinedname) method can be used to get a defined name in the workbook, returning an `FDefinedName` instance. +[`FWorkbook.getDefinedName()`](https://docs.univer.ai/reference/facade/workbook#getdefinedname) method can be used to get a defined name in the workbook, returning an `FDefinedName` instance. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -84,12 +84,12 @@ if (definedName) { ``` Other methods: -- [`FWorkbook.getDefinedNames()`](https://reference.univer.ai/en-US/classes/FWorkbook#getdefinednames) method can be used to get all defined names in the workbook, returning an array of `FDefinedName[]`. -- [`FWorksheet.getDefinedNames()`](https://reference.univer.ai/en-US/classes/FWorksheet#getdefinednames) method can be used to get all defined names available for this worksheet, returning an array of `FDefinedName[]`. +- [`FWorkbook.getDefinedNames()`](https://docs.univer.ai/reference/facade/workbook#getdefinednames) method can be used to get all defined names in the workbook, returning an array of `FDefinedName[]`. +- [`FWorksheet.getDefinedNames()`](https://docs.univer.ai/reference/facade/worksheet#getdefinednames) method can be used to get all defined names available for this worksheet, returning an array of `FDefinedName[]`. ### Modify Defined Names -[`FWorkbook.updateDefinedNameBuilder()`](https://reference.univer.ai/en-US/classes/FWorkbook#updatedefinednamebuilder) method can be used to modify a defined name in the workbook. +[`FWorkbook.updateDefinedNameBuilder()`](https://docs.univer.ai/reference/facade/workbook#updatedefinednamebuilder) method can be used to modify a defined name in the workbook. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -106,7 +106,7 @@ if (definedName) { } ``` -[`FDefinedName`](https://reference.univer.ai/en-US/classes/FDefinedName) instance can also be used to directly modify the defined name configuration. +[`FDefinedName`](https://docs.univer.ai/reference/facade/defined-name) instance can also be used to directly modify the defined name configuration. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -122,14 +122,14 @@ if (definedName) { ### Delete Defined Names -[`FWorkbook.deleteDefinedName()`](https://reference.univer.ai/en-US/classes/FWorkbook#deletedefinedname) method can be used to delete a defined name in the workbook. +[`FWorkbook.deleteDefinedName()`](https://docs.univer.ai/reference/facade/workbook#deletedefinedname) method can be used to delete a defined name in the workbook. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() fWorkbook.deleteDefinedName('MyDefinedName') ``` -You can also directly delete the defined name using the returned [`FDefinedName`](https://reference.univer.ai/en-US/classes/FDefinedName) instance. +You can also directly delete the defined name using the returned [`FDefinedName`](https://docs.univer.ai/reference/facade/defined-name) instance. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() diff --git a/content/guides/sheets/features/core/defined-names.zh-CN.mdx b/content/guides/sheets/features/core/defined-names.zh-CN.mdx index b8588c85..8ecb376c 100644 --- a/content/guides/sheets/features/core/defined-names.zh-CN.mdx +++ b/content/guides/sheets/features/core/defined-names.zh-CN.mdx @@ -35,7 +35,7 @@ title: 定义名称 `FWorkbook.newDefinedNameBuilder()` 创建一个定义名称构建器，返回一个 `FDefinedNameBuilder` 实例，可以通过链式调用生成 `ISetDefinedNameMutationParam` 对象用于创建定义名称。 -以下是 [`FDefinedNameBuilder`](https://reference.univer.ai/zh-CN/classes/FDefinedNameBuilder) 上的一些成员方法： +以下是 [`FDefinedNameBuilder`](https://docs.univer.ai/reference/facade/defined-name) 上的一些成员方法： | 方法 | 描述 | | ---- | ---- | @@ -47,7 +47,7 @@ title: 定义名称 | setScopeToWorksheet | 设置定义名称为某个工作表可用 | | setScopeToWorkbook | 设置定义名称为整个工作簿可用 | -通过 [`FWorkbook.insertDefinedNameBuilder()`](https://reference.univer.ai/zh-CN/classes/FWorkbook#insertdefinednamebuilder) 方法可以创建整个工作簿可用的定义名称。 +通过 [`FWorkbook.insertDefinedNameBuilder()`](https://docs.univer.ai/reference/facade/workbook#insertdefinednamebuilder) 方法可以创建整个工作簿可用的定义名称。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -59,7 +59,7 @@ const definedNameParam = fWorkbook.newDefinedNameBuilder() fWorkbook.insertDefinedNameBuilder(definedNameParam) ``` -也可以通过 [`FWorkbook.insertDefinedName()`](https://reference.univer.ai/zh-CN/classes/FWorkbook#insertdefinedname) 方法快速创建定义名称。 +也可以通过 [`FWorkbook.insertDefinedName()`](https://docs.univer.ai/reference/facade/workbook#insertdefinedname) 方法快速创建定义名称。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -67,11 +67,11 @@ fWorkbook.insertDefinedName('MyDefinedName', 'Sheet1!$A$1') ``` 其他方法： -- [`FWorksheet.insertDefinedName()`](https://reference.univer.ai/zh-CN/classes/FWorksheet#insertdefinedname)：创建工作表可用的定义名称。 +- [`FWorksheet.insertDefinedName()`](https://docs.univer.ai/reference/facade/worksheet#insertdefinedname)：创建工作表可用的定义名称。 ### 获取定义名称 -[`FWorkbook.getDefinedName()`](https://reference.univer.ai/zh-CN/classes/FWorkbook#getdefinedname) 方法可以获取工作簿中已定义的名称，返回一个 `FDefinedName` 实例。 +[`FWorkbook.getDefinedName()`](https://docs.univer.ai/reference/facade/workbook#getdefinedname) 方法可以获取工作簿中已定义的名称，返回一个 `FDefinedName` 实例。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -84,8 +84,8 @@ if (definedName) { ``` 其他方法： -- [`FWorkbook.getDefinedNames()`](https://reference.univer.ai/zh-CN/classes/FWorkbook#getdefinednames) 方法可以获取工作簿中所有已定义的名称，返回一个 `FDefinedName[]` 数组。 -- [`FWorksheet.getDefinedNames()`](https://reference.univer.ai/zh-CN/classes/FWorksheet#getdefinednames) 方法可以获取所有此工作表可用的定义名称，返回一个 `FDefinedName[]` 数组。 +- [`FWorkbook.getDefinedNames()`](https://docs.univer.ai/reference/facade/workbook#getdefinednames) 方法可以获取工作簿中所有已定义的名称，返回一个 `FDefinedName[]` 数组。 +- [`FWorksheet.getDefinedNames()`](https://docs.univer.ai/reference/facade/worksheet#getdefinednames) 方法可以获取所有此工作表可用的定义名称，返回一个 `FDefinedName[]` 数组。 ### 修改定义名称 @@ -106,7 +106,7 @@ if (definedName) { } ``` -也可以通过返回的 [`FDefinedName`](https://reference.univer.ai/zh-CN/classes/FDefinedName) 实例直接修改定义名称配置。 +也可以通过返回的 [`FDefinedName`](https://docs.univer.ai/reference/facade/defined-name) 实例直接修改定义名称配置。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -122,14 +122,14 @@ if (definedName) { ### 删除定义名称 -[`FWorkbook.deleteDefinedName()`](https://reference.univer.ai/zh-CN/classes/FWorkbook#deletedefinedname) 方法可以删除工作簿中已定义的名称。 +[`FWorkbook.deleteDefinedName()`](https://docs.univer.ai/reference/facade/workbook#deletedefinedname) 方法可以删除工作簿中已定义的名称。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() fWorkbook.deleteDefinedName('MyDefinedName') ``` -也可以通过返回的 [`FDefinedName`](https://reference.univer.ai/zh-CN/classes/FDefinedName) 实例直接删除定义名称。 +也可以通过返回的 [`FDefinedName`](https://docs.univer.ai/reference/facade/defined-name) 实例直接删除定义名称。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() diff --git a/content/guides/sheets/features/core/defined-names.zh-TW.mdx b/content/guides/sheets/features/core/defined-names.zh-TW.mdx index 4afe29a6..9ef0ccb4 100644 --- a/content/guides/sheets/features/core/defined-names.zh-TW.mdx +++ b/content/guides/sheets/features/core/defined-names.zh-TW.mdx @@ -35,7 +35,7 @@ title: 定義名稱 `FWorkbook.newDefinedNameBuilder()` 建立一個定義名稱構建器，返回一個 `FDefinedNameBuilder` 例項，可以透過鏈式呼叫生成 `ISetDefinedNameMutationParam` 物件用於建立定義名稱。 -以下是 [`FDefinedNameBuilder`](https://reference.univer.ai/zh-TW/classes/FDefinedNameBuilder) 上的一些成員方法： +以下是 [`FDefinedNameBuilder`](https://docs.univer.ai/reference/facade/defined-name) 上的一些成員方法： | 方法 | 描述 | | ---- | ---- | @@ -47,7 +47,7 @@ title: 定義名稱 | setScopeToWorksheet | 設定定義名稱為某個工作表可用 | | setScopeToWorkbook | 設定定義名稱為整個工作簿可用 | -透過 [`FWorkbook.insertDefinedNameBuilder()`](https://reference.univer.ai/zh-TW/classes/FWorkbook#insertdefinednamebuilder) 方法可以建立整個工作簿可用的定義名稱。 +透過 [`FWorkbook.insertDefinedNameBuilder()`](https://docs.univer.ai/reference/facade/workbook#insertdefinednamebuilder) 方法可以建立整個工作簿可用的定義名稱。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -59,7 +59,7 @@ const definedNameParam = fWorkbook.newDefinedNameBuilder() fWorkbook.insertDefinedNameBuilder(definedNameParam) ``` -也可以透過 [`FWorkbook.insertDefinedName()`](https://reference.univer.ai/zh-TW/classes/FWorkbook#insertdefinedname) 方法快速建立定義名稱。 +也可以透過 [`FWorkbook.insertDefinedName()`](https://docs.univer.ai/reference/facade/workbook#insertdefinedname) 方法快速建立定義名稱。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -67,11 +67,11 @@ fWorkbook.insertDefinedName('MyDefinedName', 'Sheet1!$A$1') ``` 其他方法： -- [`FWorksheet.insertDefinedName()`](https://reference.univer.ai/zh-TW/classes/FWorksheet#insertdefinedname)：建立工作表可用的定義名稱。 +- [`FWorksheet.insertDefinedName()`](https://docs.univer.ai/reference/facade/worksheet#insertdefinedname)：建立工作表可用的定義名稱。 ### 獲取定義名稱 -[`FWorkbook.getDefinedName()`](https://reference.univer.ai/zh-TW/classes/FWorkbook#getdefinedname) 方法可以獲取工作簿中已定義的名稱，返回一個 `FDefinedName` 例項。 +[`FWorkbook.getDefinedName()`](https://docs.univer.ai/reference/facade/workbook#getdefinedname) 方法可以獲取工作簿中已定義的名稱，返回一個 `FDefinedName` 例項。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -84,8 +84,8 @@ if (definedName) { ``` 其他方法： -- [`FWorkbook.getDefinedNames()`](https://reference.univer.ai/zh-TW/classes/FWorkbook#getdefinednames) 方法可以獲取工作簿中所有已定義的名稱，返回一個 `FDefinedName[]` 陣列。 -- [`FWorksheet.getDefinedNames()`](https://reference.univer.ai/zh-TW/classes/FWorksheet#getdefinednames) 方法可以獲取所有此工作表可用的定義名稱，返回一個 `FDefinedName[]` 陣列。 +- [`FWorkbook.getDefinedNames()`](https://docs.univer.ai/reference/facade/workbook#getdefinednames) 方法可以獲取工作簿中所有已定義的名稱，返回一個 `FDefinedName[]` 陣列。 +- [`FWorksheet.getDefinedNames()`](https://docs.univer.ai/reference/facade/worksheet#getdefinednames) 方法可以獲取所有此工作表可用的定義名稱，返回一個 `FDefinedName[]` 陣列。 ### 修改定義名稱 @@ -106,7 +106,7 @@ if (definedName) { } ``` -也可以透過返回的 [`FDefinedName`](https://reference.univer.ai/zh-TW/classes/FDefinedName) 例項直接修改定義名稱配置。 +也可以透過返回的 [`FDefinedName`](https://docs.univer.ai/reference/facade/defined-name) 例項直接修改定義名稱配置。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -122,14 +122,14 @@ if (definedName) { ### 刪除定義名稱 -[`FWorkbook.deleteDefinedName()`](https://reference.univer.ai/zh-TW/classes/FWorkbook#deletedefinedname) 方法可以刪除工作簿中已定義的名稱。 +[`FWorkbook.deleteDefinedName()`](https://docs.univer.ai/reference/facade/workbook#deletedefinedname) 方法可以刪除工作簿中已定義的名稱。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() fWorkbook.deleteDefinedName('MyDefinedName') ``` -也可以透過返回的 [`FDefinedName`](https://reference.univer.ai/zh-TW/classes/FDefinedName) 例項直接刪除定義名稱。 +也可以透過返回的 [`FDefinedName`](https://docs.univer.ai/reference/facade/defined-name) 例項直接刪除定義名稱。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() diff --git a/content/guides/sheets/features/core/formula.ja-JP.mdx b/content/guides/sheets/features/core/formula.ja-JP.mdx index f208735b..aa222555 100644 --- a/content/guides/sheets/features/core/formula.ja-JP.mdx +++ b/content/guides/sheets/features/core/formula.ja-JP.mdx @@ -12,8 +12,8 @@ import FormulaList from '@/components/formula-list' | プラグイン | 設定項目 | | --- | --- | -| `@univerjs/engine-formula` | [IUniverEngineFormulaConfig](https://github.com/dream-num/univer/blob/dev/packages/engine-formula/src/controller/config.schema.ts#L29) | -| `@univerjs/sheets-formula` | [IUniverSheetsFormulaBaseConfig](https://github.com/dream-num/univer/blob/dev/packages/sheets-formula/src/controllers/config.schema.ts#L44) | +| `@univerjs/engine-formula` | [IUniverEngineFormulaConfig](/reference/packages/plugins/univerjs/engine-formula) | +| `@univerjs/sheets-formula` | [IUniverSheetsFormulaBaseConfig](/reference/packages/plugins/univerjs/sheets-formula) | ### プリセット設定 @@ -78,7 +78,7 @@ enum CalculationMode { ## Facade API -完全な Facade API については、[FFormula](https://reference.univer.ai/classes/FFormula) を参照してください。 +完全な Facade API については、[FFormula](https://docs.univer.ai/reference/facade/formula) を参照してください。 ### インポート diff --git a/content/guides/sheets/features/core/formula.mdx b/content/guides/sheets/features/core/formula.mdx index b89a9a1b..31f7e561 100644 --- a/content/guides/sheets/features/core/formula.mdx +++ b/content/guides/sheets/features/core/formula.mdx @@ -12,8 +12,8 @@ Following are the links to the configuration items related to the formula plugin | Plugin | Configuration Item | | --- | --- | -| `@univerjs/engine-formula` | [IUniverEngineFormulaConfig](https://github.com/dream-num/univer/blob/dev/packages/engine-formula/src/controller/config.schema.ts#L29) | -| `@univerjs/sheets-formula` | [IUniverSheetsFormulaBaseConfig](https://github.com/dream-num/univer/blob/dev/packages/sheets-formula/src/controllers/config.schema.ts#L44) | +| `@univerjs/engine-formula` | [IUniverEngineFormulaConfig](/reference/packages/plugins/univerjs/engine-formula) | +| `@univerjs/sheets-formula` | [IUniverSheetsFormulaBaseConfig](/reference/packages/plugins/univerjs/sheets-formula) | ### Presets Configuration @@ -78,7 +78,7 @@ enum CalculationMode { ## Facade API -For more details, please refer to the [FFormula Facade API](https://reference.univer.ai/classes/FFormula). +For more details, please refer to the [FFormula Facade API](https://docs.univer.ai/reference/facade/formula). ### Importing diff --git a/content/guides/sheets/features/core/formula.zh-CN.mdx b/content/guides/sheets/features/core/formula.zh-CN.mdx index 3b90cad1..0d83ab83 100644 --- a/content/guides/sheets/features/core/formula.zh-CN.mdx +++ b/content/guides/sheets/features/core/formula.zh-CN.mdx @@ -12,8 +12,8 @@ import FormulaList from '@/components/formula-list' | 插件 | 配置项 | | --- | --- | -| `@univerjs/engine-formula` | [IUniverEngineFormulaConfig](https://github.com/dream-num/univer/blob/dev/packages/engine-formula/src/controller/config.schema.ts#L29) | -| `@univerjs/sheets-formula` | [IUniverSheetsFormulaBaseConfig](https://github.com/dream-num/univer/blob/dev/packages/sheets-formula/src/controllers/config.schema.ts#L44) | +| `@univerjs/engine-formula` | [IUniverEngineFormulaConfig](/reference/packages/plugins/univerjs/engine-formula) | +| `@univerjs/sheets-formula` | [IUniverSheetsFormulaBaseConfig](/reference/packages/plugins/univerjs/sheets-formula) | ### Presets 配置 @@ -78,7 +78,7 @@ enum CalculationMode { ## Facade API -完整 Facade API 见 [FFormula](https://reference.univer.ai/classes/FFormula)。 +完整 Facade API 见 [FFormula](https://docs.univer.ai/reference/facade/formula)。 ### 引入 diff --git a/content/guides/sheets/features/core/formula.zh-TW.mdx b/content/guides/sheets/features/core/formula.zh-TW.mdx index 49de3909..875df44d 100644 --- a/content/guides/sheets/features/core/formula.zh-TW.mdx +++ b/content/guides/sheets/features/core/formula.zh-TW.mdx @@ -12,8 +12,8 @@ import FormulaList from '@/components/formula-list' | 外掛 | 配置項 | | --- | --- | -| `@univerjs/engine-formula` | [IUniverEngineFormulaConfig](https://github.com/dream-num/univer/blob/dev/packages/engine-formula/src/controller/config.schema.ts#L29) | -| `@univerjs/sheets-formula` | [IUniverSheetsFormulaBaseConfig](https://github.com/dream-num/univer/blob/dev/packages/sheets-formula/src/controllers/config.schema.ts#L44) | +| `@univerjs/engine-formula` | [IUniverEngineFormulaConfig](/reference/packages/plugins/univerjs/engine-formula) | +| `@univerjs/sheets-formula` | [IUniverSheetsFormulaBaseConfig](/reference/packages/plugins/univerjs/sheets-formula) | ### Presets 配置 @@ -78,7 +78,7 @@ enum CalculationMode { ## Facade API -完整 Facade API 請參閱 [FFormula](https://reference.univer.ai/classes/FFormula)。 +完整 Facade API 請參閱 [FFormula](https://docs.univer.ai/reference/facade/formula)。 ### 導入 diff --git a/content/guides/sheets/features/core/index.ja-JP.mdx b/content/guides/sheets/features/core/index.ja-JP.mdx index c5eb71b0..8e93a076 100644 --- a/content/guides/sheets/features/core/index.ja-JP.mdx +++ b/content/guides/sheets/features/core/index.ja-JP.mdx @@ -134,7 +134,7 @@ interface CreateUniverParameter { } ``` -参照：[`createUniver`](/reference/methods/create-univer) +参照：[`createUniver`(https://docs.univer.ai/reference/methods/create-univer) #### @univerjs/preset-sheets-core @@ -245,7 +245,7 @@ UniverSheetsCorePreset({ ここで `'sheet.command.set-range-bold'` と `'sheet.command.set-range-italic'` はコマンド名で、該当メニュー項目を指します。以下の [メニュー項目 ID リスト](#menu-item-id-list) を参照してください。 -参照：[@univerjs/preset-sheets-core](/reference/packages/presets/univerjs/preset-sheets-core) +参照：[@univerjs/preset-sheets-core(https://docs.univer.ai/reference/packages/presets/univerjs/preset-sheets-core) ## プラグインモード @@ -344,19 +344,19 @@ interface UniverParameter { } ``` -参照：[`Univer`](/reference/classes/univer) +参照：[`Univer`(https://docs.univer.ai/reference/classes/univer) #### @univerjs/engine-render レンダリングエンジンで、描画・スクロールバー・カーソル・選択範囲等の処理を担当。`UniverRenderEnginePlugin` を提供。 -参照：[@univerjs/engine-render](/reference/packages/plugins/univerjs/engine-render) +参照：[@univerjs/engine-render(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-render) #### @univerjs/engine-formula 数式エンジンで、数式の計算と処理を担当。`UniverFormulaEnginePlugin` を提供。 -参照：[@univerjs/engine-formula](/reference/packages/plugins/univerjs/engine-formula) +参照：[@univerjs/engine-formula(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-formula) #### @univerjs/design @@ -409,19 +409,19 @@ univer.registerPlugin(UniverSheetsUIPlugin, { ここで `'sheet.command.set-range-bold'` と `'sheet.command.set-range-italic'` はコマンド名で、該当メニュー項目を指します。以下の [メニュー項目 ID リスト](#menu-item-id-list) を参照してください。 -参照：[@univerjs/ui](/reference/packages/plugins/univerjs/ui) +参照：[@univerjs/ui(https://docs.univer.ai/reference/packages/plugins/univerjs/ui) #### @univerjs/docs Univer Docs のコアプラグイン。`UniverDocsPlugin` を提供。 -参照：[@univerjs/docs](/reference/packages/plugins/univerjs/docs) +参照：[@univerjs/docs(https://docs.univer.ai/reference/packages/plugins/univerjs/docs) #### @univerjs/docs-ui Univer Docs の UI プラグイン。ドキュメントエディタの UI コンポーネントとインタラクションを提供。`UniverDocsUIPlugin` を提供。 -参照：[@univerjs/docs-ui](/reference/packages/plugins/univerjs/docs-ui) +参照：[@univerjs/docs-ui(https://docs.univer.ai/reference/packages/plugins/univerjs/docs-ui) #### @univerjs/sheets @@ -443,7 +443,7 @@ interface IUniverSheetsConfig { } ``` -参照：[@univerjs/sheets](/reference/packages/plugins/univerjs/sheets) +参照：[@univerjs/sheets(https://docs.univer.ai/reference/packages/plugins/univerjs/sheets) #### @univerjs/sheets-ui @@ -509,7 +509,7 @@ interface IUniverSheetsUIConfig { } ``` -参照：[@univerjs/sheets-ui](/reference/packages/plugins/univerjs/sheets-ui) +参照：[@univerjs/sheets-ui(https://docs.univer.ai/reference/packages/plugins/univerjs/sheets-ui) ## ツールバーレイアウトと `RibbonType` diff --git a/content/guides/sheets/features/core/index.mdx b/content/guides/sheets/features/core/index.mdx index a598511d..31405288 100644 --- a/content/guides/sheets/features/core/index.mdx +++ b/content/guides/sheets/features/core/index.mdx @@ -134,7 +134,7 @@ interface CreateUniverParameter { } ``` -Reference: [`createUniver`](/reference/methods/create-univer) +Reference: [`createUniver`(https://docs.univer.ai/reference/methods/create-univer) #### @univerjs/preset-sheets-core @@ -245,7 +245,7 @@ UniverSheetsCorePreset({ Here, `'sheet.command.set-range-bold'` and `'sheet.command.set-range-italic'` are the names of the commands, indicating the corresponding menu items. You can refer to the [Menu Item ID List](#menu-item-id-list) below. -Reference: [@univerjs/preset-sheets-core](/reference/packages/presets/univerjs/preset-sheets-core) +Reference: [@univerjs/preset-sheets-core(https://docs.univer.ai/reference/packages/presets/univerjs/preset-sheets-core) ## Plugin Mode @@ -344,19 +344,19 @@ interface UniverParameter { } ``` -Reference: [`Univer`](/reference/classes/univer) +Reference: [`Univer`(https://docs.univer.ai/reference/classes/univer) #### @univerjs/engine-render This plugin is the rendering engine of Univer, responsible for rendering, scrollbars, cursor, and selection rendering. It provides the `UniverRenderEnginePlugin`. -Reference: [@univerjs/engine-render](/reference/packages/plugins/univerjs/engine-render) +Reference: [@univerjs/engine-render(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-render) #### @univerjs/engine-formula This plugin is the formula engine of Univer, responsible for calculating and processing formulas. It provides the `UniverFormulaEnginePlugin`. -Reference: [@univerjs/engine-formula](/reference/packages/plugins/univerjs/engine-formula) +Reference: [@univerjs/engine-formula(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-formula) #### @univerjs/design @@ -409,19 +409,19 @@ univer.registerPlugin(UniverSheetsUIPlugin, { Here, `'sheet.command.set-range-bold'` and `'sheet.command.set-range-italic'` are the names of the commands, indicating the corresponding menu items. You can refer to the [Menu Item ID List](#menu-item-id-list) below. -Reference: [@univerjs/ui](/reference/packages/plugins/univerjs/ui) +Reference: [@univerjs/ui(https://docs.univer.ai/reference/packages/plugins/univerjs/ui) #### @univerjs/docs This plugin is the core plugin of Univer Docs. It provides the `UniverDocsPlugin`. -Reference: [@univerjs/docs](/reference/packages/plugins/univerjs/docs) +Reference: [@univerjs/docs(https://docs.univer.ai/reference/packages/plugins/univerjs/docs) #### @univerjs/docs-ui This plugin is the UI plugin of Univer Docs, which includes UI components and interactions for the document editor. It provides the `UniverDocsUIPlugin`. -Reference: [@univerjs/docs-ui](/reference/packages/plugins/univerjs/docs-ui) +Reference: [@univerjs/docs-ui(https://docs.univer.ai/reference/packages/plugins/univerjs/docs-ui) #### @univerjs/sheets @@ -443,7 +443,7 @@ interface IUniverSheetsConfig { } ``` -Reference: [@univerjs/sheets](/reference/packages/plugins/univerjs/sheets) +Reference: [@univerjs/sheets(https://docs.univer.ai/reference/packages/plugins/univerjs/sheets) #### @univerjs/sheets-ui @@ -509,7 +509,7 @@ interface IUniverSheetsUIConfig { } ``` -Reference: [@univerjs/sheets-ui](/reference/packages/plugins/univerjs/sheets-ui) +Reference: [@univerjs/sheets-ui(https://docs.univer.ai/reference/packages/plugins/univerjs/sheets-ui) ## Toolbar Layout and `RibbonType` diff --git a/content/guides/sheets/features/core/index.zh-CN.mdx b/content/guides/sheets/features/core/index.zh-CN.mdx index 81418851..8cfc091c 100644 --- a/content/guides/sheets/features/core/index.zh-CN.mdx +++ b/content/guides/sheets/features/core/index.zh-CN.mdx @@ -134,7 +134,7 @@ interface CreateUniverParameter { } ``` -参考：[`createUniver`](/reference/methods/create-univer) +参考：[`createUniver`(https://docs.univer.ai/reference/methods/create-univer) #### @univerjs/preset-sheets-core @@ -245,7 +245,7 @@ UniverSheetsCorePreset({ 这里的 `'sheet.command.set-range-bold'` 和 `'sheet.command.set-range-italic'` 是命令的名称，表示对应的菜单项。可参考下方的 [菜单项 ID 列表](#menu-item-id-list)。 -参考：[@univerjs/preset-sheets-core](/reference/packages/presets/univerjs/preset-sheets-core) +参考：[@univerjs/preset-sheets-core(https://docs.univer.ai/reference/packages/presets/univerjs/preset-sheets-core) ## 插件模式 @@ -344,19 +344,19 @@ interface UniverParameter { } ``` -参考：[`Univer`](/reference/classes/univer) +参考：[`Univer`(https://docs.univer.ai/reference/classes/univer) #### @univerjs/engine-render 本插件是 Univer 的渲染引擎，负责渲染、滚动条、光标和选区等的绘制。其提供了 `UniverRenderEnginePlugin` 插件。 -参考：[@univerjs/engine-render](/reference/packages/plugins/univerjs/engine-render) +参考：[@univerjs/engine-render(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-render) #### @univerjs/engine-formula 本插件是 Univer 的公式引擎，负责公式的计算和处理。其提供了 `UniverFormulaEnginePlugin` 插件。 -参考：[@univerjs/engine-formula](/reference/packages/plugins/univerjs/engine-formula) +参考：[@univerjs/engine-formula(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-formula) #### @univerjs/design @@ -409,19 +409,19 @@ univer.registerPlugin(UniverSheetsUIPlugin, { 这里的 `'sheet.command.set-range-bold'` 和 `'sheet.command.set-range-italic'` 是命令的名称，表示对应的菜单项。可参考下方的 [菜单项 ID 列表](#menu-item-id-list)。 -参考：[@univerjs/ui](/reference/packages/plugins/univerjs/ui) +参考：[@univerjs/ui(https://docs.univer.ai/reference/packages/plugins/univerjs/ui) #### @univerjs/docs 本插件是 Univer Docs 的核心插件。其提供了 `UniverDocsPlugin` 插件。 -参考：[@univerjs/docs](/reference/packages/plugins/univerjs/docs) +参考：[@univerjs/docs(https://docs.univer.ai/reference/packages/plugins/univerjs/docs) #### @univerjs/docs-ui 本插件是 Univer Docs 的 UI 插件，包含了文档编辑器的 UI 组件和交互。其提供了 `UniverDocsUIPlugin` 插件。 -参考：[@univerjs/docs-ui](/reference/packages/plugins/univerjs/docs-ui) +参考：[@univerjs/docs-ui(https://docs.univer.ai/reference/packages/plugins/univerjs/docs-ui) #### @univerjs/sheets @@ -443,7 +443,7 @@ interface IUniverSheetsConfig { } ``` -参考：[@univerjs/sheets](/reference/packages/plugins/univerjs/sheets) +参考：[@univerjs/sheets(https://docs.univer.ai/reference/packages/plugins/univerjs/sheets) #### @univerjs/sheets-ui @@ -509,7 +509,7 @@ interface IUniverSheetsUIConfig { } ``` -参考：[@univerjs/sheets-ui](/reference/packages/plugins/univerjs/sheets-ui) +参考：[@univerjs/sheets-ui(https://docs.univer.ai/reference/packages/plugins/univerjs/sheets-ui) ## 工具栏布局与 `RibbonType` diff --git a/content/guides/sheets/features/core/index.zh-TW.mdx b/content/guides/sheets/features/core/index.zh-TW.mdx index 71a7f99b..42bdd52e 100644 --- a/content/guides/sheets/features/core/index.zh-TW.mdx +++ b/content/guides/sheets/features/core/index.zh-TW.mdx @@ -134,7 +134,7 @@ interface CreateUniverParameter { } ``` -參考：[`createUniver`](/reference/methods/create-univer) +參考：[`createUniver`(https://docs.univer.ai/reference/methods/create-univer) #### @univerjs/preset-sheets-core @@ -245,7 +245,7 @@ UniverSheetsCorePreset({ 這裡的 `'sheet.command.set-range-bold'` 和 `'sheet.command.set-range-italic'` 是命令的名稱，表示對應的菜單項。可參考下方的 [菜單項 ID 列表](#menu-item-id-list)。 -參考：[@univerjs/preset-sheets-core](/reference/packages/presets/univerjs/preset-sheets-core) +參考：[@univerjs/preset-sheets-core(https://docs.univer.ai/reference/packages/presets/univerjs/preset-sheets-core) ## 外掛模式 @@ -344,19 +344,19 @@ interface UniverParameter { } ``` -參考：[`Univer`](/reference/classes/univer) +參考：[`Univer`(https://docs.univer.ai/reference/classes/univer) #### @univerjs/engine-render 本外掛是 Univer 的渲染引擎，負責渲染、滾動條、游標和選區等的繪製。其提供了 `UniverRenderEnginePlugin` 外掛。 -參考：[@univerjs/engine-render](/reference/packages/plugins/univerjs/engine-render) +參考：[@univerjs/engine-render(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-render) #### @univerjs/engine-formula 本外掛是 Univer 的公式引擎，負責公式的計算和處理。其提供了 `UniverFormulaEnginePlugin` 外掛。 -參考：[@univerjs/engine-formula](/reference/packages/plugins/univerjs/engine-formula) +參考：[@univerjs/engine-formula(https://docs.univer.ai/reference/packages/plugins/univerjs/engine-formula) #### @univerjs/design @@ -409,19 +409,19 @@ univer.registerPlugin(UniverSheetsUIPlugin, { 這裡的 `'sheet.command.set-range-bold'` 和 `'sheet.command.set-range-italic'` 是命令的名稱，表示對應的菜單項。可參考下方的 [菜單項 ID 列表](#menu-item-id-list)。 -參考：[@univerjs/ui](/reference/packages/plugins/univerjs/ui) +參考：[@univerjs/ui(https://docs.univer.ai/reference/packages/plugins/univerjs/ui) #### @univerjs/docs 本外掛是 Univer Docs 的核心外掛。其提供了 `UniverDocsPlugin` 外掛。 -參考：[@univerjs/docs](/reference/packages/plugins/univerjs/docs) +參考：[@univerjs/docs(https://docs.univer.ai/reference/packages/plugins/univerjs/docs) #### @univerjs/docs-ui 本外掛是 Univer Docs 的 UI 外掛，包含了文件編輯器的 UI 組件和交互。其提供了 `UniverDocsUIPlugin` 外掛。 -參考：[@univerjs/docs-ui](/reference/packages/plugins/univerjs/docs-ui) +參考：[@univerjs/docs-ui(https://docs.univer.ai/reference/packages/plugins/univerjs/docs-ui) #### @univerjs/sheets @@ -443,7 +443,7 @@ interface IUniverSheetsConfig { } ``` -參考：[@univerjs/sheets](/reference/packages/plugins/univerjs/sheets) +參考：[@univerjs/sheets(https://docs.univer.ai/reference/packages/plugins/univerjs/sheets) #### @univerjs/sheets-ui @@ -509,7 +509,7 @@ interface IUniverSheetsUIConfig { } ``` -參考：[@univerjs/sheets-ui](/reference/packages/plugins/univerjs/sheets-ui) +參考：[@univerjs/sheets-ui(https://docs.univer.ai/reference/packages/plugins/univerjs/sheets-ui) ## 工具列佈局與 `RibbonType` diff --git a/content/guides/sheets/features/core/numfmt.ja-JP.mdx b/content/guides/sheets/features/core/numfmt.ja-JP.mdx index 87add246..4c1ed7cb 100644 --- a/content/guides/sheets/features/core/numfmt.ja-JP.mdx +++ b/content/guides/sheets/features/core/numfmt.ja-JP.mdx @@ -114,7 +114,7 @@ fRange.getNumberFormats() ### 数値書式のロケール設定 -[`FWorkbook.setNumfmtLocal(local)`](https://reference.univer.ai/en-US/classes/FWorkbook#setnumfmtlocal) を使用して数値書式のロケールを設定できます。 +[`FWorkbook.setNumfmtLocal(local)`](https://docs.univer.ai/reference/facade/workbook#setnumfmtlocal) を使用して数値書式のロケールを設定できます。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() diff --git a/content/guides/sheets/features/core/numfmt.mdx b/content/guides/sheets/features/core/numfmt.mdx index f1586f47..7927703f 100644 --- a/content/guides/sheets/features/core/numfmt.mdx +++ b/content/guides/sheets/features/core/numfmt.mdx @@ -114,7 +114,7 @@ fRange.getNumberFormats() ### Set the locale for number formatting -You can use the [`FWorkbook.setNumfmtLocal(local)`](https://reference.univer.ai/en-US/classes/FWorkbook#setnumfmtlocal) method to set the locale for number formatting. +You can use the [`FWorkbook.setNumfmtLocal(local)`](https://docs.univer.ai/reference/facade/workbook#setnumfmtlocal) method to set the locale for number formatting. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() diff --git a/content/guides/sheets/features/core/numfmt.zh-CN.mdx b/content/guides/sheets/features/core/numfmt.zh-CN.mdx index 218bf158..6de4b885 100644 --- a/content/guides/sheets/features/core/numfmt.zh-CN.mdx +++ b/content/guides/sheets/features/core/numfmt.zh-CN.mdx @@ -114,7 +114,7 @@ fRange.getNumberFormats() ### 设置数字格式的区域设置 -使用 [`FWorkbook.setNumfmtLocal(local)`](https://reference.univer.ai/zh-CN/classes/FWorkbook#setnumfmtlocal) 方法设置数字格式的区域设置。 +使用 [`FWorkbook.setNumfmtLocal(local)`](https://docs.univer.ai/reference/facade/workbook#setnumfmtlocal) 方法设置数字格式的区域设置。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() diff --git a/content/guides/sheets/features/core/numfmt.zh-TW.mdx b/content/guides/sheets/features/core/numfmt.zh-TW.mdx index 403c5550..360c8de9 100644 --- a/content/guides/sheets/features/core/numfmt.zh-TW.mdx +++ b/content/guides/sheets/features/core/numfmt.zh-TW.mdx @@ -114,7 +114,7 @@ fRange.getNumberFormats() ### 設定數字格式的區域設定 -使用 [`FWorkbook.setNumfmtLocal(local)`](https://reference.univer.ai/zh-TW/classes/FWorkbook#setnumfmtlocal) 方法設定數字格式的區域設定。 +使用 [`FWorkbook.setNumfmtLocal(local)`](https://docs.univer.ai/reference/facade/workbook#setnumfmtlocal) 方法設定數字格式的區域設定。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() diff --git a/content/guides/sheets/features/core/permission.ja-JP.mdx b/content/guides/sheets/features/core/permission.ja-JP.mdx index c3d236f6..0fa4035c 100644 --- a/content/guides/sheets/features/core/permission.ja-JP.mdx +++ b/content/guides/sheets/features/core/permission.ja-JP.mdx @@ -188,8 +188,8 @@ class ConsumeService { bindEvent() { // これは Rx オブジェクトを取得し、権限変更を監視したりリストを更新したりできる - const pount$ = this._permissionService.getPermissionPoint$(new CustomPermissionPoint('unitId', 'subUnitId', 'my-id').id) - console.log(pount$) + const point$ = this._permissionService.getPermissionPoint$(new CustomPermissionPoint('unitId', 'subUnitId', 'my-id').id) + console.log(point$) } } ``` @@ -451,6 +451,9 @@ univer.registerPlugin(YourPlugin) | univerAPI.Enum.WorksheetPermissionPoint.InsertHyperlink | WorksheetInsertHyperlinkPermission | ハイパーリンク使用可能 | | univerAPI.Enum.WorksheetPermissionPoint.ManageCollaborator | WorksheetManageCollaboratorPermission | 共同編集者管理可能 | | univerAPI.Enum.WorksheetPermissionPoint.DeleteProtection | WorksheetDeleteProtectionPermission | 保護範囲削除可能 | +| univerAPI.Enum.WorksheetPermissionPoint.EditExtraObject | WorksheetEditExtraObjectPermission | 追加オブジェクト編集可能 | +| univerAPI.Enum.WorksheetPermissionPoint.SelectProtectedCells | WorksheetSelectProtectedCellsPermission | 保護されたセル選択可能 | +| univerAPI.Enum.WorksheetPermissionPoint.SelectUnProtectedCells | WorksheetSelectUnProtectedCellsPermission | 保護されていないセル選択可能 | ### 範囲 [#range-point] @@ -459,6 +462,7 @@ univer.registerPlugin(YourPlugin) | univerAPI.Enum.RangePermissionPoint.Edit | RangeProtectionPermissionEditPoint | 保護範囲を編集可能 | | univerAPI.Enum.RangePermissionPoint.View | RangeProtectionPermissionViewPoint | 保護範囲の内容を閲覧可能 | | univerAPI.Enum.RangePermissionPoint.Delete | RangeProtectionPermissionDeleteProtectionPoint | 保護範囲を削除可能 | +| univerAPI.Enum.RangePermissionPoint.ManageCollaborator | RangeProtectionPermissionManageCollaPoint | 保護範囲の共同編集者管理可能 | ## 設定 @@ -955,6 +959,7 @@ if (rangePermission.isProtected()) { | `canEdit(): boolean` | チェック保護ルールが編集を許可するかどうか | | `canView(): boolean` | チェック保護ルールが閲覧を許可するかどうか | | `canDelete(): boolean` | チェック保護ルールが削除を許可するかどうか | +| `canManageCollaborator(): boolean` | チェック保護ルールが共同編集者管理を許可するかどうか | | `getSnapshot(): RangePermissionSnapshot` | 保護ルールの現在の状態のスナップショットを取得 | ```typescript @@ -964,7 +969,7 @@ const worksheetPermission = fWorksheet.getWorksheetPermission() const rules = await worksheetPermission.listRangeProtectionRules() const rule = rules?.[0] -// ID 最初の保護ルールの ID を取得 +// 最初の保護ルールの ID を取得 const ruleId = rule?.id console.log(ruleId) @@ -972,7 +977,7 @@ console.log(ruleId) const ranges = rule?.ranges console.log(ranges) -// A1:C3 最初の保護ルールの範囲を A1:C3 に更新 +// 最初の保護ルールの範囲を A1:C3 に更新 await rule?.updateRanges([fWorksheet.getRange('A1:C3')]) // 最初の保護ルールを削除 diff --git a/content/guides/sheets/features/core/permission.mdx b/content/guides/sheets/features/core/permission.mdx index 9f723536..014b4c6b 100644 --- a/content/guides/sheets/features/core/permission.mdx +++ b/content/guides/sheets/features/core/permission.mdx @@ -4,27 +4,27 @@ title: Permission Control import { MigrationCell, MigrationRow, MigrationTable } from './components/migration-table' -Univer provides permission control capabilities, typically used to restrict user operations on workbooks, sheets, and ranges. When a user performs an operation without permission, the code execution can be halted and the user will be prompted about the missing permissions. For example, you can set area protection within a range, which allows setting whether other collaborators can edit, read, copy, filter, etc., within the protected range. +Univer provides permission control capabilities to restrict user operations on workbooks, worksheets, and ranges. When a user attempts an operation without the required permission, execution is halted and the user is notified. For example, you can protect a range to control whether collaborators can edit, view, copy, or filter within that range. - Univer provides extendable foundational capabilities, not customized features. - If you have more extensive and tailored requirements such as persistence or organizational structures, you need to implement the storage of permission rules and integrate organizational structures yourself. In this case, you need to write custom plugins to achieve this. - Therefore, after setting permissions, you might find the permission list empty when viewing it, or user information returns empty when you check it. This is because this information needs to be fetched via API requests; it's custom logic that requires additional implementation on your part. You can refer to the third-party integration below. + Univer provides extensible foundational capabilities, not out-of-the-box customized features. + If you need persistence, organizational structures, or other tailored requirements, you must implement the storage of permission rules and integrate organizational structures yourself—typically through custom plugins. + Therefore, it is normal to find the permission list empty or user information missing after setting permissions. This data must be fetched via your own API requests, which is custom logic you need to implement. Refer to the third-party integration section below for details. ## Core Concepts -- Scope of Action: Permissions can be applied at three levels: workbook, worksheet, and range. -- Permission Points: Each function corresponds to a permission point, and modifying the point can control whether the function is available. -- Protection Rules: Before setting permission points for worksheets and ranges, you need to create protection rules +- Scope: Permissions apply at three levels—workbook, worksheet, and range. +- Permission Points: Each feature corresponds to a permission point. Modifying a point controls whether that feature is available. +- Protection Rules: Before setting permission points for worksheets and ranges, you must create a protection rule. - Local non-persistent (non-collaborative editing environment) permission control can be directly achieved by modifying the permission points. For persistent permissions, please refer to the "Integration of Third-Party Authorization Service" section below. - In a collaborative editing scenario, updating permission points will synchronize the server state: - - false: This permission point requires at least the `owner` role - - true: This permission point requires at least the `reader` role + In a local, non-persistent environment (without collaborative editing), you can control permissions directly by modifying permission points. For persistent permissions, refer to the "Integrating a Third-Party Authorization Service" section below. + In a collaborative editing scenario, updating a permission point synchronizes the server state: + - `false`: The permission point requires at least the `owner` role + - `true`: The permission point requires at least the `reader` role ## Basic Example @@ -33,9 +33,9 @@ The most common permission setting methods are shown below at three levels: work ### Workbook Permissions Code Example -Currently, workbook-level permissions are directly modified through the API. We provide the [Facade API](/guides/sheets/getting-started/facade), and you can use this API to set permissions for different functions of the workbook. +Workbook-level permissions can be set directly via the [Facade API](/guides/sheets/getting-started/facade). -Taking edit permission as an example (other functions require replacing the permission points, see the [list of permission points - Workbook](#workbook-point) for details), you can use the following code to set the entire workbook to be non-editable: +The following example disables editing for the entire workbook. For other functions, replace the permission point accordingly (see the [workbook permission points list](#workbook-point)): ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -46,11 +46,11 @@ await workbookPermission.setPoint(univerAPI.Enum.WorkbookPermissionPoint.Edit, f ``` Key points: -- Workbook permissions points can be directly set without the need to create protection rules. +- Workbook permission points can be set directly without creating protection rules. ### Worksheet Permissions Code Example -Worksheet and range-related permissions can be set via both the Facade API and command. Here, we'll use worksheet edit permissions as an example. Other worksheet functions require replacing the permission points, see the [list of permission points - Worksheet](#worksheet-point) for details. +Worksheet and range permissions can be set via the Facade API or commands. The following example demonstrates how to set worksheet edit permissions. For other features, replace the permission point accordingly (see the [worksheet permission points list](#worksheet-point)): ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -63,7 +63,7 @@ const permissionId = await worksheetPermission.protect({ name: 'My Worksheet Protection', }) -// If you need to set permission points, you must first create worksheet protection +// To set permission points, you must first protect the worksheet await worksheetPermission.setPoint(univerAPI.Enum.WorksheetPermissionPoint.Edit, false) ``` @@ -96,7 +96,7 @@ const rule = await rangePermission.protect({ }) console.log(rule) -// If you need to set permission points, you must first create range protection. +// To set permission points, you must first create a range protection rule. await rule.setPoint(univerAPI.Enum.RangePermissionPoint.Edit, false) await rule.setPoint(univerAPI.Enum.RangePermissionPoint.View, true) ``` @@ -121,9 +121,9 @@ if (rules.length > 0) { ## Extended usage -When you need to add permission verification in your own plug-in, you can directly manipulate the permission points. +When you need to check permissions in your own plugin, you can manipulate the permission points directly. -Here we take `WorkbookEditablePermission` as an example and add permission verification in your own plug-in. Other points are similar. +The following example uses `WorkbookEditablePermission` to demonstrate how to check permissions in your own plugin. Other permission points work similarly. ```typescript import { IPermissionService } from '@univerjs/core' @@ -143,11 +143,11 @@ class YourService { } ``` -You can also extend and modify other permission points to achieve permission control for different functions. For a specific list of points, please refer to the bottom of the article. +You can also extend and modify other permission points to control different features. See the full list at the bottom of this page. -### How to extend the permission point +### How to Extend Permission Points -If you need to customize permission points, you can implement `IPermissionPoint` and register it to the permission service: +To customize permission points, implement `IPermissionPoint` and register it with the permission service: ```typescript import type { IPermissionPoint } from '@univerjs/core' @@ -158,10 +158,10 @@ export class CustomPermissionPoint implements IPermissionPoint { type = UnitObject.Unkonwn // your type subType = UnitAction.View // your subType status = PermissionStatus.INIT - value = true // Initial values + value = true // Default value id: string constructor(unitId: string, subUnitId: string, customId: string) { - // The id attribute needs to be guaranteed to be unique throughout `IPermissionService`. + // The id must be unique within `IPermissionService`. this.id = `${unitId}.${subUnitId}.${customId}` } } @@ -187,14 +187,14 @@ class ConsumeService { } bindEvent() { - // This will get an RX object, allowing you to listen for changes to the current permissions and make a list of changes - const pount$ = this._permissionService.getPermissionPoint$(new CustomPermissionPoint('unitId', 'subUnitId', 'my-id').id) - console.log(pount$) + // This returns an RxJS observable that lets you listen for permission changes + const point$ = this._permissionService.getPermissionPoint$(new CustomPermissionPoint('unitId', 'subUnitId', 'my-id').id) + console.log(point$) } } ``` -### Integration of Third-Party Authorization Service(Advanced Usage) +### Integrating a Third-Party Authorization Service (Advanced) It is recommended to avoid mixing custom permission access with the Permission Facade API, as it allows for more granular control over permission points. @@ -399,9 +399,9 @@ univer.registerPlugin(YourPlugin) ## List of permission points [#point-list] -To access the specific code related to permission point at the given URL, you can refer to the [code](https://github.com/dream-num/univer/tree/dev/packages/sheets/src/services/permission/permission-point). +You can view the source code for all permission points [here](https://github.com/dream-num/univer/tree/dev/packages/sheets/src/services/permission/permission-point). -In the case where the permission control of the workbook intersects with the worksheet/range, all permissions must be set to true in order to use them. +When workbook permissions overlap with worksheet or range permissions, **all** relevant permissions must be set to `true` for the feature to be usable. ### Workbook Permissions [#workbook-point] @@ -451,6 +451,9 @@ In the case where the permission control of the workbook intersects with the wor | univerAPI.Enum.WorksheetPermissionPoint.InsertHyperlink | WorksheetInsertHyperlinkPermission | Can use hyperlinks | | univerAPI.Enum.WorksheetPermissionPoint.ManageCollaborator | WorksheetManageCollaboratorPermission | Can manage collaborators | | univerAPI.Enum.WorksheetPermissionPoint.DeleteProtection | WorksheetDeleteProtectionPermission | Can delete protection | +| univerAPI.Enum.WorksheetPermissionPoint.EditExtraObject | WorksheetEditExtraObjectPermission | Can edit extra objects | +| univerAPI.Enum.WorksheetPermissionPoint.SelectProtectedCells | WorksheetSelectProtectedCellsPermission | Can select protected cells | +| univerAPI.Enum.WorksheetPermissionPoint.SelectUnProtectedCells | WorksheetSelectUnProtectedCellsPermission | Can select unprotected cells | ### Range Protection [#range-point] @@ -459,12 +462,13 @@ In the case where the permission control of the workbook intersects with the wor | univerAPI.Enum.RangePermissionPoint.Edit | RangeProtectionPermissionEditPoint | Can edit protected ranges | | univerAPI.Enum.RangePermissionPoint.View | RangeProtectionPermissionViewPoint | Can view content of protected ranges | | univerAPI.Enum.RangePermissionPoint.Delete | RangeProtectionPermissionDeleteProtectionPoint | Can delete protected ranges | +| univerAPI.Enum.RangePermissionPoint.ManageCollaborator | RangeProtectionPermissionManageCollaPoint | Can manage collaborators for protected ranges | ## Configuration -### Protection Range Shadow Strategy +### Protected Range Shadow Strategy -The permission background shadow is displayed by default. You can hide it using the following code: +The protected range shadow is shown by default. You can hide it with the following configuration: @@ -505,7 +509,7 @@ The permission background shadow is displayed by default. You can hide it using -Also can be modified dynamically through the API: +You can also modify it dynamically via the API: ```typescript // Set to only show shadows for non-editable ranges @@ -526,7 +530,7 @@ subscription.unsubscribe() ### Custom User Component -Univer's built-in custom user components are limited in their adaptability. If you need more complex custom components, you can create them using the following method. +Univer's built-in user selector has limited flexibility. For more complex scenarios, you can provide a custom component as shown below. You can refer to [Custom Components](/guides/sheets/ui/components) for how to create custom components. @@ -541,7 +545,7 @@ Univer's built-in custom user components are limited in their adaptability. If y sheets: { protectedRangeUserSelector: { /** - * custom component, should implement the `IPermissionDetailUserPartProps` interface. + * Custom component; must implement the `IPermissionDetailUserPartProps` interface. */ component: CustomPermissionDetailUserPart, /** @@ -560,7 +564,7 @@ Univer's built-in custom user components are limited in their adaptability. If y univer.registerPlugin(UniverSheetsUIPlugin, { protectedRangeUserSelector: { /** - * custom component, should implement the `IPermissionDetailUserPartProps` interface. + * Custom component; must implement the `IPermissionDetailUserPartProps` interface. */ component: CustomPermissionDetailUserPart, /** @@ -573,7 +577,7 @@ Univer's built-in custom user components are limited in their adaptability. If y -After completing the custom user settings, please synchronize it to the `sheetPermissionUserManagerService` service's `_selectUserList` for later use. +After configuring your custom user component, synchronize the selected user list to `SheetPermissionUserManagerService` via `setSelectUserList()` for later use. @@ -612,17 +616,17 @@ const workbookPermission = fWorkbook.getWorkbookPermission() #### Set Workbook Permission Point -`WorkbookPermissionPoint` enum values list can be found in [Workbook Permission Points List](#workbook-point). +For the `WorkbookPermissionPoint` enum values, see the [workbook permission points list](#workbook-point). ```typescript const fWorkbook = univerAPI.getActiveWorkbook() const workbookPermission = fWorkbook.getWorkbookPermission() -// Set the workbook print permission to unavailable +// Disable the workbook print permission await workbookPermission.setPoint(univerAPI.Enum.WorkbookPermissionPoint.Print, false) ``` -Using predefined modes: +Predefined modes: ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -641,10 +645,10 @@ await workbookPermission.setMode('viewer') await workbookPermission.setMode('commenter') ``` -Using shortcut methods: +Shortcut methods: -- `FWorkbookPermission.setReadOnly()`: Set to read-only mode, equivalent to `setMode('viewer')` -- `FWorkbookPermission.setEditable()`: Set to editable mode, equivalent to `setMode('editor')` +- `FWorkbookPermission.setReadOnly()`: Sets read-only mode (equivalent to `setMode('viewer')`) +- `FWorkbookPermission.setEditable()`: Sets editable mode (equivalent to `setMode('editor')`) #### Get Workbook Permission Point Status @@ -652,24 +656,24 @@ Using shortcut methods: const fWorkbook = univerAPI.getActiveWorkbook() const workbookPermission = fWorkbook.getWorkbookPermission() -// Get workbook print permission status +// Check whether the workbook can be printed const canPrint = workbookPermission.getPoint(univerAPI.Enum.WorkbookPermissionPoint.Print) console.log('Can print:', canPrint) -// Get all workbook permission point statuses +// Get the status of all workbook permission points const snapshot = workbookPermission.getSnapshot() console.log('Workbook permission snapshot:', snapshot) ``` -Using shortcut methods: +Shortcut methods: -- `FWorkbookPermission.canEdit()`: Check if the workbook is editable +- `FWorkbookPermission.canEdit()`: Returns `true` if the workbook is editable #### Collaborator Management - Collaborator management related APIs are only available when using the collaborative editing feature and integrating with the USIP service. - When using a custom permission service, please refer to the "Integration of Third-Party Authorization Service" section above to implement the collaborator management logic yourself. + Collaborator management APIs are only available in collaborative editing scenarios with the USIP service integrated. + When using a custom permission service, implement collaborator management logic yourself as described in the "Integrating a Third-Party Authorization Service" section above. - Get Collaborators List @@ -700,14 +704,14 @@ await workbookPermission.setCollaborators([ }, ]) -// Add single Collaborator +// Add a single collaborator await workbookPermission.addCollaborator( { userID: 'user1', name: 'John Doe', avatar: 'https://...' }, univerAPI.Enum.UnitRole.Editor, ) ``` -- Update Collaborator Role +- Update collaborator role ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -719,7 +723,7 @@ await workbookPermission.updateCollaborator( ) ``` -- Remove Collaborators +- Remove collaborators ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -728,7 +732,7 @@ const workbookPermission = fWorkbook.getWorkbookPermission() // Remove multiple collaborators await workbookPermission.removeCollaborators(['user1', 'user2']) -// Remove single collaborator +// Remove a single collaborator await workbookPermission.removeCollaborator('user1') ``` @@ -749,7 +753,7 @@ const fWorkbook = univerAPI.getActiveWorkbook() const fWorksheet = fWorkbook.getActiveSheet() const worksheetPermission = fWorksheet.getWorksheetPermission() -// Set worksheet protection, allowing specified users to edit +// Protect the worksheet, allowing only specified users to edit const permissionId = await worksheetPermission.protect({ allowedUsers: ['user1', 'user2'], name: 'My Worksheet Protection', @@ -760,24 +764,24 @@ const isProtected = worksheetPermission.isProtected() console.log('Is worksheet protected:', isProtected) if (isProtected) { - // Remove worksheet protection + // Unprotect the worksheet await worksheetPermission.unprotect() } ``` #### Set Worksheet Permission Point -`WorksheetPermissionPoint` enum values list can be found in [Worksheet Permission Points List](#worksheet-point). +For the `WorksheetPermissionPoint` enum values, see the [worksheet permission points list](#worksheet-point). ```typescript const fWorkbook = univerAPI.getActiveWorkbook() const fWorksheet = fWorkbook.getActiveSheet() const worksheetPermission = fWorksheet.getWorksheetPermission() -// If you need to set permission points, you must first create worksheet protection +// To set permission points, you must first protect the worksheet await worksheetPermission.protect() -// Set the worksheet insert row permission to unavailable +// Disable the worksheet insert-row permission await worksheetPermission.setPoint(univerAPI.Enum.WorksheetPermissionPoint.InsertRow, false) ``` @@ -788,7 +792,7 @@ const fWorkbook = univerAPI.getActiveWorkbook() const fWorksheet = fWorkbook.getActiveSheet() const worksheetPermission = fWorksheet.getWorksheetPermission() -// If you need to set permission points, you must first create worksheet protection +// To set permission points, you must first protect the worksheet await worksheetPermission.protect() // Set to editable mode @@ -800,7 +804,7 @@ await worksheetPermission.setMode('readOnly') // Set to filter/sort only mode await worksheetPermission.setMode('filterOnly') -// Set to custom mode +// Apply a custom configuration await worksheetPermission.applyConfig({ mode: 'readOnly', points: { @@ -810,10 +814,10 @@ await worksheetPermission.applyConfig({ }) ``` -Using shortcut methods: +Shortcut methods: -- `FWorksheetPermission.setReadOnly()`: Set to read-only mode, equivalent to `setMode('readOnly')` -- `FWorksheetPermission.setEditable()`: Set to editable mode, equivalent to `setMode('editable')` +- `FWorksheetPermission.setReadOnly()`: Sets read-only mode (equivalent to `setMode('readOnly')`) +- `FWorksheetPermission.setEditable()`: Sets editable mode (equivalent to `setMode('editable')`) #### Get Worksheet Permission Point Status @@ -822,10 +826,10 @@ const fWorkbook = univerAPI.getActiveWorkbook() const fWorksheet = fWorkbook.getActiveSheet() const worksheetPermission = fWorksheet.getWorksheetPermission() -// Get worksheet insert row permission status +// Check whether the worksheet can insert rows const canInsertRow = worksheetPermission.getPoint(univerAPI.Enum.WorksheetPermissionPoint.InsertRow) -// Get all worksheet permission point statuses +// Get the status of all worksheet permission points const snapshot = worksheetPermission.getSnapshot() ``` @@ -850,14 +854,15 @@ const rangePermission = fRange.getRangePermission() #### Set Range Protection -- Set range protection using the worksheet-level permission: +- Protect ranges via the worksheet-level API: ```typescript const fWorkbook = univerAPI.getActiveWorkbook() const fWorksheet = fWorkbook.getActiveSheet() const worksheetPermission = fWorksheet.getWorksheetPermission() -// Set multiple protected ranges, A1:B2 is not editable but viewable by others, C3:D4 is editable by specified users but not viewable by others +// Protect two ranges: A1:B2 is viewable by everyone but not editable, +// while C3:D4 is editable only by specified users and hidden from others const rules = await worksheetPermission.protectRanges([ { ranges: [fWorksheet.getRange('A1:B2')], @@ -870,18 +875,18 @@ const rules = await worksheetPermission.protectRanges([ ]) console.log(rules) -// Get all protection rules for the worksheet +// List all protection rules on the worksheet const rules = await worksheetPermission.listRangeProtectionRules() console.log(rules) -// Delete the first protection rule +// Delete the first rule await worksheetPermission.unprotectRules([rules[0].id]) -// Or delete protection range through `FRangeProtectionRule.remove()` +// Or delete a rule via `FRangeProtectionRule.remove()` await ruleList[0].remove() ``` -- Set range protection using the range-level permission: +- Protect a range via the range-level API: ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -889,7 +894,7 @@ const fWorksheet = fWorkbook.getActiveSheet() const fRange = fWorksheet.getRange('A1:B2') const rangePermission = fRange.getRangePermission() -// Set protection for the range, allowing specified users to edit but not allowing others to view +// Protect the range so only specified users can edit it, while others cannot view it const rule = await rangePermission.protect({ name: 'My protected range', allowViewByOthers: false, @@ -897,20 +902,20 @@ const rule = await rangePermission.protect({ }) console.log(rule) -// Get all protection rules for the range +// List all protection rules covering the range const rules = await rangePermission.listRules() console.log(rules) -// Delete all protection rules for the range +// Delete all protection rules covering the range await rangePermission.unprotect() -// Or delete protection rules through `FRangeProtectionRule.remove()` +// Or delete a rule via `FRangeProtectionRule.remove()` await rules[0].remove() ``` #### Set Range Permission Point -`RangePermissionPoint` enum values list can be found in [Range Protection Points List](#range-point). +For the `RangePermissionPoint` enum values, see the [range protection points list](#range-point). ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -918,11 +923,11 @@ const fWorksheet = fWorkbook.getActiveSheet() const fRange = fWorksheet.getRange('A1:B2') const rangePermission = fRange.getRangePermission() -// If you need to set permission points, you must first create range protection +// To set permission points, you must first create a range protection rule if (rangePermission.isProtected()) { const rules = await rangePermission.listRules() - // Set the edit permission of the first protection rule to unavailable, and the view permission to available + // Disable editing but enable viewing for the first protection rule await rules[0].setPoint(univerAPI.Enum.RangePermissionPoint.Edit, false) await rules[0].setPoint(univerAPI.Enum.RangePermissionPoint.View, true) } else { @@ -932,7 +937,7 @@ if (rangePermission.isProtected()) { allowedUsers: ['user1', 'user2'], }) - // Set the edit permission of the A1:B2 selection to unavailable, and the view permission to available + // Disable editing but enable viewing for the A1:B2 range await rule.setPoint(univerAPI.Enum.RangePermissionPoint.Edit, false) await rule.setPoint(univerAPI.Enum.RangePermissionPoint.View, true) } @@ -940,7 +945,7 @@ if (rangePermission.isProtected()) { ### Range Permission Rule API -Here are some member methods of `FRangeProtectionRule`: +`FRangeProtectionRule` provides the following members: | API | Description | | --- | --- | @@ -955,6 +960,7 @@ Here are some member methods of `FRangeProtectionRule`: | `canEdit(): boolean` | Check if the protection rule allows editing | | `canView(): boolean` | Check if the protection rule allows viewing | | `canDelete(): boolean` | Check if the protection rule allows deletion | +| `canManageCollaborator(): boolean` | Check if the protection rule allows managing collaborators | | `getSnapshot(): RangePermissionSnapshot` | Get a snapshot of the current permission status of the protection rule, including all permission points | ```typescript @@ -964,7 +970,7 @@ const worksheetPermission = fWorksheet.getWorksheetPermission() const rules = await worksheetPermission.listRangeProtectionRules() const rule = rules?.[0] -// ID Get the ID of the first protection rule +// Get the ID of the first protection rule const ruleId = rule?.id console.log(ruleId) @@ -972,20 +978,20 @@ console.log(ruleId) const ranges = rule?.ranges console.log(ranges) -// A1:C3 Update the ranges of the first protection rule to A1:C3 +// Update the ranges of the first protection rule to A1:C3 await rule?.updateRanges([fWorksheet.getRange('A1:C3')]) // Remove the first protection rule await rule?.remove() ``` -### Remove Permission Dialog +### Hide the Permission Dialog ```typescript univerAPI.setPermissionDialogVisible(false) ``` -### Old API Migration Guide +### Migrating from the Old API @@ -1149,7 +1155,7 @@ univerAPI.setPermissionDialogVisible(false) FRangeProtectionRule.updateRanges(ranges: FRange[]) - + Old API:
diff --git a/content/guides/sheets/features/core/permission.zh-CN.mdx b/content/guides/sheets/features/core/permission.zh-CN.mdx index bee1ad5b..db346ac1 100644 --- a/content/guides/sheets/features/core/permission.zh-CN.mdx +++ b/content/guides/sheets/features/core/permission.zh-CN.mdx @@ -451,6 +451,9 @@ univer.registerPlugin(YourPlugin) | univerAPI.Enum.WorksheetPermissionPoint.InsertHyperlink | WorksheetInsertHyperlinkPermission | 能否使用超链接 | | univerAPI.Enum.WorksheetPermissionPoint.ManageCollaborator | WorksheetManageCollaboratorPermission | 能否管理协作者 | | univerAPI.Enum.WorksheetPermissionPoint.DeleteProtection | WorksheetDeleteProtectionPermission | 能否删除保护 | +| univerAPI.Enum.WorksheetPermissionPoint.EditExtraObject | WorksheetEditExtraObjectPermission | 能否编辑额外对象 | +| univerAPI.Enum.WorksheetPermissionPoint.SelectProtectedCells | WorksheetSelectProtectedCellsPermission | 能否选择受保护单元格 | +| univerAPI.Enum.WorksheetPermissionPoint.SelectUnProtectedCells | WorksheetSelectUnProtectedCellsPermission | 能否选择未受保护单元格 | ### 区域保护 [#range-point] @@ -459,6 +462,7 @@ univer.registerPlugin(YourPlugin) | univerAPI.Enum.RangePermissionPoint.Edit | RangeProtectionPermissionEditPoint | 能否编辑保护区域 | | univerAPI.Enum.RangePermissionPoint.View | RangeProtectionPermissionViewPoint | 能否查看保护区域的内容 | | univerAPI.Enum.RangePermissionPoint.Delete | RangeProtectionPermissionDeleteProtectionPoint | 能否删除保护区域 | +| univerAPI.Enum.RangePermissionPoint.ManageCollaborator | RangeProtectionPermissionManageCollaPoint | 能否管理保护区域的协作者 | ## 配置 @@ -955,6 +959,7 @@ if (rangePermission.isProtected()) { | `canEdit(): boolean` | 检查保护规则是否允许编辑 | | `canView(): boolean` | 检查保护规则是否允许查看 | | `canDelete(): boolean` | 检查保护规则是否允许删除 | +| `canManageCollaborator(): boolean` | 检查保护规则是否允许管理协作者 | | `getSnapshot(): RangePermissionSnapshot` | 获取保护规则的权限快照 | ```typescript diff --git a/content/guides/sheets/features/core/permission.zh-TW.mdx b/content/guides/sheets/features/core/permission.zh-TW.mdx index 2640526e..1a9cb6b6 100644 --- a/content/guides/sheets/features/core/permission.zh-TW.mdx +++ b/content/guides/sheets/features/core/permission.zh-TW.mdx @@ -451,6 +451,9 @@ univer.registerPlugin(YourPlugin) | univerAPI.Enum.WorksheetPermissionPoint.InsertHyperlink | WorksheetInsertHyperlinkPermission | 能否使用超連結 | | univerAPI.Enum.WorksheetPermissionPoint.ManageCollaborator | WorksheetManageCollaboratorPermission | 能否管理協作者 | | univerAPI.Enum.WorksheetPermissionPoint.DeleteProtection | WorksheetDeleteProtectionPermission | 能否刪除保護 | +| univerAPI.Enum.WorksheetPermissionPoint.EditExtraObject | WorksheetEditExtraObjectPermission | 能否編輯額外物件 | +| univerAPI.Enum.WorksheetPermissionPoint.SelectProtectedCells | WorksheetSelectProtectedCellsPermission | 能否選取受保護儲存格 | +| univerAPI.Enum.WorksheetPermissionPoint.SelectUnProtectedCells | WorksheetSelectUnProtectedCellsPermission | 能否選取未受保護儲存格 | ### 區域保護 [#range-point] @@ -459,6 +462,7 @@ univer.registerPlugin(YourPlugin) | univerAPI.Enum.RangePermissionPoint.Edit | RangeProtectionPermissionEditPoint | 能否編輯保護區域 | | univerAPI.Enum.RangePermissionPoint.View | RangeProtectionPermissionViewPoint | 能否檢視保護區域的內容 | | univerAPI.Enum.RangePermissionPoint.Delete | RangeProtectionPermissionDeleteProtectionPoint | 能否刪除保護區域 | +| univerAPI.Enum.RangePermissionPoint.ManageCollaborator | RangeProtectionPermissionManageCollaPoint | 能否管理保護區域的協作者 | ## 配置 @@ -955,6 +959,7 @@ if (rangePermission.isProtected()) { | `canEdit(): boolean` | 檢查保護規則是否允許編輯 | | `canView(): boolean` | 檢查保護規則是否允許檢視 | | `canDelete(): boolean` | 檢查保護規則是否允許刪除 | +| `canManageCollaborator(): boolean` | 檢查保護規則是否允許管理協作者 | | `getSnapshot(): RangePermissionSnapshot` | 獲取保護規則的快照資訊 | ```typescript diff --git a/content/guides/sheets/features/core/range-selection.ja-JP.mdx b/content/guides/sheets/features/core/range-selection.ja-JP.mdx index a22dfeaf..635563f9 100644 --- a/content/guides/sheets/features/core/range-selection.ja-JP.mdx +++ b/content/guides/sheets/features/core/range-selection.ja-JP.mdx @@ -10,7 +10,7 @@ title: 範囲・選択・セル ### Facade API -範囲関連 Facade API の完全な定義は [FRange FacadeAPI](https://reference.univer.ai/en-US/classes/FRange) を参照してください。 +範囲関連 Facade API の完全な定義は [FRange FacadeAPI](https://docs.univer.ai/reference/facade/range) を参照してください。 #### 範囲の生成 @@ -134,7 +134,7 @@ fRange.setValue({ }) ``` -範囲左上セルのみ設定したい場合は [`FRange.setValueForCell`](https://reference.univer.ai/en-US/classes/FRange#setvalueforcell)： +範囲左上セルのみ設定したい場合は [`FRange.setValueForCell`](https://docs.univer.ai/reference/facade/range#setvalueforcell)： ```typescript fRange.setValueForCell('Hello, Univer') @@ -183,9 +183,9 @@ fRange.setValues({ #### 範囲データのクリア -- [`FRange.clear`](https://reference.univer.ai/en-US/classes/FRange#clear)： コンテンツと書式をすべてクリア -- [`FRange.clearContent`](https://reference.univer.ai/en-US/classes/FRange#clearcontent)： コンテンツのみクリア -- [`FRange.clearFormat`](https://reference.univer.ai/en-US/classes/FRange#clearformat)： 書式のみクリア +- [`FRange.clear`](https://docs.univer.ai/reference/facade/range#clear)： コンテンツと書式をすべてクリア +- [`FRange.clearContent`](https://docs.univer.ai/reference/facade/range#clearcontent)： コンテンツのみクリア +- [`FRange.clearFormat`](https://docs.univer.ai/reference/facade/range#clearformat)： 書式のみクリア ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -235,7 +235,7 @@ fRange #### セル挿入 -[`FRange.insertCells`](https://reference.univer.ai/en-US/classes/FRange#insertcells) は指定範囲内に空セルを挿入し、指定次元方向に既存データを押し出します。 +[`FRange.insertCells`](https://docs.univer.ai/reference/facade/range#insertcells) は指定範囲内に空セルを挿入し、指定次元方向に既存データを押し出します。 ```typescript // アクティブシートは空と仮定 @@ -290,7 +290,7 @@ console.log(fWorksheet.getRange('A1:D5').getValues()) // [[null, null, 3, 4], [n #### セル削除 -[`FRange.deleteCells`](https://reference.univer.ai/zh-CN/classes/FRange#deletecells) は指定範囲を削除し、指定次元方向へデータを詰めます。 +[`FRange.deleteCells`](https://docs.univer.ai/reference/facade/range#deletecells) は指定範囲を削除し、指定次元方向へデータを詰めます。 ```typescript // アクティブシートは空と仮定 @@ -369,7 +369,7 @@ fRange2.breakApart() #### 範囲のハイライト -[`FRange.highlight`](https://reference.univer.ai/en-US/classes/FRange#highlight) は指定スタイルと主セル（primary cell）で範囲を強調表示します。 +[`FRange.highlight`](https://docs.univer.ai/reference/facade/range#highlight) は指定スタイルと主セル（primary cell）で範囲を強調表示します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -402,7 +402,7 @@ setTimeout(() => { #### テキストを列に分割 -[`FRange.splitTextToColumns`](https://reference.univer.ai/en-US/classes/FRange#splittexttocolumns) は指定した区切り文字に従いテキストを複数列へ分割します。 +[`FRange.splitTextToColumns`](https://docs.univer.ai/reference/facade/range#splittexttocolumns) は指定した区切り文字に従いテキストを複数列へ分割します。 デフォルト区切り文字の例: @@ -520,7 +520,7 @@ Univer Sheets は複数の離散的な選択範囲（マルチセレクション ### Facade API -選択関連 Facade API の完全な定義は [FSelection FacadeAPI](https://reference.univer.ai/en-US/classes/FSelection) を参照してください。 +選択関連 Facade API の完全な定義は [FSelection FacadeAPI](https://docs.univer.ai/reference/facade/selection) を参照してください。 #### アクティブ選択の取得 diff --git a/content/guides/sheets/features/core/range-selection.mdx b/content/guides/sheets/features/core/range-selection.mdx index 51985c65..dedcfb2d 100644 --- a/content/guides/sheets/features/core/range-selection.mdx +++ b/content/guides/sheets/features/core/range-selection.mdx @@ -10,7 +10,7 @@ Most operations in a spreadsheet can be performed through the Range API, such as ### Facade API -To get full definition of range related facade api, please refer to [FRange FacadeAPI](https://reference.univer.ai/en-US/classes/FRange) +To get full definition of range related facade api, please refer to [FRange FacadeAPI](https://docs.univer.ai/reference/facade/range) #### Create a Range @@ -134,7 +134,7 @@ fRange.setValue({ }) ``` -If you only want to set the value of the top-left cell in the range, you can use the [`FRange.setValueForCell`](https://reference.univer.ai/en-US/classes/FRange#setvalueforcell) method: +If you only want to set the value of the top-left cell in the range, you can use the [`FRange.setValueForCell`](https://docs.univer.ai/reference/facade/range#setvalueforcell) method: ```typescript fRange.setValueForCell('Hello, Univer') @@ -183,9 +183,9 @@ fRange.setValues({ #### Clear Range data -- [`FRange.clear`](https://reference.univer.ai/en-US/classes/FRange#clear) method can clear the content and format information of the range. -- [`FRange.clearContent`](https://reference.univer.ai/en-US/classes/FRange#clearcontent) method can clear the content information of the range. -- [`FRange.clearFormat`](https://reference.univer.ai/en-US/classes/FRange#clearformat) method can clear the format information of the range. +- [`FRange.clear`](https://docs.univer.ai/reference/facade/range#clear) method can clear the content and format information of the range. +- [`FRange.clearContent`](https://docs.univer.ai/reference/facade/range#clearcontent) method can clear the content information of the range. +- [`FRange.clearFormat`](https://docs.univer.ai/reference/facade/range#clearformat) method can clear the format information of the range. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -235,7 +235,7 @@ fRange #### Insert Cells -[`FRange.insertCells`](https://reference.univer.ai/en-US/classes/FRange#insertcells) method can inserts empty cells into this range. Existing data in the sheet along the provided dimension is shifted away from the inserted range. +[`FRange.insertCells`](https://docs.univer.ai/reference/facade/range#insertcells) method can inserts empty cells into this range. Existing data in the sheet along the provided dimension is shifted away from the inserted range. ```typescript // Assume the active sheet empty sheet. @@ -290,7 +290,7 @@ console.log(fWorksheet.getRange('A1:D5').getValues()) // [[null, null, 3, 4], [n #### Delete Cells -[`FRange.deleteCells`](https://reference.univer.ai/zh-CN/classes/FRange#deletecells) method can deletes this range of cells. Existing data in the sheet along the provided dimension is shifted towards the deleted range. +[`FRange.deleteCells`](https://docs.univer.ai/reference/facade/range#deletecells) method can deletes this range of cells. Existing data in the sheet along the provided dimension is shifted towards the deleted range. ```typescript // Assume the active sheet empty sheet. @@ -369,7 +369,7 @@ fRange2.breakApart() #### Highlight Range -[`FRange.highlight`](https://reference.univer.ai/en-US/classes/FRange#highlight) method can highlight the range with the specified style and primary cell. +[`FRange.highlight`](https://docs.univer.ai/reference/facade/range#highlight) method can highlight the range with the specified style and primary cell. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -402,7 +402,7 @@ setTimeout(() => { #### Split text into columns -[`FRange.splitTextToColumns`](https://reference.univer.ai/en-US/classes/FRange#splittexttocolumns) method can split the text in the range into columns accrording to the specified delimiter. +[`FRange.splitTextToColumns`](https://docs.univer.ai/reference/facade/range#splittexttocolumns) method can split the text in the range into columns accrording to the specified delimiter. Default delimiter example: @@ -520,7 +520,7 @@ We also provide APIs to get the current selection, set the selection, and listen ### Facade API -To get full definition of selection related facade api, please refer to [FSelection FacadeAPI](https://reference.univer.ai/en-US/classes/FSelection) +To get full definition of selection related facade api, please refer to [FSelection FacadeAPI](https://docs.univer.ai/reference/facade/selection) #### Get Active Selection @@ -576,7 +576,7 @@ console.log(fWorksheet.getRange(newRow, newColumn).getA1Notation()) // B11 #### Disable/Enable/Hide/Show Selection -After disabled, there would be no response for selection. Set selection invisible, Unlike disableSelection, selection still works, you just can not see them. +When disabled, selection becomes unresponsive. `hideSelection` makes the selection invisible—unlike `disableSelection`, selection still works; you just cannot see it. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() diff --git a/content/guides/sheets/features/core/range-selection.zh-CN.mdx b/content/guides/sheets/features/core/range-selection.zh-CN.mdx index ef489f89..df31bb71 100644 --- a/content/guides/sheets/features/core/range-selection.zh-CN.mdx +++ b/content/guides/sheets/features/core/range-selection.zh-CN.mdx @@ -10,7 +10,7 @@ title: 范围 & 选区 & 单元格 ### Facade API -范围完整 Facade API 类型定义，请查看 [FRange Facade API](https://reference.univer.ai/zh-CN/classes/FRange) +范围完整 Facade API 类型定义，请查看 [FRange Facade API](https://docs.univer.ai/reference/facade/range) #### 创建范围 @@ -134,7 +134,7 @@ fRange.setValue({ }) ``` -如果只想设置范围左上角的单元格值，可以使用 [`FRange.setValueForCell`](https://reference.univer.ai/zh-CN/classes/FRange#setvalueforcell) 方法： +如果只想设置范围左上角的单元格值，可以使用 [`FRange.setValueForCell`](https://docs.univer.ai/reference/facade/range#setvalueforcell) 方法： ```typescript fRange.setValueForCell('Hello, Univer') @@ -183,9 +183,9 @@ fRange.setValues({ #### 清理范围数据 -- [`FRange.clear`](https://reference.univer.ai/zh-CN/classes/FRange#clear) 方法可以清理范围的内容和格式信息。 -- [`FRange.clearContent`](https://reference.univer.ai/zh-CN/classes/FRange#clearcontent) 方法可以清理范围的内容信息。 -- [`FRange.clearFormat`](https://reference.univer.ai/zh-CN/classes/FRange#clearformat) 方法可以清理范围的格式信息。 +- [`FRange.clear`](https://docs.univer.ai/reference/facade/range#clear) 方法可以清理范围的内容和格式信息。 +- [`FRange.clearContent`](https://docs.univer.ai/reference/facade/range#clearcontent) 方法可以清理范围的内容信息。 +- [`FRange.clearFormat`](https://docs.univer.ai/reference/facade/range#clearformat) 方法可以清理范围的格式信息。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -235,7 +235,7 @@ fRange #### 插入单元格 -[`FRange.insertCells`](https://reference.univer.ai/zh-CN/classes/FRange#insertcells) 方法可以在此范围内插入空单元格。工作表中沿指定维度的现有数据将移离插入的范围。 +[`FRange.insertCells`](https://docs.univer.ai/reference/facade/range#insertcells) 方法可以在此范围内插入空单元格。工作表中沿指定维度的现有数据将移离插入的范围。 ```typescript // 假设当前工作表是空工作表 @@ -290,7 +290,7 @@ console.log(fWorksheet.getRange('A1:D5').getValues()) // [[null, null, 3, 4], [n #### 删除单元格 -[`FRange.deleteCells`](https://reference.univer.ai/zh-CN/classes/FRange#deletecells) 方法可以在范围内删除单元格。工作表中沿指定维度的现有数据将向已删除的范围移动。 +[`FRange.deleteCells`](https://docs.univer.ai/reference/facade/range#deletecells) 方法可以在范围内删除单元格。工作表中沿指定维度的现有数据将向已删除的范围移动。 ```typescript // 假设当前工作表是空工作表 @@ -369,7 +369,7 @@ fRange2.breakApart() #### 高亮范围 -[`FRange.highlight`](https://reference.univer.ai/en-US/classes/FRange#highlight) 方法可以使用指定样式和主单元格高亮范围。 +[`FRange.highlight`](https://docs.univer.ai/reference/facade/range#highlight) 方法可以使用指定样式和主单元格高亮范围。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -402,7 +402,7 @@ setTimeout(() => { #### 数据分列 -[`FRange.splitTextToColumns`](https://reference.univer.ai/zh-CN/classes/FRange#splittexttocolumns) 方法可以将单元格中的文本按指定分隔符分列。 +[`FRange.splitTextToColumns`](https://docs.univer.ai/reference/facade/range#splittexttocolumns) 方法可以将单元格中的文本按指定分隔符分列。 默认分隔符示例： @@ -520,7 +520,7 @@ Univer 表格支持多选区，所以选区是一个范围数组，可以通过 ### Facade API -选区完整 Facade API 类型定义，请查看 [FSelection Facade API](https://reference.univer.ai/zh-CN/classes/FSelection) +选区完整 Facade API 类型定义，请查看 [FSelection Facade API](https://docs.univer.ai/reference/facade/selection) #### 获取激活选区的范围 diff --git a/content/guides/sheets/features/core/range-selection.zh-TW.mdx b/content/guides/sheets/features/core/range-selection.zh-TW.mdx index 3cf32ac8..dd2e47e9 100644 --- a/content/guides/sheets/features/core/range-selection.zh-TW.mdx +++ b/content/guides/sheets/features/core/range-selection.zh-TW.mdx @@ -10,7 +10,7 @@ title: 範圍 & 選區 & 單元格 ### Facade API -範圍完整 Facade API 型別定義，請檢視 [FRange Facade API](https://reference.univer.ai/zh-TW/classes/FRange) +範圍完整 Facade API 型別定義，請檢視 [FRange Facade API](https://docs.univer.ai/reference/facade/range) #### 建立範圍 @@ -134,7 +134,7 @@ fRange.setValue({ }) ``` -如果只想設定範圍左上角的單元格值，可以使用 [`FRange.setValueForCell`](https://reference.univer.ai/zh-TW/classes/FRange#setvalueforcell) 方法： +如果只想設定範圍左上角的單元格值，可以使用 [`FRange.setValueForCell`](https://docs.univer.ai/reference/facade/range#setvalueforcell) 方法： ```typescript fRange.setValueForCell('Hello, Univer') @@ -183,9 +183,9 @@ fRange.setValues({ #### 清理範圍資料 -- [`FRange.clear`](https://reference.univer.ai/zh-TW/classes/FRange#clear) 方法可以清理範圍的內容和格式資訊。 -- [`FRange.clearContent`](https://reference.univer.ai/zh-TW/classes/FRange#clearcontent) 方法可以清理範圍的內容資訊。 -- [`FRange.clearFormat`](https://reference.univer.ai/zh-TW/classes/FRange#clearformat) 方法可以清理範圍的格式資訊。 +- [`FRange.clear`](https://docs.univer.ai/reference/facade/range#clear) 方法可以清理範圍的內容和格式資訊。 +- [`FRange.clearContent`](https://docs.univer.ai/reference/facade/range#clearcontent) 方法可以清理範圍的內容資訊。 +- [`FRange.clearFormat`](https://docs.univer.ai/reference/facade/range#clearformat) 方法可以清理範圍的格式資訊。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -235,7 +235,7 @@ fRange #### 插入單元格 -[`FRange.insertCells`](https://reference.univer.ai/zh-TW/classes/FRange#insertcells) 方法可以在此範圍內插入空單元格。工作表中沿指定維度的現有資料將移離插入的範圍。 +[`FRange.insertCells`](https://docs.univer.ai/reference/facade/range#insertcells) 方法可以在此範圍內插入空單元格。工作表中沿指定維度的現有資料將移離插入的範圍。 ```typescript // 假設當前工作表是空工作表 @@ -290,7 +290,7 @@ console.log(fWorksheet.getRange('A1:D5').getValues()) // [[null, null, 3, 4], [n #### 刪除單元格 -[`FRange.deleteCells`](https://reference.univer.ai/zh-TW/classes/FRange#deletecells) 方法可以在範圍內刪除單元格。工作表中沿指定維度的現有資料將向已刪除的範圍移動。 +[`FRange.deleteCells`](https://docs.univer.ai/reference/facade/range#deletecells) 方法可以在範圍內刪除單元格。工作表中沿指定維度的現有資料將向已刪除的範圍移動。 ```typescript // 假設當前工作表是空工作表 @@ -369,7 +369,7 @@ fRange2.breakApart() #### 高亮範圍 -[`FRange.highlight`](https://reference.univer.ai/en-US/classes/FRange#highlight) 方法可以使用指定樣式和主單元格高亮範圍。 +[`FRange.highlight`](https://docs.univer.ai/reference/facade/range#highlight) 方法可以使用指定樣式和主單元格高亮範圍。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -402,7 +402,7 @@ setTimeout(() => { #### 資料分列 -[`FRange.splitTextToColumns`](https://reference.univer.ai/zh-TW/classes/FRange#splittexttocolumns) 方法可以將單元格中的文字按指定分隔符分列。 +[`FRange.splitTextToColumns`](https://docs.univer.ai/reference/facade/range#splittexttocolumns) 方法可以將單元格中的文字按指定分隔符分列。 預設分隔符示例： @@ -520,7 +520,7 @@ Univer 表格支援多選區，所以選區是一個範圍陣列，可以透過 ### Facade API -選區完整 Facade API 型別定義，請檢視 [FSelection Facade API](https://reference.univer.ai/zh-TW/classes/FSelection) +選區完整 Facade API 型別定義，請檢視 [FSelection Facade API](https://docs.univer.ai/reference/facade/selection) #### 獲取啟用選區的範圍 diff --git a/content/guides/sheets/features/core/rich-text.ja-JP.mdx b/content/guides/sheets/features/core/rich-text.ja-JP.mdx index 97957960..49c9b7de 100644 --- a/content/guides/sheets/features/core/rich-text.ja-JP.mdx +++ b/content/guides/sheets/features/core/rich-text.ja-JP.mdx @@ -100,7 +100,7 @@ const indentedStyle = univerAPI.newParagraphStyle() ### 1. セルのリッチテキスト -セルにリッチテキストを設定する方法は2通りあります（[`setRichTextValueForCell`](https://reference.univer.ai/en-US/classes/FRange#setrichtextvalueforcell) と [`setRichTextValues`](https://reference.univer.ai/en-US/classes/FRange#setrichtextvalues)）。 +セルにリッチテキストを設定する方法は2通りあります（[`setRichTextValueForCell`](https://docs.univer.ai/reference/facade/range#setrichtextvalueforcell) と [`setRichTextValues`](https://docs.univer.ai/reference/facade/range#setrichtextvalues)）。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() diff --git a/content/guides/sheets/features/core/rich-text.mdx b/content/guides/sheets/features/core/rich-text.mdx index a5a6b71b..bad00278 100644 --- a/content/guides/sheets/features/core/rich-text.mdx +++ b/content/guides/sheets/features/core/rich-text.mdx @@ -100,7 +100,7 @@ const indentedStyle = univerAPI.newParagraphStyle() ### 1. Cell Rich Text -There are two ways to set rich text for cells: [`setRichTextValueForCell`](https://reference.univer.ai/en-US/classes/FRange#setrichtextvalueforcell) and [`setRichTextValues`](https://reference.univer.ai/en-US/classes/FRange#setrichtextvalues). +There are two ways to set rich text for cells: [`setRichTextValueForCell`](https://docs.univer.ai/reference/facade/range#setrichtextvalueforcell) and [`setRichTextValues`](https://docs.univer.ai/reference/facade/range#setrichtextvalues). ```typescript const fWorkbook = univerAPI.getActiveWorkbook() diff --git a/content/guides/sheets/features/core/rich-text.zh-CN.mdx b/content/guides/sheets/features/core/rich-text.zh-CN.mdx index 8358243d..a22865d6 100644 --- a/content/guides/sheets/features/core/rich-text.zh-CN.mdx +++ b/content/guides/sheets/features/core/rich-text.zh-CN.mdx @@ -100,7 +100,7 @@ const indentedStyle = univerAPI.newParagraphStyle() ### 1. 单元格富文本 -有两种方式可以设置单元格的富文本：[`setRichTextValueForCell`](https://reference.univer.ai/zh-CN/classes/FRange#setrichtextvalueforcell) 和 [`setRichTextValues`](https://reference.univer.ai/zh-CN/classes/FRange#setrichtextvalues)。 +有两种方式可以设置单元格的富文本：[`setRichTextValueForCell`](https://docs.univer.ai/reference/facade/range#setrichtextvalueforcell) 和 [`setRichTextValues`](https://docs.univer.ai/reference/facade/range#setrichtextvalues)。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() diff --git a/content/guides/sheets/features/core/rich-text.zh-TW.mdx b/content/guides/sheets/features/core/rich-text.zh-TW.mdx index 12585346..ce539691 100644 --- a/content/guides/sheets/features/core/rich-text.zh-TW.mdx +++ b/content/guides/sheets/features/core/rich-text.zh-TW.mdx @@ -100,7 +100,7 @@ const indentedStyle = univerAPI.newParagraphStyle() ### 1. 單元格富文字 -有兩種方式可以設定單元格的富文字：[`setRichTextValueForCell`](https://reference.univer.ai/zh-TW/classes/FRange#setrichtextvalueforcell) 和 [`setRichTextValues`](https://reference.univer.ai/zh-TW/classes/FRange#setrichtextvalues)。 +有兩種方式可以設定單元格的富文字：[`setRichTextValueForCell`](https://docs.univer.ai/reference/facade/range#setrichtextvalueforcell) 和 [`setRichTextValues`](https://docs.univer.ai/reference/facade/range#setrichtextvalues)。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() diff --git a/content/guides/sheets/features/core/row-col.ja-JP.mdx b/content/guides/sheets/features/core/row-col.ja-JP.mdx index 2310ac5f..e451dece 100644 --- a/content/guides/sheets/features/core/row-col.ja-JP.mdx +++ b/content/guides/sheets/features/core/row-col.ja-JP.mdx @@ -10,7 +10,7 @@ title: 行と列 #### 指定位置の直後に行を挿入 -[`insertRowAfter(afterPosition)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertrowafter)：指定した行位置の直後に 1 行挿入します。 +[`insertRowAfter(afterPosition)`](https://docs.univer.ai/reference/facade/worksheet#insertrowafter)：指定した行位置の直後に 1 行挿入します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -21,7 +21,7 @@ sheet.insertRowAfter(0) #### 指定位置の直前に行を挿入 -[`insertRowBefore(beforePosition)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertrowbefore)：指定した行位置の直前に 1 行挿入します。 +[`insertRowBefore(beforePosition)`](https://docs.univer.ai/reference/facade/worksheet#insertrowbefore)：指定した行位置の直前に 1 行挿入します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -32,7 +32,7 @@ sheet.insertRowBefore(0) #### 指定位置から複数行を挿入 -[`insertRows(rowIndex, numRows)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertrows)：指定開始位置から連続する空白行を 1 行以上挿入します。 +[`insertRows(rowIndex, numRows)`](https://docs.univer.ai/reference/facade/worksheet#insertrows)：指定開始位置から連続する空白行を 1 行以上挿入します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -43,7 +43,7 @@ sheet.insertRows(0, 3) #### 指定行の直後に複数行を挿入 -[`insertRowsAfter(afterPosition, howMany)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertrowsafter)：指定した行位置の直後に複数行を挿入します。 +[`insertRowsAfter(afterPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertrowsafter)：指定した行位置の直後に複数行を挿入します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -54,7 +54,7 @@ sheet.insertRowsAfter(0, 5) #### 指定行の直前に複数行を挿入 -[`insertRowsBefore(beforePosition, howMany)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertrowsbefore)：指定した行位置の直前に複数行を挿入します。 +[`insertRowsBefore(beforePosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertrowsbefore)：指定した行位置の直前に複数行を挿入します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -65,7 +65,7 @@ sheet.insertRowsBefore(0, 5) #### 指定位置の行を削除 -[`deleteRow(rowPosition)`](https://reference.univer.ai/en-US/classes/FWorksheet#deleterow)：指定した位置の 1 行を削除します。 +[`deleteRow(rowPosition)`](https://docs.univer.ai/reference/facade/worksheet#deleterow)：指定した位置の 1 行を削除します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -76,7 +76,7 @@ sheet.deleteRow(0) #### 指定位置から複数行を削除 -[`deleteRows(rowPosition, howMany)`](https://reference.univer.ai/en-US/classes/FWorksheet#deleterows)：指定した開始位置から複数行を削除します。 +[`deleteRows(rowPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#deleterows)：指定した開始位置から複数行を削除します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -87,7 +87,7 @@ sheet.deleteRows(0, 2) #### 複数行（不連続）を削除 -[`deleteRowsByPoints(rowPoints)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#deleterowsbypoints): 指定された行位置の配列に基づいて、複数の行（不連続）を削除します。 +[`deleteRowsByPoints(rowPoints)`](https://docs.univer.ai/reference/facade/worksheet#deleterowsbypoints): 指定された行位置の配列に基づいて、複数の行（不連続）を削除します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -98,7 +98,7 @@ fWorksheet.deleteRowsByPoints([2, [4, 6]]) #### 行を新しい位置へ移動 -[`moveRows(rowSpec, destinationIndex)`](https://reference.univer.ai/en-US/classes/FWorksheet#moverows)：指定範囲に含まれるすべての行を `destinationIndex` の位置へ移動します。`rowSpec` は行全体を完全に指定している必要はなく、その範囲が跨る行すべてが対象となります。 +[`moveRows(rowSpec, destinationIndex)`](https://docs.univer.ai/reference/facade/worksheet#moverows)：指定範囲に含まれるすべての行を `destinationIndex` の位置へ移動します。`rowSpec` は行全体を完全に指定している必要はなく、その範囲が跨る行すべてが対象となります。 ```typescript // 下記コードは行 1-2 (表示上 2-3 行目) を宛先インデックス 5 に移動 @@ -112,7 +112,7 @@ sheet.moveRows(rowSpec, 5) #### 範囲内の行を非表示 -[`hideRow(row)`](https://reference.univer.ai/en-US/classes/FWorksheet#hiderow)：指定範囲内の行を非表示にします。 +[`hideRow(row)`](https://docs.univer.ai/reference/facade/worksheet#hiderow)：指定範囲内の行を非表示にします。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -124,7 +124,7 @@ sheet.hideRow(range) #### 連続する複数行を非表示 -[`hideRows(rowIndex, numRows)`](https://reference.univer.ai/en-US/classes/FWorksheet#hiderows)：指定インデックスから 0 起算で連続する複数行を非表示にします。 +[`hideRows(rowIndex, numRows)`](https://docs.univer.ai/reference/facade/worksheet#hiderows)：指定インデックスから 0 起算で連続する複数行を非表示にします。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -135,7 +135,7 @@ sheet.hideRows(0, 3) #### 範囲内の行を再表示 -[`unhideRow(row)`](https://reference.univer.ai/en-US/classes/FWorksheet#unhiderow)：指定範囲の行を再表示します。 +[`unhideRow(row)`](https://docs.univer.ai/reference/facade/worksheet#unhiderow)：指定範囲の行を再表示します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -147,7 +147,7 @@ sheet.unhideRow(range) #### 連続する複数行を再表示 -[`showRows(rowIndex, numRows)`](https://reference.univer.ai/en-US/classes/FWorksheet#showrows)：指定インデックスから 0 起算で連続する複数行を再表示します。 +[`showRows(rowIndex, numRows)`](https://docs.univer.ai/reference/facade/worksheet#showrows)：指定インデックスから 0 起算で連続する複数行を再表示します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -158,7 +158,7 @@ sheet.showRows(0, 3) #### 行の高さを設定 -[`setRowHeight(rowPosition, height)`](https://reference.univer.ai/en-US/classes/FWorksheet#setrowheight)：指定行の高さ（ピクセル）を設定します。既定ではセル内容に応じて自動伸長します。固定したい場合は `setRowHeightsForced(startRow, numRows, height)` を使用してください。 +[`setRowHeight(rowPosition, height)`](https://docs.univer.ai/reference/facade/worksheet#setrowheight)：指定行の高さ（ピクセル）を設定します。既定ではセル内容に応じて自動伸長します。固定したい場合は `setRowHeightsForced(startRow, numRows, height)` を使用してください。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -169,7 +169,7 @@ sheet.setRowHeight(0, 200) #### 複数行の高さを設定 -[`setRowHeights(startRow, numRows, height)`](https://reference.univer.ai/en-US/classes/FWorksheet#setrowheights)：指定範囲の複数行の高さを設定します。自動伸長は維持されます。 +[`setRowHeights(startRow, numRows, height)`](https://docs.univer.ai/reference/facade/worksheet#setrowheights)：指定範囲の複数行の高さを設定します。自動伸長は維持されます。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -180,7 +180,7 @@ sheet.setRowHeights(0, 3, 200) #### 複数行の高さを強制固定 -[`setRowHeightsForced(startRow, numRows, height)`](https://reference.univer.ai/en-US/classes/FWorksheet#setrowheightsforced): セル内容より小さくても指定高さに強制固定します。 +[`setRowHeightsForced(startRow, numRows, height)`](https://docs.univer.ai/reference/facade/worksheet#setrowheightsforced): セル内容より小さくても指定高さに強制固定します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -191,7 +191,7 @@ sheet.setRowHeightsForced(0, 3, 5) #### 行の自動高さ調整 -[`autoResizeRows(startRow, numRows)`](https://reference.univer.ai/en-US/classes/FWorksheet#autoresizerows): テキスト内容に合わせて自動で高さを調整します。 +[`autoResizeRows(startRow, numRows)`](https://docs.univer.ai/reference/facade/worksheet#autoresizerows): テキスト内容に合わせて自動で高さを調整します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -202,7 +202,7 @@ sheet.autoResizeRows(0, 3) #### 行のカスタムプロパティ設定 -[`setRowCustom(custom)`](https://reference.univer.ai/en-US/classes/FWorksheet#setrowcustom)：指定行に JSON 互換の任意データを格納する `custom` プロパティを設定します。 +[`setRowCustom(custom)`](https://docs.univer.ai/reference/facade/worksheet#setrowcustom)：指定行に JSON 互換の任意データを格納する `custom` プロパティを設定します。 更新時は既存の `custom` を上書きするため、保持したい場合は取得後マージしてください。 ```typescript @@ -219,7 +219,7 @@ sheet.setRowCustom({ #### 指定位置の直後に列を挿入 -[`insertColumnAfter(afterPosition)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertcolumnafter)：指定した列位置の直後に 1 列挿入します。 +[`insertColumnAfter(afterPosition)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnafter)：指定した列位置の直後に 1 列挿入します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -230,7 +230,7 @@ sheet.insertColumnAfter(0) #### 指定位置の直前に列を挿入 -[`insertColumnBefore(beforePosition)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertcolumnbefore)：指定した列位置の直前に 1 列挿入します。 +[`insertColumnBefore(beforePosition)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnbefore)：指定した列位置の直前に 1 列挿入します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -241,7 +241,7 @@ sheet.insertColumnBefore(0) #### 指定位置から複数列を挿入 -[`insertColumns(columnIndex, numColumns)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertcolumns)：指定開始位置から連続する空白列を挿入します。 +[`insertColumns(columnIndex, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumns)：指定開始位置から連続する空白列を挿入します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -252,7 +252,7 @@ sheet.insertColumns(0, 3) #### 指定列の直後に複数列を挿入 -[`insertColumnsAfter(afterPosition, howMany)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertcolumnsafter)：指定した列位置の直後に複数列を挿入します。 +[`insertColumnsAfter(afterPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnsafter)：指定した列位置の直後に複数列を挿入します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -263,7 +263,7 @@ sheet.insertColumnsAfter(0, 2) #### 指定列の直前に複数列を挿入 -[`insertColumnsBefore(beforePosition, howMany)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertcolumnsbefore)：指定した列位置の直前に複数列を挿入します。 +[`insertColumnsBefore(beforePosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnsbefore)：指定した列位置の直前に複数列を挿入します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -274,7 +274,7 @@ sheet.insertColumnsBefore(0, 5) #### 指定位置の列を削除 -[`deleteColumn(columnPosition)`](https://reference.univer.ai/en-US/classes/FWorksheet#deletecolumn)：指定位置の列を削除します。 +[`deleteColumn(columnPosition)`](https://docs.univer.ai/reference/facade/worksheet#deletecolumn)：指定位置の列を削除します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -285,7 +285,7 @@ sheet.deleteColumn(0) #### 指定位置から複数列を削除 -[`deleteColumns(columnPosition, howMany)`](https://reference.univer.ai/en-US/classes/FWorksheet#deletecolumns)：指定開始位置から複数列を削除します。 +[`deleteColumns(columnPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#deletecolumns)：指定開始位置から複数列を削除します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -296,7 +296,7 @@ sheet.deleteColumns(0, 2) #### 複数列（不連続）を削除 -[`deleteColumnsByPoints(columnPoints)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#deletecolumnsbypoints): 指定された列位置の配列に基づいて、複数の列（不連続）を削除します。 +[`deleteColumnsByPoints(columnPoints)`](https://docs.univer.ai/reference/facade/worksheet#deletecolumnsbypoints): 指定された列位置の配列に基づいて、複数の列（不連続）を削除します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -307,7 +307,7 @@ fWorksheet.deleteColumnsByPoints([2, [4, 6]]) #### 列を新しい位置へ移動 -[`moveColumns(columnSpec, destinationIndex)`](https://reference.univer.ai/en-US/classes/FWorksheet#movecolumns)：指定範囲が跨るすべての列を `destinationIndex` へ移動します。`columnSpec` が列全体を完全指定している必要はありません。 +[`moveColumns(columnSpec, destinationIndex)`](https://docs.univer.ai/reference/facade/worksheet#movecolumns)：指定範囲が跨るすべての列を `destinationIndex` へ移動します。`columnSpec` が列全体を完全指定している必要はありません。 ```typescript // 下記コードは列 A-B を宛先インデックス 5 へ移動 @@ -321,7 +321,7 @@ sheet.moveColumns(columnSpec, 5) #### 範囲内の列を非表示 -[`hideColumn(column)`](https://reference.univer.ai/en-US/classes/FWorksheet#hidecolumn)：指定範囲の列を非表示にします。 +[`hideColumn(column)`](https://docs.univer.ai/reference/facade/worksheet#hidecolumn)：指定範囲の列を非表示にします。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -333,7 +333,7 @@ sheet.hideColumn(range) #### 連続する複数列を非表示 -[`hideColumns(columnIndex, numColumns)`](https://reference.univer.ai/en-US/classes/FWorksheet#hidecolumns)：指定インデックスから 0 起算で連続する複数列を非表示にします。 +[`hideColumns(columnIndex, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#hidecolumns)：指定インデックスから 0 起算で連続する複数列を非表示にします。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -344,7 +344,7 @@ sheet.hideColumns(0, 3) #### 範囲内の列を再表示 -[`unhideColumn(column)`](https://reference.univer.ai/en-US/classes/FWorksheet#unhidecolumn)：指定範囲の列を再表示します。 +[`unhideColumn(column)`](https://docs.univer.ai/reference/facade/worksheet#unhidecolumn)：指定範囲の列を再表示します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -356,7 +356,7 @@ sheet.unhideColumn(range) #### 連続する複数列を再表示 -[`showColumns(columnIndex, numColumns)`](https://reference.univer.ai/en-US/classes/FWorksheet#showcolumns)：指定インデックスから 0 起算で連続する複数列を再表示します。 +[`showColumns(columnIndex, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#showcolumns)：指定インデックスから 0 起算で連続する複数列を再表示します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -367,7 +367,7 @@ sheet.showColumns(0, 3) #### 列幅を設定 -[`setColumnWidth(columnPosition, width)`](https://reference.univer.ai/en-US/classes/FWorksheet#setcolumnwidth)：指定列の幅（ピクセル）を設定します。 +[`setColumnWidth(columnPosition, width)`](https://docs.univer.ai/reference/facade/worksheet#setcolumnwidth)：指定列の幅（ピクセル）を設定します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -378,7 +378,7 @@ sheet.setColumnWidth(0, 200) #### 複数列の幅を設定 -[`setColumnWidths(startColumn, numColumns, width)`](https://reference.univer.ai/en-US/classes/FWorksheet#setcolumnwidths)：指定範囲の複数列の幅（ピクセル）を設定します。 +[`setColumnWidths(startColumn, numColumns, width)`](https://docs.univer.ai/reference/facade/worksheet#setcolumnwidths)：指定範囲の複数列の幅（ピクセル）を設定します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -389,7 +389,7 @@ sheet.setColumnWidths(0, 3, 200) #### 列幅を自動調整 -[`autoResizeColumns(startColumn, numColumns)`](https://reference.univer.ai/en-US/classes/FWorksheet#autoresizecolumns)：指定範囲列の内容に最適な幅へ自動調整します。 +[`autoResizeColumns(startColumn, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#autoresizecolumns)：指定範囲列の内容に最適な幅へ自動調整します。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -400,7 +400,7 @@ sheet.autoResizeColumns(0, 3) #### 列のカスタムプロパティ設定 -[`setColumnCustom(custom)`](https://reference.univer.ai/en-US/classes/FWorksheet#setcolumncustom)：指定列に JSON 互換データを格納する `custom` プロパティを設定します。 +[`setColumnCustom(custom)`](https://docs.univer.ai/reference/facade/worksheet#setcolumncustom)：指定列に JSON 互換データを格納する `custom` プロパティを設定します。 更新は既存 `custom` を上書きするため、保持が必要な場合は取得後マージしてください。 ```typescript diff --git a/content/guides/sheets/features/core/row-col.mdx b/content/guides/sheets/features/core/row-col.mdx index 0324bbcf..b727c3fa 100644 --- a/content/guides/sheets/features/core/row-col.mdx +++ b/content/guides/sheets/features/core/row-col.mdx @@ -10,7 +10,7 @@ Complete Facade API type definitions can be found in the [Facade API](https://re #### Insert row after given position -[`insertRowAfter(afterPosition)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertrowafter): Inserts a row after the specified row position. +[`insertRowAfter(afterPosition)`](https://docs.univer.ai/reference/facade/worksheet#insertrowafter): Inserts a row after the specified row position. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -21,7 +21,7 @@ sheet.insertRowAfter(0) #### Insert row before given position -[`insertRowBefore(beforePosition)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertrowbefore): Inserts a row before the specified row position. +[`insertRowBefore(beforePosition)`](https://docs.univer.ai/reference/facade/worksheet#insertrowbefore): Inserts a row before the specified row position. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -32,7 +32,7 @@ sheet.insertRowBefore(0) #### Insert multiple rows at specified location -[`insertRows(rowIndex, numRows)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertrows): Inserts one or more consecutive blank rows in a sheet starting at the specified location. +[`insertRows(rowIndex, numRows)`](https://docs.univer.ai/reference/facade/worksheet#insertrows): Inserts one or more consecutive blank rows in a sheet starting at the specified location. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -43,7 +43,7 @@ sheet.insertRows(0, 3) #### Insert multiple rows after given position -[`insertRowsAfter(afterPosition, howMany)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertrowsafter): Inserts a specified number of rows after the given row position. +[`insertRowsAfter(afterPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertrowsafter): Inserts a specified number of rows after the given row position. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -54,7 +54,7 @@ sheet.insertRowsAfter(0, 5) #### Insert multiple rows before given position -[`insertRowsBefore(beforePosition, howMany)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertrowsbefore): Inserts a specified number of rows before the given row position. +[`insertRowsBefore(beforePosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertrowsbefore): Inserts a specified number of rows before the given row position. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -65,7 +65,7 @@ sheet.insertRowsBefore(0, 5) #### Delete row at given position -[`deleteRow(rowPosition)`](https://reference.univer.ai/en-US/classes/FWorksheet#deleterow): Deletes the row at the specified row position. +[`deleteRow(rowPosition)`](https://docs.univer.ai/reference/facade/worksheet#deleterow): Deletes the row at the specified row position. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -76,7 +76,7 @@ sheet.deleteRow(0) #### Delete multiple rows starting at given position -[`deleteRows(rowPosition, howMany)`](https://reference.univer.ai/en-US/classes/FWorksheet#deleterows): Deletes a specified number of rows starting at the given row position. +[`deleteRows(rowPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#deleterows): Deletes a specified number of rows starting at the given row position. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -87,7 +87,7 @@ sheet.deleteRows(0, 2) #### Delete multiple rows by specified positions -[`deleteRowsByPoints(rowPoints)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#deleterowsbypoints): Deletes multiple rows (not necessarily consecutive) specified by an array of row positions. +[`deleteRowsByPoints(rowPoints)`](https://docs.univer.ai/reference/facade/worksheet#deleterowsbypoints): Deletes multiple rows (not necessarily consecutive) specified by an array of row positions. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -98,7 +98,7 @@ fWorksheet.deleteRowsByPoints([2, [4, 6]]) #### Move rows to new position -[`moveRows(rowSpec, destinationIndex)`](https://reference.univer.ai/en-US/classes/FWorksheet#moverows): Moves the rows selected by the given range to the position indicated by the `destinationIndex`. The `rowSpec` itself does not have to exactly represent an entire row or group of rows to move—it selects all rows that the range spans. +[`moveRows(rowSpec, destinationIndex)`](https://docs.univer.ai/reference/facade/worksheet#moverows): Moves the rows selected by the given range to the position indicated by the `destinationIndex`. The `rowSpec` itself does not have to exactly represent an entire row or group of rows to move—it selects all rows that the range spans. ```typescript // The code below moves rows 1-2 to destination index 5 @@ -112,7 +112,7 @@ sheet.moveRows(rowSpec, 5) #### Hide rows in given range -[`hideRow(row)`](https://reference.univer.ai/en-US/classes/FWorksheet#hiderow): Hides the rows in the specified range. +[`hideRow(row)`](https://docs.univer.ai/reference/facade/worksheet#hiderow): Hides the rows in the specified range. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -124,7 +124,7 @@ sheet.hideRow(range) #### Hide multiple consecutive rows -[`hideRows(rowIndex, numRows)`](https://reference.univer.ai/en-US/classes/FWorksheet#hiderows): Hides one or more consecutive rows starting at the given index. Use 0-index for this method. +[`hideRows(rowIndex, numRows)`](https://docs.univer.ai/reference/facade/worksheet#hiderows): Hides one or more consecutive rows starting at the given index. Use 0-index for this method. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -135,7 +135,7 @@ sheet.hideRows(0, 3) #### Unhide row in given range -[`unhideRow(row)`](https://reference.univer.ai/en-US/classes/FWorksheet#unhiderow): Unhides the row in the specified range. +[`unhideRow(row)`](https://docs.univer.ai/reference/facade/worksheet#unhiderow): Unhides the row in the specified range. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -147,7 +147,7 @@ sheet.unhideRow(range) #### Unhide multiple consecutive rows -[`showRows(rowIndex, numRows)`](https://reference.univer.ai/en-US/classes/FWorksheet#showrows): Unhides one or more consecutive rows starting at the given index. Use 0-index for this method. +[`showRows(rowIndex, numRows)`](https://docs.univer.ai/reference/facade/worksheet#showrows): Unhides one or more consecutive rows starting at the given index. Use 0-index for this method. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -158,7 +158,7 @@ sheet.showRows(0, 3) #### Set row height -[`setRowHeight(rowPosition, height)`](https://reference.univer.ai/en-US/classes/FWorksheet#setrowheight): Sets the row height of the given row in pixels. By default, rows grow to fit cell contents. If you want to force rows to a specified height, use `setRowHeightsForced(startRow, numRows, height)`. +[`setRowHeight(rowPosition, height)`](https://docs.univer.ai/reference/facade/worksheet#setrowheight): Sets the row height of the given row in pixels. By default, rows grow to fit cell contents. If you want to force rows to a specified height, use `setRowHeightsForced(startRow, numRows, height)`. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -169,7 +169,7 @@ sheet.setRowHeight(0, 200) #### Set height for multiple rows -[`setRowHeights(startRow, numRows, height)`](https://reference.univer.ai/en-US/classes/FWorksheet#setrowheights): Sets the height of the given rows in pixels. By default, rows grow to fit cell contents. If you want to force rows to a specified height, use `setRowHeightsForced(startRow, numRows, height)`. +[`setRowHeights(startRow, numRows, height)`](https://docs.univer.ai/reference/facade/worksheet#setrowheights): Sets the height of the given rows in pixels. By default, rows grow to fit cell contents. If you want to force rows to a specified height, use `setRowHeightsForced(startRow, numRows, height)`. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -180,7 +180,7 @@ sheet.setRowHeights(0, 3, 200) #### Force set height for multiple rows -[`setRowHeightsForced(startRow, numRows, height)`](https://reference.univer.ai/en-US/classes/FWorksheet#setrowheightsforced): Sets the height of the given rows in pixels. By default, rows grow to fit cell contents. When you use `setRowHeightsForced`, rows are forced to the specified height even if the cell contents are taller than the row height. +[`setRowHeightsForced(startRow, numRows, height)`](https://docs.univer.ai/reference/facade/worksheet#setrowheightsforced): Sets the height of the given rows in pixels. By default, rows grow to fit cell contents. When you use `setRowHeightsForced`, rows are forced to the specified height even if the cell contents are taller than the row height. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -191,7 +191,7 @@ sheet.setRowHeightsForced(0, 3, 5) #### Auto resize rows -[`autoResizeRows(startRow, numRows)`](https://reference.univer.ai/en-US/classes/FWorksheet#autoresizerows): Automatically resizes the height of the given rows to fit their text content. +[`autoResizeRows(startRow, numRows)`](https://docs.univer.ai/reference/facade/worksheet#autoresizerows): Automatically resizes the height of the given rows to fit their text content. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -202,7 +202,7 @@ sheet.autoResizeRows(0, 3) #### Set row custom properties -[`setRowCustom(custom)`](https://reference.univer.ai/en-US/classes/FWorksheet#setrowcustom): Set custom properties for given rows, store an object `custom` on the row, in which you can put any data that conforms to the JSON format, for custom storage of some additional information. +[`setRowCustom(custom)`](https://docs.univer.ai/reference/facade/worksheet#setrowcustom): Set custom properties for given rows, store an object `custom` on the row, in which you can put any data that conforms to the JSON format, for custom storage of some additional information. Updating `custom` data will overwrite the original `custom` data. If you need to keep the original `custom` data when updating data, please get the `custom` data in advance and merge it into new data before updating. ```typescript @@ -219,7 +219,7 @@ sheet.setRowCustom({ #### Insert column after given position -[`insertColumnAfter(afterPosition)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertcolumnafter): Inserts a column after the given column position. +[`insertColumnAfter(afterPosition)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnafter): Inserts a column after the given column position. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -230,7 +230,7 @@ sheet.insertColumnAfter(0) #### Insert column before given position -[`insertColumnBefore(beforePosition)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertcolumnbefore): Inserts a column before the given column position. +[`insertColumnBefore(beforePosition)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnbefore): Inserts a column before the given column position. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -241,7 +241,7 @@ sheet.insertColumnBefore(0) #### Insert multiple columns at specified location -[`insertColumns(columnIndex, numColumns)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertcolumns): Inserts one or more consecutive blank columns in a sheet starting at the specified location. +[`insertColumns(columnIndex, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumns): Inserts one or more consecutive blank columns in a sheet starting at the specified location. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -252,7 +252,7 @@ sheet.insertColumns(0, 3) #### Insert multiple columns after given position -[`insertColumnsAfter(afterPosition, howMany)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertcolumnsafter): Inserts a given number of columns after the given column position. +[`insertColumnsAfter(afterPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnsafter): Inserts a given number of columns after the given column position. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -263,7 +263,7 @@ sheet.insertColumnsAfter(0, 2) #### Insert multiple columns before given position -[`insertColumnsBefore(beforePosition, howMany)`](https://reference.univer.ai/en-US/classes/FWorksheet#insertcolumnsbefore): Inserts a number of columns before the given column position. +[`insertColumnsBefore(beforePosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnsbefore): Inserts a number of columns before the given column position. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -274,7 +274,7 @@ sheet.insertColumnsBefore(0, 5) #### Delete column at given position -[`deleteColumn(columnPosition)`](https://reference.univer.ai/en-US/classes/FWorksheet#deletecolumn): Deletes the column at the given column position. +[`deleteColumn(columnPosition)`](https://docs.univer.ai/reference/facade/worksheet#deletecolumn): Deletes the column at the given column position. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -285,7 +285,7 @@ sheet.deleteColumn(0) #### Delete multiple columns starting at given position -[`deleteColumns(columnPosition, howMany)`](https://reference.univer.ai/en-US/classes/FWorksheet#deletecolumns): Deletes a number of columns starting at the given column position. +[`deleteColumns(columnPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#deletecolumns): Deletes a number of columns starting at the given column position. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -296,7 +296,7 @@ sheet.deleteColumns(0, 2) #### Delete multiple columns by specified positions -[`deleteColumnsByPoints(columnPoints)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#deletecolumnsbypoints): Deletes multiple columns (not necessarily consecutive) specified by an array of column positions. +[`deleteColumnsByPoints(columnPoints)`](https://docs.univer.ai/reference/facade/worksheet#deletecolumnsbypoints): Deletes multiple columns (not necessarily consecutive) specified by an array of column positions. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -307,7 +307,7 @@ fWorksheet.deleteColumnsByPoints([2, [4, 6]]) #### Move columns to new position -[`moveColumns(columnSpec, destinationIndex)`](https://reference.univer.ai/en-US/classes/FWorksheet#movecolumns): Moves the columns selected by the given range to the position indicated by the `destinationIndex`. The `columnSpec` itself does not have to exactly represent an entire column or group of columns to move—it selects all columns that the range spans. +[`moveColumns(columnSpec, destinationIndex)`](https://docs.univer.ai/reference/facade/worksheet#movecolumns): Moves the columns selected by the given range to the position indicated by the `destinationIndex`. The `columnSpec` itself does not have to exactly represent an entire column or group of columns to move—it selects all columns that the range spans. ```typescript // The code below moves rows A-B to destination index 5. @@ -321,7 +321,7 @@ sheet.moveColumns(columnSpec, 5) #### Hide columns in given range -[`hideColumn(column)`](https://reference.univer.ai/en-US/classes/FWorksheet#hidecolumn): Hides the column or columns in the given range. +[`hideColumn(column)`](https://docs.univer.ai/reference/facade/worksheet#hidecolumn): Hides the column or columns in the given range. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -333,7 +333,7 @@ sheet.hideColumn(range) #### Hide multiple consecutive columns -[`hideColumns(columnIndex, numColumns)`](https://reference.univer.ai/en-US/classes/FWorksheet#hidecolumns): Hides one or more consecutive columns starting at the given index. Use 0-index for this method. +[`hideColumns(columnIndex, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#hidecolumns): Hides one or more consecutive columns starting at the given index. Use 0-index for this method. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -344,7 +344,7 @@ sheet.hideColumns(0, 3) #### Unhide column in given range -[`unhideColumn(column)`](https://reference.univer.ai/en-US/classes/FWorksheet#unhidecolumn): Unhides the column in the given range. +[`unhideColumn(column)`](https://docs.univer.ai/reference/facade/worksheet#unhidecolumn): Unhides the column in the given range. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -356,7 +356,7 @@ sheet.unhideColumn(range) #### Unhide multiple consecutive columns -[`showColumns(columnIndex, numColumns)`](https://reference.univer.ai/en-US/classes/FWorksheet#showcolumns): Unhides one or more consecutive columns starting at the given index. Use 0-index for this method. +[`showColumns(columnIndex, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#showcolumns): Unhides one or more consecutive columns starting at the given index. Use 0-index for this method. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -367,7 +367,7 @@ sheet.showColumns(0, 3) #### Set column width -[`setColumnWidth(columnPosition, width)`](https://reference.univer.ai/en-US/classes/FWorksheet#setcolumnwidth): Sets the width of the given column in pixels. +[`setColumnWidth(columnPosition, width)`](https://docs.univer.ai/reference/facade/worksheet#setcolumnwidth): Sets the width of the given column in pixels. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -378,7 +378,7 @@ sheet.setColumnWidth(0, 200) #### Set width for multiple columns -[`setColumnWidths(startColumn, numColumns, width)`](https://reference.univer.ai/en-US/classes/FWorksheet#setcolumnwidths): Sets the width of the given columns in pixels. +[`setColumnWidths(startColumn, numColumns, width)`](https://docs.univer.ai/reference/facade/worksheet#setcolumnwidths): Sets the width of the given columns in pixels. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -389,7 +389,7 @@ sheet.setColumnWidths(0, 3, 200) #### Auto resize columns -[`autoResizeColumns(startColumn, numColumns)`](https://reference.univer.ai/en-US/classes/FWorksheet#autoresizecolumns): Sets the width of the given columns to automatically fit their text content. +[`autoResizeColumns(startColumn, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#autoresizecolumns): Sets the width of the given columns to automatically fit their text content. ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -400,7 +400,7 @@ sheet.autoResizeColumns(0, 3) #### Set column custom properties -[`setColumnCustom(custom)`](https://reference.univer.ai/en-US/classes/FWorksheet#setcolumncustom): Set custom properties for given columns, store an object `custom` on the column, in which you can put any data that conforms to the JSON format, for custom storage of some additional information. +[`setColumnCustom(custom)`](https://docs.univer.ai/reference/facade/worksheet#setcolumncustom): Set custom properties for given columns, store an object `custom` on the column, in which you can put any data that conforms to the JSON format, for custom storage of some additional information. Updating `custom` data will overwrite the original `custom` data. If you need to keep the original `custom` data when updating data, please get the `custom` data in advance and merge it into new data before updating. ```typescript diff --git a/content/guides/sheets/features/core/row-col.zh-CN.mdx b/content/guides/sheets/features/core/row-col.zh-CN.mdx index 09bab2e2..8f776116 100644 --- a/content/guides/sheets/features/core/row-col.zh-CN.mdx +++ b/content/guides/sheets/features/core/row-col.zh-CN.mdx @@ -10,7 +10,7 @@ title: 行列操作 #### 在指定行后插入行 -[`insertRowAfter(afterPosition)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#insertrowafter): 在指定行位置之后插入一行。 +[`insertRowAfter(afterPosition)`](https://docs.univer.ai/reference/facade/worksheet#insertrowafter): 在指定行位置之后插入一行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -21,7 +21,7 @@ sheet.insertRowAfter(0) #### 在指定行前插入行 -[`insertRowBefore(beforePosition)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#insertrowbefore): 在指定行位置之前插入一行。 +[`insertRowBefore(beforePosition)`](https://docs.univer.ai/reference/facade/worksheet#insertrowbefore): 在指定行位置之前插入一行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -32,7 +32,7 @@ sheet.insertRowBefore(0) #### 插入多行 -[`insertRows(rowIndex, numRows)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#insertrows): 在工作表中从指定位置开始插入一个或多个连续的空白行。 +[`insertRows(rowIndex, numRows)`](https://docs.univer.ai/reference/facade/worksheet#insertrows): 在工作表中从指定位置开始插入一个或多个连续的空白行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -43,7 +43,7 @@ sheet.insertRows(0, 3) #### 在指定行后插入多行 -[`insertRowsAfter(afterPosition, howMany)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#insertrowsafter): 在指定行位置之后插入若干行。 +[`insertRowsAfter(afterPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertrowsafter): 在指定行位置之后插入若干行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -54,7 +54,7 @@ sheet.insertRowsAfter(0, 5) #### 在指定行前插入多行 -[`insertRowsBefore(beforePosition, howMany)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#insertrowsbefore): 在指定行位置之前插入若干行。 +[`insertRowsBefore(beforePosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertrowsbefore): 在指定行位置之前插入若干行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -65,7 +65,7 @@ sheet.insertRowsBefore(0, 5) #### 删除指定行 -[`deleteRow(rowPosition)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#deleterow): 删除给定行位置处的行。 +[`deleteRow(rowPosition)`](https://docs.univer.ai/reference/facade/worksheet#deleterow): 删除给定行位置处的行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -76,7 +76,7 @@ sheet.deleteRow(0) #### 删除多行 -[`deleteRows(rowPosition, howMany)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#deleterows): 删除从给定行位置开始的若干行。 +[`deleteRows(rowPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#deleterows): 删除从给定行位置开始的若干行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -87,7 +87,7 @@ sheet.deleteRows(0, 2) #### 删除多行（不连续） -[`deleteRowsByPoints(rowPoints)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#deleterowsbypoints): 删除由行位置数组指定的多行（不连续）。 +[`deleteRowsByPoints(rowPoints)`](https://docs.univer.ai/reference/facade/worksheet#deleterowsbypoints): 删除由行位置数组指定的多行（不连续）。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -98,7 +98,7 @@ fWorksheet.deleteRowsByPoints([2, [4, 6]]) #### 移动行 -[`moveRows(rowSpec, destinationIndex)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#moverows): 将给定范围选定的行移动到 `destinationIndex` 指示的位置。`rowSpec` 本身不必准确表示要移动的整行或整组行 — 它选择范围跨越的所有行。 +[`moveRows(rowSpec, destinationIndex)`](https://docs.univer.ai/reference/facade/worksheet#moverows): 将给定范围选定的行移动到 `destinationIndex` 指示的位置。`rowSpec` 本身不必准确表示要移动的整行或整组行 — 它选择范围跨越的所有行。 ```typescript // 以下代码将行 1-2 移动到目标索引 5 @@ -112,7 +112,7 @@ sheet.moveRows(rowSpec, 5) #### 隐藏行 -[`hideRow(row)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#hiderow): 隐藏指定范围内的行。 +[`hideRow(row)`](https://docs.univer.ai/reference/facade/worksheet#hiderow): 隐藏指定范围内的行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -124,7 +124,7 @@ sheet.hideRow(range) #### 隐藏多行 -[`hideRows(rowIndex, numRows)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#hiderows): 隐藏从指定索引开始的一个或多个连续行。此方法使用 0 索引。 +[`hideRows(rowIndex, numRows)`](https://docs.univer.ai/reference/facade/worksheet#hiderows): 隐藏从指定索引开始的一个或多个连续行。此方法使用 0 索引。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -135,7 +135,7 @@ sheet.hideRows(0, 3) #### 取消隐藏行 -[`unhideRow(row)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#unhiderow): 取消隐藏指定范围内的行。 +[`unhideRow(row)`](https://docs.univer.ai/reference/facade/worksheet#unhiderow): 取消隐藏指定范围内的行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -147,7 +147,7 @@ sheet.unhideRow(range) #### 显示多行 -[`showRows(rowIndex, numRows)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#showrows): 取消隐藏从指定索引开始的一个或多个连续行。此方法使用 0 索引。 +[`showRows(rowIndex, numRows)`](https://docs.univer.ai/reference/facade/worksheet#showrows): 取消隐藏从指定索引开始的一个或多个连续行。此方法使用 0 索引。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -158,7 +158,7 @@ sheet.showRows(0, 3) #### 设置行高 -[`setRowHeight(rowPosition, height)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#setrowheight): 设置给定行的行高（以像素为单位）。默认情况下，行会扩展以适应单元格内容的大小。如果想要将行强制设置为指定高度，请使用 `setRowHeightsForced(startRow, numRows, height)`。 +[`setRowHeight(rowPosition, height)`](https://docs.univer.ai/reference/facade/worksheet#setrowheight): 设置给定行的行高（以像素为单位）。默认情况下，行会扩展以适应单元格内容的大小。如果想要将行强制设置为指定高度，请使用 `setRowHeightsForced(startRow, numRows, height)`。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -169,7 +169,7 @@ sheet.setRowHeight(0, 200) #### 设置多行高度 -[`setRowHeights(startRow, numRows, height)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#setrowheights): 设置给定行的高度（以像素为单位）。默认情况下，行会扩展以适应单元格内容的大小。如果想要将行强制设置为指定高度，请使用 `setRowHeightsForced(startRow, numRows, height)`。 +[`setRowHeights(startRow, numRows, height)`](https://docs.univer.ai/reference/facade/worksheet#setrowheights): 设置给定行的高度（以像素为单位）。默认情况下，行会扩展以适应单元格内容的大小。如果想要将行强制设置为指定高度，请使用 `setRowHeightsForced(startRow, numRows, height)`。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -180,7 +180,7 @@ sheet.setRowHeights(0, 3, 200) #### 强制设置多行高度 -[`setRowHeightsForced(startRow, numRows, height)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#setrowheightsforced): 设置给定行的高度（以像素为单位）。默认情况下，行会扩展以适应单元格内容的大小。使用 `setRowHeightsForced` 时，即使单元格内容高于行高，行也会被强制为指定的高度。 +[`setRowHeightsForced(startRow, numRows, height)`](https://docs.univer.ai/reference/facade/worksheet#setrowheightsforced): 设置给定行的高度（以像素为单位）。默认情况下，行会扩展以适应单元格内容的大小。使用 `setRowHeightsForced` 时，即使单元格内容高于行高，行也会被强制为指定的高度。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -191,7 +191,7 @@ sheet.setRowHeightsForced(0, 3, 5) #### 设置行高自动调整 -[`autoResizeRows(startRow, numRows)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#autoresizerows): 设置给定行的高度自动调整以适应单元格内容。 +[`autoResizeRows(startRow, numRows)`](https://docs.univer.ai/reference/facade/worksheet#autoresizerows): 设置给定行的高度自动调整以适应单元格内容。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -202,7 +202,7 @@ sheet.autoResizeRows(0, 3) #### 设置行自定义属性 -[`setRowCustom(custom)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#setrowcustom)：设置给定行的自定义属性，在行上存储一个对象 `custom`, 其中可以放入任何符合 JSON 格式的数据，用于自定义存储一些额外的信息。 +[`setRowCustom(custom)`](https://docs.univer.ai/reference/facade/worksheet#setrowcustom)：设置给定行的自定义属性，在行上存储一个对象 `custom`, 其中可以放入任何符合 JSON 格式的数据，用于自定义存储一些额外的信息。 更新 `custom` 数据会覆盖原有的 `custom` 数据，如果你在更新数据时需要保留原有的 `custom` 数据，请提前获取到 `custom` 数据合并成新的数据后再更新。 ```typescript @@ -219,7 +219,7 @@ sheet.setRowCustom({ #### 在指定列后插入列 -[`insertColumnAfter(afterPosition)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#insertcolumnafter): 在指定列位置之后插入一列。 +[`insertColumnAfter(afterPosition)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnafter): 在指定列位置之后插入一列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -230,7 +230,7 @@ sheet.insertColumnAfter(0) #### 在指定列前插入列 -[`insertColumnBefore(beforePosition)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#insertcolumnbefore): 在指定列位置之前插入一列。 +[`insertColumnBefore(beforePosition)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnbefore): 在指定列位置之前插入一列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -241,7 +241,7 @@ sheet.insertColumnBefore(0) #### 插入多列 -[`insertColumns(columnIndex, numColumns)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#insertcolumns): 在工作表中从指定位置开始插入一个或多个连续的空白列。 +[`insertColumns(columnIndex, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumns): 在工作表中从指定位置开始插入一个或多个连续的空白列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -252,7 +252,7 @@ sheet.insertColumns(0, 3) #### 在指定列后插入多列 -[`insertColumnsAfter(afterPosition, howMany)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#insertcolumnsafter): 在指定列位置后插入指定数量的列。 +[`insertColumnsAfter(afterPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnsafter): 在指定列位置后插入指定数量的列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -263,7 +263,7 @@ sheet.insertColumnsAfter(0, 2) #### 在指定列前插入多列 -[`insertColumnsBefore(beforePosition, howMany)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#insertcolumnsbefore): 在指定列位置之前插入若干列。 +[`insertColumnsBefore(beforePosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnsbefore): 在指定列位置之前插入若干列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -274,7 +274,7 @@ sheet.insertColumnsBefore(0, 5) #### 删除指定列 -[`deleteColumn(columnPosition)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#deletecolumn): 删除给定列位置处的列。 +[`deleteColumn(columnPosition)`](https://docs.univer.ai/reference/facade/worksheet#deletecolumn): 删除给定列位置处的列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -285,7 +285,7 @@ sheet.deleteColumn(0) #### 删除多列 -[`deleteColumns(columnPosition, howMany)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#deletecolumns): 删除从给定列位置开始的若干列。 +[`deleteColumns(columnPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#deletecolumns): 删除从给定列位置开始的若干列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -296,7 +296,7 @@ sheet.deleteColumns(0, 2) #### 删除多列（不连续） -[`deleteColumnsByPoints(columnPoints)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#deletecolumnsbypoints): 删除由列位置数组指定的多列（不连续）。 +[`deleteColumnsByPoints(columnPoints)`](https://docs.univer.ai/reference/facade/worksheet#deletecolumnsbypoints): 删除由列位置数组指定的多列（不连续）。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -307,7 +307,7 @@ fWorksheet.deleteColumnsByPoints([2, [4, 6]]) #### 移动列 -[`moveColumns(columnSpec, destinationIndex)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#movecolumns): 将给定范围选定的列移动到 `destinationIndex` 指示的位置。 `columnSpec` 本身不必准确表示要移动的整列或整组列 - 它会选择范围跨越的所有列。 +[`moveColumns(columnSpec, destinationIndex)`](https://docs.univer.ai/reference/facade/worksheet#movecolumns): 将给定范围选定的列移动到 `destinationIndex` 指示的位置。 `columnSpec` 本身不必准确表示要移动的整列或整组列 - 它会选择范围跨越的所有列。 ```typescript // 以下代码将 A-B 行移动到目标索引 5。 @@ -321,7 +321,7 @@ sheet.moveColumns(columnSpec, 5) #### 隐藏列 -[`hideColumn(column)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#hidecolumn): 隐藏给定范围内的一列或多列。 +[`hideColumn(column)`](https://docs.univer.ai/reference/facade/worksheet#hidecolumn): 隐藏给定范围内的一列或多列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -333,7 +333,7 @@ sheet.hideColumn(range) #### 隐藏多列 -[`hideColumns(columnIndex, numColumns)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#hidecolumns): 隐藏从给定索引开始的一个或多个连续列。此方法使用 0 索引。 +[`hideColumns(columnIndex, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#hidecolumns): 隐藏从给定索引开始的一个或多个连续列。此方法使用 0 索引。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -344,7 +344,7 @@ sheet.hideColumns(0, 3) #### 取消隐藏列 -[`unhideColumn(column)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#unhidecolumn): 取消隐藏指定范围内的列。 +[`unhideColumn(column)`](https://docs.univer.ai/reference/facade/worksheet#unhidecolumn): 取消隐藏指定范围内的列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -356,7 +356,7 @@ sheet.unhideColumn(range) #### 显示多列 -[`showColumns(columnIndex, numColumns)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#showcolumns): 取消隐藏从指定索引开始的一个或多个连续列。此方法使用 0 索引。 +[`showColumns(columnIndex, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#showcolumns): 取消隐藏从指定索引开始的一个或多个连续列。此方法使用 0 索引。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -367,7 +367,7 @@ sheet.showColumns(0, 3) #### 设置列宽 -[`setColumnWidth(columnPosition, width)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#setcolumnwidth): 设置指定列的宽度（以像素为单位）。 +[`setColumnWidth(columnPosition, width)`](https://docs.univer.ai/reference/facade/worksheet#setcolumnwidth): 设置指定列的宽度（以像素为单位）。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -378,7 +378,7 @@ sheet.setColumnWidth(0, 200) #### 设置多列宽度 -[`setColumnWidths(startColumn, numColumns, width)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#setcolumnwidths): 设置指定列的宽度（以像素为单位）。 +[`setColumnWidths(startColumn, numColumns, width)`](https://docs.univer.ai/reference/facade/worksheet#setcolumnwidths): 设置指定列的宽度（以像素为单位）。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -389,7 +389,7 @@ sheet.setColumnWidths(0, 3, 200) #### 设置列宽自动调整 -[`autoResizeColumns(startColumn, numColumns)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#autoresizecolumns): 设置指定列的宽度自动调整以适应单元格内容。 +[`autoResizeColumns(startColumn, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#autoresizecolumns): 设置指定列的宽度自动调整以适应单元格内容。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -400,7 +400,7 @@ sheet.autoResizeColumns(0, 3) #### 设置列自定义属性 -[`setColumnCustom(custom)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#setcolumncustom): 设置给定列的自定义属性，在列上存储一个对象 `custom`, 其中可以放入任何符合 JSON 格式的数据，用于自定义存储一些额外的信息。 +[`setColumnCustom(custom)`](https://docs.univer.ai/reference/facade/worksheet#setcolumncustom): 设置给定列的自定义属性，在列上存储一个对象 `custom`, 其中可以放入任何符合 JSON 格式的数据，用于自定义存储一些额外的信息。 更新 `custom` 数据会覆盖原有的 `custom` 数据，如果你在更新数据时需要保留原有的 `custom` 数据，请提前获取到 `custom` 数据合并成新的数据后再更新。 ```typescript diff --git a/content/guides/sheets/features/core/row-col.zh-TW.mdx b/content/guides/sheets/features/core/row-col.zh-TW.mdx index e4d5c535..fb65e1c1 100644 --- a/content/guides/sheets/features/core/row-col.zh-TW.mdx +++ b/content/guides/sheets/features/core/row-col.zh-TW.mdx @@ -10,7 +10,7 @@ title: 行列操作 #### 在指定行後插入行 -[`insertRowAfter(afterPosition)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#insertrowafter): 在指定行位置之後插入一行。 +[`insertRowAfter(afterPosition)`](https://docs.univer.ai/reference/facade/worksheet#insertrowafter): 在指定行位置之後插入一行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -21,7 +21,7 @@ sheet.insertRowAfter(0) #### 在指定行前插入行 -[`insertRowBefore(beforePosition)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#insertrowbefore): 在指定行位置之前插入一行。 +[`insertRowBefore(beforePosition)`](https://docs.univer.ai/reference/facade/worksheet#insertrowbefore): 在指定行位置之前插入一行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -32,7 +32,7 @@ sheet.insertRowBefore(0) #### 插入多行 -[`insertRows(rowIndex, numRows)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#insertrows): 在工作表中從指定位置開始插入一個或多個連續的空白行。 +[`insertRows(rowIndex, numRows)`](https://docs.univer.ai/reference/facade/worksheet#insertrows): 在工作表中從指定位置開始插入一個或多個連續的空白行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -43,7 +43,7 @@ sheet.insertRows(0, 3) #### 在指定行後插入多行 -[`insertRowsAfter(afterPosition, howMany)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#insertrowsafter): 在指定行位置之後插入若干行。 +[`insertRowsAfter(afterPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertrowsafter): 在指定行位置之後插入若干行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -54,7 +54,7 @@ sheet.insertRowsAfter(0, 5) #### 在指定行前插入多行 -[`insertRowsBefore(beforePosition, howMany)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#insertrowsbefore): 在指定行位置之前插入若干行。 +[`insertRowsBefore(beforePosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertrowsbefore): 在指定行位置之前插入若干行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -65,7 +65,7 @@ sheet.insertRowsBefore(0, 5) #### 刪除指定行 -[`deleteRow(rowPosition)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#deleterow): 刪除給定行位置處的行。 +[`deleteRow(rowPosition)`](https://docs.univer.ai/reference/facade/worksheet#deleterow): 刪除給定行位置處的行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -76,7 +76,7 @@ sheet.deleteRow(0) #### 刪除多行 -[`deleteRows(rowPosition, howMany)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#deleterows): 刪除從給定行位置開始的若干行。 +[`deleteRows(rowPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#deleterows): 刪除從給定行位置開始的若干行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -87,7 +87,7 @@ sheet.deleteRows(0, 2) #### 刪除多行 (不連續) -[`deleteRowsByPoints(rowPoints)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#deleterowsbypoints): 刪除由行位置陣列指定的多行（不連續）。 +[`deleteRowsByPoints(rowPoints)`](https://docs.univer.ai/reference/facade/worksheet#deleterowsbypoints): 刪除由行位置陣列指定的多行（不連續）。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -98,7 +98,7 @@ fWorksheet.deleteRowsByPoints([2, [4, 6]]) #### 移動行 -[`moveRows(rowSpec, destinationIndex)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#moverows): 將給定範圍選定的行移動到 `destinationIndex` 指示的位置。`rowSpec` 本身不必準確表示要移動的整行或整組行 — 它選擇範圍跨越的所有行。 +[`moveRows(rowSpec, destinationIndex)`](https://docs.univer.ai/reference/facade/worksheet#moverows): 將給定範圍選定的行移動到 `destinationIndex` 指示的位置。`rowSpec` 本身不必準確表示要移動的整行或整組行 — 它選擇範圍跨越的所有行。 ```typescript // 以下程式碼將行 1-2 移動到目標索引 5 @@ -112,7 +112,7 @@ sheet.moveRows(rowSpec, 5) #### 隱藏行 -[`hideRow(row)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#hiderow): 隱藏指定範圍內的行。 +[`hideRow(row)`](https://docs.univer.ai/reference/facade/worksheet#hiderow): 隱藏指定範圍內的行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -124,7 +124,7 @@ sheet.hideRow(range) #### 隱藏多行 -[`hideRows(rowIndex, numRows)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#hiderows): 隱藏從指定索引開始的一個或多個連續行。此方法使用 0 索引。 +[`hideRows(rowIndex, numRows)`](https://docs.univer.ai/reference/facade/worksheet#hiderows): 隱藏從指定索引開始的一個或多個連續行。此方法使用 0 索引。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -135,7 +135,7 @@ sheet.hideRows(0, 3) #### 取消隱藏行 -[`unhideRow(row)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#unhiderow): 取消隱藏指定範圍內的行。 +[`unhideRow(row)`](https://docs.univer.ai/reference/facade/worksheet#unhiderow): 取消隱藏指定範圍內的行。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -147,7 +147,7 @@ sheet.unhideRow(range) #### 顯示多行 -[`showRows(rowIndex, numRows)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#showrows): 取消隱藏從指定索引開始的一個或多個連續行。此方法使用 0 索引。 +[`showRows(rowIndex, numRows)`](https://docs.univer.ai/reference/facade/worksheet#showrows): 取消隱藏從指定索引開始的一個或多個連續行。此方法使用 0 索引。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -158,7 +158,7 @@ sheet.showRows(0, 3) #### 設定行高 -[`setRowHeight(rowPosition, height)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#setrowheight): 設定給定行的行高（以畫素為單位）。預設情況下，行會擴充以適應單元格內容的大小。如果想要將行強制設定為指定高度，請使用 `setRowHeightsForced(startRow, numRows, height)`。 +[`setRowHeight(rowPosition, height)`](https://docs.univer.ai/reference/facade/worksheet#setrowheight): 設定給定行的行高（以畫素為單位）。預設情況下，行會擴充以適應單元格內容的大小。如果想要將行強制設定為指定高度，請使用 `setRowHeightsForced(startRow, numRows, height)`。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -169,7 +169,7 @@ sheet.setRowHeight(0, 200) #### 設定多行高度 -[`setRowHeights(startRow, numRows, height)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#setrowheights): 設定給定行的高度（以畫素為單位）。預設情況下，行會擴充以適應單元格內容的大小。如果想要將行強制設定為指定高度，請使用 `setRowHeightsForced(startRow, numRows, height)`。 +[`setRowHeights(startRow, numRows, height)`](https://docs.univer.ai/reference/facade/worksheet#setrowheights): 設定給定行的高度（以畫素為單位）。預設情況下，行會擴充以適應單元格內容的大小。如果想要將行強制設定為指定高度，請使用 `setRowHeightsForced(startRow, numRows, height)`。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -180,7 +180,7 @@ sheet.setRowHeights(0, 3, 200) #### 強制設定多行高度 -[`setRowHeightsForced(startRow, numRows, height)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#setrowheightsforced): 設定給定行的高度（以畫素為單位）。預設情況下，行會擴充以適應單元格內容的大小。使用 `setRowHeightsForced` 時，即使單元格內容高於行高，行也會被強制為指定的高度。 +[`setRowHeightsForced(startRow, numRows, height)`](https://docs.univer.ai/reference/facade/worksheet#setrowheightsforced): 設定給定行的高度（以畫素為單位）。預設情況下，行會擴充以適應單元格內容的大小。使用 `setRowHeightsForced` 時，即使單元格內容高於行高，行也會被強制為指定的高度。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -191,7 +191,7 @@ sheet.setRowHeightsForced(0, 3, 5) #### 設定行高自動調整 -[`autoResizeRows(startRow, numRows)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#autoresizerows): 設定給定行的高度自動調整以適應單元格內容。 +[`autoResizeRows(startRow, numRows)`](https://docs.univer.ai/reference/facade/worksheet#autoresizerows): 設定給定行的高度自動調整以適應單元格內容。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -202,7 +202,7 @@ sheet.autoResizeRows(0, 3) #### 設定行自訂屬性 -[`setRowCustom(custom)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#setrowcustom)：設定給定行的自訂屬性，在行上儲存一個物件 `custom`, 其中可以放入任何符合 JSON 格式的資料，用於自訂儲存一些額外的資訊。 +[`setRowCustom(custom)`](https://docs.univer.ai/reference/facade/worksheet#setrowcustom)：設定給定行的自訂屬性，在行上儲存一個物件 `custom`, 其中可以放入任何符合 JSON 格式的資料，用於自訂儲存一些額外的資訊。 更新 `custom` 資料會覆蓋原有的 `custom` 資料，如果你在更新資料時需要保留原有的 `custom` 資料，請提前獲取到 `custom` 資料合併成新的資料後再更新。 ```typescript @@ -219,7 +219,7 @@ sheet.setRowCustom({ #### 在指定列後插入列 -[`insertColumnAfter(afterPosition)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#insertcolumnafter): 在指定列位置之後插入一列。 +[`insertColumnAfter(afterPosition)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnafter): 在指定列位置之後插入一列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -230,7 +230,7 @@ sheet.insertColumnAfter(0) #### 在指定列前插入列 -[`insertColumnBefore(beforePosition)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#insertcolumnbefore): 在指定列位置之前插入一列。 +[`insertColumnBefore(beforePosition)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnbefore): 在指定列位置之前插入一列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -241,7 +241,7 @@ sheet.insertColumnBefore(0) #### 插入多列 -[`insertColumns(columnIndex, numColumns)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#insertcolumns): 在工作表中從指定位置開始插入一個或多個連續的空白列。 +[`insertColumns(columnIndex, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumns): 在工作表中從指定位置開始插入一個或多個連續的空白列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -252,7 +252,7 @@ sheet.insertColumns(0, 3) #### 在指定列後插入多列 -[`insertColumnsAfter(afterPosition, howMany)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#insertcolumnsafter): 在指定列位置後插入指定數量的列。 +[`insertColumnsAfter(afterPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnsafter): 在指定列位置後插入指定數量的列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -263,7 +263,7 @@ sheet.insertColumnsAfter(0, 2) #### 在指定列前插入多列 -[`insertColumnsBefore(beforePosition, howMany)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#insertcolumnsbefore): 在指定列位置之前插入若干列。 +[`insertColumnsBefore(beforePosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#insertcolumnsbefore): 在指定列位置之前插入若干列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -274,7 +274,7 @@ sheet.insertColumnsBefore(0, 5) #### 刪除指定列 -[`deleteColumn(columnPosition)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#deletecolumn): 刪除給定列位置處的列。 +[`deleteColumn(columnPosition)`](https://docs.univer.ai/reference/facade/worksheet#deletecolumn): 刪除給定列位置處的列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -285,7 +285,7 @@ sheet.deleteColumn(0) #### 刪除多列 -[`deleteColumns(columnPosition, howMany)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#deletecolumns): 刪除從給定列位置開始的若干列。 +[`deleteColumns(columnPosition, howMany)`](https://docs.univer.ai/reference/facade/worksheet#deletecolumns): 刪除從給定列位置開始的若干列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -296,7 +296,7 @@ sheet.deleteColumns(0, 2) #### 刪除多列（不連續） -[`deleteColumnsByPoints(columnPoints)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#deletecolumnsbypoints): 刪除由列位置陣列指定的多列（不連續）。 +[`deleteColumnsByPoints(columnPoints)`](https://docs.univer.ai/reference/facade/worksheet#deletecolumnsbypoints): 刪除由列位置陣列指定的多列（不連續）。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -307,7 +307,7 @@ fWorksheet.deleteColumnsByPoints([2, [4, 6]]) #### 移動列 -[`moveColumns(columnSpec, destinationIndex)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#movecolumns): 將給定範圍選定的列移動到 `destinationIndex` 指示的位置。 `columnSpec` 本身不必準確表示要移動的整列或整組列 - 它會選擇範圍跨越的所有列。 +[`moveColumns(columnSpec, destinationIndex)`](https://docs.univer.ai/reference/facade/worksheet#movecolumns): 將給定範圍選定的列移動到 `destinationIndex` 指示的位置。 `columnSpec` 本身不必準確表示要移動的整列或整組列 - 它會選擇範圍跨越的所有列。 ```typescript // 以下程式碼將 A-B 行移動到目標索引 5。 @@ -321,7 +321,7 @@ sheet.moveColumns(columnSpec, 5) #### 隱藏列 -[`hideColumn(column)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#hidecolumn): 隱藏給定範圍內的一列或多列。 +[`hideColumn(column)`](https://docs.univer.ai/reference/facade/worksheet#hidecolumn): 隱藏給定範圍內的一列或多列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -333,7 +333,7 @@ sheet.hideColumn(range) #### 隱藏多列 -[`hideColumns(columnIndex, numColumns)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#hidecolumns): 隱藏從給定索引開始的一個或多個連續列。此方法使用 0 索引。 +[`hideColumns(columnIndex, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#hidecolumns): 隱藏從給定索引開始的一個或多個連續列。此方法使用 0 索引。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -344,7 +344,7 @@ sheet.hideColumns(0, 3) #### 取消隱藏列 -[`unhideColumn(column)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#unhidecolumn): 取消隱藏指定範圍內的列。 +[`unhideColumn(column)`](https://docs.univer.ai/reference/facade/worksheet#unhidecolumn): 取消隱藏指定範圍內的列。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -356,7 +356,7 @@ sheet.unhideColumn(range) #### 顯示多列 -[`showColumns(columnIndex, numColumns)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#showcolumns): 取消隱藏從指定索引開始的一個或多個連續列。此方法使用 0 索引。 +[`showColumns(columnIndex, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#showcolumns): 取消隱藏從指定索引開始的一個或多個連續列。此方法使用 0 索引。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -367,7 +367,7 @@ sheet.showColumns(0, 3) #### 設定列寬 -[`setColumnWidth(columnPosition, width)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#setcolumnwidth): 設定指定列的寬度（以畫素為單位）。 +[`setColumnWidth(columnPosition, width)`](https://docs.univer.ai/reference/facade/worksheet#setcolumnwidth): 設定指定列的寬度（以畫素為單位）。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -378,7 +378,7 @@ sheet.setColumnWidth(0, 200) #### 設定多列寬度 -[`setColumnWidths(startColumn, numColumns, width)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#setcolumnwidths): 設定指定列的寬度（以畫素為單位）。 +[`setColumnWidths(startColumn, numColumns, width)`](https://docs.univer.ai/reference/facade/worksheet#setcolumnwidths): 設定指定列的寬度（以畫素為單位）。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -389,7 +389,7 @@ sheet.setColumnWidths(0, 3, 200) #### 設定列寬自動調整 -[`autoResizeColumns(startColumn, numColumns)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#autoresizecolumns): 設定指定列的寬度自動調整以適應單元格內容。 +[`autoResizeColumns(startColumn, numColumns)`](https://docs.univer.ai/reference/facade/worksheet#autoresizecolumns): 設定指定列的寬度自動調整以適應單元格內容。 ```typescript const sheet = univerAPI.getActiveWorkbook().getActiveSheet() @@ -400,7 +400,7 @@ sheet.autoResizeColumns(0, 3) #### 設定列自訂屬性 -[`setColumnCustom(custom)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#setcolumncustom): 設定給定列的自訂屬性，在列上儲存一個物件 `custom`, 其中可以放入任何符合 JSON 格式的資料，用於自訂儲存一些額外的資訊。 +[`setColumnCustom(custom)`](https://docs.univer.ai/reference/facade/worksheet#setcolumncustom): 設定給定列的自訂屬性，在列上儲存一個物件 `custom`, 其中可以放入任何符合 JSON 格式的資料，用於自訂儲存一些額外的資訊。 更新 `custom` 資料會覆蓋原有的 `custom` 資料，如果你在更新資料時需要保留原有的 `custom` 資料，請提前獲取到 `custom` 資料合併成新的資料後再更新。 ```typescript diff --git a/content/guides/sheets/features/core/sheets-api.ja-JP.mdx b/content/guides/sheets/features/core/sheets-api.ja-JP.mdx index ac89e873..1b128425 100644 --- a/content/guides/sheets/features/core/sheets-api.ja-JP.mdx +++ b/content/guides/sheets/features/core/sheets-api.ja-JP.mdx @@ -19,7 +19,7 @@ import '@univerjs/sheets-ui/facade' ### ワークブックの作成 -[`univerAPI.createWorkbook(data, options)`](https://reference.univer.ai/en-US/classes/FUniver#createworkbook) メソッドは `FWorkbook` オブジェクトを作成して返します。 +[`univerAPI.createWorkbook(data, options)`](https://docs.univer.ai/reference/facade/univer#createworkbook) メソッドは `FWorkbook` オブジェクトを作成して返します。 [`IWorkbookData`](/guides/sheets/model/workbook-data) はワークブックの設定情報を含むオブジェクトです。 @@ -106,7 +106,7 @@ const sheetSnapshot = fWorksheet.getSheet().getSnapshot() ### ワークシートの作成 [#create-worksheet] -以下の例は [`FWorkbook.create`](https://reference.univer.ai/en-US/classes/FWorkbook#create) メソッドを使用してワークシートを作成する方法を示しています。 +以下の例は [`FWorkbook.create`](https://docs.univer.ai/reference/facade/workbook#create) メソッドを使用してワークシートを作成する方法を示しています。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -271,5 +271,5 @@ console.log(scrollState) // sheetViewStartRow: 9, sheetViewStartColumn: 3, offse 詳細については、以下の API ドキュメントを参照してください： -- [FWorkbook](https://reference.univer.ai/en-US/classes/FWorkbook) -- [FWorksheet](https://reference.univer.ai/en-US/classes/FWorksheet) +- [FWorkbook](https://docs.univer.ai/reference/facade/workbook) +- [FWorksheet](https://docs.univer.ai/reference/facade/worksheet) diff --git a/content/guides/sheets/features/core/sheets-api.mdx b/content/guides/sheets/features/core/sheets-api.mdx index 3937c43c..b53bd26d 100644 --- a/content/guides/sheets/features/core/sheets-api.mdx +++ b/content/guides/sheets/features/core/sheets-api.mdx @@ -19,7 +19,7 @@ The `unitId` can be used as a unique identifier for the workbook. ### Create a Workbook -The [`univerAPI.createWorkbook(data, options)`](https://reference.univer.ai/en-US/classes/FUniver#createworkbook) method creates and returns the `FWorkbook` object. +The [`univerAPI.createWorkbook(data, options)`](https://docs.univer.ai/reference/facade/univer#createworkbook) method creates and returns the `FWorkbook` object. The [`IWorkbookData`](/guides/sheets/model/workbook-data) is an object that contains the configuration information of the workbook. @@ -106,7 +106,7 @@ const sheetSnapshot = fWorksheet.getSheet().getSnapshot() ### Create a Worksheet [#create-worksheet] -The following example shows how to create a worksheet using the [`FWorkbook.create`](https://reference.univer.ai/en-US/classes/FWorkbook#create) method. +The following example shows how to create a worksheet using the [`FWorkbook.create`](https://docs.univer.ai/reference/facade/workbook#create) method. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -271,5 +271,5 @@ Reference: [Integrating Custom Components into Univer](/en-US/guides/sheets/ui/c Please refer to the following API documentation for more information: -- [FWorkbook](https://reference.univer.ai/en-US/classes/FWorkbook) -- [FWorksheet](https://reference.univer.ai/en-US/classes/FWorksheet) +- [FWorkbook](https://docs.univer.ai/reference/facade/workbook) +- [FWorksheet](https://docs.univer.ai/reference/facade/worksheet) diff --git a/content/guides/sheets/features/core/sheets-api.zh-CN.mdx b/content/guides/sheets/features/core/sheets-api.zh-CN.mdx index 3f022b95..3c485c07 100644 --- a/content/guides/sheets/features/core/sheets-api.zh-CN.mdx +++ b/content/guides/sheets/features/core/sheets-api.zh-CN.mdx @@ -19,7 +19,7 @@ import '@univerjs/sheets-ui/facade' ### 创建工作簿 -[`univerAPI.createWorkbook(data, options)`](https://reference.univer.ai/zh-CN/classes/FUniver#createworkbook) 方法会创建并返回 `FWorkbook` 实例。 +[`univerAPI.createWorkbook(data, options)`](https://docs.univer.ai/reference/facade/univer#createworkbook) 方法会创建并返回 `FWorkbook` 实例。 [`IWorkbookData`](/guides/sheets/model/workbook-data) 是一个对象，包含了工作簿的配置信息。 @@ -106,7 +106,7 @@ const sheetSnapshot = fWorksheet.getSheet().getSnapshot() ### 创建工作表 [#create-worksheet] -下面例子展示通过 [`FWorkbook.create`](https://reference.univer.ai/zh-CN/classes/FWorkbook#create) 方法创建一个工作表。 +下面例子展示通过 [`FWorkbook.create`](https://docs.univer.ai/reference/facade/workbook#create) 方法创建一个工作表。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -271,5 +271,5 @@ console.log(scrollState) // sheetViewStartRow: 9, sheetViewStartColumn: 3, offse 更多 API 请查看： -- [FWorkbook](https://reference.univer.ai/zh-CN/classes/FWorkbook) -- [FWorksheet](https://reference.univer.ai/zh-CN/classes/FWorksheet) +- [FWorkbook](https://docs.univer.ai/reference/facade/workbook) +- [FWorksheet](https://docs.univer.ai/reference/facade/worksheet) diff --git a/content/guides/sheets/features/core/sheets-api.zh-TW.mdx b/content/guides/sheets/features/core/sheets-api.zh-TW.mdx index ab57d2ce..b989e83a 100644 --- a/content/guides/sheets/features/core/sheets-api.zh-TW.mdx +++ b/content/guides/sheets/features/core/sheets-api.zh-TW.mdx @@ -19,7 +19,7 @@ import '@univerjs/sheets-ui/facade' ### 建立工作簿 -[`univerAPI.createWorkbook(data, options)`](https://reference.univer.ai/zh-TW/classes/FUniver#createworkbook) 方法會建立並回傳 `FWorkbook` 實例。 +[`univerAPI.createWorkbook(data, options)`](https://docs.univer.ai/reference/facade/univer#createworkbook) 方法會建立並回傳 `FWorkbook` 實例。 [`IWorkbookData`](/guides/sheets/model/workbook-data) 是一個物件，包含了工作簿的配置資訊。 @@ -106,7 +106,7 @@ const sheetSnapshot = fWorksheet.getSheet().getSnapshot() ### 建立工作表 [#create-worksheet] -下面例子展示透過 [`FWorkbook.create`](https://reference.univer.ai/zh-TW/classes/FWorkbook#create) 方法建立一個工作表。 +下面例子展示透過 [`FWorkbook.create`](https://docs.univer.ai/reference/facade/workbook#create) 方法建立一個工作表。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -271,5 +271,5 @@ console.log(scrollState) // sheetViewStartRow: 9, sheetViewStartColumn: 3, offse 更多 API 請查看： -- [FWorkbook](https://reference.univer.ai/zh-TW/classes/FWorkbook) -- [FWorksheet](https://reference.univer.ai/zh-TW/classes/FWorksheet) +- [FWorkbook](https://docs.univer.ai/reference/facade/workbook) +- [FWorksheet](https://docs.univer.ai/reference/facade/worksheet) diff --git a/content/guides/sheets/features/crosshair-highlighting.ja-JP.mdx b/content/guides/sheets/features/crosshair-highlighting.ja-JP.mdx index 91a97130..84ef0650 100644 --- a/content/guides/sheets/features/crosshair-highlighting.ja-JP.mdx +++ b/content/guides/sheets/features/crosshair-highlighting.ja-JP.mdx @@ -128,7 +128,7 @@ univerAPI.getCrosshairHighlightColor() ### イベントリスナー -イベントの型定義は [Events](https://reference.univer.ai/en-US/classes/FEventName) を参照してください。 +イベントの型定義は [Events](https://docs.univer.ai/reference/facade/events) を参照してください。 `CrosshairHighlightEnabledChanged` イベントは、クロスヘアハイライトの有効状態が変更されたときにトリガーします。 diff --git a/content/guides/sheets/features/crosshair-highlighting.mdx b/content/guides/sheets/features/crosshair-highlighting.mdx index 7efa36fd..5985fce7 100644 --- a/content/guides/sheets/features/crosshair-highlighting.mdx +++ b/content/guides/sheets/features/crosshair-highlighting.mdx @@ -128,7 +128,7 @@ univerAPI.getCrosshairHighlightColor() ### Event Listeners -Complete event type definitions can be found in the [Events](https://reference.univer.ai/en-US/classes/FEventName). +Complete event type definitions can be found in the [Events](https://docs.univer.ai/reference/facade/events). `CrosshairHighlightEnabledChanged` event will be triggered when the crosshair highlight enabled status changes. diff --git a/content/guides/sheets/features/crosshair-highlighting.zh-CN.mdx b/content/guides/sheets/features/crosshair-highlighting.zh-CN.mdx index 75a7194b..72fe609c 100644 --- a/content/guides/sheets/features/crosshair-highlighting.zh-CN.mdx +++ b/content/guides/sheets/features/crosshair-highlighting.zh-CN.mdx @@ -128,7 +128,7 @@ univerAPI.getCrosshairHighlightColor() ### 事件监听 -完整事件类型定义，请查看 [Events](https://reference.univer.ai/zh-CN/classes/FEventName)。 +完整事件类型定义，请查看 [Events](https://docs.univer.ai/reference/facade/events)。 `CrosshairHighlightEnabledChanged` 事件将在十字高亮开关状态发生变化时触发。 diff --git a/content/guides/sheets/features/crosshair-highlighting.zh-TW.mdx b/content/guides/sheets/features/crosshair-highlighting.zh-TW.mdx index e4579d56..6cf65632 100644 --- a/content/guides/sheets/features/crosshair-highlighting.zh-TW.mdx +++ b/content/guides/sheets/features/crosshair-highlighting.zh-TW.mdx @@ -128,7 +128,7 @@ univerAPI.getCrosshairHighlightColor() ### 事件監聽 -完整事件型別定義，請檢視 [Events](https://reference.univer.ai/zh-TW/classes/FEventName)。 +完整事件型別定義，請檢視 [Events](https://docs.univer.ai/reference/facade/events)。 `CrosshairHighlightEnabledChanged` 事件將在十字高亮開關狀態發生變化時觸發。 diff --git a/content/guides/sheets/features/data-validation.ja-JP.mdx b/content/guides/sheets/features/data-validation.ja-JP.mdx index dca98da4..f0750ebf 100644 --- a/content/guides/sheets/features/data-validation.ja-JP.mdx +++ b/content/guides/sheets/features/data-validation.ja-JP.mdx @@ -89,8 +89,8 @@ UniverSheetsDataValidationPreset({ }) ``` -{/* 完整的配置项参考 [`IUniverSheetsDataValidationPresetConfig`](https://github.com/dream-num/univer-presets/blob/dev/packages/preset-sheets-data-validation/src/umd.ts#L13)。 */} -Complete configuration options can be found in the [`IUniverSheetsDataValidationPresetConfig`](https://github.com/dream-num/univer-presets/blob/dev/packages/preset-sheets-data-validation/src/umd.ts#L13). +{/* 完整的配置项参考 [`IUniverSheetsDataValidationPresetConfig`](https://github.com/dream-num/univer-presets/tree/dev/packages/preset-sheets-data-validation)。 */} +Complete configuration options can be found in the [`IUniverSheetsDataValidationPresetConfig`](https://github.com/dream-num/univer-presets/tree/dev/packages/preset-sheets-data-validation). ## プラグインモード @@ -144,8 +144,7 @@ univer.registerPlugin(UniverSheetsDataValidationUIPlugin, { }) ``` -{/* 完整的配置项参考 [IUniverSheetsDataValidationUIConfig](https://github.com/dream-num/univer/blob/dev/packages/sheets-data-validation-ui/src/controllers/config.schema.ts#L23)。 */} -Complete configuration options can be found in the [`IUniverSheetsDataValidationUIConfig`](https://github.com/dream-num/univer/blob/dev/packages/sheets-data-validation-ui/src/controllers/config.schema.ts#L23). +Complete configuration options can be found in the [`IUniverSheetsDataValidationUIConfig`](https://github.com/dream-num/univer/blob/dev/packages/sheets-data-validation-ui/src/config/config.ts). ## Facade API @@ -163,9 +162,9 @@ import '@univerjs/sheets-data-validation/facade' ### データ検証ルールの追加 -[`univerAPI.newDataValidation()`](https://reference.univer.ai/en-US/classes/FUniver#newdatavalidation) は、新しいデータ検証ビルダーを作成します。これは `FDataValidationBuilder` インスタンスを返し、チェーン呼び出しでデータ検証ルールを生成できます。 +[`univerAPI.newDataValidation()`](https://docs.univer.ai/reference/facade/univer#newdatavalidation) は、新しいデータ検証ビルダーを作成します。これは `FDataValidationBuilder` インスタンスを返し、チェーン呼び出しでデータ検証ルールを生成できます。 -以下は [`FDataValidationBuilder`](https://reference.univer.ai/en-US/classes/FDataValidationBuilder) のメソッドの一部です: +以下は [`FDataValidationBuilder`](https://docs.univer.ai/reference/facade/data-validation) のメソッドの一部です: | Method | Description | | ------ | ----------- | @@ -187,8 +186,8 @@ import '@univerjs/sheets-data-validation/facade' | requireNumberLessThanOrEqualTo | 指定した値以下の数値を要求するルールを設定します | | requireNumberNotBetween | 指定した 2 つの数値の間にない、かつどちらとも等しくない数値を要求するルールを設定します | | requireNumberNotEqualTo | 指定した値と等しくない数値を要求するルールを設定します | -| requireValueInList | ユーザーが特定の値のリストから値を入力することを要求するルールを設定します | -| requireValueInRange | 指定した範囲内の値を入力することを要求するルールを設定します | +| requireValueInList | ユーザーが特定の値のリストから値を入力することを要求するルールを設定します。単一/複数選択、ドロップダウンの表示/非表示をサポートします | +| requireValueInRange | 指定した範囲内の値を入力することを要求するルールを設定します。単一/複数選択、ドロップダウンの表示/非表示をサポートします | | setOptions | データ検証ルールのオプションを設定します | ```typescript @@ -223,10 +222,11 @@ fRange.setDataValidation(null) 返されるデータ検証ルールオブジェクトは `FDataValidation` インスタンスであり、ルールの条件やオプションなどを取得できます。 -以下は [`FDataValidation`](https://reference.univer.ai/en-US/classes/FDataValidation) のメソッドの一部です: +以下は [`FDataValidation`](https://docs.univer.ai/reference/facade/data-validation) のメソッドの一部です: | Method | Description | | ---- | ---- | +| copy | 現在のルールオブジェクトを使用して新しい FDataValidationBuilder インスタンスを作成します | | getCriteriaType | ルールのデータ検証タイプを取得します | | getCriteriaValues | 条件評価に使用される値を取得します | | getHelpText | ヘルプテキスト情報を取得します（ユーザーへの案内に使用されます） | @@ -243,6 +243,9 @@ const fWorksheet = fWorkbook.getActiveSheet() // 現在のシートのすべてのデータ検証ルールを取得します const rulesOfSheet = fWorksheet.getDataValidations() +// ルール ID でデータ検証ルールを取得します +const ruleById = fWorksheet.getDataValidation(rulesOfSheet[0]?.rule?.uid) + const fRange = fWorksheet.getRange('A1:B10') // 現在の範囲の最初のデータ検証ルールを取得します @@ -293,8 +296,41 @@ setTimeout(() => { }, 6000) ``` +### 検証エラーの取得 + +```typescript +const fWorkbook = univerAPI.getActiveWorkbook() +const fWorksheet = fWorkbook.getActiveSheet() + +// 現在のワークブックのすべてのデータ検証エラーを取得します +const workbookErrors = await fWorkbook.getAllDataValidationErrorAsync() +console.log('workbookErrors:', workbookErrors) + +// 現在のシートのすべてのデータ検証エラーを取得します +const worksheetErrors = await fWorksheet.getAllDataValidationErrorAsync() +console.log('worksheetErrors:', worksheetErrors) + +// 現在の範囲のデータ検証エラーを取得します +const fRange = fWorksheet.getRange('A1:B10') +const rangeErrors = await fRange.getDataValidationErrorAsync() +console.log('rangeErrors:', rangeErrors) +``` + +各エラーオブジェクトには以下のフィールドが含まれます： +- `sheetName`：エラーが発生したワークシートの名前 +- `row`：エラーをトリガーしたセルの行インデックス +- `column`：エラーをトリガーしたセルの列インデックス +- `ruleId`：エラーをトリガーしたルールの ID +- `inputValue`：エラーをトリガーした入力値 +- `rule`：ルールコンテンツのスナップショット + ### バリデータの状態を取得 +バリデータの状態は `DataValidationStatus` の列挙値であり、以下を含みます： +- `valid`：セルの値が検証を通過しました +- `invalid`：セルの値が検証に失敗しました +- `validating`：セルが検証中です + ```typescript const fWorkbook = univerAPI.getActiveWorkbook() const fWorksheet = fWorkbook.getActiveSheet() @@ -317,7 +353,7 @@ fRange.getValidatorStatus().then((status) => { ### イベントリスナー -完全なイベント型定義は、[Events](https://reference.univer.ai/en-US/classes/FEventName) を参照してください。 +完全なイベント型定義は、[Events](https://docs.univer.ai/reference/facade/events) を参照してください。 データ検証モジュールは、ルールの追加、更新、削除、バリデーション状態の変更を監視するための一連のイベントを提供します。すべてのイベントは `univerAPI.addEvent()` で購読できます。 @@ -439,10 +475,38 @@ const disposable = univerAPI.addEvent(univerAPI.Event.SheetDataValidatorStatusCh `Before` プレフィックスが付いたすべてのイベントコールバックは `params.cancel = true` を使用して対応する操作を防止できます。 +### エラースタイル + +`errorStyle` オプションは、無効なデータが入力されたときの動作を制御します。これは `DataValidationErrorStyle` の列挙値であり、以下を含みます： +- `STOP`：ユーザーが無効なデータを入力するのを防ぎます +- `WARNING`：ユーザーが無効なデータを入力することを許可しますが、警告を表示します +- `INFO`：ユーザーが無効なデータを入力することを許可しますが、情報メッセージを表示します + +```typescript +const fWorkbook = univerAPI.getActiveWorkbook() +const fWorksheet = fWorkbook.getActiveSheet() +const fRange = fWorksheet.getRange('A1:B10') + +const rule = univerAPI.newDataValidation() + .requireNumberBetween(1, 10) + .setOptions({ + allowBlank: true, + showErrorMessage: true, + error: '1 から 10 の間の数値を入力してください', + errorStyle: univerAPI.Enum.DataValidationErrorStyle.STOP, + }) + .build() +fRange.setDataValidation(rule) +``` + ### 変更リストのレンダーモード設定 ```typescript -dataValidation.setOptions({ +const fWorkbook = univerAPI.getActiveWorkbook() +const fWorksheet = fWorkbook.getActiveSheet() +const fRange = fWorksheet.getRange('A1:B10') + +fRange.getDataValidation()?.setOptions({ // support TEXT, ARROW, CUSTOM // default is `CUSTOM` renderMode: univerAPI.Enum.DataValidationRenderMode.TEXT, diff --git a/content/guides/sheets/features/data-validation.mdx b/content/guides/sheets/features/data-validation.mdx index ba3343b4..330e3775 100644 --- a/content/guides/sheets/features/data-validation.mdx +++ b/content/guides/sheets/features/data-validation.mdx @@ -89,8 +89,8 @@ UniverSheetsDataValidationPreset({ }) ``` -{/* 完整的配置项参考 [`IUniverSheetsDataValidationPresetConfig`](https://github.com/dream-num/univer-presets/blob/dev/packages/preset-sheets-data-validation/src/umd.ts#L13)。 */} -Complete configuration options can be found in the [`IUniverSheetsDataValidationPresetConfig`](https://github.com/dream-num/univer-presets/blob/dev/packages/preset-sheets-data-validation/src/umd.ts#L13). +{/* 完整的配置项参考 [`IUniverSheetsDataValidationPresetConfig`](https://github.com/dream-num/univer-presets/tree/dev/packages/preset-sheets-data-validation)。 */} +Complete configuration options can be found in the [`IUniverSheetsDataValidationPresetConfig`](https://github.com/dream-num/univer-presets/tree/dev/packages/preset-sheets-data-validation). ## Plugin Mode @@ -144,8 +144,7 @@ univer.registerPlugin(UniverSheetsDataValidationUIPlugin, { }) ``` -{/* 完整的配置项参考 [IUniverSheetsDataValidationUIConfig](https://github.com/dream-num/univer/blob/dev/packages/sheets-data-validation-ui/src/controllers/config.schema.ts#L23)。 */} -Complete configuration options can be found in the [`IUniverSheetsDataValidationUIConfig`](https://github.com/dream-num/univer/blob/dev/packages/sheets-data-validation-ui/src/controllers/config.schema.ts#L23). +Complete configuration options can be found in the [`IUniverSheetsDataValidationUIConfig`](https://github.com/dream-num/univer/blob/dev/packages/sheets-data-validation-ui/src/config/config.ts). ## Facade API @@ -163,9 +162,9 @@ import '@univerjs/sheets-data-validation/facade' ### Add a data validation rule -[`univerAPI.newDataValidation()`](https://reference.univer.ai/en-US/classes/FUniver#newdatavalidation) can create a new data validation builder, which returns an `FDataValidationBuilder` instance that can generate data validation rules through chained calls. +[`univerAPI.newDataValidation()`](https://docs.univer.ai/reference/facade/univer#newdatavalidation) can create a new data validation builder, which returns an `FDataValidationBuilder` instance that can generate data validation rules through chained calls. -Here are some member methods on [`FDataValidationBuilder`](https://reference.univer.ai/en-US/classes/FDataValidationBuilder): +Here are some member methods on [`FDataValidationBuilder`](https://docs.univer.ai/reference/facade/data-validation): | Method | Description | | ------ | ----------- | @@ -187,15 +186,15 @@ Here are some member methods on [`FDataValidationBuilder`](https://reference.uni | requireNumberLessThanOrEqualTo | Sets the data validation rule to require a number less than or equal to the given value | | requireNumberNotBetween | Sets the data validation rule to require a number that does not fall between, and is neither of, two specified numbers | | requireNumberNotEqualTo | Sets the data validation rule to require a number not equal to the given value | -| requireValueInList | Sets a data validation rule that requires the user to enter a value from a list of specific values | -| requireValueInRange | Sets a data validation rule that requires the user to enter a value within a specific range | +| requireValueInList | Sets a data validation rule that requires the user to enter a value from a list of specific values. Supports single/multiple selection and show/hide dropdown | +| requireValueInRange | Sets a data validation rule that requires the user to enter a value within a specific range. Supports single/multiple selection and show/hide dropdown | | setOptions | Sets the options for the data validation rule | ```typescript const fWorkbook = univerAPI.getActiveWorkbook() const fWorksheet = fWorkbook.getActiveSheet() -// Create a new data validation rule that requires a number between 1 and 10 fot the range A1:B10 +// Create a new data validation rule that requires a number between 1 and 10 for the range A1:B10 const fRange = fWorksheet.getRange('A1:B10') const rule = univerAPI.newDataValidation() .requireNumberBetween(1, 10) @@ -223,10 +222,11 @@ fRange.setDataValidation(null) The returned data validation rule object is an `FDataValidation` instance, which can be used to obtain the conditions, options, etc. of the validation rule. -Here are some member methods on [`FDataValidation`](https://reference.univer.ai/en-US/classes/FDataValidation): +Here are some member methods on [`FDataValidation`](https://docs.univer.ai/reference/facade/data-validation): | Method | Description | | ---- | ---- | +| copy | Creates a new instance of FDataValidationBuilder using the current rule object | | getCriteriaType | Gets the data validation type of the rule | | getCriteriaValues | Gets the values used for criteria evaluation | | getHelpText | Gets the help text information, which is used to provide users with guidance and support | @@ -243,6 +243,9 @@ const fWorksheet = fWorkbook.getActiveSheet() // Get all data validation rules in current sheet. const rulesOfSheet = fWorksheet.getDataValidations() +// Get a data validation rule by rule ID. +const ruleById = fWorksheet.getDataValidation(rulesOfSheet[0]?.rule?.uid) + const fRange = fWorksheet.getRange('A1:B10') // Get first data validation rule in current range. @@ -293,8 +296,41 @@ setTimeout(() => { }, 6000) ``` +### Get validation errors + +```typescript +const fWorkbook = univerAPI.getActiveWorkbook() +const fWorksheet = fWorkbook.getActiveSheet() + +// Get all data validation errors for current workbook. +const workbookErrors = await fWorkbook.getAllDataValidationErrorAsync() +console.log('workbookErrors:', workbookErrors) + +// Get all data validation errors for current sheet. +const worksheetErrors = await fWorksheet.getAllDataValidationErrorAsync() +console.log('worksheetErrors:', worksheetErrors) + +// Get data validation errors for current range. +const fRange = fWorksheet.getRange('A1:B10') +const rangeErrors = await fRange.getDataValidationErrorAsync() +console.log('rangeErrors:', rangeErrors) +``` + +Each error object contains the following fields: +- `sheetName`: The name of the worksheet where the error occurred +- `row`: The row index of the cell that triggered the error +- `column`: The column index of the cell that triggered the error +- `ruleId`: The ID of the rule that triggered the error +- `inputValue`: The input value that triggered the error +- `rule`: The rule content snapshot + ### Get validator status +The validator status is an enum value of `DataValidationStatus`, which includes: +- `valid`: The cell value passes validation +- `invalid`: The cell value fails validation +- `validating`: The cell is being validated + ```typescript const fWorkbook = univerAPI.getActiveWorkbook() const fWorksheet = fWorkbook.getActiveSheet() @@ -317,7 +353,7 @@ fRange.getValidatorStatus().then((status) => { ### Event Listeners -Full event type definitions, please refer to [Events](https://reference.univer.ai/en-US/classes/FEventName). +Full event type definitions, please refer to [Events](https://docs.univer.ai/reference/facade/events). The data validation module provides a series of events for monitoring validation rule additions, updates, deletions, and validation status changes. All events can be listened to using `univerAPI.addEvent()`. @@ -439,10 +475,38 @@ Special parameters: All event callbacks with the `Before` prefix can use `params.cancel = true` to prevent the corresponding operation. +### Error style + +The `errorStyle` option controls the behavior when invalid data is entered. It is an enum value of `DataValidationErrorStyle`, which includes: +- `STOP`: Prevents the user from entering invalid data +- `WARNING`: Allows the user to enter invalid data, but displays a warning +- `INFO`: Allows the user to enter invalid data, but displays an information message + +```typescript +const fWorkbook = univerAPI.getActiveWorkbook() +const fWorksheet = fWorkbook.getActiveSheet() +const fRange = fWorksheet.getRange('A1:B10') + +const rule = univerAPI.newDataValidation() + .requireNumberBetween(1, 10) + .setOptions({ + allowBlank: true, + showErrorMessage: true, + error: 'Please enter a number between 1 and 10', + errorStyle: univerAPI.Enum.DataValidationErrorStyle.STOP, + }) + .build() +fRange.setDataValidation(rule) +``` + ### Change List render mode ```typescript -dataValidation.setOptions({ +const fWorkbook = univerAPI.getActiveWorkbook() +const fWorksheet = fWorkbook.getActiveSheet() +const fRange = fWorksheet.getRange('A1:B10') + +fRange.getDataValidation()?.setOptions({ // support TEXT, ARROW, CUSTOM // default is `CUSTOM` renderMode: univerAPI.Enum.DataValidationRenderMode.TEXT, diff --git a/content/guides/sheets/features/data-validation.zh-CN.mdx b/content/guides/sheets/features/data-validation.zh-CN.mdx index 082b4f97..578a5d4c 100644 --- a/content/guides/sheets/features/data-validation.zh-CN.mdx +++ b/content/guides/sheets/features/data-validation.zh-CN.mdx @@ -89,7 +89,7 @@ UniverSheetsDataValidationPreset({ }) ``` -完整的配置项参考 [`IUniverSheetsDataValidationPresetConfig`](https://github.com/dream-num/univer-presets/blob/dev/packages/preset-sheets-data-validation/src/umd.ts#L13)。 +完整的配置项参考 [`IUniverSheetsDataValidationPresetConfig`](https://github.com/dream-num/univer-presets/tree/dev/packages/preset-sheets-data-validation)。 ## 插件模式 @@ -143,7 +143,7 @@ univer.registerPlugin(UniverSheetsDataValidationUIPlugin, { }) ``` -完整的配置项参考 [`IUniverSheetsDataValidationUIConfig`](https://github.com/dream-num/univer/blob/dev/packages/sheets-data-validation-ui/src/controllers/config.schema.ts#L23)。 +完整的配置项参考 [`IUniverSheetsDataValidationUIConfig`](https://github.com/dream-num/univer/blob/dev/packages/sheets-data-validation-ui/src/config/config.ts)。 ## Facade API @@ -161,9 +161,9 @@ import '@univerjs/sheets-data-validation/facade' ### 添加一个数据验证规则 -[`univerAPI.newDataValidation()`](https://reference.univer.ai/zh-CN/classes/FUniver#newdatavalidation) 可以创建一个新的数据验证构建器，返回一个 `FDataValidationBuilder` 实例，可以通过链式调用生成数据验证规则。 +[`univerAPI.newDataValidation()`](https://docs.univer.ai/reference/facade/univer#newdatavalidation) 可以创建一个新的数据验证构建器，返回一个 `FDataValidationBuilder` 实例，可以通过链式调用生成数据验证规则。 -以下是 [`FDataValidationBuilder`](https://reference.univer.ai/zh-CN/classes/FDataValidationBuilder) 上的一些成员方法： +以下是 [`FDataValidationBuilder`](https://docs.univer.ai/reference/facade/data-validation) 上的一些成员方法： | 方法 | 描述 | | ---- | ---- | @@ -185,8 +185,8 @@ import '@univerjs/sheets-data-validation/facade' | requireNumberLessThanOrEqualTo | 设置数据验证规则要求数字小于或等于给定值 | | requireNumberNotBetween | 设置数据验证规则要求数字不在两个指定数字之间，也不是其中之一 | | requireNumberNotEqualTo | 设置数据验证规则要求数字不等于给定值 | -| requireValueInList | 设置数据验证规则，要求用户从特定值列表中输入一个值。 | -| requireValueInRange | 设置数据验证规则，要求用户输入特定范围内的值 | +| requireValueInList | 设置数据验证规则，要求用户从特定值列表中输入一个值。支持单选/多选，支持显示/隐藏下拉框 | +| requireValueInRange | 设置数据验证规则，要求用户输入特定范围内的值。支持单选/多选，支持显示/隐藏下拉框 | | setOptions | 设置数据验证规则的选项 | ```typescript @@ -221,10 +221,11 @@ fRange.setDataValidation(null) 返回的数据验证规则对象是一个 `FDataValidation` 实例，可以通过该实例获取验证规则的条件、选项等。 -以下是 [`FDataValidation`](https://reference.univer.ai/zh-CN/classes/FDataValidation) 上的一些成员方法： +以下是 [`FDataValidation`](https://docs.univer.ai/reference/facade/data-validation) 上的一些成员方法： | 方法 | 描述 | | ---- | ---- | +| copy | 使用当前规则对象创建一个新的 FDataValidationBuilder 实例 | | getCriteriaType | 获取数据验证规则的类型 | | getCriteriaValues | 获取数据验证规则的条件值 | | getHelpText | 获取帮助文本信息，用于为用户提供指导和支持 | @@ -241,6 +242,9 @@ const fWorksheet = fWorkbook.getActiveSheet() // 获取当前工作表的所有数据验证规则 const rulesOfSheet = fWorksheet.getDataValidations() +// 通过规则 ID 获取数据验证规则 +const ruleById = fWorksheet.getDataValidation(rulesOfSheet[0]?.rule?.uid) + const fRange = fWorksheet.getRange('A1:B10') // 获取当前范围的第一个数据验证规则 @@ -291,8 +295,41 @@ setTimeout(() => { }, 6000) ``` +### 获取验证错误 + +```typescript +const fWorkbook = univerAPI.getActiveWorkbook() +const fWorksheet = fWorkbook.getActiveSheet() + +// 获取当前工作簿的所有数据验证错误 +const workbookErrors = await fWorkbook.getAllDataValidationErrorAsync() +console.log('workbookErrors:', workbookErrors) + +// 获取当前工作表的所有数据验证错误 +const worksheetErrors = await fWorksheet.getAllDataValidationErrorAsync() +console.log('worksheetErrors:', worksheetErrors) + +// 获取当前范围的数据验证错误 +const fRange = fWorksheet.getRange('A1:B10') +const rangeErrors = await fRange.getDataValidationErrorAsync() +console.log('rangeErrors:', rangeErrors) +``` + +每个错误对象包含以下字段： +- `sheetName`：发生错误的工作表名称 +- `row`：触发错误的单元格行索引 +- `column`：触发错误的单元格列索引 +- `ruleId`：触发错误的规则 ID +- `inputValue`：触发错误的输入值 +- `rule`：规则内容快照 + ### 查询校验状态 +校验状态是 `DataValidationStatus` 的枚举值，包括： +- `valid`：单元格值通过验证 +- `invalid`：单元格值未通过验证 +- `validating`：单元格正在验证中 + ```typescript const fWorkbook = univerAPI.getActiveWorkbook() const fWorksheet = fWorkbook.getActiveSheet() @@ -313,7 +350,7 @@ fRange.getValidatorStatus().then((status) => { ### 事件监听 -完整事件类型定义，请查看 [Events](https://reference.univer.ai/zh-CN/classes/FEventName)。 +完整事件类型定义，请查看 [Events](https://docs.univer.ai/reference/facade/events)。 数据验证模块提供了一系列事件用于监听验证规则的添加、更新、删除和验证状态变更。所有事件都可以通过 `univerAPI.addEvent()` 进行监听。 @@ -435,10 +472,38 @@ const disposable = univerAPI.addEvent(univerAPI.Event.SheetDataValidatorStatusCh 所有 `Before` 前缀的事件回调函数都可以使用 `params.cancel = true` 来阻止对应的操作。 +### 错误样式 + +`errorStyle` 选项控制输入无效数据时的行为。它是 `DataValidationErrorStyle` 的枚举值，包括： +- `STOP`：阻止用户输入无效数据 +- `WARNING`：允许用户输入无效数据，但显示警告 +- `INFO`：允许用户输入无效数据，但显示信息提示 + +```typescript +const fWorkbook = univerAPI.getActiveWorkbook() +const fWorksheet = fWorkbook.getActiveSheet() +const fRange = fWorksheet.getRange('A1:B10') + +const rule = univerAPI.newDataValidation() + .requireNumberBetween(1, 10) + .setOptions({ + allowBlank: true, + showErrorMessage: true, + error: '请输入 1 到 10 之间的数字', + errorStyle: univerAPI.Enum.DataValidationErrorStyle.STOP, + }) + .build() +fRange.setDataValidation(rule) +``` + ### 变更列表型验证的渲染模式 ```typescript -dataValidation.setOptions({ +const fWorkbook = univerAPI.getActiveWorkbook() +const fWorksheet = fWorkbook.getActiveSheet() +const fRange = fWorksheet.getRange('A1:B10') + +fRange.getDataValidation()?.setOptions({ // support TEXT, ARROW, CUSTOM // default is `CUSTOM` renderMode: univerAPI.Enum.DataValidationRenderMode.TEXT, diff --git a/content/guides/sheets/features/data-validation.zh-TW.mdx b/content/guides/sheets/features/data-validation.zh-TW.mdx index ea6f50a4..a2c323ab 100644 --- a/content/guides/sheets/features/data-validation.zh-TW.mdx +++ b/content/guides/sheets/features/data-validation.zh-TW.mdx @@ -89,7 +89,7 @@ UniverSheetsDataValidationPreset({ }) ``` -完整的配置項參考 [`IUniverSheetsDataValidationPresetConfig`](https://github.com/dream-num/univer-presets/blob/dev/packages/preset-sheets-data-validation/src/umd.ts#L13)。 +完整的配置項參考 [`IUniverSheetsDataValidationPresetConfig`](https://github.com/dream-num/univer-presets/tree/dev/packages/preset-sheets-data-validation)。 ## 外掛模式 @@ -143,7 +143,7 @@ univer.registerPlugin(UniverSheetsDataValidationUIPlugin, { }) ``` -完整的配置項參考 [`IUniverSheetsDataValidationUIConfig`](https://github.com/dream-num/univer/blob/dev/packages/sheets-data-validation-ui/src/controllers/config.schema.ts#L23)。 +完整的配置項參考 [`IUniverSheetsDataValidationUIConfig`](https://github.com/dream-num/univer/blob/dev/packages/sheets-data-validation-ui/src/config/config.ts)。 ## Facade API @@ -161,9 +161,9 @@ import '@univerjs/sheets-data-validation/facade' ### 新增一個資料驗證規則 -[`univerAPI.newDataValidation()`](https://reference.univer.ai/zh-TW/classes/FUniver#newdatavalidation) 可以建立一個新的資料驗證構建器，返回一個 `FDataValidationBuilder` 例項，可以透過鏈式呼叫生成資料驗證規則。 +[`univerAPI.newDataValidation()`](https://docs.univer.ai/reference/facade/univer#newdatavalidation) 可以建立一個新的資料驗證構建器，返回一個 `FDataValidationBuilder` 例項，可以透過鏈式呼叫生成資料驗證規則。 -以下是 [`FDataValidationBuilder`](https://reference.univer.ai/zh-TW/classes/FDataValidationBuilder) 上的一些成員方法： +以下是 [`FDataValidationBuilder`](https://docs.univer.ai/reference/facade/data-validation) 上的一些成員方法： | 方法 | 描述 | | ---- | ---- | @@ -185,8 +185,8 @@ import '@univerjs/sheets-data-validation/facade' | requireNumberLessThanOrEqualTo | 設定資料驗證規則要求數字小於或等於給定值 | | requireNumberNotBetween | 設定資料驗證規則要求數字不在兩個指定數字之間，也不是其中之一 | | requireNumberNotEqualTo | 設定資料驗證規則要求數字不等於給定值 | -| requireValueInList | 設定資料驗證規則，要求使用者從特定值列表中輸入一個值。 | -| requireValueInRange | 設定資料驗證規則，要求使用者輸入特定範圍內的值 | +| requireValueInList | 設定資料驗證規則，要求使用者從特定值列表中輸入一個值。支援單選/多選，支援顯示/隱藏下拉框 | +| requireValueInRange | 設定資料驗證規則，要求使用者輸入特定範圍內的值。支援單選/多選，支援顯示/隱藏下拉框 | | setOptions | 設定資料驗證規則的選項 | ```typescript @@ -221,10 +221,11 @@ fRange.setDataValidation(null) 返回的資料驗證規則物件是一個 `FDataValidation` 例項，可以透過該例項獲取驗證規則的條件、選項等。 -以下是 [`FDataValidation`](https://reference.univer.ai/zh-TW/classes/FDataValidation) 上的一些成員方法： +以下是 [`FDataValidation`](https://docs.univer.ai/reference/facade/data-validation) 上的一些成員方法： | 方法 | 描述 | | ---- | ---- | +| copy | 使用當前規則物件建立一個新的 FDataValidationBuilder 實例 | | getCriteriaType | 獲取資料驗證規則的型別 | | getCriteriaValues | 獲取資料驗證規則的條件值 | | getHelpText | 獲取幫助文字資訊，用於為使用者提供指導和支援 | @@ -241,6 +242,9 @@ const fWorksheet = fWorkbook.getActiveSheet() // 獲取當前工作表的所有資料驗證規則 const rulesOfSheet = fWorksheet.getDataValidations() +// 透過規則 ID 獲取資料驗證規則 +const ruleById = fWorksheet.getDataValidation(rulesOfSheet[0]?.rule?.uid) + const fRange = fWorksheet.getRange('A1:B10') // 獲取當前範圍的第一個資料驗證規則 @@ -291,8 +295,41 @@ setTimeout(() => { }, 6000) ``` +### 獲取驗證錯誤 + +```typescript +const fWorkbook = univerAPI.getActiveWorkbook() +const fWorksheet = fWorkbook.getActiveSheet() + +// 獲取當前工作簿的所有資料驗證錯誤 +const workbookErrors = await fWorkbook.getAllDataValidationErrorAsync() +console.log('workbookErrors:', workbookErrors) + +// 獲取當前工作表的所有資料驗證錯誤 +const worksheetErrors = await fWorksheet.getAllDataValidationErrorAsync() +console.log('worksheetErrors:', worksheetErrors) + +// 獲取當前範圍的資料驗證錯誤 +const fRange = fWorksheet.getRange('A1:B10') +const rangeErrors = await fRange.getDataValidationErrorAsync() +console.log('rangeErrors:', rangeErrors) +``` + +每個錯誤物件包含以下欄位： +- `sheetName`：發生錯誤的工作表名稱 +- `row`：觸發錯誤的儲存格列索引 +- `column`：觸發錯誤的儲存格欄索引 +- `ruleId`：觸發錯誤的規則 ID +- `inputValue`：觸發錯誤的輸入值 +- `rule`：規則內容快照 + ### 查詢校驗狀態 +校驗狀態是 `DataValidationStatus` 的列舉值，包括： +- `valid`：儲存格值通過驗證 +- `invalid`：儲存格值未通過驗證 +- `validating`：儲存格正在驗證中 + ```typescript const fWorkbook = univerAPI.getActiveWorkbook() const fWorksheet = fWorkbook.getActiveSheet() @@ -313,7 +350,7 @@ fRange.getValidatorStatus().then((status) => { ### 事件監聽 -完整事件型別定義，請檢視 [Events](https://reference.univer.ai/zh-TW/classes/FEventName)。 +完整事件型別定義，請檢視 [Events](https://docs.univer.ai/reference/facade/events)。 資料驗證模組提供了一系列事件用於監聽驗證規則的新增、更新、刪除和驗證狀態變更。所有事件都可以透過 `univerAPI.addEvent()` 進行監聽。 @@ -435,10 +472,38 @@ const disposable = univerAPI.addEvent(univerAPI.Event.SheetDataValidatorStatusCh 所有 `Before` 字首的事件回撥函式都可以使用 `params.cancel = true` 來阻止對應的操作。 +### 錯誤樣式 + +`errorStyle` 選項控制輸入無效資料時的行為。它是 `DataValidationErrorStyle` 的列舉值，包括： +- `STOP`：阻止使用者輸入無效資料 +- `WARNING`：允許使用者輸入無效資料，但顯示警告 +- `INFO`：允許使用者輸入無效資料，但顯示資訊提示 + +```typescript +const fWorkbook = univerAPI.getActiveWorkbook() +const fWorksheet = fWorkbook.getActiveSheet() +const fRange = fWorksheet.getRange('A1:B10') + +const rule = univerAPI.newDataValidation() + .requireNumberBetween(1, 10) + .setOptions({ + allowBlank: true, + showErrorMessage: true, + error: '請輸入 1 到 10 之間的數字', + errorStyle: univerAPI.Enum.DataValidationErrorStyle.STOP, + }) + .build() +fRange.setDataValidation(rule) +``` + ### 變更列表型驗證的渲染模式 ```typescript -dataValidation.setOptions({ +const fWorkbook = univerAPI.getActiveWorkbook() +const fWorksheet = fWorkbook.getActiveSheet() +const fRange = fWorksheet.getRange('A1:B10') + +fRange.getDataValidation()?.setOptions({ // support TEXT, ARROW, CUSTOM // default is `CUSTOM` renderMode: univerAPI.Enum.DataValidationRenderMode.TEXT, diff --git a/content/guides/sheets/features/filter.ja-JP.mdx b/content/guides/sheets/features/filter.ja-JP.mdx index 1ba623cb..3688a128 100644 --- a/content/guides/sheets/features/filter.ja-JP.mdx +++ b/content/guides/sheets/features/filter.ja-JP.mdx @@ -61,7 +61,7 @@ const { univerAPI } = createUniver({ }) ``` -### Presets and Configuration +### プリセットと設定 ```typescript interface IUniverSheetsFilterPresetConfig { @@ -108,7 +108,7 @@ univer.registerPlugin(UniverSheetsFilterPlugin) // [!code ++] univer.registerPlugin(UniverSheetsFilterUIPlugin) // [!code ++] ``` -### Plugins and Configuration +### プラグインと設定 ```typescript interface IUniverSheetsFilterConfig { @@ -138,10 +138,10 @@ import '@univerjs/sheets-filter/facade' ### フィルターの取得 -[`FFilter`](https://reference.univer.ai/en-US/classes/FFilter) オブジェクトを返します。シートにフィルターが存在しない場合は `null` を返します。 +[`FFilter`](https://docs.univer.ai/reference/facade/filter) オブジェクトを返します。シートにフィルターが存在しない場合は `null` を返します。 -- `FWorksheet` オブジェクトでは [`getFilter()`](https://reference.univer.ai/en-US/classes/FWorksheet#getfilter) を使用 -- `FRange` オブジェクトでは [`getFilter()`](https://reference.univer.ai/en-US/classes/FRange#getfilter) を使用 +- `FWorksheet` オブジェクトでは [`getFilter()`](https://docs.univer.ai/reference/facade/worksheet#getfilter) を使用 +- `FRange` オブジェクトでは [`getFilter()`](https://docs.univer.ai/reference/facade/range#getfilter) を使用 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -159,9 +159,9 @@ fFilter2?.getRange().getA1Notation() ### フィルターの作成 -[`FFilter`](https://reference.univer.ai/en-US/classes/FFilter) オブジェクトを新規作成します。シートに既にフィルターが存在する場合は `null` を返します。 +[`FFilter`](https://docs.univer.ai/reference/facade/filter) オブジェクトを新規作成します。シートに既にフィルターが存在する場合は `null` を返します。 -- `FRange` オブジェクト上で [`createFilter()`](https://reference.univer.ai/en-US/classes/FRange#createfilter) を使用 +- `FRange` オブジェクト上で [`createFilter()`](https://docs.univer.ai/reference/facade/range#createfilter) を使用 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -179,7 +179,7 @@ fFilter.getRange().getA1Notation() ### フィルターの削除 -[`FFilter.remove()`](https://reference.univer.ai/en-US/classes/FFilter#remove) メソッドはフィルターを削除します。 +[`FFilter.remove()`](https://docs.univer.ai/reference/facade/filter#remove) メソッドはフィルターを削除します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -189,7 +189,7 @@ fWorksheet.getFilter()?.remove() ### 列フィルター条件の取得 -[`FFilter.getColumnFilterCriteria(column)`](https://reference.univer.ai/en-US/classes/FFilter#getcolumnfiltercriteria) は指定した列のフィルター条件を返します。 +[`FFilter.getColumnFilterCriteria(column)`](https://docs.univer.ai/reference/facade/filter#getcolumnfiltercriteria) は指定した列のフィルター条件を返します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -235,7 +235,7 @@ fFilter.getColumnFilterCriteria(column + 1) // undefined ### 列フィルター条件の設定 -[`FFilter.setColumnFilterCriteria(column, criteria)`](https://reference.univer.ai/en-US/classes/FFilter#setcolumnfiltercriteria) は指定列のフィルター条件を設定します。 +[`FFilter.setColumnFilterCriteria(column, criteria)`](https://docs.univer.ai/reference/facade/filter#setcolumnfiltercriteria) は指定列のフィルター条件を設定します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -277,8 +277,8 @@ fFilter.setColumnFilterCriteria(column, { ### 列フィルター条件の削除 -- [`FFilter.removeColumnFilterCriteria(column)`](https://reference.univer.ai/en-US/classes/FFilter#removecolumnfiltercriteria) は指定列のフィルター条件を削除します。 -- [`FFilter.removeFilterCriteria()`](https://reference.univer.ai/en-US/classes/FFilter#removefiltercriteria) はすべての列のフィルター条件を削除します。 +- [`FFilter.removeColumnFilterCriteria(column)`](https://docs.univer.ai/reference/facade/filter#removecolumnfiltercriteria) は指定列のフィルター条件を削除します。 +- [`FFilter.removeFilterCriteria()`](https://docs.univer.ai/reference/facade/filter#removefiltercriteria) はすべての列のフィルター条件を削除します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -326,7 +326,7 @@ setTimeout(() => { ### 除外された行の取得 -[`FFilter.getFilteredOutRows()`](https://reference.univer.ai/en-US/classes/FFilter#getfilteredoutrows) はフィルターにより非表示（除外）された行インデックスの配列を返します。 +[`FFilter.getFilteredOutRows()`](https://docs.univer.ai/reference/facade/filter#getfilteredoutrows) はフィルターにより非表示（除外）された行インデックスの配列を返します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -371,7 +371,7 @@ fFilter.getFilteredOutRows() // [1, 2, 3, 5, 6, 7, 9] ### イベントリスナー -完全なイベント型定義は [Events](https://reference.univer.ai/en-US/classes/FEventName) を参照してください。 +完全なイベント型定義は [Events](https://docs.univer.ai/reference/facade/events) を参照してください。 `SheetRangeFiltered` イベントは列フィルター条件が変更されたときにトリガーされます。 diff --git a/content/guides/sheets/features/filter.mdx b/content/guides/sheets/features/filter.mdx index 8435d452..71955fe1 100644 --- a/content/guides/sheets/features/filter.mdx +++ b/content/guides/sheets/features/filter.mdx @@ -133,15 +133,15 @@ Complete Facade API type definitions can be found in the [FacadeAPI](https://ref ```typescript -import '@univerjs/sheets-numfmt/facade' +import '@univerjs/sheets-filter/facade' ``` ### Get Filter -Returns an [`FFilter`](https://reference.univer.ai/en-US/classes/FFilter) object. If the sheet does not have a filter, it returns `null`. +Returns an [`FFilter`](https://docs.univer.ai/reference/facade/filter) object. If the sheet does not have a filter, it returns `null`. -- On the `FWorksheet` object, use [`getFilter()`](https://reference.univer.ai/en-US/classes/FWorksheet#getfilter) -- On the `FRange` object, use [`getFilter()`](https://reference.univer.ai/en-US/classes/FRange#getfilter) +- On the `FWorksheet` object, use [`getFilter()`](https://docs.univer.ai/reference/facade/worksheet#getfilter) +- On the `FRange` object, use [`getFilter()`](https://docs.univer.ai/reference/facade/range#getfilter) ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -159,9 +159,9 @@ fFilter2?.getRange().getA1Notation() ### Create Filter -Creates an [`FFilter`](https://reference.univer.ai/en-US/classes/FFilter) object. If the sheet already has a filter, it returns `null`. +Creates an [`FFilter`](https://docs.univer.ai/reference/facade/filter) object. If the sheet already has a filter, it returns `null`. -- On the `FRange` object, use [`createFilter()`](https://reference.univer.ai/en-US/classes/FRange#createfilter) +- On the `FRange` object, use [`createFilter()`](https://docs.univer.ai/reference/facade/range#createfilter) ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -179,7 +179,7 @@ fFilter.getRange().getA1Notation() ### Remove Filter -[`FFilter.remove()`](https://reference.univer.ai/en-US/classes/FFilter#remove) 方法移除筛选器。 +[`FFilter.remove()`](https://docs.univer.ai/reference/facade/filter#remove) removes the filter from the worksheet. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -189,7 +189,7 @@ fWorksheet.getFilter()?.remove() ### Get Column Filter Criteria -[`FFilter.getColumnFilterCriteria(column)`](https://reference.univer.ai/en-US/classes/FFilter#getcolumnfiltercriteria) 方法返回指定列的筛选条件。 +The [`FFilter.getColumnFilterCriteria(column)`](https://docs.univer.ai/reference/facade/filter#getcolumnfiltercriteria) method returns the filter criteria of the specified column. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -210,7 +210,7 @@ fRange.setValues([ [10, 11, 12, 13], ]) -// Set some values of the range C1:F10 +// Create a filter on the range C1:F10 let fFilter = fRange.createFilter() // If the filter already exists, remove it and create a new one @@ -235,7 +235,7 @@ fFilter.getColumnFilterCriteria(column + 1) // undefined ### Set Column Filter Criteria -[`FFilter.setColumnFilterCriteria(column, criteria)`](https://reference.univer.ai/en-US/classes/FFilter#setcolumnfiltercriteria) method sets the filter criteria of the specified column. +[`FFilter.setColumnFilterCriteria(column, criteria)`](https://docs.univer.ai/reference/facade/filter#setcolumnfiltercriteria) method sets the filter criteria of the specified column. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -277,8 +277,8 @@ fFilter.setColumnFilterCriteria(column, { ### Remove Column Filter Criteria -- [`FFilter.removeColumnFilterCriteria(column)`](https://reference.univer.ai/en-US/classes/FFilter#removecolumnfiltercriteria) method removes the filter criteria of the specified column. -- [`FFilter.removeFilterCriteria()`](https://reference.univer.ai/en-US/classes/FFilter#removefiltercriteria) method removes the filter criteria of all columns. +- [`FFilter.removeColumnFilterCriteria(column)`](https://docs.univer.ai/reference/facade/filter#removecolumnfiltercriteria) method removes the filter criteria of the specified column. +- [`FFilter.removeFilterCriteria()`](https://docs.univer.ai/reference/facade/filter#removefiltercriteria) method removes the filter criteria of all columns. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -326,7 +326,7 @@ setTimeout(() => { ### Get Filtered Out Rows -[`FFilter.getFilteredOutRows()`](https://reference.univer.ai/en-US/classes/FFilter#getfilteredoutrows) method returns an array containing the indexes of the rows that are filtered out. +[`FFilter.getFilteredOutRows()`](https://docs.univer.ai/reference/facade/filter#getfilteredoutrows) method returns an array containing the indexes of the rows that are filtered out. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -371,7 +371,7 @@ fFilter.getFilteredOutRows() // [1, 2, 3, 5, 6, 7, 9] ### Event Listeners -Complete event type definitions can be found in the [Events](https://reference.univer.ai/en-US/classes/FEventName). +Complete event type definitions can be found in the [Events](https://docs.univer.ai/reference/facade/events). `SheetRangeFiltered` event is triggered when the column filter criteria changes. diff --git a/content/guides/sheets/features/filter.zh-CN.mdx b/content/guides/sheets/features/filter.zh-CN.mdx index 1558ad83..967d3b6d 100644 --- a/content/guides/sheets/features/filter.zh-CN.mdx +++ b/content/guides/sheets/features/filter.zh-CN.mdx @@ -133,15 +133,15 @@ interface IUniverSheetsFilterConfig { ```typescript -import '@univerjs/sheets-numfmt/facade' +import '@univerjs/sheets-filter/facade' ``` ### 获取筛选器 -返回一个 [`FFilter`](https://reference.univer.ai/zh-CN/classes/FFilter) 对象，若 sheet 没有筛选器，则返回 `null`。 +返回一个 [`FFilter`](https://docs.univer.ai/reference/facade/filter) 对象，若 sheet 没有筛选器，则返回 `null`。 -- `FWorksheet` 对象上的 [`getFilter()`](https://reference.univer.ai/zh-CN/classes/FWorksheet#getfilter) -- `FRange` 对象上的 [`getFilter()`](https://reference.univer.ai/zh-CN/classes/FRange#getfilter) +- `FWorksheet` 对象上的 [`getFilter()`](https://docs.univer.ai/reference/facade/worksheet#getfilter) +- `FRange` 对象上的 [`getFilter()`](https://docs.univer.ai/reference/facade/range#getfilter) ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -159,9 +159,9 @@ fFilter2?.getRange().getA1Notation() ### 创建筛选器 -创建一个 [`FFilter`](https://reference.univer.ai/zh-CN/classes/FFilter) 对象，若 sheet 已经有筛选器，则返回 `null`。 +创建一个 [`FFilter`](https://docs.univer.ai/reference/facade/filter) 对象，若 sheet 已经有筛选器，则返回 `null`。 -- `FRange` 对象上的 [`createFilter()`](https://reference.univer.ai/zh-CN/classes/FRange#createfilter) +- `FRange` 对象上的 [`createFilter()`](https://docs.univer.ai/reference/facade/range#createfilter) ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -179,7 +179,7 @@ fFilter.getRange().getA1Notation() ### 移除筛选器 -[`FFilter.remove()`](https://reference.univer.ai/zh-CN/classes/FFilter#remove) 方法移除筛选器。 +[`FFilter.remove()`](https://docs.univer.ai/reference/facade/filter#remove) 方法移除筛选器。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -189,7 +189,7 @@ fWorksheet.getFilter()?.remove() ### 获取列过滤条件 -[`FFilter.getColumnFilterCriteria(column)`](https://reference.univer.ai/zh-CN/classes/FFilter#getcolumnfiltercriteria) 方法返回指定列的筛选条件。 +[`FFilter.getColumnFilterCriteria(column)`](https://docs.univer.ai/reference/facade/filter#getcolumnfiltercriteria) 方法返回指定列的筛选条件。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -235,7 +235,7 @@ fFilter.getColumnFilterCriteria(column + 1) // undefined ### 设置列筛选条件 -[`FFilter.setColumnFilterCriteria(column, criteria)`](https://reference.univer.ai/zh-CN/classes/FFilter#setcolumnfiltercriteria) 方法设置指定列的筛选条件。 +[`FFilter.setColumnFilterCriteria(column, criteria)`](https://docs.univer.ai/reference/facade/filter#setcolumnfiltercriteria) 方法设置指定列的筛选条件。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -277,8 +277,8 @@ fFilter.setColumnFilterCriteria(column, { ### 移除列筛选条件 -- [`FFilter.removeColumnFilterCriteria(column)`](https://reference.univer.ai/zh-CN/classes/FFilter#removecolumnfiltercriteria) 方法移除指定列的筛选条件。 -- [`FFilter.removeFilterCriteria()`](https://reference.univer.ai/zh-CN/classes/FFilter#removefiltercriteria) 方法移除所有列的筛选条件。 +- [`FFilter.removeColumnFilterCriteria(column)`](https://docs.univer.ai/reference/facade/filter#removecolumnfiltercriteria) 方法移除指定列的筛选条件。 +- [`FFilter.removeFilterCriteria()`](https://docs.univer.ai/reference/facade/filter#removefiltercriteria) 方法移除所有列的筛选条件。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -326,7 +326,7 @@ setTimeout(() => { ### 获取过滤掉的行 -[`FFilter.getFilteredOutRows()`](https://reference.univer.ai/zh-CN/classes/FFilter#getfilteredoutrows) 方法返回一个数组，包含被筛选掉的行的索引。 +[`FFilter.getFilteredOutRows()`](https://docs.univer.ai/reference/facade/filter#getfilteredoutrows) 方法返回一个数组，包含被筛选掉的行的索引。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -371,7 +371,7 @@ fFilter.getFilteredOutRows() // [1, 2, 3, 5, 6, 7, 9] ### 事件监听 -完整事件类型定义，请查看 [Events](https://reference.univer.ai/zh-CN/classes/FEventName)。 +完整事件类型定义，请查看 [Events](https://docs.univer.ai/reference/facade/events)。 `SheetRangeFiltered` 事件在列过滤条件发生改变时触发。 diff --git a/content/guides/sheets/features/filter.zh-TW.mdx b/content/guides/sheets/features/filter.zh-TW.mdx index f8fd169f..ef3bd40c 100644 --- a/content/guides/sheets/features/filter.zh-TW.mdx +++ b/content/guides/sheets/features/filter.zh-TW.mdx @@ -133,15 +133,15 @@ interface IUniverSheetsFilterConfig { ```typescript -import '@univerjs/sheets-numfmt/facade' +import '@univerjs/sheets-filter/facade' ``` ### 獲取篩選器 -返回一個 [`FFilter`](https://reference.univer.ai/zh-TW/classes/FFilter) 物件，若 sheet 沒有篩選器，則返回 `null`。 +返回一個 [`FFilter`](https://docs.univer.ai/reference/facade/filter) 物件，若 sheet 沒有篩選器，則返回 `null`。 -- `FWorksheet` 物件上的 [`getFilter()`](https://reference.univer.ai/zh-TW/classes/FWorksheet#getfilter) -- `FRange` 物件上的 [`getFilter()`](https://reference.univer.ai/zh-TW/classes/FRange#getfilter) +- `FWorksheet` 物件上的 [`getFilter()`](https://docs.univer.ai/reference/facade/worksheet#getfilter) +- `FRange` 物件上的 [`getFilter()`](https://docs.univer.ai/reference/facade/range#getfilter) ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -159,9 +159,9 @@ fFilter2?.getRange().getA1Notation() ### 建立篩選器 -建立一個 [`FFilter`](https://reference.univer.ai/zh-TW/classes/FFilter) 物件，若 sheet 已經有篩選器，則返回 `null`。 +建立一個 [`FFilter`](https://docs.univer.ai/reference/facade/filter) 物件，若 sheet 已經有篩選器，則返回 `null`。 -- `FRange` 物件上的 [`createFilter()`](https://reference.univer.ai/zh-TW/classes/FRange#createfilter) +- `FRange` 物件上的 [`createFilter()`](https://docs.univer.ai/reference/facade/range#createfilter) ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -179,7 +179,7 @@ fFilter.getRange().getA1Notation() ### 移除篩選器 -[`FFilter.remove()`](https://reference.univer.ai/zh-TW/classes/FFilter#remove) 方法移除篩選器。 +[`FFilter.remove()`](https://docs.univer.ai/reference/facade/filter#remove) 方法移除篩選器。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -189,7 +189,7 @@ fWorksheet.getFilter()?.remove() ### 獲取列過濾條件 -[`FFilter.getColumnFilterCriteria(column)`](https://reference.univer.ai/zh-TW/classes/FFilter#getcolumnfiltercriteria) 方法返回指定列的篩選條件。 +[`FFilter.getColumnFilterCriteria(column)`](https://docs.univer.ai/reference/facade/filter#getcolumnfiltercriteria) 方法返回指定列的篩選條件。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -235,7 +235,7 @@ fFilter.getColumnFilterCriteria(column + 1) // undefined ### 設定列篩選條件 -[`FFilter.setColumnFilterCriteria(column, criteria)`](https://reference.univer.ai/zh-TW/classes/FFilter#setcolumnfiltercriteria) 方法設定指定列的篩選條件。 +[`FFilter.setColumnFilterCriteria(column, criteria)`](https://docs.univer.ai/reference/facade/filter#setcolumnfiltercriteria) 方法設定指定列的篩選條件。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -277,8 +277,8 @@ fFilter.setColumnFilterCriteria(column, { ### 移除列篩選條件 -- [`FFilter.removeColumnFilterCriteria(column)`](https://reference.univer.ai/zh-TW/classes/FFilter#removecolumnfiltercriteria) 方法移除指定列的篩選條件。 -- [`FFilter.removeFilterCriteria()`](https://reference.univer.ai/zh-TW/classes/FFilter#removefiltercriteria) 方法移除所有列的篩選條件。 +- [`FFilter.removeColumnFilterCriteria(column)`](https://docs.univer.ai/reference/facade/filter#removecolumnfiltercriteria) 方法移除指定列的篩選條件。 +- [`FFilter.removeFilterCriteria()`](https://docs.univer.ai/reference/facade/filter#removefiltercriteria) 方法移除所有列的篩選條件。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -326,7 +326,7 @@ setTimeout(() => { ### 獲取過濾掉的行 -[`FFilter.getFilteredOutRows()`](https://reference.univer.ai/zh-TW/classes/FFilter#getfilteredoutrows) 方法返回一個陣列，包含被篩選掉的行的索引。 +[`FFilter.getFilteredOutRows()`](https://docs.univer.ai/reference/facade/filter#getfilteredoutrows) 方法返回一個陣列，包含被篩選掉的行的索引。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -371,7 +371,7 @@ fFilter.getFilteredOutRows() // [1, 2, 3, 5, 6, 7, 9] ### 事件監聽 -完整事件型別定義，請檢視 [Events](https://reference.univer.ai/zh-TW/classes/FEventName)。 +完整事件型別定義，請檢視 [Events](https://docs.univer.ai/reference/facade/events)。 `SheetRangeFiltered` 事件在列過濾條件發生改變時觸發。 diff --git a/content/guides/sheets/features/find-replace.ja-JP.mdx b/content/guides/sheets/features/find-replace.ja-JP.mdx index d14698d2..b1bf5abc 100644 --- a/content/guides/sheets/features/find-replace.ja-JP.mdx +++ b/content/guides/sheets/features/find-replace.ja-JP.mdx @@ -116,7 +116,7 @@ import '@univerjs/sheets-find-replace/facade' `univerAPI.createTextFinderAsync()` はテキスト検索器を作成し、`FTextFinder` インスタンスを返します。 -以下は [`FTextFinder`](https://reference.univer.ai/en-US/classes/FTextFinder) の主なメソッドです。 +以下は [`FTextFinder`](https://docs.univer.ai/reference/facade/find-replace) の主なメソッドです。 | メソッド | 説明 | | ------ | ----------- | diff --git a/content/guides/sheets/features/find-replace.mdx b/content/guides/sheets/features/find-replace.mdx index f27e3eab..1d33fb51 100644 --- a/content/guides/sheets/features/find-replace.mdx +++ b/content/guides/sheets/features/find-replace.mdx @@ -116,7 +116,7 @@ import '@univerjs/sheets-find-replace/facade' `univerAPI.createTextFinderAsync()` creates a text finder and returns an `FTextFinder` instance. -Here are some member methods on [`FTextFinder`](https://reference.univer.ai/en-US/classes/FTextFinder): +Here are some member methods on [`FTextFinder`](https://docs.univer.ai/reference/facade/find-replace): | Method | Description | | ------ | ----------- | diff --git a/content/guides/sheets/features/find-replace.zh-CN.mdx b/content/guides/sheets/features/find-replace.zh-CN.mdx index 49f05d1f..58650f66 100644 --- a/content/guides/sheets/features/find-replace.zh-CN.mdx +++ b/content/guides/sheets/features/find-replace.zh-CN.mdx @@ -116,7 +116,7 @@ import '@univerjs/sheets-find-replace/facade' `univerAPI.createTextFinderAsync()` 创建一个文本查找器，返回一个 `FTextFinder` 实例。 -以下是 [`FTextFinder`](https://reference.univer.ai/zh-CN/classes/FTextFinder) 上的一些成员方法： +以下是 [`FTextFinder`](https://docs.univer.ai/reference/facade/find-replace) 上的一些成员方法： | 方法 | 描述 | | ---- | ---- | diff --git a/content/guides/sheets/features/find-replace.zh-TW.mdx b/content/guides/sheets/features/find-replace.zh-TW.mdx index 12321044..f126ef05 100644 --- a/content/guides/sheets/features/find-replace.zh-TW.mdx +++ b/content/guides/sheets/features/find-replace.zh-TW.mdx @@ -116,7 +116,7 @@ import '@univerjs/sheets-find-replace/facade' `univerAPI.createTextFinderAsync()` 建立一個文字查詢器，返回一個 `FTextFinder` 例項。 -以下是 [`FTextFinder`](https://reference.univer.ai/zh-TW/classes/FTextFinder) 上的一些成員方法： +以下是 [`FTextFinder`](https://docs.univer.ai/reference/facade/find-replace) 上的一些成員方法： | 方法 | 描述 | | ---- | ---- | diff --git a/content/guides/sheets/features/hyper-link.ja-JP.mdx b/content/guides/sheets/features/hyper-link.ja-JP.mdx index 6e6cca87..b49e11d0 100644 --- a/content/guides/sheets/features/hyper-link.ja-JP.mdx +++ b/content/guides/sheets/features/hyper-link.ja-JP.mdx @@ -74,7 +74,7 @@ UniverSheetsHyperLinkPreset({ }) ``` -完全な設定オプションは [`IUniverSheetsHyperLinkPresetConfig`](https://github.com/dream-num/univer-presets/blob/dev/packages/preset-sheets-hyper-link/src/umd.ts#L14) で確認できます。 +完全な設定オプションは [`IUniverSheetsHyperLinkPresetConfig`](/reference/packages/presets/univerjs/preset-sheets-hyper-link) で確認できます。 ## プラグインモード @@ -121,7 +121,7 @@ univer.registerPlugin(UniverSheetsHyperLinkUIPlugin, { }) ``` -完全な設定オプションは [`IUniverSheetsHyperLinkUIConfig`](https://github.com/dream-num/univer/blob/dev/packages/sheets-hyper-link-ui/src/controllers/config.schema.ts#L26) で確認できます。 +完全な設定オプションは [`IUniverSheetsHyperLinkUIConfig`](/reference/packages/plugins/univerjs/sheets-hyper-link-ui) で確認できます。 ## Facade API @@ -197,7 +197,7 @@ setTimeout(() => { ### Event Listeners -イベントの型定義は [Events](https://reference.univer.ai/en-US/classes/FEventName) を参照してください。 +イベントの型定義は [Events](https://docs.univer.ai/reference/facade/events) を参照してください。 ハイパーリンクに関するイベントは `univerAPI.addEvent()` で監視できます。 diff --git a/content/guides/sheets/features/hyper-link.mdx b/content/guides/sheets/features/hyper-link.mdx index 6aaad032..cc3d8a9d 100644 --- a/content/guides/sheets/features/hyper-link.mdx +++ b/content/guides/sheets/features/hyper-link.mdx @@ -74,7 +74,7 @@ UniverSheetsHyperLinkPreset({ }) ``` -Complete configuration options can be found in [`IUniverSheetsHyperLinkPresetConfig`](https://github.com/dream-num/univer-presets/blob/dev/packages/preset-sheets-hyper-link/src/umd.ts#L14). +Complete configuration options can be found in [`IUniverSheetsHyperLinkPresetConfig`](/reference/packages/presets/univerjs/preset-sheets-hyper-link). ## Plugin Mode @@ -121,7 +121,7 @@ univer.registerPlugin(UniverSheetsHyperLinkUIPlugin, { }) ``` -Complete configuration options can be found in [`IUniverSheetsHyperLinkUIConfig`](https://github.com/dream-num/univer/blob/dev/packages/sheets-hyper-link-ui/src/controllers/config.schema.ts#L26). +Complete configuration options can be found in [`IUniverSheetsHyperLinkUIConfig`](/reference/packages/plugins/univerjs/sheets-hyper-link-ui). ## Facade API @@ -197,7 +197,7 @@ setTimeout(() => { ### Event Listeners -Full event type definitions, please refer to [Events](https://reference.univer.ai/en-US/classes/FEventName). +Full event type definitions, please refer to [Events](https://docs.univer.ai/reference/facade/events). You can listen to hyperlink-related events using `univerAPI.addEvent()`: @@ -250,7 +250,7 @@ Each event includes the following common parameters: - `workbook`: Current workbook instance - `worksheet`: Current worksheet instance - `row`: Row index of the cell containing the link -- `column`: Column index of the cell containing the link +- `column`: Column index of the cell containing the link (note: `BeforeSheetLinkAdd` uses `col` instead of `column`) Special parameters: - `BeforeSheetLinkAdd` event includes `link`: The link to be added diff --git a/content/guides/sheets/features/hyper-link.zh-CN.mdx b/content/guides/sheets/features/hyper-link.zh-CN.mdx index 69da5ed7..3a5cced9 100644 --- a/content/guides/sheets/features/hyper-link.zh-CN.mdx +++ b/content/guides/sheets/features/hyper-link.zh-CN.mdx @@ -74,7 +74,7 @@ UniverSheetsHyperLinkPreset({ }) ``` -完整的配置项参考 [`IUniverSheetsHyperLinkPresetConfig`](https://github.com/dream-num/univer-presets/blob/dev/packages/preset-sheets-hyper-link/src/umd.ts#L14)。 +完整的配置项参考 [`IUniverSheetsHyperLinkPresetConfig`](/reference/packages/presets/univerjs/preset-sheets-hyper-link)。 ## 插件模式 @@ -121,7 +121,7 @@ univer.registerPlugin(UniverSheetsHyperLinkUIPlugin, { }) ``` -完整的配置项参考 [`IUniverSheetsHyperLinkUIConfig`](https://github.com/dream-num/univer/blob/dev/packages/sheets-hyper-link-ui/src/controllers/config.schema.ts#L26)。 +完整的配置项参考 [`IUniverSheetsHyperLinkUIConfig`](/reference/packages/plugins/univerjs/sheets-hyper-link-ui)。 ## Facade API @@ -197,7 +197,7 @@ setTimeout(() => { ### 事件监听 -完整事件类型定义，请查看 [Events](https://reference.univer.ai/zh-CN/classes/FEventName)。 +完整事件类型定义，请查看 [Events](https://docs.univer.ai/reference/facade/events)。 通过 `univerAPI.addEvent()` 可以监听超链接相关的事件： diff --git a/content/guides/sheets/features/hyper-link.zh-TW.mdx b/content/guides/sheets/features/hyper-link.zh-TW.mdx index 55093226..30a05e7f 100644 --- a/content/guides/sheets/features/hyper-link.zh-TW.mdx +++ b/content/guides/sheets/features/hyper-link.zh-TW.mdx @@ -74,7 +74,7 @@ UniverSheetsHyperLinkPreset({ }) ``` -完整的配置項參考 [`IUniverSheetsHyperLinkPresetConfig`](https://github.com/dream-num/univer-presets/blob/dev/packages/preset-sheets-hyper-link/src/umd.ts#L14)。 +完整的配置項參考 [`IUniverSheetsHyperLinkPresetConfig`](/reference/packages/presets/univerjs/preset-sheets-hyper-link)。 ## 外掛模式 @@ -121,7 +121,7 @@ univer.registerPlugin(UniverSheetsHyperLinkUIPlugin, { }) ``` -完整的配置項參考 [`IUniverSheetsHyperLinkUIConfig`](https://github.com/dream-num/univer/blob/dev/packages/sheets-hyper-link-ui/src/controllers/config.schema.ts#L26)。 +完整的配置項參考 [`IUniverSheetsHyperLinkUIConfig`](/reference/packages/plugins/univerjs/sheets-hyper-link-ui)。 ## Facade API @@ -197,7 +197,7 @@ setTimeout(() => { ### 事件監聽 -完整事件型別定義，請檢視 [Events](https://reference.univer.ai/zh-TW/classes/FEventName)。 +完整事件型別定義，請檢視 [Events](https://docs.univer.ai/reference/facade/events)。 透過 `univerAPI.addEvent()` 可以監聽超連結相關的事件： diff --git a/content/guides/sheets/features/images.ja-JP.mdx b/content/guides/sheets/features/images.ja-JP.mdx index 2fdc3bc8..402604bf 100644 --- a/content/guides/sheets/features/images.ja-JP.mdx +++ b/content/guides/sheets/features/images.ja-JP.mdx @@ -355,9 +355,9 @@ setTimeout(() => { ### 浮動画像の挿入 -[`FWorksheet.newOverGridImage()`](https://reference.univer.ai/en-US/classes/FWorksheet#newovergridimage) は浮動画像ビルダーを作成し、`FOverGridImageBuilder` のインスタンスを返します。チェーン呼び出しで `ISheetImage` オブジェクトを生成して画像を挿入できます。 +[`FWorksheet.newOverGridImage()`](https://docs.univer.ai/reference/facade/worksheet#newovergridimage) は浮動画像ビルダーを作成し、`FOverGridImageBuilder` のインスタンスを返します。チェーン呼び出しで `ISheetImage` オブジェクトを生成して画像を挿入できます。 -以下は [`FOverGridImageBuilder`](https://reference.univer.ai/en-US/classes/FOverGridImageBuilder) の主なメソッドです: +以下は [`FOverGridImageBuilder`](https://docs.univer.ai/reference/facade/chart) の主なメソッドです: | メソッド | 説明 | | ------ | ----------- | @@ -401,7 +401,7 @@ const result = await fWorksheet.insertImage('https://avatars.githubusercontent.c ### 浮動画像の取得 -`FWorksheet.getImages()` メソッドはワークシート内のすべての浮動画像を取得し、[`FOverGridImage[]`](https://reference.univer.ai/en-US/classes/FOverGridImage) の配列を返します。 +`FWorksheet.getImages()` メソッドはワークシート内のすべての浮動画像を取得し、[`FOverGridImage[]`](https://docs.univer.ai/reference/facade/chart) の配列を返します。 ```typescript const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet() diff --git a/content/guides/sheets/features/images.mdx b/content/guides/sheets/features/images.mdx index f8f4dbb8..9376e578 100644 --- a/content/guides/sheets/features/images.mdx +++ b/content/guides/sheets/features/images.mdx @@ -355,9 +355,9 @@ setTimeout(() => { ### Insert Floating Images -[`FWorksheet.newOverGridImage()`](https://reference.univer.ai/en-US/classes/FWorksheet#newovergridimage) creates a floating image builder, returns an instance of `FOverGridImageBuilder`, and generates an `ISheetImage` object for inserting floating images through chain calls. +[`FWorksheet.newOverGridImage()`](https://docs.univer.ai/reference/facade/worksheet#newovergridimage) creates a floating image builder, returns an instance of `FOverGridImageBuilder`, and generates an `ISheetImage` object for inserting floating images through chain calls. -Here are some member methods on [`FOverGridImageBuilder`](https://reference.univer.ai/en-US/classes/FOverGridImageBuilder): +Here are some member methods on [`FOverGridImageBuilder`](https://docs.univer.ai/reference/facade/chart): | Method | Description | | ------ | ----------- | @@ -401,7 +401,7 @@ const result = await fWorksheet.insertImage('https://avatars.githubusercontent.c ### Get Floating Images -`FWorksheet.getImages()` method can get all floating images in the worksheet, and return an array of [`FOverGridImage[]`](https://reference.univer.ai/en-US/classes/FOverGridImage) instances. +`FWorksheet.getImages()` method can get all floating images in the worksheet, and return an array of [`FOverGridImage[]`](https://docs.univer.ai/reference/facade/chart) instances. ```typescript const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet() diff --git a/content/guides/sheets/features/images.zh-CN.mdx b/content/guides/sheets/features/images.zh-CN.mdx index 955379f3..0f7c5744 100644 --- a/content/guides/sheets/features/images.zh-CN.mdx +++ b/content/guides/sheets/features/images.zh-CN.mdx @@ -355,9 +355,9 @@ setTimeout(() => { ### 插入浮动图片 -[`FWorksheet.newOverGridImage()`](https://reference.univer.ai/zh-CN/classes/FWorksheet#newovergridimage) 创建一个浮动图片构建器，返回一个 `FOverGridImageBuilder` 实例，可以通过链式调用生成 `ISheetImage` 对象用于插入浮动图片。 +[`FWorksheet.newOverGridImage()`](https://docs.univer.ai/reference/facade/worksheet#newovergridimage) 创建一个浮动图片构建器，返回一个 `FOverGridImageBuilder` 实例，可以通过链式调用生成 `ISheetImage` 对象用于插入浮动图片。 -以下是 [`FOverGridImageBuilder`](https://reference.univer.ai/zh-CN/classes/FOverGridImageBuilder) 上的一些成员方法： +以下是 [`FOverGridImageBuilder`](https://docs.univer.ai/reference/facade/chart) 上的一些成员方法： | 方法 | 描述 | | ---- | ---- | @@ -401,7 +401,7 @@ const result = await fWorksheet.insertImage('https://avatars.githubusercontent.c ### 获取浮动图片 -`FWorksheet.getImages()` 方法可以获取工作表中的所有浮动图片，返回一个 [`FOverGridImage[]`](https://reference.univer.ai/zh-CN/classes/FOverGridImage) 实例数组。 +`FWorksheet.getImages()` 方法可以获取工作表中的所有浮动图片，返回一个 [`FOverGridImage[]`](https://docs.univer.ai/reference/facade/chart) 实例数组。 ```typescript const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet() diff --git a/content/guides/sheets/features/images.zh-TW.mdx b/content/guides/sheets/features/images.zh-TW.mdx index dda2fb74..d6336ea3 100644 --- a/content/guides/sheets/features/images.zh-TW.mdx +++ b/content/guides/sheets/features/images.zh-TW.mdx @@ -355,9 +355,9 @@ setTimeout(() => { ### 插入浮動圖片 -[`FWorksheet.newOverGridImage()`](https://reference.univer.ai/zh-TW/classes/FWorksheet#newovergridimage) 建立一個浮動圖片構建器，返回一個 `FOverGridImageBuilder` 例項，可以透過鏈式呼叫生成 `ISheetImage` 物件用於插入浮動圖片。 +[`FWorksheet.newOverGridImage()`](https://docs.univer.ai/reference/facade/worksheet#newovergridimage) 建立一個浮動圖片構建器，返回一個 `FOverGridImageBuilder` 例項，可以透過鏈式呼叫生成 `ISheetImage` 物件用於插入浮動圖片。 -以下是 [`FOverGridImageBuilder`](https://reference.univer.ai/zh-TW/classes/FOverGridImageBuilder) 上的一些成員方法： +以下是 [`FOverGridImageBuilder`](https://docs.univer.ai/reference/facade/chart) 上的一些成員方法： | 方法 | 描述 | | ---- | ---- | @@ -401,7 +401,7 @@ const result = await fWorksheet.insertImage('https://avatars.githubusercontent.c ### 獲取浮動圖片 -`FWorksheet.getImages()` 方法可以獲取工作表中的所有浮動圖片，返回一個 [`FOverGridImage[]`](https://reference.univer.ai/zh-TW/classes/FOverGridImage) 例項陣列。 +`FWorksheet.getImages()` 方法可以獲取工作表中的所有浮動圖片，返回一個 [`FOverGridImage[]`](https://docs.univer.ai/reference/facade/chart) 例項陣列。 ```typescript const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet() diff --git a/content/guides/sheets/features/import-export.ja-JP.mdx b/content/guides/sheets/features/import-export.ja-JP.mdx index 1f0c0c58..78ed5a1a 100644 --- a/content/guides/sheets/features/import-export.ja-JP.mdx +++ b/content/guides/sheets/features/import-export.ja-JP.mdx @@ -257,7 +257,7 @@ url.searchParams.set('type', '2') // 2 は UniverInstanceType.UNIVER_SHEET を window.location.href = url.toString() -// あるいは API: univerAPI.loadServerUnit(unitId, 2) を呼び出してドキュメントを読み込みます，パラメーターの詳細は https://reference.univer.ai/en-US/classes/FUniver#loadserverunit を参照 +// あるいは API: univerAPI.loadServerUnit(unitId, 2) を呼び出してドキュメントを読み込みます，パラメーターの詳細は /reference/facade/univer#loadserverunit を参照 ``` #### `.xlsx` ファイルをインポートして `IWorkbookData` を取得 diff --git a/content/guides/sheets/features/import-export.mdx b/content/guides/sheets/features/import-export.mdx index 3664125b..260b44e1 100644 --- a/content/guides/sheets/features/import-export.mdx +++ b/content/guides/sheets/features/import-export.mdx @@ -257,7 +257,7 @@ url.searchParams.set('type', '2') // The meaning of 2 is UniverInstanceType.UNIV window.location.href = url.toString() -// Or call the API: univerAPI.loadServerUnit(unitId, 2) to load the document, refer to https://reference.univer.ai/en-US/classes/FUniver#loadserverunit for specific parameters +// Or call the API: univerAPI.loadServerUnit(unitId, 2) to load the document, refer to /reference/facade/univer#loadserverunit for specific parameters ``` #### Import `.xlsx` file and get `IWorkbookData` diff --git a/content/guides/sheets/features/import-export.zh-CN.mdx b/content/guides/sheets/features/import-export.zh-CN.mdx index 291d9179..18ad14c2 100644 --- a/content/guides/sheets/features/import-export.zh-CN.mdx +++ b/content/guides/sheets/features/import-export.zh-CN.mdx @@ -257,7 +257,7 @@ url.searchParams.set('type', '2') // 2 的意思是 String(UniverInstanceType.UN window.location.href = url.toString() -// 或者调用API: univerAPI.loadServerUnit(unitId, 2) 加载文档，具体参数参考 https://reference.univer.ai/zh-CN/classes/FUniver#loadserverunit +// 或者调用API: univerAPI.loadServerUnit(unitId, 2) 加载文档，具体参数参考 /reference/facade/univer#loadserverunit ``` #### 导入 `.xlsx` 文件并获取 `IWorkbookData` diff --git a/content/guides/sheets/features/import-export.zh-TW.mdx b/content/guides/sheets/features/import-export.zh-TW.mdx index e3286e92..67999231 100644 --- a/content/guides/sheets/features/import-export.zh-TW.mdx +++ b/content/guides/sheets/features/import-export.zh-TW.mdx @@ -257,7 +257,7 @@ url.searchParams.set('type', '2') // 2 的意思是 String(UniverInstanceType.UN window.location.href = url.toString() -// 或者呼叫API: univerAPI.loadServerUnit(unitId, 2) 載入文件，具體參數參考 https://reference.univer.ai/zh-TW/classes/FUniver#loadserverunit +// 或者呼叫API: univerAPI.loadServerUnit(unitId, 2) 載入文件，具體參數參考 /reference/facade/univer#loadserverunit ``` #### 匯入 `.xlsx` 檔案並獲取 `IWorkbookData` diff --git a/content/guides/sheets/features/notes.ja-JP.mdx b/content/guides/sheets/features/notes.ja-JP.mdx index 81c00235..8ce2b13f 100644 --- a/content/guides/sheets/features/notes.ja-JP.mdx +++ b/content/guides/sheets/features/notes.ja-JP.mdx @@ -175,7 +175,7 @@ fRange.deleteNote() ### イベントリスナー -完全なイベント型定義は [Events](https://reference.univer.ai/en-US/classes/FEventName) を参照してください。 +完全なイベント型定義は [Events](https://docs.univer.ai/reference/facade/events) を参照してください。 | Event Name | 説明 | | ---------- | ---- | diff --git a/content/guides/sheets/features/notes.mdx b/content/guides/sheets/features/notes.mdx index aa69a06f..24224de4 100644 --- a/content/guides/sheets/features/notes.mdx +++ b/content/guides/sheets/features/notes.mdx @@ -175,7 +175,7 @@ fRange.deleteNote() ### Event Listeners -Complete event type definitions can be found in the [Events](https://reference.univer.ai/en-US/classes/FEventName). +Complete event type definitions can be found in the [Events](https://docs.univer.ai/reference/facade/events). | Event Name | Description | | ---------- | ----------- | diff --git a/content/guides/sheets/features/notes.zh-CN.mdx b/content/guides/sheets/features/notes.zh-CN.mdx index c060802b..fbf657e2 100644 --- a/content/guides/sheets/features/notes.zh-CN.mdx +++ b/content/guides/sheets/features/notes.zh-CN.mdx @@ -175,7 +175,7 @@ fRange.deleteNote() ### 事件监听 -完整事件类型定义，请查看 [Events](https://reference.univer.ai/zh-CN/classes/FEventName)。 +完整事件类型定义，请查看 [Events](https://docs.univer.ai/reference/facade/events)。 | 事件名称 | 说明 | | -------- | ---- | diff --git a/content/guides/sheets/features/notes.zh-TW.mdx b/content/guides/sheets/features/notes.zh-TW.mdx index 08a00164..74929727 100644 --- a/content/guides/sheets/features/notes.zh-TW.mdx +++ b/content/guides/sheets/features/notes.zh-TW.mdx @@ -175,7 +175,7 @@ fRange.deleteNote() ### 事件監聽 -完整事件型別定義，請檢視 [Events](https://reference.univer.ai/zh-TW/classes/FEventName)。 +完整事件型別定義，請檢視 [Events](https://docs.univer.ai/reference/facade/events)。 | 事件名稱 | 說明 | | -------- | ---- | diff --git a/content/guides/sheets/features/pivot-table.ja-JP.mdx b/content/guides/sheets/features/pivot-table.ja-JP.mdx index c5befa6f..d37e58f6 100644 --- a/content/guides/sheets/features/pivot-table.ja-JP.mdx +++ b/content/guides/sheets/features/pivot-table.ja-JP.mdx @@ -247,7 +247,7 @@ import '@univerjs-pro/sheets-pivot/facade' ### ピボットテーブルの追加 -[`FWorkbook.addPivotTable`](https://reference.univer.ai/en-US/classes/FWorkbook#addpivottable) メソッドはピボットテーブルを追加するために使用され、成功すると `FPivotTable` インスタンスを返します。 +[`FWorkbook.addPivotTable`](https://docs.univer.ai/reference/facade/workbook#addpivottable) メソッドはピボットテーブルを追加するために使用され、成功すると `FPivotTable` インスタンスを返します。 ```typescript // シート範囲 A1:G9 が空でないことを確認してください @@ -289,7 +289,7 @@ univerAPI.addEvent(univerAPI.Event.PivotTableRendered, (params) => { ### ピボットテーブルの取得 -[`FWorkbook.getPivotTableByCell`](https://reference.univer.ai/en-US/classes/FWorkbook#getpivottablebycell) メソッドは、アンカーセルからピボットテーブルのインスタンスを取得します。対象セルがピボットテーブル内にある場合、`FPivotTable` インスタンスを返します。 +[`FWorkbook.getPivotTableByCell`](https://docs.univer.ai/reference/facade/workbook#getpivottablebycell) メソッドは、アンカーセルからピボットテーブルのインスタンスを取得します。対象セルがピボットテーブル内にある場合、`FPivotTable` インスタンスを返します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -304,24 +304,24 @@ const fPivotTable = fWorkbook.getPivotTableByCell(unitId, subUnitId, 0, 8) const pivotTable2 = fSheet.getPivotTableByCell(0, 8) ``` -[`FPivotTable`](https://reference.univer.ai/en-US/classes/FPivotTable) インスタンスには、ピボットテーブルを操作するためのいくつかのメソッドがあります。 +[`FPivotTable`](https://docs.univer.ai/reference/facade/pivot-table) インスタンスには、ピボットテーブルを操作するためのいくつかのメソッドがあります。 | メソッド | 説明 | | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------- | -| [remove](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#remove) | ピボットテーブルをインスタンスから削除します | -| [getConfig](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#getconfig) | ピボットテーブルの設定（ソース範囲情報、アンカーセル情報、設定）を返します | -| [addField](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#addfield) | ピボットテーブルにフィールドを追加します | -| [removeField](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#removefield) | ピボットテーブルからフィールドを削除します | -| [updateFieldPosition](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#updatefieldposition) | ピボットテーブル内のフィールド位置を更新します | -| [updateValuePosition](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#updatevalueposition) | ∑ 値の位置を制御します | -| [setSubtotalType](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setsubtotaltype) | フィールドの小計タイプを設定します | -| [setLabelSort](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setlabelsort) | フィールドのラベル ソートを設定します | -| [setLabelManualFilter](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setlabelmanualfilter) | フィールドのラベル フィルターを設定します | -| [renameField](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#renamefield) | フィールド名を変更します | -| [setValueFilter](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setValueFilter) | 値フィルターを設定します | -| [reset](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#reset) | ピボットテーブルのフィールドをリセットします | -| [setFieldsConfig](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setfieldsconfig) | ピボットテーブルのフィールド構成を設定します | -| [getValueFilters](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#getvaluefilters) | ピボットテーブルのすべての値フィルターを取得します | +| [remove](https://docs.univer.ai/reference/facade/pivot-table#remove) | ピボットテーブルをインスタンスから削除します | +| [getConfig](https://docs.univer.ai/reference/facade/pivot-table#getconfig) | ピボットテーブルの設定（ソース範囲情報、アンカーセル情報、設定）を返します | +| [addField](https://docs.univer.ai/reference/facade/pivot-table#addfield) | ピボットテーブルにフィールドを追加します | +| [removeField](https://docs.univer.ai/reference/facade/pivot-table#removefield) | ピボットテーブルからフィールドを削除します | +| [updateFieldPosition](https://docs.univer.ai/reference/facade/pivot-table#updatefieldposition) | ピボットテーブル内のフィールド位置を更新します | +| [updateValuePosition](https://docs.univer.ai/reference/facade/pivot-table#updatevalueposition) | ∑ 値の位置を制御します | +| [setSubtotalType](https://docs.univer.ai/reference/facade/pivot-table#setsubtotaltype) | フィールドの小計タイプを設定します | +| [setLabelSort](https://docs.univer.ai/reference/facade/pivot-table#setlabelsort) | フィールドのラベル ソートを設定します | +| [setLabelManualFilter](https://docs.univer.ai/reference/facade/pivot-table#setlabelmanualfilter) | フィールドのラベル フィルターを設定します | +| [renameField](https://docs.univer.ai/reference/facade/pivot-table#renamefield) | フィールド名を変更します | +| [setValueFilter](https://docs.univer.ai/reference/facade/pivot-table#setValueFilter) | 値フィルターを設定します | +| [reset](https://docs.univer.ai/reference/facade/pivot-table#reset) | ピボットテーブルのフィールドをリセットします | +| [setFieldsConfig](https://docs.univer.ai/reference/facade/pivot-table#setfieldsconfig) | ピボットテーブルのフィールド構成を設定します | +| [getValueFilters](https://docs.univer.ai/reference/facade/pivot-table#getvaluefilters) | ピボットテーブルのすべての値フィルターを取得します | ```typescript class FPivotTable { @@ -431,7 +431,7 @@ class FPivotTable { ### イベントリスナー -完全なイベント型定義は [Events](https://reference.univer.ai/en-US/classes/FEventName) を参照してください。 +完全なイベント型定義は [Events](https://docs.univer.ai/reference/facade/events) を参照してください。 `univerAPI.Event.BeforePivotTableAdd` イベントは、ピボットテーブルを追加する前にトリガーされます。 diff --git a/content/guides/sheets/features/pivot-table.mdx b/content/guides/sheets/features/pivot-table.mdx index ccb521b0..1a4e2068 100644 --- a/content/guides/sheets/features/pivot-table.mdx +++ b/content/guides/sheets/features/pivot-table.mdx @@ -247,7 +247,7 @@ import '@univerjs-pro/sheets-pivot/facade' ### Add a Pivot Table -[`FWorkbook.addPivotTable`](https://reference.univer.ai/en-US/classes/FWorkbook#addpivottable) method is used to add a pivot table, and it will return the `FPivotTable` instance if successful. +[`FWorkbook.addPivotTable`](https://docs.univer.ai/reference/facade/workbook#addpivottable) method is used to add a pivot table, and it will return the `FPivotTable` instance if successful. ```typescript // should ensure the sheet range A1:G9 is not empty @@ -289,7 +289,7 @@ univerAPI.addEvent(univerAPI.Event.PivotTableRendered, (params) => { ### Get a Pivot Table -[`FWorkbook.getPivotTableByCell`](https://reference.univer.ai/en-US/classes/FWorkbook#getpivottablebycell) method is used to get a pivot table instance by the anchor cell, and it will return the `FPivotTable` instance if the target cell is in a pivot table. +[`FWorkbook.getPivotTableByCell`](https://docs.univer.ai/reference/facade/workbook#getpivottablebycell) method is used to get a pivot table instance by the anchor cell, and it will return the `FPivotTable` instance if the target cell is in a pivot table. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -304,24 +304,24 @@ const fPivotTable = fWorkbook.getPivotTableByCell(unitId, subUnitId, 0, 8) const pivotTable2 = fSheet.getPivotTableByCell(0, 8) ``` -There are some methods in the [`FPivotTable`](https://reference.univer.ai/en-US/classes/FPivotTable) instance, which can be used to operate the pivot table. +There are some methods in the [`FPivotTable`](https://docs.univer.ai/reference/facade/pivot-table) instance, which can be used to operate the pivot table. | Method | Description | | ------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- | -| [remove](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#remove) | remove the pivot table from instance | -| [getConfig](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#getconfig) | return the pivot table config, the source range info, anchor cell info and config | -| [addField](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#addfield) | add a field to pivot table | -| [removeField](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#removefield) | remove a field from pivot table | -| [updateFieldPosition](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#updatefieldposition) | update the field position in pivot table | -| [updateValuePosition](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#updatevalueposition) | control the ∑Value position | -| [setSubtotalType](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setsubtotaltype) | set the subtotal type of the field | -| [setLabelSort](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setlabelsort) | set the label sort of the field | -| [setLabelManualFilter](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setlabelmanualfilter) | set the label filter of the field | -| [renameField](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#renamefield) | rename the field | -| [setValueFilter](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setValueFilter) | set value filter | -| [reset](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#reset) | reset the pivot table fields | -| [setFieldsConfig](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setfieldsconfig) | set the pivot table fields config | -| [getValueFilters](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#getvaluefilters) | get all value filters of the pivot table | +| [remove](https://docs.univer.ai/reference/facade/pivot-table#remove) | remove the pivot table from instance | +| [getConfig](https://docs.univer.ai/reference/facade/pivot-table#getconfig) | return the pivot table config, the source range info, anchor cell info and config | +| [addField](https://docs.univer.ai/reference/facade/pivot-table#addfield) | add a field to pivot table | +| [removeField](https://docs.univer.ai/reference/facade/pivot-table#removefield) | remove a field from pivot table | +| [updateFieldPosition](https://docs.univer.ai/reference/facade/pivot-table#updatefieldposition) | update the field position in pivot table | +| [updateValuePosition](https://docs.univer.ai/reference/facade/pivot-table#updatevalueposition) | control the ∑Value position | +| [setSubtotalType](https://docs.univer.ai/reference/facade/pivot-table#setsubtotaltype) | set the subtotal type of the field | +| [setLabelSort](https://docs.univer.ai/reference/facade/pivot-table#setlabelsort) | set the label sort of the field | +| [setLabelManualFilter](https://docs.univer.ai/reference/facade/pivot-table#setlabelmanualfilter) | set the label filter of the field | +| [renameField](https://docs.univer.ai/reference/facade/pivot-table#renamefield) | rename the field | +| [setValueFilter](https://docs.univer.ai/reference/facade/pivot-table#setValueFilter) | set value filter | +| [reset](https://docs.univer.ai/reference/facade/pivot-table#reset) | reset the pivot table fields | +| [setFieldsConfig](https://docs.univer.ai/reference/facade/pivot-table#setfieldsconfig) | set the pivot table fields config | +| [getValueFilters](https://docs.univer.ai/reference/facade/pivot-table#getvaluefilters) | get all value filters of the pivot table | ```typescript class FPivotTable { @@ -431,7 +431,7 @@ class FPivotTable { ### Event Listeners -Complete event type definitions can be found in the [Events](https://reference.univer.ai/en-US/classes/FEventName). +Complete event type definitions can be found in the [Events](https://docs.univer.ai/reference/facade/events). `univerAPI.Event.BeforePivotTableAdd` event is triggered before adding a pivot table. diff --git a/content/guides/sheets/features/pivot-table.zh-CN.mdx b/content/guides/sheets/features/pivot-table.zh-CN.mdx index 1d66d987..8954023a 100644 --- a/content/guides/sheets/features/pivot-table.zh-CN.mdx +++ b/content/guides/sheets/features/pivot-table.zh-CN.mdx @@ -247,7 +247,7 @@ import '@univerjs-pro/sheets-pivot/facade' ### 添加透视表 -[`FWorkbook.addPivotTable`](https://reference.univer.ai/zh-CN/classes/FWorkbook#addpivottable) 方法用于添加透视表，成功会返回 `FPivotTable` 实例。 +[`FWorkbook.addPivotTable`](https://docs.univer.ai/reference/facade/workbook#addpivottable) 方法用于添加透视表，成功会返回 `FPivotTable` 实例。 ```typescript // 需要确保工作表范围 A1:G9 是非空的 @@ -289,7 +289,7 @@ univerAPI.addEvent(univerAPI.Event.PivotTableRendered, (params) => { ### 获取透视表 -[`FWorkbook.getPivotTableByCell`](https://reference.univer.ai/zh-CN/classes/FWorkbook#getpivottablebycell) 方法通过锚定单元格获取透视表实例。如果目标单元格在透视表中，它将返回 `FPivotTable` 实例。 +[`FWorkbook.getPivotTableByCell`](https://docs.univer.ai/reference/facade/workbook#getpivottablebycell) 方法通过锚定单元格获取透视表实例。如果目标单元格在透视表中，它将返回 `FPivotTable` 实例。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -304,24 +304,24 @@ const fPivotTable = fWorkbook.getPivotTableByCell(unitId, subUnitId, 0, 8) const pivotTable2 = fSheet.getPivotTableByCell(0, 8) ``` -[`FPivotTable`](https://reference.univer.ai/zh-CN/classes/FPivotTable) 实例中有一些方法，可以用来操作透视表。 +[`FPivotTable`](https://docs.univer.ai/reference/facade/pivot-table) 实例中有一些方法，可以用来操作透视表。 | 方法 | 描述 | | ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------- | -| [remove](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#remove) | 删除透视表实例 | -| [getConfig](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#getconfig) | 获取当前透视表的配置信息，其中包括数据源范围，锚定单元格， 维度配置信息 | -| [addField](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#addfield) | 添加一个维度 | -| [removeField](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#removefield) | 删除一个维度 | -| [updateFieldPosition](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#updatefieldposition) | 更新维度的所在区域以及顺序 | -| [updateValuePosition](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#updatevalueposition) | 更新 ∑Value 的位置 | -| [setSubtotalType](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setsubtotaltype) | 设置汇总方式 | -| [setLabelSort](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setlabelsort) | 设置标签排序 | -| [setLabelManualFilter](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setlabelmanualfilter) | 设置标签筛选 | -| [renameField](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#renamefield) | 重命名维度 | -| [setValueFilter](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setValueFilter) | 设置值维度 | -| [reset](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#reset) | 重置透视表的维度配置 | -| [setFieldsConfig](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setfieldsconfig) | 设置透视表的维度配置 | -| [getValueFilters](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#getvaluefilters) | 获取透视表的值维度配置 | +| [remove](https://docs.univer.ai/reference/facade/pivot-table#remove) | 删除透视表实例 | +| [getConfig](https://docs.univer.ai/reference/facade/pivot-table#getconfig) | 获取当前透视表的配置信息，其中包括数据源范围，锚定单元格， 维度配置信息 | +| [addField](https://docs.univer.ai/reference/facade/pivot-table#addfield) | 添加一个维度 | +| [removeField](https://docs.univer.ai/reference/facade/pivot-table#removefield) | 删除一个维度 | +| [updateFieldPosition](https://docs.univer.ai/reference/facade/pivot-table#updatefieldposition) | 更新维度的所在区域以及顺序 | +| [updateValuePosition](https://docs.univer.ai/reference/facade/pivot-table#updatevalueposition) | 更新 ∑Value 的位置 | +| [setSubtotalType](https://docs.univer.ai/reference/facade/pivot-table#setsubtotaltype) | 设置汇总方式 | +| [setLabelSort](https://docs.univer.ai/reference/facade/pivot-table#setlabelsort) | 设置标签排序 | +| [setLabelManualFilter](https://docs.univer.ai/reference/facade/pivot-table#setlabelmanualfilter) | 设置标签筛选 | +| [renameField](https://docs.univer.ai/reference/facade/pivot-table#renamefield) | 重命名维度 | +| [setValueFilter](https://docs.univer.ai/reference/facade/pivot-table#setValueFilter) | 设置值维度 | +| [reset](https://docs.univer.ai/reference/facade/pivot-table#reset) | 重置透视表的维度配置 | +| [setFieldsConfig](https://docs.univer.ai/reference/facade/pivot-table#setfieldsconfig) | 设置透视表的维度配置 | +| [getValueFilters](https://docs.univer.ai/reference/facade/pivot-table#getvaluefilters) | 获取透视表的值维度配置 | ```typescript class FPivotTable { @@ -431,7 +431,7 @@ class FPivotTable { ### 事件监听 -完整事件类型定义，请查看 [Events](https://reference.univer.ai/zh-CN/classes/FEventName)。 +完整事件类型定义，请查看 [Events](https://docs.univer.ai/reference/facade/events)。 `univerAPI.Event.BeforePivotTableAdd` 事件在添加透视表之前触发。 diff --git a/content/guides/sheets/features/pivot-table.zh-TW.mdx b/content/guides/sheets/features/pivot-table.zh-TW.mdx index 81c1b604..60a9a2bd 100644 --- a/content/guides/sheets/features/pivot-table.zh-TW.mdx +++ b/content/guides/sheets/features/pivot-table.zh-TW.mdx @@ -247,7 +247,7 @@ import '@univerjs-pro/sheets-pivot/facade' ### 新增透視表 -[`FWorkbook.addPivotTable`](https://reference.univer.ai/zh-TW/classes/FWorkbook#addpivottable) 方法用於新增透視表，成功會返回 `FPivotTable` 例項。 +[`FWorkbook.addPivotTable`](https://docs.univer.ai/reference/facade/workbook#addpivottable) 方法用於新增透視表，成功會返回 `FPivotTable` 例項。 ```typescript // 需要確保工作表範圍 A1:G9 是非空的 @@ -289,7 +289,7 @@ univerAPI.addEvent(univerAPI.Event.PivotTableRendered, (params) => { ### 獲取透視表 -[`FWorkbook.getPivotTableByCell`](https://reference.univer.ai/zh-TW/classes/FWorkbook#getpivottablebycell) 方法透過錨定單元格獲取透視表例項。如果目標單元格在透視表中，它將返回 `FPivotTable` 例項。 +[`FWorkbook.getPivotTableByCell`](https://docs.univer.ai/reference/facade/workbook#getpivottablebycell) 方法透過錨定單元格獲取透視表例項。如果目標單元格在透視表中，它將返回 `FPivotTable` 例項。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -304,24 +304,24 @@ const fPivotTable = fWorkbook.getPivotTableByCell(unitId, subUnitId, 0, 8) const pivotTable2 = fSheet.getPivotTableByCell(0, 8) ``` -[`FPivotTable`](https://reference.univer.ai/zh-TW/classes/FPivotTable) 例項中有一些方法，可以用來操作透視表。 +[`FPivotTable`](https://docs.univer.ai/reference/facade/pivot-table) 例項中有一些方法，可以用來操作透視表。 | 方法 | 描述 | | ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------- | -| [remove](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#remove) | 刪除透視表例項 | -| [getConfig](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#getconfig) | 獲取當前透視表的配置資訊，其中包括資料來源範圍，錨定單元格， 維度配置資訊 | -| [addField](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#addfield) | 新增一個維度 | -| [removeField](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#removefield) | 刪除一個維度 | -| [updateFieldPosition](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#updatefieldposition) | 更新維度的所在區域以及順序 | -| [updateValuePosition](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#updatevalueposition) | 更新 ∑Value 的位置 | -| [setSubtotalType](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setsubtotaltype) | 設定彙總方式 | -| [setLabelSort](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setlabelsort) | 設定標籤排序 | -| [setLabelManualFilter](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setlabelmanualfilter) | 設定標籤篩選 | -| [renameField](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#renamefield) | 重新命名維度 | -| [setValueFilter](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setValueFilter) | 設定值維度 | -| [reset](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#reset) | 重置透視表的維度配置 | -| [setFieldsConfig](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#setfieldsconfig) | 設定透視表的維度配置 | -| [getValueFilters](https://reference.univer.ai/@univerjs-pro/sheets-pivot/facade/classes/FPivotTable#getvaluefilters) | 獲取透視表的值維度配置 | +| [remove](https://docs.univer.ai/reference/facade/pivot-table#remove) | 刪除透視表例項 | +| [getConfig](https://docs.univer.ai/reference/facade/pivot-table#getconfig) | 獲取當前透視表的配置資訊，其中包括資料來源範圍，錨定單元格， 維度配置資訊 | +| [addField](https://docs.univer.ai/reference/facade/pivot-table#addfield) | 新增一個維度 | +| [removeField](https://docs.univer.ai/reference/facade/pivot-table#removefield) | 刪除一個維度 | +| [updateFieldPosition](https://docs.univer.ai/reference/facade/pivot-table#updatefieldposition) | 更新維度的所在區域以及順序 | +| [updateValuePosition](https://docs.univer.ai/reference/facade/pivot-table#updatevalueposition) | 更新 ∑Value 的位置 | +| [setSubtotalType](https://docs.univer.ai/reference/facade/pivot-table#setsubtotaltype) | 設定彙總方式 | +| [setLabelSort](https://docs.univer.ai/reference/facade/pivot-table#setlabelsort) | 設定標籤排序 | +| [setLabelManualFilter](https://docs.univer.ai/reference/facade/pivot-table#setlabelmanualfilter) | 設定標籤篩選 | +| [renameField](https://docs.univer.ai/reference/facade/pivot-table#renamefield) | 重新命名維度 | +| [setValueFilter](https://docs.univer.ai/reference/facade/pivot-table#setValueFilter) | 設定值維度 | +| [reset](https://docs.univer.ai/reference/facade/pivot-table#reset) | 重置透視表的維度配置 | +| [setFieldsConfig](https://docs.univer.ai/reference/facade/pivot-table#setfieldsconfig) | 設定透視表的維度配置 | +| [getValueFilters](https://docs.univer.ai/reference/facade/pivot-table#getvaluefilters) | 獲取透視表的值維度配置 | ```typescript class FPivotTable { @@ -431,7 +431,7 @@ class FPivotTable { ### 事件監聽 -完整事件型別定義，請檢視 [Events](https://reference.univer.ai/zh-TW/classes/FEventName)。 +完整事件型別定義，請檢視 [Events](https://docs.univer.ai/reference/facade/events)。 `univerAPI.Event.BeforePivotTableAdd` 事件在新增透視表之前觸發。 diff --git a/content/guides/sheets/features/print.ja-JP.mdx b/content/guides/sheets/features/print.ja-JP.mdx index adea408c..550667c0 100644 --- a/content/guides/sheets/features/print.ja-JP.mdx +++ b/content/guides/sheets/features/print.ja-JP.mdx @@ -171,7 +171,7 @@ setTimeout(() => { ### 印刷レイアウト設定の更新 -[`FWorkbook.updatePrintConfig(config: ISheetPrintLayoutConfig)`](https://reference.univer.ai/en-US/classes/FWorkbook#updateprintconfig) メソッドを使用して、印刷レイアウト設定を更新します。 +[`FWorkbook.updatePrintConfig(config: ISheetPrintLayoutConfig)`](https://docs.univer.ai/reference/facade/workbook#updateprintconfig) メソッドを使用して、印刷レイアウト設定を更新します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -342,7 +342,7 @@ fWorkbook.print() ### 印刷レンダー設定の更新 -[`FWorkbook.updatePrintRenderConfig(config: ISheetPrintRenderConfig)`](https://reference.univer.ai/en-US/classes/FWorkbook#updateprintrenderconfig) メソッドを使用して、印刷レンダー設定を更新します。 +[`FWorkbook.updatePrintRenderConfig(config: ISheetPrintRenderConfig)`](https://docs.univer.ai/reference/facade/workbook#updateprintrenderconfig) メソッドを使用して、印刷レンダー設定を更新します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() diff --git a/content/guides/sheets/features/print.mdx b/content/guides/sheets/features/print.mdx index e36228d2..a4a37455 100644 --- a/content/guides/sheets/features/print.mdx +++ b/content/guides/sheets/features/print.mdx @@ -171,7 +171,7 @@ setTimeout(() => { ### Update Print Layout Configuration -Using [`FWorkbook.updatePrintConfig(config: ISheetPrintLayoutConfig)`](https://reference.univer.ai/en-US/classes/FWorkbook#updateprintconfig) method to update the print layout configuration. +Using [`FWorkbook.updatePrintConfig(config: ISheetPrintLayoutConfig)`](https://docs.univer.ai/reference/facade/workbook#updateprintconfig) method to update the print layout configuration. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -342,7 +342,7 @@ fWorkbook.print() ### Update Print Render Configuration -Using [`FWorkbook.updatePrintRenderConfig(config: ISheetPrintRenderConfig)`](https://reference.univer.ai/en-US/classes/FWorkbook#updateprintrenderconfig) method to update the print render configuration. +Using [`FWorkbook.updatePrintRenderConfig(config: ISheetPrintRenderConfig)`](https://docs.univer.ai/reference/facade/workbook#updateprintrenderconfig) method to update the print render configuration. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() diff --git a/content/guides/sheets/features/print.zh-CN.mdx b/content/guides/sheets/features/print.zh-CN.mdx index b13eada4..e1baf498 100644 --- a/content/guides/sheets/features/print.zh-CN.mdx +++ b/content/guides/sheets/features/print.zh-CN.mdx @@ -167,7 +167,7 @@ setTimeout(() => { ### 更新打印布局配置 -使用 [`FWorkbook.updatePrintConfig(config: ISheetPrintLayoutConfig)`](https://reference.univer.ai/zh-CN/classes/FWorkbook#updateprintconfig) 方法更新打印布局配置。 +使用 [`FWorkbook.updatePrintConfig(config: ISheetPrintLayoutConfig)`](https://docs.univer.ai/reference/facade/workbook#updateprintconfig) 方法更新打印布局配置。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -338,7 +338,7 @@ fWorkbook.print() ### 更新打印渲染配置 -使用 [`FWorkbook.updatePrintRenderConfig(config: ISheetPrintRenderConfig)`](https://reference.univer.ai/zh-CN/classes/FWorkbook#updateprintrenderconfig) 方法更新打印渲染配置。 +使用 [`FWorkbook.updatePrintRenderConfig(config: ISheetPrintRenderConfig)`](https://docs.univer.ai/reference/facade/workbook#updateprintrenderconfig) 方法更新打印渲染配置。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -489,7 +489,7 @@ fRange.getScreenshot({ includeHeaders: true }) // 包含行列标题 ### 事件监听 -完整事件类型定义，请查看 [Events](https://reference.univer.ai/zh-CN/classes/FEventName)。 +完整事件类型定义，请查看 [Events](https://docs.univer.ai/reference/facade/events)。 `univerAPI.Event.BeforeSheetPrintOpen` 事件在打开打印配置对话框之前触发。 diff --git a/content/guides/sheets/features/print.zh-TW.mdx b/content/guides/sheets/features/print.zh-TW.mdx index c967a764..82665ba0 100644 --- a/content/guides/sheets/features/print.zh-TW.mdx +++ b/content/guides/sheets/features/print.zh-TW.mdx @@ -167,7 +167,7 @@ setTimeout(() => { ### 更新列印佈局配置 -使用 [`FWorkbook.updatePrintConfig(config: ISheetPrintLayoutConfig)`](https://reference.univer.ai/zh-TW/classes/FWorkbook#updateprintconfig) 方法更新列印佈局配置。 +使用 [`FWorkbook.updatePrintConfig(config: ISheetPrintLayoutConfig)`](https://docs.univer.ai/reference/facade/workbook#updateprintconfig) 方法更新列印佈局配置。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -338,7 +338,7 @@ fWorkbook.print() ### 更新列印渲染配置 -使用 [`FWorkbook.updatePrintRenderConfig(config: ISheetPrintRenderConfig)`](https://reference.univer.ai/zh-TW/classes/FWorkbook#updateprintrenderconfig) 方法更新列印渲染配置。 +使用 [`FWorkbook.updatePrintRenderConfig(config: ISheetPrintRenderConfig)`](https://docs.univer.ai/reference/facade/workbook#updateprintrenderconfig) 方法更新列印渲染配置。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -489,7 +489,7 @@ fRange.getScreenshot({ includeHeaders: true }) // 包含行列標題 ### 事件監聽 -完整事件型別定義，請檢視 [Events](https://reference.univer.ai/zh-TW/classes/FEventName)。 +完整事件型別定義，請檢視 [Events](https://docs.univer.ai/reference/facade/events)。 `univerAPI.Event.BeforeSheetPrintOpen` 事件在開啟列印配置對話方塊之前觸發。 diff --git a/content/guides/sheets/features/shapes.ja-JP.mdx b/content/guides/sheets/features/shapes.ja-JP.mdx index 5eba8117..84ef13ec 100644 --- a/content/guides/sheets/features/shapes.ja-JP.mdx +++ b/content/guides/sheets/features/shapes.ja-JP.mdx @@ -125,7 +125,7 @@ import '@univerjs-pro/sheets-shape/facade' ### 基本図形の挿入 -[`FWorksheet.newShape`](/reference/facade/f-worksheet-shape-mixin#newshape) で図形ビルダーを作成し、[`FWorksheet.insertShape`](/reference/facade/f-worksheet-shape-mixin#insertshape) で挿入します。 +[`FWorksheet.newShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#newshape) で図形ビルダーを作成し、[`FWorksheet.insertShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#insertshape) で挿入します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -146,7 +146,7 @@ await fWorksheet.insertShape(rectShape) ### コネクタ図形の挿入と接続 -[`FWorksheet.newConnector`](/reference/facade/f-worksheet-shape-mixin#newconnector) でコネクタを作成し、[`FWorksheet.connectShapes`](/reference/facade/f-worksheet-shape-mixin#connectshapes) で両端を図形の接続点に接続します。 +[`FWorksheet.newConnector`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#newconnector) でコネクタを作成し、[`FWorksheet.connectShapes`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#connectshapes) で両端を図形の接続点に接続します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -199,7 +199,7 @@ if (connectorShape && basicShapes.length >= 2) { ### 図形の更新と削除 -既存図形の更新には [`FWorksheet.updateShape`](/reference/facade/f-worksheet-shape-mixin#updateshape)、削除には [`FWorksheet.removeShape`](/reference/facade/f-worksheet-shape-mixin#removeshape) を使います。 +既存図形の更新には [`FWorksheet.updateShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#updateshape)、削除には [`FWorksheet.removeShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#removeshape) を使います。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -224,7 +224,7 @@ if (firstShape) { ### 関連 Facade オブジェクト -- [`FShape`](/reference/facade/f-shape): 図形ビルダーと図形インスタンスの操作。 -- [`FConnectorShape`](/reference/facade/f-connector-shape): コネクタ専用メソッド（矢印・接続情報）。 -- [`FShapeEnum`](/reference/facade/f-shape-enum): `univerAPI.Enum` で使える図形関連 enum。 -- [`FWorksheetShapeMixin`](/reference/facade/f-worksheet-shape-mixin): ワークシート単位の図形操作。 +- [`FShape`](https://docs.univer.ai/reference/facade/f-shape): 図形ビルダーと図形インスタンスの操作。 +- [`FConnectorShape`](https://docs.univer.ai/reference/facade/f-connector-shape): コネクタ専用メソッド（矢印・接続情報）。 +- [`FShapeEnum`](https://docs.univer.ai/reference/facade/f-shape-enum): `univerAPI.Enum` で使える図形関連 enum。 +- [`FWorksheetShapeMixin`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin): ワークシート単位の図形操作。 diff --git a/content/guides/sheets/features/shapes.mdx b/content/guides/sheets/features/shapes.mdx index d901a35b..96eb7213 100644 --- a/content/guides/sheets/features/shapes.mdx +++ b/content/guides/sheets/features/shapes.mdx @@ -81,9 +81,13 @@ If you have a commercial license for Univer, please refer to [Using License in C ### Installation ```package-install -npm install @univerjs-pro/sheets-shape @univerjs-pro/sheets-shape-ui +npm install @univerjs/drawing @univerjs/drawing-ui @univerjs/sheets-drawing @univerjs/sheets-drawing-ui @univerjs-pro/sheets-shape @univerjs-pro/sheets-shape-ui ``` + + The shape plugins depend on the drawing plugins. You must also register `UniverDrawingPlugin`, `UniverSheetsDrawingPlugin`, `UniverDrawingUIPlugin`, and `UniverSheetsDrawingUIPlugin` before registering the shape plugins. + + ### Usage ```typescript @@ -125,7 +129,7 @@ import '@univerjs-pro/sheets-shape/facade' ### Insert Basic Shapes -Use [`FWorksheet.newShape`](/reference/facade/f-worksheet-shape-mixin#newshape) to create a shape builder, then call [`FWorksheet.insertShape`](/reference/facade/f-worksheet-shape-mixin#insertshape) to insert it. +Use [`FWorksheet.newShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#newshape) to create a shape builder, then call [`FWorksheet.insertShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#insertshape) to insert it. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -146,7 +150,7 @@ await fWorksheet.insertShape(rectShape) ### Insert and Connect Connector Shapes -Use [`FWorksheet.newConnector`](/reference/facade/f-worksheet-shape-mixin#newconnector) to create connector lines, and [`FWorksheet.connectShapes`](/reference/facade/f-worksheet-shape-mixin#connectshapes) to attach both ends to shape connection sites. +Use [`FWorksheet.newConnector`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#newconnector) to create connector lines, and [`FWorksheet.connectShapes`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#connectshapes) to attach both ends to shape connection sites. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -199,7 +203,7 @@ if (connectorShape && basicShapes.length >= 2) { ### Update and Remove Shapes -Use [`FWorksheet.updateShape`](/reference/facade/f-worksheet-shape-mixin#updateshape) to update an existing shape and [`FWorksheet.removeShape`](/reference/facade/f-worksheet-shape-mixin#removeshape) to remove it. +Use [`FWorksheet.updateShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#updateshape) to update an existing shape and [`FWorksheet.removeShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#removeshape) to remove it. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -224,7 +228,7 @@ if (firstShape) { ### Related Facade Objects -- [`FShape`](/reference/facade/f-shape): shape builder and shape instance methods. -- [`FConnectorShape`](/reference/facade/f-connector-shape): connector-specific methods (arrow and relation data). -- [`FShapeEnum`](/reference/facade/f-shape-enum): shape-related enums exposed on `univerAPI.Enum`. -- [`FWorksheetShapeMixin`](/reference/facade/f-worksheet-shape-mixin): worksheet-level shape operations. +- [`FShape`](https://docs.univer.ai/reference/facade/f-shape): shape builder and shape instance methods. +- [`FConnectorShape`](https://docs.univer.ai/reference/facade/f-connector-shape): connector-specific methods (arrow and relation data). +- [`FShapeEnum`](https://docs.univer.ai/reference/facade/f-shape-enum): shape-related enums exposed on `univerAPI.Enum`. +- [`FWorksheetShapeMixin`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin): worksheet-level shape operations. diff --git a/content/guides/sheets/features/shapes.zh-CN.mdx b/content/guides/sheets/features/shapes.zh-CN.mdx index 602a5b51..078e403b 100644 --- a/content/guides/sheets/features/shapes.zh-CN.mdx +++ b/content/guides/sheets/features/shapes.zh-CN.mdx @@ -125,7 +125,7 @@ import '@univerjs-pro/sheets-shape/facade' ### 插入基础形状 -通过 [`FWorksheet.newShape`](/reference/facade/f-worksheet-shape-mixin#newshape) 创建形状构建器，然后调用 [`FWorksheet.insertShape`](/reference/facade/f-worksheet-shape-mixin#insertshape) 插入形状。 +通过 [`FWorksheet.newShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#newshape) 创建形状构建器，然后调用 [`FWorksheet.insertShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#insertshape) 插入形状。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -146,7 +146,7 @@ await fWorksheet.insertShape(rectShape) ### 插入并连接连接线形状 -通过 [`FWorksheet.newConnector`](/reference/facade/f-worksheet-shape-mixin#newconnector) 创建连接线，再使用 [`FWorksheet.connectShapes`](/reference/facade/f-worksheet-shape-mixin#connectshapes) 将连接线两端挂接到目标形状的连接点。 +通过 [`FWorksheet.newConnector`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#newconnector) 创建连接线，再使用 [`FWorksheet.connectShapes`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#connectshapes) 将连接线两端挂接到目标形状的连接点。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -199,7 +199,7 @@ if (connectorShape && basicShapes.length >= 2) { ### 更新和删除形状 -通过 [`FWorksheet.updateShape`](/reference/facade/f-worksheet-shape-mixin#updateshape) 更新已有形状，通过 [`FWorksheet.removeShape`](/reference/facade/f-worksheet-shape-mixin#removeshape) 删除形状。 +通过 [`FWorksheet.updateShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#updateshape) 更新已有形状，通过 [`FWorksheet.removeShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#removeshape) 删除形状。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -224,7 +224,7 @@ if (firstShape) { ### 相关 Facade 对象 -- [`FShape`](/reference/facade/f-shape)：形状构建与实例操作方法。 -- [`FConnectorShape`](/reference/facade/f-connector-shape)：连接线相关方法（箭头与连接关系）。 -- [`FShapeEnum`](/reference/facade/f-shape-enum)：挂载在 `univerAPI.Enum` 上的形状枚举。 -- [`FWorksheetShapeMixin`](/reference/facade/f-worksheet-shape-mixin)：工作表级形状操作方法。 +- [`FShape`](https://docs.univer.ai/reference/facade/f-shape)：形状构建与实例操作方法。 +- [`FConnectorShape`](https://docs.univer.ai/reference/facade/f-connector-shape)：连接线相关方法（箭头与连接关系）。 +- [`FShapeEnum`](https://docs.univer.ai/reference/facade/f-shape-enum)：挂载在 `univerAPI.Enum` 上的形状枚举。 +- [`FWorksheetShapeMixin`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin)：工作表级形状操作方法。 diff --git a/content/guides/sheets/features/shapes.zh-TW.mdx b/content/guides/sheets/features/shapes.zh-TW.mdx index 0172dadc..d9316940 100644 --- a/content/guides/sheets/features/shapes.zh-TW.mdx +++ b/content/guides/sheets/features/shapes.zh-TW.mdx @@ -125,7 +125,7 @@ import '@univerjs-pro/sheets-shape/facade' ### 插入基礎形狀 -透過 [`FWorksheet.newShape`](/reference/facade/f-worksheet-shape-mixin#newshape) 建立形狀建構器，再呼叫 [`FWorksheet.insertShape`](/reference/facade/f-worksheet-shape-mixin#insertshape) 插入形狀。 +透過 [`FWorksheet.newShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#newshape) 建立形狀建構器，再呼叫 [`FWorksheet.insertShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#insertshape) 插入形狀。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -146,7 +146,7 @@ await fWorksheet.insertShape(rectShape) ### 插入並連接連接線形狀 -透過 [`FWorksheet.newConnector`](/reference/facade/f-worksheet-shape-mixin#newconnector) 建立連接線，再使用 [`FWorksheet.connectShapes`](/reference/facade/f-worksheet-shape-mixin#connectshapes) 將連接線兩端連到目標形狀的連接點。 +透過 [`FWorksheet.newConnector`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#newconnector) 建立連接線，再使用 [`FWorksheet.connectShapes`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#connectshapes) 將連接線兩端連到目標形狀的連接點。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -199,7 +199,7 @@ if (connectorShape && basicShapes.length >= 2) { ### 更新與刪除形狀 -使用 [`FWorksheet.updateShape`](/reference/facade/f-worksheet-shape-mixin#updateshape) 更新既有形狀，使用 [`FWorksheet.removeShape`](/reference/facade/f-worksheet-shape-mixin#removeshape) 刪除形狀。 +使用 [`FWorksheet.updateShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#updateshape) 更新既有形狀，使用 [`FWorksheet.removeShape`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin#removeshape) 刪除形狀。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -224,7 +224,7 @@ if (firstShape) { ### 相關 Facade 物件 -- [`FShape`](/reference/facade/f-shape)：形狀建構與實例操作方法。 -- [`FConnectorShape`](/reference/facade/f-connector-shape)：連接線專用方法（箭頭與連接關係）。 -- [`FShapeEnum`](/reference/facade/f-shape-enum)：掛載於 `univerAPI.Enum` 的形狀列舉。 -- [`FWorksheetShapeMixin`](/reference/facade/f-worksheet-shape-mixin)：工作表層級的形狀操作方法。 +- [`FShape`](https://docs.univer.ai/reference/facade/f-shape)：形狀建構與實例操作方法。 +- [`FConnectorShape`](https://docs.univer.ai/reference/facade/f-connector-shape)：連接線專用方法（箭頭與連接關係）。 +- [`FShapeEnum`](https://docs.univer.ai/reference/facade/f-shape-enum)：掛載於 `univerAPI.Enum` 的形狀列舉。 +- [`FWorksheetShapeMixin`](https://docs.univer.ai/reference/facade/f-worksheet-shape-mixin)：工作表層級的形狀操作方法。 diff --git a/content/guides/sheets/features/sort.ja-JP.mdx b/content/guides/sheets/features/sort.ja-JP.mdx index 1cbcbf28..a8313e3f 100644 --- a/content/guides/sheets/features/sort.ja-JP.mdx +++ b/content/guides/sheets/features/sort.ja-JP.mdx @@ -113,7 +113,7 @@ import '@univerjs/sheets-sort/facade' ### ワークシートの並べ替え -[`FWorksheet.sort(colIndex, asc)`](https://reference.univer.ai/ja-JP/classes/FWorksheet#sort) メソッドは、指定した列でワークシートを並べ替えるために使用できます。 +[`FWorksheet.sort(colIndex, asc)`](https://docs.univer.ai/reference/facade/worksheet#sort) メソッドは、指定した列でワークシートを並べ替えるために使用できます。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -128,7 +128,7 @@ fWorksheet.sort(0, false) ### 範囲の並べ替え -[`FRange.sort(column)`](https://reference.univer.ai/ja-JP/classes/FRange#sort) メソッドは、指定した列と順序に基づいて範囲内のセルを並べ替えるために使用できます。 +[`FRange.sort(column)`](https://docs.univer.ai/reference/facade/range#sort) メソッドは、指定した列と順序に基づいて範囲内のセルを並べ替えるために使用できます。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -147,7 +147,7 @@ fRange.sort([{ column: 0, ascending: false }, 1]) ### イベントリスナー -完全なイベント型定義は、[Events](https://reference.univer.ai/ja-JP/classes/FEventName) で確認できます。 +完全なイベント型定義は、[Events](https://docs.univer.ai/reference/facade/events) で確認できます。 `SheetRangeSorted` イベントは、セル範囲の並べ替えが完了したときにトリガーします。 diff --git a/content/guides/sheets/features/sort.mdx b/content/guides/sheets/features/sort.mdx index 65edd08d..5ef803e9 100644 --- a/content/guides/sheets/features/sort.mdx +++ b/content/guides/sheets/features/sort.mdx @@ -113,7 +113,7 @@ import '@univerjs/sheets-sort/facade' ### Worksheet Sorting -[`FWorksheet.sort(colIndex, asc)`](https://reference.univer.ai/en-US/classes/FWorksheet#sort) method can sort the worksheet by the specified column. +[`FWorksheet.sort(colIndex, asc)`](https://docs.univer.ai/reference/facade/worksheet#sort) method can sort the worksheet by the specified column. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -128,7 +128,7 @@ fWorksheet.sort(0, false) ### Range Sorting -[`FRange.sort(column)`](https://reference.univer.ai/en-US/classes/FRange#sort) method can sort the cells in a specified range by the given column and order. +[`FRange.sort(column)`](https://docs.univer.ai/reference/facade/range#sort) method can sort the cells in a specified range by the given column and order. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -147,7 +147,7 @@ fRange.sort([{ column: 0, ascending: false }, 1]) ### Event Listeners -Complete event type definitions can be found in the [Events](https://reference.univer.ai/en-US/classes/FEventName). +Complete event type definitions can be found in the [Events](https://docs.univer.ai/reference/facade/events). `SheetRangeSorted` event is triggered after the cell range sorting is completed. diff --git a/content/guides/sheets/features/sort.zh-CN.mdx b/content/guides/sheets/features/sort.zh-CN.mdx index b9712962..37d726aa 100644 --- a/content/guides/sheets/features/sort.zh-CN.mdx +++ b/content/guides/sheets/features/sort.zh-CN.mdx @@ -113,7 +113,7 @@ import '@univerjs/sheets-sort/facade' ### 工作表排序 -[`FWorksheet.sort(colIndex, asc)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#sort) 方法可以按指定的列对工作表进行排序。 +[`FWorksheet.sort(colIndex, asc)`](https://docs.univer.ai/reference/facade/worksheet#sort) 方法可以按指定的列对工作表进行排序。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -128,7 +128,7 @@ fWorksheet.sort(0, false) ### 区域排序 -[`FRange.sort(column)`](https://reference.univer.ai/zh-CN/classes/FRange#sort) 方法可以按指定的列和顺序对给定范围内的单元格进行排序。 +[`FRange.sort(column)`](https://docs.univer.ai/reference/facade/range#sort) 方法可以按指定的列和顺序对给定范围内的单元格进行排序。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -147,7 +147,7 @@ fRange.sort([{ column: 0, ascending: false }, 1]) ### 事件监听 -完整事件类型定义，请查看 [Events](https://reference.univer.ai/zh-CN/classes/FEventName)。 +完整事件类型定义，请查看 [Events](https://docs.univer.ai/reference/facade/events)。 `SheetRangeSorted` 事件在单元格范围排序完成后触发。 diff --git a/content/guides/sheets/features/sort.zh-TW.mdx b/content/guides/sheets/features/sort.zh-TW.mdx index deb355d4..813eca8c 100644 --- a/content/guides/sheets/features/sort.zh-TW.mdx +++ b/content/guides/sheets/features/sort.zh-TW.mdx @@ -113,7 +113,7 @@ import '@univerjs/sheets-sort/facade' ### 工作表排序 -[`FWorksheet.sort(colIndex, asc)`](https://reference.univer.ai/zh-TW/classes/FWorksheet#sort) 方法可以按指定的列對工作表進行排序。 +[`FWorksheet.sort(colIndex, asc)`](https://docs.univer.ai/reference/facade/worksheet#sort) 方法可以按指定的列對工作表進行排序。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -128,7 +128,7 @@ fWorksheet.sort(0, false) ### 區域排序 -[`FRange.sort(column)`](https://reference.univer.ai/zh-TW/classes/FRange#sort) 方法可以按指定的列和順序對給定範圍內的單元格進行排序。 +[`FRange.sort(column)`](https://docs.univer.ai/reference/facade/range#sort) 方法可以按指定的列和順序對給定範圍內的單元格進行排序。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -147,7 +147,7 @@ fRange.sort([{ column: 0, ascending: false }, 1]) ### 事件監聽 -完整事件型別定義，請檢視 [Events](https://reference.univer.ai/zh-TW/classes/FEventName)。 +完整事件型別定義，請檢視 [Events](https://docs.univer.ai/reference/facade/events)。 `SheetRangeSorted` 事件在單元格範圍排序完成後觸發。 diff --git a/content/guides/sheets/features/sparkline.ja-JP.mdx b/content/guides/sheets/features/sparkline.ja-JP.mdx index 1a0b7f7f..f415ac27 100644 --- a/content/guides/sheets/features/sparkline.ja-JP.mdx +++ b/content/guides/sheets/features/sparkline.ja-JP.mdx @@ -125,7 +125,7 @@ import '@univerjs-pro/sheets-sparkline/facade' ### スパークラインの追加 -[`FWorksheet.addSparkline`](https://reference.univer.ai/en-US/classes/FWorksheet#addsparkline) メソッドは、指定した範囲にスパークラインを追加し、`FSparkline` インスタンスを返します。 +[`FWorksheet.addSparkline`](https://docs.univer.ai/reference/facade/worksheet#addsparkline) メソッドは、指定した範囲にスパークラインを追加し、`FSparkline` インスタンスを返します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -139,7 +139,7 @@ const sparkline = fWorksheet.addSparkline(sourceRanges, targetRanges, univerAPI. ### スパークラインの合成と分解 -[`FWorksheet.composeSparkline`](https://reference.univer.ai/en-US/classes/FWorksheet#composesparkline) と [`FWorksheet.unComposeSparkline`](https://reference.univer.ai/en-US/classes/FWorksheet#uncomposesparkline) メソッドは、スパークラインの合成および分解に使用されます。 +[`FWorksheet.composeSparkline`](https://docs.univer.ai/reference/facade/worksheet#composesparkline) と [`FWorksheet.unComposeSparkline`](https://docs.univer.ai/reference/facade/worksheet#uncomposesparkline) メソッドは、スパークラインの合成および分解に使用されます。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -170,7 +170,7 @@ setTimeout(() => { ### スパークラインおよびスパークライングループの取得 -[`FWorksheet.getSparklineByCell`](https://reference.univer.ai/en-US/classes/FWorksheet#getsparklinebycell) は、指定したセルのスパークラインインスタンスを取得し、`FSparkline` インスタンスを返します。 +[`FWorksheet.getSparklineByCell`](https://docs.univer.ai/reference/facade/worksheet#getsparklinebycell) は、指定したセルのスパークラインインスタンスを取得し、`FSparkline` インスタンスを返します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -185,7 +185,7 @@ console.log('Cell A10: ', fWorksheet.getSparklineByCell(9, 0)) console.log('Cell A11: ', fWorksheet.getSparklineByCell(10, 0)) ``` -[`FWorksheet.getSparklineGroupByCell`](https://reference.univer.ai/en-US/classes/FWorksheet#getsparklinegroupbycell) は、指定したセルのスパークライングループインスタンスを取得し、`FSparklineGroup` インスタンスを返します。 +[`FWorksheet.getSparklineGroupByCell`](https://docs.univer.ai/reference/facade/worksheet#getsparklinegroupbycell) は、指定したセルのスパークライングループインスタンスを取得し、`FSparklineGroup` インスタンスを返します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -211,14 +211,14 @@ setTimeout(() => { }, 3000) ``` -[`FSparkline`](https://reference.univer.ai/en-US/classes/FSparkline) インスタンスは、スパークラインを操作する次のメソッドを持ちます: +[`FSparkline`](https://docs.univer.ai/reference/facade/sparkline) インスタンスは、スパークラインを操作する次のメソッドを持ちます: | Method | Description | | --- | --- | | changeDataSource | 現在のセル内のスパークラインのデータソースと配置を変更します | removeSparkline | 現在のセル内のスパークラインを削除します | -[`FSparklineGroup`](https://reference.univer.ai/en-US/classes/FSparklineGroup) インスタンスは、スパークライングループを操作する次のメソッドを持ちます: +[`FSparklineGroup`](https://docs.univer.ai/reference/facade/sparkline) インスタンスは、スパークライングループを操作する次のメソッドを持ちます: | Method | Description | | --- | --- | @@ -228,7 +228,7 @@ setTimeout(() => { ### イベントリスナー -完全なイベント型定義は、[Events](https://reference.univer.ai/en-US/classes/FEventName) で確認できます。 +完全なイベント型定義は、[Events](https://docs.univer.ai/reference/facade/events) で確認できます。 `univerAPI.Event.SheetSparklineChanged` イベントは、スパークラインが変更されたときにトリガーします。 diff --git a/content/guides/sheets/features/sparkline.mdx b/content/guides/sheets/features/sparkline.mdx index d8b634c9..03128b16 100644 --- a/content/guides/sheets/features/sparkline.mdx +++ b/content/guides/sheets/features/sparkline.mdx @@ -125,7 +125,7 @@ import '@univerjs-pro/sheets-sparkline/facade' ### Add Sparkline -[`FWorksheet.addSparkline`](https://reference.univer.ai/en-US/classes/FWorksheet#addsparkline) method is used to add a sparkline in the specified range, returning an `FSparkline` instance. +[`FWorksheet.addSparkline`](https://docs.univer.ai/reference/facade/worksheet#addsparkline) method is used to add a sparkline in the specified range, returning an `FSparkline` instance. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -139,7 +139,7 @@ const sparkline = fWorksheet.addSparkline(sourceRanges, targetRanges, univerAPI. ### Compose and Uncomposing Sparkline -[`FWorksheet.composeSparkline`](https://reference.univer.ai/en-US/classes/FWorksheet#composesparkline) and [`FWorksheet.unComposeSparkline`](https://reference.univer.ai/en-US/classes/FWorksheet#uncomposesparkline) methods are used to compose and uncompose sparklines. +[`FWorksheet.composeSparkline`](https://docs.univer.ai/reference/facade/worksheet#composesparkline) and [`FWorksheet.unComposeSparkline`](https://docs.univer.ai/reference/facade/worksheet#uncomposesparkline) methods are used to compose and uncompose sparklines. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -170,7 +170,7 @@ setTimeout(() => { ### Get Sparkline and Sparkline Group Instances -[`FWorksheet.getSparklineByCell`](https://reference.univer.ai/en-US/classes/FWorksheet#getsparklinebycell) is used to get the sparkline instance in a specified cell, returning an `FSparkline` instance. +[`FWorksheet.getSparklineByCell`](https://docs.univer.ai/reference/facade/worksheet#getsparklinebycell) is used to get the sparkline instance in a specified cell, returning an `FSparkline` instance. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -185,7 +185,7 @@ console.log('Cell A10: ', fWorksheet.getSparklineByCell(9, 0)) console.log('Cell A11: ', fWorksheet.getSparklineByCell(10, 0)) ``` -[`FWorksheet.getSparklineGroupByCell`](https://reference.univer.ai/en-US/classes/FWorksheet#getsparklinegroupbycell) is used to get the sparkline group instance in a specified cell, returning an `FSparklineGroup` instance. +[`FWorksheet.getSparklineGroupByCell`](https://docs.univer.ai/reference/facade/worksheet#getsparklinegroupbycell) is used to get the sparkline group instance in a specified cell, returning an `FSparklineGroup` instance. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -211,14 +211,14 @@ setTimeout(() => { }, 3000) ``` -[`FSparkline`](https://reference.univer.ai/en-US/classes/FSparkline) instance has the following methods to manipulate the sparkline: +[`FSparkline`](https://docs.univer.ai/reference/facade/sparkline) instance has the following methods to manipulate the sparkline: | Method | Description | | --- | --- | | changeDataSource | Modify the data source and placement of the sparkline in the current cell | removeSparkline | Remove the sparkline in the current cell | -[`FSparklineGroup`](https://reference.univer.ai/en-US/classes/FSparklineGroup) instance has the following methods to manipulate the sparkline group: +[`FSparklineGroup`](https://docs.univer.ai/reference/facade/sparkline) instance has the following methods to manipulate the sparkline group: | Method | Description | | --- | --- | @@ -228,7 +228,7 @@ setTimeout(() => { ### Event Listeners -Complete event type definitions can be found in the [Events](https://reference.univer.ai/en-US/classes/FEventName). +Complete event type definitions can be found in the [Events](https://docs.univer.ai/reference/facade/events). `univerAPI.Event.SheetSparklineChanged` event is triggered when the sparkline changes. diff --git a/content/guides/sheets/features/sparkline.zh-CN.mdx b/content/guides/sheets/features/sparkline.zh-CN.mdx index d911d27b..8b6b2262 100644 --- a/content/guides/sheets/features/sparkline.zh-CN.mdx +++ b/content/guides/sheets/features/sparkline.zh-CN.mdx @@ -125,7 +125,7 @@ import '@univerjs-pro/sheets-sparkline/facade' ### 添加迷你图 -[`FWorksheet.addSparkline`](https://reference.univer.ai/zh-CN/classes/FWorksheet#addsparkline) 方法用于在指定区域添加迷你图，返回一个 `FSparkline` 实例。 +[`FWorksheet.addSparkline`](https://docs.univer.ai/reference/facade/worksheet#addsparkline) 方法用于在指定区域添加迷你图，返回一个 `FSparkline` 实例。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -139,7 +139,7 @@ const sparkline = fWorksheet.addSparkline(sourceRanges, targetRanges, univerAPI. ### 组合迷你图和取消组合迷你图 -[`FWorksheet.composeSparkline`](https://reference.univer.ai/zh-CN/classes/FWorksheet#composesparkline) 和 [`FWorksheet.unComposeSparkline`](https://reference.univer.ai/zh-CN/classes/FWorksheet#uncomposesparkline) 方法用于组合和取消组合迷你图。 +[`FWorksheet.composeSparkline`](https://docs.univer.ai/reference/facade/worksheet#composesparkline) 和 [`FWorksheet.unComposeSparkline`](https://docs.univer.ai/reference/facade/worksheet#uncomposesparkline) 方法用于组合和取消组合迷你图。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -170,7 +170,7 @@ setTimeout(() => { ### 获取迷你图和迷你图组实例 -[`FWorksheet.getSparklineByCell`](https://reference.univer.ai/zh-CN/classes/FWorksheet#getsparklinebycell) 用于获取指定单元格内的迷你图实例，返回一个 `FSparkline` 实例。 +[`FWorksheet.getSparklineByCell`](https://docs.univer.ai/reference/facade/worksheet#getsparklinebycell) 用于获取指定单元格内的迷你图实例，返回一个 `FSparkline` 实例。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -185,7 +185,7 @@ console.log('Cell A10: ', fWorksheet.getSparklineByCell(9, 0)) console.log('Cell A11: ', fWorksheet.getSparklineByCell(10, 0)) ``` -[`FWorksheet.getSparklineGroupByCell`](https://reference.univer.ai/zh-CN/classes/FWorksheet#getsparklinegroupbycell) 用于获取指定单元格内的迷你图组实例，返回一个 `FSparklineGroup` 实例。 +[`FWorksheet.getSparklineGroupByCell`](https://docs.univer.ai/reference/facade/worksheet#getsparklinegroupbycell) 用于获取指定单元格内的迷你图组实例，返回一个 `FSparklineGroup` 实例。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -211,14 +211,14 @@ setTimeout(() => { }, 3000) ``` -[`FSparkline`](https://reference.univer.ai/zh-CN/classes/FSparkline) 实例有以下方法用来操作迷你图： +[`FSparkline`](https://docs.univer.ai/reference/facade/sparkline) 实例有以下方法用来操作迷你图： | 方法 | 描述 | | --- | --- | | changeDataSource | 修改当前单元格内迷你图的数据源和放置位置 | | removeSparkline | 删除当前单元格内的迷你图 | -[`FSparklineGroup`](https://reference.univer.ai/zh-CN/classes/FSparklineGroup) 实例有以下方法用来操作迷你图组： +[`FSparklineGroup`](https://docs.univer.ai/reference/facade/sparkline) 实例有以下方法用来操作迷你图组： | 方法 | 描述 | | --- | --- | @@ -228,7 +228,7 @@ setTimeout(() => { ### 事件监听 -完整事件类型定义，请查看 [Events](https://reference.univer.ai/zh-CN/classes/FEventName)。 +完整事件类型定义，请查看 [Events](https://docs.univer.ai/reference/facade/events)。 `univerAPI.Event.SheetSparklineChanged` 事件在迷你图发生变化时触发。 diff --git a/content/guides/sheets/features/sparkline.zh-TW.mdx b/content/guides/sheets/features/sparkline.zh-TW.mdx index 819e5c68..cee1dfb1 100644 --- a/content/guides/sheets/features/sparkline.zh-TW.mdx +++ b/content/guides/sheets/features/sparkline.zh-TW.mdx @@ -125,7 +125,7 @@ import '@univerjs-pro/sheets-sparkline/facade' ### 新增迷你圖 -[`FWorksheet.addSparkline`](https://reference.univer.ai/zh-TW/classes/FWorksheet#addsparkline) 方法用於在指定區域新增迷你圖，返回一個 `FSparkline` 例項。 +[`FWorksheet.addSparkline`](https://docs.univer.ai/reference/facade/worksheet#addsparkline) 方法用於在指定區域新增迷你圖，返回一個 `FSparkline` 例項。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -139,7 +139,7 @@ const sparkline = fWorksheet.addSparkline(sourceRanges, targetRanges, univerAPI. ### 組合迷你圖和取消組合迷你圖 -[`FWorksheet.composeSparkline`](https://reference.univer.ai/zh-TW/classes/FWorksheet#composesparkline) 和 [`FWorksheet.unComposeSparkline`](https://reference.univer.ai/zh-TW/classes/FWorksheet#uncomposesparkline) 方法用於組合和取消組合迷你圖。 +[`FWorksheet.composeSparkline`](https://docs.univer.ai/reference/facade/worksheet#composesparkline) 和 [`FWorksheet.unComposeSparkline`](https://docs.univer.ai/reference/facade/worksheet#uncomposesparkline) 方法用於組合和取消組合迷你圖。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -170,7 +170,7 @@ setTimeout(() => { ### 獲取迷你圖和迷你圖組例項 -[`FWorksheet.getSparklineByCell`](https://reference.univer.ai/zh-TW/classes/FWorksheet#getsparklinebycell) 用於獲取指定單元格內的迷你圖例項，返回一個 `FSparkline` 例項。 +[`FWorksheet.getSparklineByCell`](https://docs.univer.ai/reference/facade/worksheet#getsparklinebycell) 用於獲取指定單元格內的迷你圖例項，返回一個 `FSparkline` 例項。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -185,7 +185,7 @@ console.log('Cell A10: ', fWorksheet.getSparklineByCell(9, 0)) console.log('Cell A11: ', fWorksheet.getSparklineByCell(10, 0)) ``` -[`FWorksheet.getSparklineGroupByCell`](https://reference.univer.ai/zh-TW/classes/FWorksheet#getsparklinegroupbycell) 用於獲取指定單元格內的迷你圖組例項，返回一個 `FSparklineGroup` 例項。 +[`FWorksheet.getSparklineGroupByCell`](https://docs.univer.ai/reference/facade/worksheet#getsparklinegroupbycell) 用於獲取指定單元格內的迷你圖組例項，返回一個 `FSparklineGroup` 例項。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -211,14 +211,14 @@ setTimeout(() => { }, 3000) ``` -[`FSparkline`](https://reference.univer.ai/zh-TW/classes/FSparkline) 例項有以下方法用來操作迷你圖： +[`FSparkline`](https://docs.univer.ai/reference/facade/sparkline) 例項有以下方法用來操作迷你圖： | 方法 | 描述 | | --- | --- | | changeDataSource | 修改當前單元格內迷你圖的資料來源和放置位置 | | removeSparkline | 刪除當前單元格內的迷你圖 | -[`FSparklineGroup`](https://reference.univer.ai/zh-TW/classes/FSparklineGroup) 例項有以下方法用來操作迷你圖組： +[`FSparklineGroup`](https://docs.univer.ai/reference/facade/sparkline) 例項有以下方法用來操作迷你圖組： | 方法 | 描述 | | --- | --- | @@ -228,7 +228,7 @@ setTimeout(() => { ### 事件監聽 -完整事件型別定義，請檢視 [Events](https://reference.univer.ai/zh-TW/classes/FEventName)。 +完整事件型別定義，請檢視 [Events](https://docs.univer.ai/reference/facade/events)。 `univerAPI.Event.SheetSparklineChanged` 事件在迷你圖發生變化時觸發。 diff --git a/content/guides/sheets/features/watermark.ja-JP.mdx b/content/guides/sheets/features/watermark.ja-JP.mdx index b0d59af5..71e4fa2d 100644 --- a/content/guides/sheets/features/watermark.ja-JP.mdx +++ b/content/guides/sheets/features/watermark.ja-JP.mdx @@ -84,7 +84,7 @@ univer.registerPlugin(UniverWatermarkPlugin, { // [!code ++] このプラグインはウォーターマーク機能のコア実装を提供します。開発者はテキストや画像の透かしをアプリケーションに追加でき、透かしの見た目や挙動をカスタマイズするための各種設定オプションを利用できます。`UniverWatermarkPlugin` プラグインを提供します。 -参照: [@univerjs/watermark](/reference/packages/plugins/univerjs/watermark) +参照: [@univerjs/watermark(https://docs.univer.ai/reference/packages/plugins/univerjs/watermark) ## Facade API diff --git a/content/guides/sheets/features/watermark.mdx b/content/guides/sheets/features/watermark.mdx index 2e44a482..ec52bfa0 100644 --- a/content/guides/sheets/features/watermark.mdx +++ b/content/guides/sheets/features/watermark.mdx @@ -84,7 +84,7 @@ univer.registerPlugin(UniverWatermarkPlugin, { // [!code ++] This plugin provides the core implementation of watermark functionality. It allows developers to add text or image watermarks to applications and offers various configuration options to customize the appearance and behavior of the watermark. It provides the `UniverWatermarkPlugin` plugin. -Reference: [@univerjs/watermark](/reference/packages/plugins/univerjs/watermark) +Reference: [@univerjs/watermark(https://docs.univer.ai/reference/packages/plugins/univerjs/watermark) ## Facade API diff --git a/content/guides/sheets/features/watermark.zh-CN.mdx b/content/guides/sheets/features/watermark.zh-CN.mdx index 00e8c41f..a756ebdc 100644 --- a/content/guides/sheets/features/watermark.zh-CN.mdx +++ b/content/guides/sheets/features/watermark.zh-CN.mdx @@ -84,7 +84,7 @@ univer.registerPlugin(UniverWatermarkPlugin, { // [!code ++] 本插件提供了水印功能的核心实现。它允许开发者在应用中添加文本或图片水印，并提供多种配置选项来定制水印的外观和行为。其提供了 `UniverWatermarkPlugin` 插件。 -参考：[@univerjs/watermark](/reference/packages/plugins/univerjs/watermark) +参考：[@univerjs/watermark(https://docs.univer.ai/reference/packages/plugins/univerjs/watermark) ## Facade API diff --git a/content/guides/sheets/features/watermark.zh-TW.mdx b/content/guides/sheets/features/watermark.zh-TW.mdx index b937e25d..70297419 100644 --- a/content/guides/sheets/features/watermark.zh-TW.mdx +++ b/content/guides/sheets/features/watermark.zh-TW.mdx @@ -84,7 +84,7 @@ univer.registerPlugin(UniverWatermarkPlugin, { // [!code ++] 本外掛提供了水印功能的核心實現。它允許開發者在應用中新增文字或圖片水印，並提供多種配置選項來客製化水印的外觀和行為。其提供了 `UniverWatermarkPlugin` 外掛。 -參考：[@univerjs/watermark](/reference/packages/plugins/univerjs/watermark) +參考：[@univerjs/watermark(https://docs.univer.ai/reference/packages/plugins/univerjs/watermark) ## Facade API diff --git a/content/guides/sheets/getting-started/installation/index.ja-JP.mdx b/content/guides/sheets/getting-started/installation/index.ja-JP.mdx index be8d1b12..ce9d1a59 100644 --- a/content/guides/sheets/getting-started/installation/index.ja-JP.mdx +++ b/content/guides/sheets/getting-started/installation/index.ja-JP.mdx @@ -90,7 +90,7 @@ univerAPI.createWorkbook({}) どのプリセットパッケージにも含まれていないプラグインを使用する場合や、独自のプラグインを実装する場合は、`plugins` プロパティを通してこれらのプラグインを登録できます。また、Univer インスタンスを取得した後に `univer.registerPlugin` メソッドを使用してプラグインを登録することも可能です。 - `createUniver` メソッドの詳細情報については、[API リファレンス / createUniver](/reference/methods/create-univer) で確認できます。 + `createUniver` メソッドの詳細情報については、[API リファレンス / createUniver(https://docs.univer.ai/reference/methods/create-univer) で確認できます。 ### CDN からのインポート @@ -112,7 +112,7 @@ Univer は一連の機能をプラグインの形で提供しています。製 - npm を使用している場合は、npm@7 以上を使用していることを確認してください。npm@3 ~ npm@6 は `peerDependencies` を正しくインストールしないためです[^1]。 - pnpm を使用している場合は、pnpm@8 以上を使用していることを確認してください。pnpm@6 ~ pnpm@7 を使用している場合は、`auto-install-peers=true` を設定[^2]して依存関係のインストール問題を解決してみてください。 - - yarn を使用している場合は、不足している `peerDependencies` を手動でインストールする必要があります[^3]が、心配しないでください。以下のインストールコマンドにはすでにこれらの依存関係が含まれています。 + - yarn を使用している場合は、不足している `peerDependencies` を手動でインストールする必要があります[^3]。以下のインストールコマンドにはすでにこれらの依存関係が含まれています。 @@ -175,7 +175,7 @@ Univer は一連の機能をプラグインの形で提供しています。製 ``` - Facade API を使用する必要がある場合は、ここで関連する facade パッケージをインポートできます。これはオプションです（きっと必要になると思います 😀）： + Facade API を使用する必要がある場合は、ここで関連する facade パッケージをインポートできます。これはオプションですが、推奨します： ```typescript import '@univerjs/engine-formula/facade' @@ -238,7 +238,7 @@ Univer は一連の機能をプラグインの形で提供しています。製 `univer.registerPlugin(Plugin, options)` メソッドを使用してプラグインを登録できます。ここで `Plugin` は登録するプラグイン、`options` はオプションの設定項目で、各プラグインは異なる設定項目を持つ場合があります。 -もちろん、配列を渡して複数のプラグインを一度に登録することも可能です。これは、プラグインを一元管理する必要があるシナリオで非常に便利です。 +配列を渡して複数のプラグインを一度に登録することも可能です。これは、プラグインを一元管理する必要があるシナリオで便利です。 ```typescript univer.registerPlugin([ @@ -341,9 +341,9 @@ npm install @univerjs/@alpha # Alpha バージョン npm install @univerjs/@beta # Beta バージョン ``` -alpha/beta バージョンを使用中に問題が発生したり、フィードバックがある場合は、[Github Issues](https://github.com/dream-num/univer/issues) や [Discord チャンネル](https://discord.gg/XPGnMBmpd6)などの適切なチャンネルを通じて Univer 開発チームに報告してください。 +alpha/beta バージョンを使用中に問題が発生したり、フィードバックがある場合は、[GitHub Issues](https://github.com/dream-num/univer/issues) や [Discord チャンネル](https://discord.gg/XPGnMBmpd6)などの適切なチャンネルを通じて Univer 開発チームに報告してください。 -早期アクセス実験をお楽しみください！ +これらの早期リリースについてのフィードバックを歓迎します。 ## 次のステップ diff --git a/content/guides/sheets/getting-started/installation/index.mdx b/content/guides/sheets/getting-started/installation/index.mdx index ee6fb2ee..e99a8af1 100644 --- a/content/guides/sheets/getting-started/installation/index.mdx +++ b/content/guides/sheets/getting-started/installation/index.mdx @@ -2,7 +2,7 @@ title: Installation & Basic Usage --- -Univer adopts a plugin-based design philosophy, aim`ing to provide developers with a flexible and extensible framework for electronic document applications. Through this plugin-based design, Univer can easily integrate various functional modules to meet the needs of different users. However, the plugin-based design increases the complexity of the application, especially for developers who are new to Univer. +Univer adopts a plugin-based design philosophy, aiming to provide developers with a flexible and extensible framework for electronic document applications. Through this plugin-based design, Univer can easily integrate various functional modules to meet the needs of different users. However, the plugin-based design increases the complexity of the application, especially for developers who are new to Univer. For this reason, Univer provides two ways to help you quickly integrate and use Univer: **plugin mode** and **preset mode**. The so-called **preset** is actually a combination of pre-configured plugins, so the capabilities provided by both modes are the same without complex extensions. @@ -41,7 +41,7 @@ npm install @univerjs/presets @univerjs/preset-docs-core If your build tool does not support the `exports` field in package.json (common in Webpack 4), you need to manually change the mapped paths to the actual paths. -With the following code, you can start an Univer Sheets application: +With the following code, you can start a Univer Sheets application: ```typescript import { UniverSheetsCorePreset } from '@univerjs/preset-sheets-core' @@ -90,7 +90,7 @@ Some properties of the configuration object are as follows: When you use a plugin that is not included in any preset package or you implement your own plugin, you can register these plugins through the `plugins` property. You can also choose to register plugins using the `univer.registerPlugin` method after obtaining the Univer instance. - You can find more detailed information about the `createUniver` method in the [API Reference / createUniver](/reference/methods/create-univer). + You can find more detailed information about the `createUniver` method in the [API Reference / createUniver](https://docs.univer.ai/reference/methods/create-univer). ### Import from CDN @@ -112,7 +112,7 @@ We use React to develop the view (this does not affect your use of Univer in Vue - If you are using npm, make sure you are using npm@7 or higher. This is because npm@3 ~ npm@6 will not correctly install `peerDependencies`[^1]. - If you are using pnpm, make sure you are using pnpm@8 or higher. If you are using pnpm@6 ~ pnpm@7, you can try configuring `auto-install-peers=true` [^2] to resolve dependency installation issues. - - If you are using yarn, you need to manually install the missing `peerDependencies`[^3], but don't worry, the installation commands below already include these dependencies. + - If you are using yarn, you need to manually install the missing `peerDependencies`[^3], the installation commands below already include these dependencies. @@ -175,7 +175,7 @@ We use React to develop the view (this does not affect your use of Univer in Vue ``` - If you need to use the Facade API, you can import the relevant facade packages here. This is optional (I believe you will need them 😀): + If you need to use the Facade API, you can import the relevant facade packages here. This is optional, but recommended: ```typescript import '@univerjs/engine-formula/facade' @@ -238,7 +238,7 @@ We use React to develop the view (this does not affect your use of Univer in Vue You can register a plugin using the `univer.registerPlugin(Plugin, options)` method, where `Plugin` is the plugin to be registered, and `options` are optional configuration items, as each plugin may have different configuration items. -Of course, you can also pass an array to register multiple plugins at once. This is very useful for scenarios where you need to manage plugins centrally. +You can also pass an array to register multiple plugins at once. This is useful for scenarios where you need to manage plugins centrally. ```typescript univer.registerPlugin([ @@ -341,9 +341,9 @@ npm install @univerjs/@alpha # Alpha version npm install @univerjs/@beta # Beta version ``` -If you encounter any issues or have any feedback while using alpha / beta versions, please report them to the Univer development team through appropriate channels, such as [Github Issues](https://github.com/dream-num/univer/issues) or the [Discord channels](https://discord.gg/XPGnMBmpd6). +If you encounter any issues or have any feedback while using alpha / beta versions, please report them to the Univer development team through appropriate channels, such as [GitHub Issues](https://github.com/dream-num/univer/issues) or the [Discord channels](https://discord.gg/XPGnMBmpd6). -Happy early access experimentation! +We welcome your feedback on these early releases. ## Next Steps diff --git a/content/guides/sheets/getting-started/installation/index.zh-CN.mdx b/content/guides/sheets/getting-started/installation/index.zh-CN.mdx index e1c98c67..a67b45d8 100644 --- a/content/guides/sheets/getting-started/installation/index.zh-CN.mdx +++ b/content/guides/sheets/getting-started/installation/index.zh-CN.mdx @@ -75,7 +75,7 @@ univerAPI.createWorkbook({}) 当你使用了一个未包含在任何预设包中的插件或者你自己实现了一个插件时，可以通过 `plugins` 属性来注册这些插件。也可以选择在获得 Univer 实例后通过 `univer.registerPlugin` 方法来注册插件。 - 你可以在 [API Reference / createUniver](/reference/methods/create-univer) 找到更多关于 `createUniver` 方法的详细信息。 + 你可以在 [API Reference / createUniver](https://docs.univer.ai/reference/methods/create-univer) 找到更多关于 `createUniver` 方法的详细信息。 ### 通过 CDN 使用 Univer @@ -97,7 +97,7 @@ Univer 使用了 React 开发视图（当然这并不影响你在 Vue 或者 Ang - 如果你正在使用 npm，请确保使用的版本为 npm@7 及以上。这是因为 npm@3 ~ npm@6 并不会正确地安装 `peerDependencies`[^1]。 - 如果你正在使用 pnpm，请确保使用的版本为 pnpm@8 及以上。如果你正在使用 pnpm@6 ~ pnpm@7，可以尝试配置 `auto-install-peers=true` [^2]来解决依赖安装问题。 - - 如果你正在使用 yarn，你需要手动安装缺失的 `peerDependencies`[^3]，不过别担心，下面的安装命令中已经包含了这些依赖。 + - 如果你正在使用 yarn，你需要手动安装缺失的 `peerDependencies`[^3]，下面的安装命令中已经包含了这些依赖。 @@ -160,7 +160,7 @@ Univer 使用了 React 开发视图（当然这并不影响你在 Vue 或者 Ang ``` - 如果你需要使用 Facade API，你可以在这里引入相关的 facade 包，这是可选的（我相信你会需要它们 😀）： + 如果你需要使用 Facade API，你可以在这里引入相关的 facade 包，这是可选的，但建议引入： ```typescript import '@univerjs/engine-formula/facade' @@ -223,7 +223,7 @@ Univer 使用了 React 开发视图（当然这并不影响你在 Vue 或者 Ang 你可以通过 `univer.registerPlugin(Plugin, options)` 的方式来注册插件，其中 `Plugin` 是要注册的插件，`options` 是可选的配置项，每个插件可能有不同的配置项。 -当然你可以可以通过传入一个数组来一次性注册多个插件。这对于需要集中管理插件的场景非常有用。 +你也可以通过传入一个数组来一次性注册多个插件。这对于需要集中管理插件的场景非常有用。 ```typescript univer.registerPlugin([ @@ -326,9 +326,9 @@ npm install @univerjs/@alpha # Alpha 版本 npm install @univerjs/@beta # Beta 版本 ``` -如果你在使用 alpha / beta 版本时遇到任何问题或者有任何反馈，请通过适当的渠道向 Univer 开发团队报告，比如 [Github Issues](https://github.com/dream-num/univer/issues) 或者 [Discord 社区](https://discord.gg/XPGnMBmpd6)。 +如果你在使用 alpha / beta 版本时遇到任何问题或者有任何反馈，请通过适当的渠道向 Univer 开发团队报告，比如 [GitHub Issues](https://github.com/dream-num/univer/issues) 或者 [Discord 社区](https://discord.gg/XPGnMBmpd6)。 -祝你在抢先体验中玩得愉快！ +我们欢迎你对于这些早期版本的反馈。 ## 下一步 diff --git a/content/guides/sheets/getting-started/installation/index.zh-TW.mdx b/content/guides/sheets/getting-started/installation/index.zh-TW.mdx index 537ff5b8..0a800b38 100644 --- a/content/guides/sheets/getting-started/installation/index.zh-TW.mdx +++ b/content/guides/sheets/getting-started/installation/index.zh-TW.mdx @@ -90,7 +90,7 @@ univerAPI.createWorkbook({}) 若使用的外掛不在任何預設中，或為自行實作，可透過 `plugins` 註冊，或於取得實例後使用 `univer.registerPlugin`。 - 參見 [API Reference / createUniver](/reference/methods/create-univer) 取得更多細節。 + 參見 [API Reference / createUniver](https://docs.univer.ai/reference/methods/create-univer) 取得更多細節。 ### 透過 CDN 使用 Univer @@ -175,7 +175,7 @@ Univer 以 React 建構視圖（仍可在 Vue / Angular 中使用），並使用 ``` - 若需使用 Facade API，可選擇引入以下 Facade 套件（多半你會需要 😀）： + 若需使用 Facade API，可選擇引入以下 Facade 套件（建議引入）： ```typescript import '@univerjs/engine-formula/facade' diff --git a/content/guides/sheets/getting-started/quickstart.ja-JP.mdx b/content/guides/sheets/getting-started/quickstart.ja-JP.mdx index 11cb8fef..47ba77b6 100644 --- a/content/guides/sheets/getting-started/quickstart.ja-JP.mdx +++ b/content/guides/sheets/getting-started/quickstart.ja-JP.mdx @@ -83,9 +83,9 @@ Univer では、すべてのデータ変更はコマンドを通じて実行す オフィスアプリケーションの複雑さにより、Univer のアーキテクチャも非常に複雑です。開発者が Univer をより簡単に使用できるようにするために、Facade API を提供しています。これは Univer の第一党プラグインのラッパーであり、開発者が Univer をより簡単に使用できるようにするシンプルなインターフェースを提供します。 -Facade API は改善を続けています。最新の更新にご期待ください。質問や要件がある場合は、GitHub で issue を提出してください。 +Facade API は積極的に改善されています。質問や要件がある場合は、GitHub で issue を提出してください。 -もちろん、すべてには代償があります。Facade API は高レベルの API であり、基礎となる詳細を抽象化しています。複雑な機能を実装する必要がある場合は、Univer のアーキテクチャを理解し、低レベルの API を直接使用する必要があるかもしれません。 +Facade API は高レベルの API であり、基礎となる詳細を抽象化しています。一般的なタスクは簡素化されますが、複雑な機能を実装するには、Univer のアーキテクチャを理解し、低レベルの API を直接使用する必要がある場合があります。 #### 関連リンク diff --git a/content/guides/sheets/getting-started/quickstart.mdx b/content/guides/sheets/getting-started/quickstart.mdx index 853f1938..b3d5f438 100644 --- a/content/guides/sheets/getting-started/quickstart.mdx +++ b/content/guides/sheets/getting-started/quickstart.mdx @@ -83,9 +83,9 @@ If you want to modify document data through commands, please refer to [How to Fi Due to the high complexity of office applications, Univer's architecture is also very complex. To make it easier for developers to use Univer, we provide the Facade API, which is a wrapper for Univer's first-party plugins, providing simpler interfaces that make it easier for developers to use Univer. -We are improving the Facade API. Stay tuned for more updates. If you have any questions or requirements, please submit an issue on GitHub. +The Facade API is actively being improved. If you have any questions or requirements, please submit an issue on GitHub. -Of course, everything comes with a price. The Facade API is a high-level API that abstracts the underlying details. If you need to implement some complex features, you may need to understand Univer's architecture and use the low-level API directly. +The Facade API is a high-level API that abstracts the underlying details. While it simplifies common tasks, complex features may require understanding Univer's architecture and using the low-level API directly. #### Related Links diff --git a/content/guides/sheets/getting-started/quickstart.zh-CN.mdx b/content/guides/sheets/getting-started/quickstart.zh-CN.mdx index 28af05e7..4b74a6da 100644 --- a/content/guides/sheets/getting-started/quickstart.zh-CN.mdx +++ b/content/guides/sheets/getting-started/quickstart.zh-CN.mdx @@ -61,7 +61,7 @@ Univer 的功能均由插件提供，插件是 Univer 的基本组成单元， 目前 Facade API 在不断完善中，如果你有任何建议或者需求，欢迎在 GitHub 上提 issue。 -当然，简单性是有代价的，如果你需要更高级的自定义能力，就需要在了解 Univer 架构的基础上使用更加底层的命令和模块所暴露的 API。 +Facade API 是对底层细节的抽象，虽然它简化了常见任务，但实现复杂功能时可能需要你了解 Univer 的架构并直接使用底层 API。 #### 相关链接 diff --git a/content/guides/sheets/ui/components.ja-JP.mdx b/content/guides/sheets/ui/components.ja-JP.mdx index 2d69d072..23d01200 100644 --- a/content/guides/sheets/ui/components.ja-JP.mdx +++ b/content/guides/sheets/ui/components.ja-JP.mdx @@ -15,7 +15,7 @@ Facade API のインスタンスを取得する方法に慣れていない場合 `FRange.attachPopup` メソッドを使用して、特定のセル範囲にカスタムポップアップを添付できます。 - ポップアップは、セルに添付される一時的な DOM 要素で、通常は一時的なステータス情報を表示するために使用され、永続的な保存をサポートしません。 -- [`FRange.attachPopup(popup: IFCanvasPopup)`](https://reference.univer.ai/en-US/classes/FRange#attachpopup) メソッドを使用して、特定のセル範囲にカスタムポップアップを添付できます。 +- [`FRange.attachPopup(popup: IFCanvasPopup)`](https://docs.univer.ai/reference/facade/range#attachpopup) メソッドを使用して、特定のセル範囲にカスタムポップアップを添付できます。 - ポップアップはセルの端に添付され、遮蔽されると自動的に位置と向きを調整します。 ```tsx diff --git a/content/guides/sheets/ui/components.mdx b/content/guides/sheets/ui/components.mdx index 83822165..7e466f99 100644 --- a/content/guides/sheets/ui/components.mdx +++ b/content/guides/sheets/ui/components.mdx @@ -15,7 +15,7 @@ If you are not familiar with how to obtain an instance of the Facade API, you ca Using the `FRange.attachPopup` method, you can attach a custom popup to a specific cell range. - A popup is a temporary DOM element attached to a cell, typically used to display transient status information and does not support persistent storage. -- You can use the [`FRange.attachPopup(popup: IFCanvasPopup)`](https://reference.univer.ai/en-US/classes/FRange#attachpopup) method to attach a custom popup to a specific cell range. +- You can use the [`FRange.attachPopup(popup: IFCanvasPopup)`](https://docs.univer.ai/reference/facade/range#attachpopup) method to attach a custom popup to a specific cell range. - The popup will attach to the edges of the cell and will automatically adjust its position and orientation if obstructed. ```tsx diff --git a/content/guides/sheets/ui/components.zh-CN.mdx b/content/guides/sheets/ui/components.zh-CN.mdx index ee7a8ffd..8e6c1f47 100644 --- a/content/guides/sheets/ui/components.zh-CN.mdx +++ b/content/guides/sheets/ui/components.zh-CN.mdx @@ -15,7 +15,7 @@ Univer 并不会直接将组件作为参数直接传递给任何渲染函数， 使用 `FRange.attachPopup` 方法可以将自定义弹出框附加到特定的单元格范围。 - Popup 是一个单元格上面依附的临时 DOM，一般用于显示一些临时的状态信息，不支持持久化存储。 -- 使用 [`FRange.attachPopup(popup: IFCanvasPopup)`](https://reference.univer.ai/zh-CN/classes/FRange#attachpopup) 方法可以将自定义弹出框附加到特定的单元格范围。 +- 使用 [`FRange.attachPopup(popup: IFCanvasPopup)`](https://docs.univer.ai/reference/facade/range#attachpopup) 方法可以将自定义弹出框附加到特定的单元格范围。 - Popup 会吸附在单元的四边，如果被遮挡，会自动调整位置和方向。 ```tsx diff --git a/content/guides/sheets/ui/components.zh-TW.mdx b/content/guides/sheets/ui/components.zh-TW.mdx index 802ca035..b21249a4 100644 --- a/content/guides/sheets/ui/components.zh-TW.mdx +++ b/content/guides/sheets/ui/components.zh-TW.mdx @@ -15,7 +15,7 @@ Univer 並不會直接將元件作為參數傳遞給任何渲染函數，你需 使用 `FRange.attachPopup` 方法可以將自訂彈出框附加到特定的儲存格範圍。 - Popup 是一個依附於儲存格之上的臨時 DOM，一般用於顯示一些臨時的狀態資訊，不支援持久化存儲。 -- 使用 [`FRange.attachPopup(popup: IFCanvasPopup)`](https://reference.univer.ai/zh-TW/classes/FRange#attachpopup) 方法可以將自訂彈出框附加到特定的儲存格範圍。 +- 使用 [`FRange.attachPopup(popup: IFCanvasPopup)`](https://docs.univer.ai/reference/facade/range#attachpopup) 方法可以將自訂彈出框附加到特定的儲存格範圍。 - Popup 會吸附在儲存格的四邊，如果被遮擋，會自動調整位置和方向。 ```tsx diff --git a/content/reference/facade/conditional-formatting.mdx b/content/reference/facade/conditional-formatting.mdx index 4783a09a..0af13671 100644 --- a/content/reference/facade/conditional-formatting.mdx +++ b/content/reference/facade/conditional-formatting.mdx @@ -17,7 +17,10 @@ icon: '#ref/F' | Method | Description | |--------|-------------| | [`build`](#build) | Constructs a conditional format rule from the settings applied to the builder | +| [`copy`](#copy) | Deep clone a current builder | +| [`createCfId`](#createcfid) | Create a conditional format ID | | [`getIconMap`](#geticonmap) | Get the icon set mapping dictionary | +| [`getRanges`](#getranges) | Gets the scope of the current conditional format | | [`setAverage`](#setaverage) | Set average rule | | [`setBackground`](#setbackground) | Sets the background color for the conditional format rule's format | | [`setBold`](#setbold) | Sets text bolding for the conditional format rule's format | @@ -34,20 +37,20 @@ icon: '#ref/F' | [`whenCellEmpty`](#whencellempty) | Sets the conditional format rule to trigger when the cell is empty | | [`whenCellNotEmpty`](#whencellnotempty) | Sets the conditional format rule to trigger when the cell is not empty | | [`whenDate`](#whendate) | Sets the conditional format rule to trigger when a time period is met | -| [`whenFormulaSatisfied`](#whenformulasatisfied) | Sets the conditional format rule to trigger when that the given formula evaluates to `true` | +| [`whenFormulaSatisfied`](#whenformulasatisfied) | Sets the conditional format rule to trigger when the given formula evaluates to `true` | | [`whenNumberBetween`](#whennumberbetween) | Sets the conditional format rule to trigger when a number falls between, or is either of, two specified values | | [`whenNumberEqualTo`](#whennumberequalto) | Sets the conditional format rule to trigger when a number is equal to the given value | | [`whenNumberGreaterThan`](#whennumbergreaterthan) | Sets the conditional format rule to trigger when a number is greater than the given value | | [`whenNumberGreaterThanOrEqualTo`](#whennumbergreaterthanorequalto) | Sets the conditional format rule to trigger when a number is greater than or equal to the given value | -| [`whenNumberLessThan`](#whennumberlessthan) | Sets the conditional conditional format rule to trigger when a number less than the given value | -| [`whenNumberLessThanOrEqualTo`](#whennumberlessthanorequalto) | Sets the conditional format rule to trigger when a number less than or equal to the given value | +| [`whenNumberLessThan`](#whennumberlessthan) | Sets the conditional format rule to trigger when a number is less than the given value | +| [`whenNumberLessThanOrEqualTo`](#whennumberlessthanorequalto) | Sets the conditional format rule to trigger when a number is less than or equal to the given value | | [`whenNumberNotBetween`](#whennumbernotbetween) | Sets the conditional format rule to trigger when a number does not fall between, and is neither of, two specified values | | [`whenNumberNotEqualTo`](#whennumbernotequalto) | Sets the conditional format rule to trigger when a number is not equal to the given value | -| [`whenTextContains`](#whentextcontains) | Sets the conditional format rule to trigger when that the input contains the given value | -| [`whenTextDoesNotContain`](#whentextdoesnotcontain) | Sets the conditional format rule to trigger when that the input does not contain the given value | -| [`whenTextEndsWith`](#whentextendswith) | Sets the conditional format rule to trigger when that the input ends with the given value | -| [`whenTextEqualTo`](#whentextequalto) | Sets the conditional format rule to trigger when that the input is equal to the given value | -| [`whenTextStartsWith`](#whentextstartswith) | Sets the conditional format rule to trigger when that the input starts with the given value | +| [`whenTextContains`](#whentextcontains) | Sets the conditional format rule to trigger when the input contains the given value | +| [`whenTextDoesNotContain`](#whentextdoesnotcontain) | Sets the conditional format rule to trigger when the input does not contain the given value | +| [`whenTextEndsWith`](#whentextendswith) | Sets the conditional format rule to trigger when the input ends with the given value | +| [`whenTextEqualTo`](#whentextequalto) | Sets the conditional format rule to trigger when the input is equal to the given value | +| [`whenTextStartsWith`](#whentextstartswith) | Sets the conditional format rule to trigger when the input starts with the given value | ## APIs @@ -82,6 +85,62 @@ fWorksheet.addConditionalFormattingRule(rule); Source: `@univerjs/sheets-conditional-formatting` +### `copy` + +Deep clone a current builder. + +**Signature** +```typescript +copy(): ConditionalFormatRuleBaseBuilder +``` + +**Returns** +- `ConditionalFormatRuleBaseBuilder` — A new builder with the same settings as the original. + +**Examples** +```ts +const fWorkbook = univerAPI.getActiveWorkbook(); +const fWorksheet = fWorkbook.getActiveSheet(); + +// Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10. +const fRange = fWorksheet.getRange('A1:D10'); +const builder = fWorksheet.newConditionalFormattingRule() + .whenCellEmpty() + .setBackground('#FF0000') + .setRanges([fRange.getRange()]); +fWorksheet.addConditionalFormattingRule(builder.build()); + +// Copy the rule and change the background color to green for the range A1:B2. +const newRange = fWorksheet.getRange('A1:B2'); +const newBuilder = builder.copy() + .setBackground('#00FF00') + .setRanges([newRange.getRange()]); +fWorksheet.addConditionalFormattingRule(newBuilder.build()); +``` + +Source: `@univerjs/sheets-conditional-formatting` + +### `createCfId` + +Create a conditional format ID. + +**Signature** +```typescript +createCfId(): string +``` + +**Returns** +- `string` — The conditional format ID. + +**Examples** +```ts +const fWorkbook = univerAPI.getActiveWorkbook(); +const fWorksheet = fWorkbook.getActiveSheet(); +console.log(fWorksheet.newConditionalFormattingRule().createCfId()); +``` + +Source: `@univerjs/sheets-conditional-formatting` + ### Getters & Queries ### `getIconMap` @@ -105,6 +164,31 @@ console.log(fWorksheet.newConditionalFormattingRule().getIconMap()); // icons ke Source: `@univerjs/sheets-conditional-formatting` +### `getRanges` + +Gets the scope of the current conditional format. + +**Signature** +```typescript +getRanges(): IRange[] +``` + +**Returns** +- `IRange[]` — The ranges to which the conditional format applies. + +**Examples** +```ts +const fWorkbook = univerAPI.getActiveWorkbook(); +const fWorksheet = fWorkbook.getActiveSheet(); +const fRange = fWorksheet.getRange('A1:D10'); +const builder = fWorksheet.newConditionalFormattingRule() + .whenCellEmpty() + .setRanges([fRange.getRange()]); +console.log(builder.getRanges()); // [{ startRow: 0, endRow: 9, startColumn: 0, endColumn: 3 }] +``` + +Source: `@univerjs/sheets-conditional-formatting` + ### Setters & Modifiers ### `setAverage` @@ -355,7 +439,7 @@ setIconSet(config: { iconConfigs: IIconSet['config']; isShowValue: boolean }): C ``` **Parameters** -- `config` `{ iconConfigs: IIconSet; isShowValue: boolean; }` — *No description* +- `config` `{ iconConfigs: IIconSet['config']; isShowValue: boolean; }` — *No description* **Returns** - `ConditionalFormatIconSetRuleBuilder` — The conditional format icon set rule builder. @@ -638,7 +722,7 @@ fWorksheet.addConditionalFormattingRule(rule); ### `whenFormulaSatisfied` -Sets the conditional format rule to trigger when that the given formula evaluates to `true`. +Sets the conditional format rule to trigger when the given formula evaluates to `true`. **Signature** ```typescript @@ -799,7 +883,7 @@ fWorksheet.addConditionalFormattingRule(rule); ### `whenNumberLessThan` -Sets the conditional conditional format rule to trigger when a number less than the given value. +Sets the conditional format rule to trigger when a number is less than the given value. **Signature** ```typescript @@ -831,7 +915,7 @@ fWorksheet.addConditionalFormattingRule(rule); ### `whenNumberLessThanOrEqualTo` -Sets the conditional format rule to trigger when a number less than or equal to the given value. +Sets the conditional format rule to trigger when a number is less than or equal to the given value. **Signature** ```typescript @@ -928,7 +1012,7 @@ fWorksheet.addConditionalFormattingRule(rule); ### `whenTextContains` -Sets the conditional format rule to trigger when that the input contains the given value. +Sets the conditional format rule to trigger when the input contains the given value. **Signature** ```typescript @@ -960,7 +1044,7 @@ fWorksheet.addConditionalFormattingRule(rule); ### `whenTextDoesNotContain` -Sets the conditional format rule to trigger when that the input does not contain the given value. +Sets the conditional format rule to trigger when the input does not contain the given value. **Signature** ```typescript @@ -992,7 +1076,7 @@ fWorksheet.addConditionalFormattingRule(rule); ### `whenTextEndsWith` -Sets the conditional format rule to trigger when that the input ends with the given value. +Sets the conditional format rule to trigger when the input ends with the given value. **Signature** ```typescript @@ -1024,7 +1108,7 @@ fWorksheet.addConditionalFormattingRule(rule); ### `whenTextEqualTo` -Sets the conditional format rule to trigger when that the input is equal to the given value. +Sets the conditional format rule to trigger when the input is equal to the given value. **Signature** ```typescript @@ -1056,7 +1140,7 @@ fWorksheet.addConditionalFormattingRule(rule); ### `whenTextStartsWith` -Sets the conditional format rule to trigger when that the input starts with the given value. +Sets the conditional format rule to trigger when the input starts with the given value. **Signature** ```typescript diff --git a/content/reference/facade/data-validation.mdx b/content/reference/facade/data-validation.mdx index eb14079f..8fd0cdfc 100644 --- a/content/reference/facade/data-validation.mdx +++ b/content/reference/facade/data-validation.mdx @@ -172,7 +172,7 @@ Gets the values used for criteria evaluation **Signature** ```typescript -getCriteriaValues(): [string | undefined, string | undefined, string | undefined] +getCriteriaValues(): [string, string, string] ``` **Returns** @@ -632,7 +632,7 @@ fRange.setDataValidation(rule); // Get the validation status of the range const status = await fRange.getValidatorStatus(); -console.log(status); // [['invalid', 'invalid', 'invalid', 'valid']] +console.log(status); // [['invalid', 'invalid'], ['invalid', 'valid']] ``` Source: `@univerjs/sheets-data-validation` @@ -672,7 +672,7 @@ fRange.setDataValidation(rule); // Get the validation status of the range const status = await fRange.getValidatorStatus(); -console.log(status); // [['valid', 'valid', 'invalid', 'invalid']] +console.log(status); // [['valid', 'valid'], ['invalid', 'invalid']] ``` Source: `@univerjs/sheets-data-validation` @@ -713,7 +713,7 @@ fRange.setDataValidation(rule); // Get the validation status of the range const status = await fRange.getValidatorStatus(); -console.log(status); // [['invalid', 'valid', 'valid', 'invalid']] +console.log(status); // [['invalid', 'valid'], ['valid', 'invalid']] ``` Source: `@univerjs/sheets-data-validation` @@ -798,7 +798,7 @@ fRange.setDataValidation(rule); // Get the validation status of the range const status = await fRange.getValidatorStatus(); -console.log(status); // [['valid', 'invalid', 'invalid', 'valid']] +console.log(status); // [['valid', 'invalid'], ['invalid', 'valid']] ``` Source: `@univerjs/sheets-data-validation` @@ -838,7 +838,7 @@ fRange.setDataValidation(rule); // Get the validation status of the range const status = await fRange.getValidatorStatus(); -console.log(status); // [['invalid', 'invalid', 'valid', 'valid']] +console.log(status); // [['invalid', 'invalid'], ['valid', 'valid']] ``` Source: `@univerjs/sheets-data-validation` @@ -878,7 +878,7 @@ fRange.setDataValidation(rule); // Get the validation status of the range const status = await fRange.getValidatorStatus(); -console.log(status); // [['valid', 'valid', 'valid', 'invalid']] +console.log(status); // [['valid', 'valid'], ['valid', 'invalid']] ``` Source: `@univerjs/sheets-data-validation` @@ -920,14 +920,14 @@ const rule = univerAPI.newDataValidation() .requireFormulaSatisfied('=A1>2') .setOptions({ showErrorMessage: true, - error: 'Please enter a value equal to A1' + error: 'Please enter a value greater than 2' }) .build(); fRange.setDataValidation(rule); // Get the validation status of the range const status = await fRange.getValidatorStatus(); -console.log(status); // [['valid', 'valid', 'invalid', 'invalid']] +console.log(status); // [['valid', 'valid'], ['invalid', 'invalid']] ``` Source: `@univerjs/sheets-data-validation` diff --git a/content/reference/facade/drawing.mdx b/content/reference/facade/drawing.mdx index 3f44715d..ae09c90a 100644 --- a/content/reference/facade/drawing.mdx +++ b/content/reference/facade/drawing.mdx @@ -16,7 +16,7 @@ icon: '#ref/F' | Method | Description | |--------|-------------| -| [`buildAsync`](#buildasync) | - | +| [`buildAsync`](#buildasync) | Asynchronously build the image and return the image data | | [`getId`](#getid) | Get the id of the image | | [`getSource`](#getsource) | Get the source of the image | | [`getSourceType`](#getsourcetype) | Get the source type of the image | @@ -36,14 +36,14 @@ icon: '#ref/F' | [`setFront`](#setfront) | Move the image layer to the top layer | | [`setHeight`](#setheight) | Set the height of the image | | [`setImage`](#setimage) | Set the initial image configuration for the image builder | -| [`setPositionAsync`](#setpositionasync) | - | +| [`setPositionAsync`](#setpositionasync) | Asynchronously set the position of the image | | [`setRotate`](#setrotate) | Set the rotation angle of the image | | [`setRow`](#setrow) | Set the vertical position of the image | | [`setRowOffset`](#setrowoffset) | Set the vertical offset of the image | | [`setSizeAsync`](#setsizeasync) | Set the size of the image | -| [`setSource`](#setsource) | - | -| [`setSubUnitId`](#setsubunitid) | - | -| [`setUnitId`](#setunitid) | - | +| [`setSource`](#setsource) | Set the source URL of the image | +| [`setSubUnitId`](#setsubunitid) | Set the sub-unit (worksheet) ID for the image | +| [`setUnitId`](#setunitid) | Set the unit (workbook) ID for the image | | [`setWidth`](#setwidth) | Set the width of the image | | [`toBuilder`](#tobuilder) | Convert the image to a FOverGridImageBuilder | diff --git a/content/reference/facade/filter.mdx b/content/reference/facade/filter.mdx index ad90ae1d..834d77f8 100644 --- a/content/reference/facade/filter.mdx +++ b/content/reference/facade/filter.mdx @@ -180,8 +180,8 @@ setColumnFilterCriteria(column: number, criteria: ISetSheetsFilterCriteriaComman ``` **Parameters** -- `column` `number` — *No description* -- `criteria` `ISetSheetsFilterCriteriaCommandParams` — *No description* +- `column` `number` — The column index (0-based) to set the filter criteria for. +- `criteria` `ISetSheetsFilterCriteriaCommandParams['criteria']` — The filter criteria to apply. **Returns** - `FFilter` — The FFilter instance for chaining. diff --git a/content/reference/facade/formula.mdx b/content/reference/facade/formula.mdx index 202c9a36..46c0f424 100644 --- a/content/reference/facade/formula.mdx +++ b/content/reference/facade/formula.mdx @@ -18,38 +18,33 @@ This interface class provides methods to modify the behavior of the operation fo | Method | Description | |--------|-------------| -| [`calculationEnd`](#calculationend) | Listening calculation ends | -| [`calculationProcessing`](#calculationprocessing) | Listening calculation processing | -| [`calculationStart`](#calculationstart) | Listening calculation starts | +| [`calculationEnd`](#calculationend) | Listen for calculation end events | +| [`calculationProcessing`](#calculationprocessing) | Listen for calculation processing events | +| [`calculationStart`](#calculationstart) | Listen for calculation start events | | [`executeCalculation`](#executecalculation) | Start the calculation of the formula | | [`executeFormulas`](#executeformulas) | Execute a batch of formulas asynchronously and receive computed results | -| [`getAllDependencyTrees`](#getalldependencytrees) | Retrieve all formula dependency trees that were produced during the latest -dependency-analysis run | +| [`getAllDependencyTrees`](#getalldependencytrees) | Retrieve all formula dependency trees produced during the latest dependency-analysis run | | [`getCellDependencyTree`](#getcelldependencytree) | Retrieve the dependency tree of a specific cell | | [`getFormulaExpressTree`](#getformulaexpresstree) | Parse a formula string and return its formula expression tree | -| [`getInRangeFormulas`](#getinrangeformulas) | Retrieve the dependency trees of all formulas *inside* the specified ranges | -| [`getRangeDependents`](#getrangedependents) | Retrieve the full dependency trees for all formulas that *depend on* the -specified ranges | -| [`getRangeDependentsAndInRangeFormulas`](#getrangedependentsandinrangeformulas) | Retrieve both: -1) the full dependency trees of all formulas that depend on the specified ranges, and -2) the dependency trees of all formulas that physically reside inside the specified ranges | +| [`getInRangeFormulas`](#getinrangeformulas) | Retrieve the dependency trees of all formulas inside the specified ranges | +| [`getRangeDependents`](#getrangedependents) | Retrieve the full dependency trees for all formulas that depend on the specified ranges | +| [`getRangeDependentsAndInRangeFormulas`](#getrangedependentsandinrangeformulas) | Retrieve both the dependency trees of formulas that depend on the specified ranges and those inside the ranges | | [`moveFormulaRefOffset`](#moveformularefoffset) | Offsets the formula | | [`onCalculationEnd`](#oncalculationend) | Waits for the formula calculation to complete | -| [`sequenceNodesBuilder`](#sequencenodesbuilder) | Resolves the formula string to a 'node' node | +| [`sequenceNodesBuilder`](#sequencenodesbuilder) | Resolves the formula string to a node tree | | [`setFormulaReturnDependencyTree`](#setformulareturndependencytree) | Enable or disable emitting formula dependency trees after each formula calculation | | [`setMaxIteration`](#setmaxiteration) | When a formula contains a circular reference, set the maximum number of iterations for the formula calculation | | [`stopCalculation`](#stopcalculation) | Stop the calculation of the formula | -| [`whenComputingCompleteAsync`](#whencomputingcompleteasync) | - | ### @univerjs/sheets-formula | Method | Description | |--------|-------------| -| [`calculationResultApplied`](#calculationresultapplied) | - | -| [`onCalculationResultApplied`](#oncalculationresultapplied) | - | -| [`registerAsyncFunction`](#registerasyncfunction) | - | -| [`registerFunction`](#registerfunction) | - | -| [`setInitialFormulaComputing`](#setinitialformulacomputing) | - | +| [`calculationResultApplied`](#calculationresultapplied) | Listens for the moment when formula-calculation results are applied | +| [`onCalculationResultApplied`](#oncalculationresultapplied) | Waits for formula-calculation results to be applied | +| [`registerAsyncFunction`](#registerasyncfunction) | Register a custom asynchronous formula function | +| [`registerFunction`](#registerfunction) | Register a custom synchronous formula function | +| [`setInitialFormulaComputing`](#setinitialformulacomputing) | Update the calculation mode of the formula | ## APIs @@ -67,7 +62,7 @@ getAllDependencyTrees(timeout = 30_000): Promise ``` **Parameters** -- `timeout` `number` *(optional)* — *No description* +- `timeout` `number` *(optional)* — The maximum time to wait for the result, in milliseconds. Default is `30_000`. **Returns** - `Promise` — A promise that resolves with the array of dependency trees. @@ -95,8 +90,8 @@ getCellDependencyTree(param: { unitId: string; sheetId: string; row: number; col ``` **Parameters** -- `param` `{ unitId: string; sheetId: string; row: number; column: number; }` — *No description* -- `timeout` `number` *(optional)* — *No description* +- `param` `{ unitId: string; sheetId: string; row: number; column: number; }` — The target cell coordinates and unit information. +- `timeout` `number` *(optional)* — The maximum time to wait for the result, in milliseconds. Default is `30_000`. **Returns** - `Promise` — A promise that resolves with the dependency tree or `undefined` @@ -142,8 +137,8 @@ getFormulaExpressTree(formulaString: string, unitId: string): IExprTreeNode | nu ``` **Parameters** -- `formulaString` `string` — *No description* -- `unitId` `string` — *No description* +- `formulaString` `string` — The formula string to parse (with or without leading `=`). +- `unitId` `string` — The ID of the workbook unit. **Returns** - `any` — A formula expression tree describing the hierarchical structure of the formula @@ -151,10 +146,11 @@ getFormulaExpressTree(formulaString: string, unitId: string): IExprTreeNode | nu **Examples** ```ts const formulaEngine = univerAPI.getFormula(); +const fWorkbook = univerAPI.getActiveWorkbook(); const formula = '=LET(x,SUM(A1,B1,A1:B10),y,OFFSET(A1:B10,0,1),SUM(x,y)+x)+1'; -const exprTree = formulaEngine.getFormulaExpressTree(formula); +const exprTree = formulaEngine.getFormulaExpressTree(formula, fWorkbook.getId()); console.log(exprTree); ``` @@ -209,8 +205,8 @@ getInRangeFormulas(unitRanges: IUnitRange[], timeout = 30_000): Promise` — A promise that resolves with an array of `IFormulaDependencyTreeJson` @@ -243,8 +239,8 @@ getRangeDependents(unitRanges: IUnitRange[], timeout = 30_000): Promise` — A promise that resolves with an array of `IFormulaDependencyTreeJson` @@ -283,8 +279,8 @@ getRangeDependentsAndInRangeFormulas(unitRanges: IUnitRange[], timeout = 30_000) ``` **Parameters** -- `unitRanges` `IUnitRange[]` — *No description* -- `timeout` `number` *(optional)* — *No description* +- `unitRanges` `IUnitRange[]` — The ranges to query for formula dependencies. +- `timeout` `number` *(optional)* — The maximum time to wait for the result, in milliseconds. Default is `30_000`. **Returns** - `Promise` — A promise that resolves with an object containing: @@ -333,7 +329,7 @@ setFormulaReturnDependencyTree(value: boolean): void ``` **Parameters** -- `value` `boolean` — *No description* +- `value` `boolean` — Whether to emit formula dependency trees after each formula calculation. **Examples** ```ts @@ -369,13 +365,15 @@ console.log('Dependency trees:', trees); ### `setInitialFormulaComputing` +Update the calculation mode of the formula. It will take effect the next time the Univer Sheet is constructed. The calculation mode only handles formulas data when the workbook initializes data. + **Signature** ```typescript setInitialFormulaComputing(calculationMode: CalculationMode): void ``` **Parameters** -- `calculationMode` `CalculationMode` — *No description* +- `calculationMode` `CalculationMode` — The calculation mode for formula initialization. See [`CalculationMode`](../../facade/formula#calculationmode) for details. Source: `@univerjs/sheets-formula` @@ -389,7 +387,7 @@ setMaxIteration(maxIteration: number): void ``` **Parameters** -- `maxIteration` `number` — *No description* +- `maxIteration` `number` — The maximum number of iterations for circular reference calculations. **Examples** ```ts @@ -405,7 +403,7 @@ formulaEngine.setMaxIteration(5); ### `moveFormulaRefOffset` -Offsets the formula +Offsets the formula references by the specified row and column offsets. **Signature** ```typescript @@ -413,10 +411,10 @@ moveFormulaRefOffset(formulaString: string, refOffsetX: number, refOffsetY: numb ``` **Parameters** -- `formulaString` `string` — *No description* -- `refOffsetX` `number` — *No description* -- `refOffsetY` `number` — *No description* -- `ignoreAbsolute` `boolean` *(optional)* — *No description* +- `formulaString` `string` — The formula string to offset. +- `refOffsetX` `number` — The number of columns to offset. +- `refOffsetY` `number` — The number of rows to offset. +- `ignoreAbsolute` `boolean` *(optional)* — Whether to ignore absolute references (e.g. `$A$1`). **Returns** - `string` — The offset formula string @@ -448,27 +446,31 @@ onCalculationEnd(): Promise ### `onCalculationResultApplied` +Waits for formula-calculation results to be applied. This method resolves when a real calculation runs and results are applied, or when no calculation starts within 500 ms. + **Signature** ```typescript onCalculationResultApplied(): Promise ``` **Returns** -- `Promise` — See signature above. +- `Promise` — A promise that resolves when calculation results are applied. Source: `@univerjs/sheets-formula` ### `registerAsyncFunction` +Register a custom asynchronous formula function. + **Signature** ```typescript registerAsyncFunction(name: string, func: IRegisterAsyncFunction, options?: string | { locales?: ILocales; description?: string | IFunctionInfo }): IDisposable ``` **Parameters** -- `name` `string` — *No description* -- `func` `IRegisterAsyncFunction` — *No description* -- `options` `string | { locales?: ILocales; description?: string | IFunctionInfo; }` *(optional)* — *No description* +- `name` `string` — The name of the function to register. This will be used in formulas (e.g., `=MYFUNC()`). +- `func` `IRegisterAsyncFunction` — The async implementation of the function. +- `options` `string | { locales?: ILocales; description?: string | IFunctionInfo; }` *(optional)* — A description string, or an object containing `locales` and `description`. **Returns** - `IDisposable` — See signature above. @@ -477,15 +479,17 @@ registerAsyncFunction(name: string, func: IRegisterAsyncFunction, options?: stri ### `registerFunction` +Register a custom synchronous formula function. + **Signature** ```typescript registerFunction(name: string, func: IRegisterFunction, options?: string | { locales?: ILocales; description?: string | IFunctionInfo }): IDisposable ``` **Parameters** -- `name` `string` — *No description* -- `func` `IRegisterFunction` — *No description* -- `options` `string | { locales?: ILocales; description?: string | IFunctionInfo; }` *(optional)* — *No description* +- `name` `string` — The name of the function to register. This will be used in formulas (e.g., `=MYFUNC()`). +- `func` `IRegisterFunction` — The implementation of the function. +- `options` `string | { locales?: ILocales; description?: string | IFunctionInfo; }` *(optional)* — A description string, or an object containing `locales` and `description`. **Returns** - `IDisposable` — See signature above. @@ -496,7 +500,7 @@ registerFunction(name: string, func: IRegisterFunction, options?: string | { loc ### `calculationEnd` -Listening calculation ends. +Listen for calculation end events. **Signature** ```typescript @@ -504,7 +508,7 @@ calculationEnd(callback: (functionsExecutedState: FormulaExecutedStateType) => v ``` **Parameters** -- `callback` `(functionsExecutedState: FormulaExecutedStateType) => void` — *No description* +- `callback` `(functionsExecutedState: FormulaExecutedStateType) => void` — A callback that receives the execution state when calculation ends. **Returns** - `IDisposable` — The disposable instance. @@ -521,7 +525,7 @@ formulaEngine.calculationEnd((functionsExecutedState) => { ### `calculationProcessing` -Listening calculation processing. +Listen for calculation processing events. **Signature** ```typescript @@ -529,7 +533,7 @@ calculationProcessing(callback: (stageInfo: IExecutionInProgressParams) => void) ``` **Parameters** -- `callback` `(stageInfo: IExecutionInProgressParams) => void` — *No description* +- `callback` `(stageInfo: IExecutionInProgressParams) => void` — A callback that receives the current calculation stage information. **Returns** - `IDisposable` — The disposable instance. @@ -546,22 +550,24 @@ formulaEngine.calculationProcessing((stageInfo) => { ### `calculationResultApplied` +Listens for the moment when formula-calculation results are applied. The callback is invoked during an idle frame after the engine completes a calculation cycle. + **Signature** ```typescript calculationResultApplied(callback: (result: ISetFormulaCalculationResultMutation) => void): IDisposable ``` **Parameters** -- `callback` `(result: ISetFormulaCalculationResultMutation) => void` — *No description* +- `callback` `(result: ISetFormulaCalculationResultMutation) => void` — A function called with the calculation result payload. **Returns** -- `IDisposable` — See signature above. +- `IDisposable` — A disposable used to unsubscribe from the event. Source: `@univerjs/sheets-formula` ### `calculationStart` -Listening calculation starts. +Listen for calculation start events. **Signature** ```typescript @@ -569,7 +575,7 @@ calculationStart(callback: (forceCalculation: boolean) => void): IDisposable ``` **Parameters** -- `callback` `(forceCalculation: boolean) => void` — *No description* +- `callback` `(forceCalculation: boolean) => void` — A callback that receives whether the calculation is forced. **Returns** - `IDisposable` — The disposable instance. @@ -631,8 +637,8 @@ executeFormulas(formulas: IFormulaStringMap, timeout = 30_000): Promise` — A promise that resolves with the computed value map mirroring @@ -676,7 +682,7 @@ console.log(result); ### `sequenceNodesBuilder` -Resolves the formula string to a 'node' node +Resolves the formula string to a sequence of nodes **Signature** ```typescript @@ -684,7 +690,7 @@ sequenceNodesBuilder(formulaString: string): (string | ISequenceNode)[] ``` **Parameters** -- `formulaString` `string` — *No description* +- `formulaString` `string` — The formula string to resolve into nodes. **Returns** - `any[]` — The nodes of the formula string @@ -715,19 +721,3 @@ formulaEngine.stopCalculation(); Source: `@univerjs/engine-formula` -### `whenComputingCompleteAsync` - -Deprecated — Use `onCalculationEnd` instead. - -**Signature** -```typescript -whenComputingCompleteAsync(timeout?: number): Promise -``` - -**Parameters** -- `timeout` `number` *(optional)* — *No description* - -**Returns** -- `Promise` — See signature above. - -Source: `@univerjs/engine-formula` diff --git a/content/reference/facade/range-permission.mdx b/content/reference/facade/range-permission.mdx index 9d6bf5af..85c2d56c 100644 --- a/content/reference/facade/range-permission.mdx +++ b/content/reference/facade/range-permission.mdx @@ -114,7 +114,7 @@ console.log(rule); ### `unprotect` -Cancel all protection rules that intersect with the current range. +Remove all protection rules that intersect with the current range. **Signature** ```typescript diff --git a/content/reference/facade/range-protection-rule.mdx b/content/reference/facade/range-protection-rule.mdx index b29aa4c2..a2657b3a 100644 --- a/content/reference/facade/range-protection-rule.mdx +++ b/content/reference/facade/range-protection-rule.mdx @@ -43,7 +43,7 @@ canDelete(): boolean ``` **Returns** -- `boolean` — true if can delete rule, false otherwise. +- `boolean` — true if the user can delete the rule, false otherwise. **Examples** ```ts @@ -95,7 +95,7 @@ canManageCollaborator(): boolean ``` **Returns** -- `boolean` — true if can manage collaborators, false otherwise. +- `boolean` — true if the user can manage collaborators, false otherwise. **Examples** ```ts @@ -230,7 +230,7 @@ const fWorkbook = univerAPI.getActiveWorkbook(); const fWorksheet = fWorkbook.getActiveSheet(); const fRange = fWorksheet.getRange('A1:B2'); // First, create a protection rule -const rule = await fRange.getRangePermission().protect({ name: 'My Range', allowEdit: true }); +const rule = await fRange.getRangePermission().protect({ name: 'My Range', allowViewByOthers: true }); // Then you can dynamically update permission points await rule.setPoint(univerAPI.Enum.RangePermissionPoint.Edit, false); // Now disable edit await rule.setPoint(univerAPI.Enum.RangePermissionPoint.View, true); // Ensure view is enabled diff --git a/content/reference/facade/range.mdx b/content/reference/facade/range.mdx index 05b0cc90..a70bbf81 100644 --- a/content/reference/facade/range.mdx +++ b/content/reference/facade/range.mdx @@ -109,13 +109,9 @@ to read contents or manipulate the range. | Method | Description | |--------|-------------| -| [`addConditionalFormattingRule`](#addconditionalformattingrule) | - | | [`clearConditionalFormatRules`](#clearconditionalformatrules) | - | | [`createConditionalFormattingRule`](#createconditionalformattingrule) | - | -| [`deleteConditionalFormattingRule`](#deleteconditionalformattingrule) | - | | [`getConditionalFormattingRules`](#getconditionalformattingrules) | - | -| [`moveConditionalFormattingRule`](#moveconditionalformattingrule) | - | -| [`setConditionalFormattingRule`](#setconditionalformattingrule) | - | ### @univerjs/sheets-data-validation @@ -151,11 +147,7 @@ to read contents or manipulate the range. | Method | Description | |--------|-------------| -| [`cancelHyperLink`](#cancelhyperlink) | - | -| [`getHyperLinks`](#gethyperlinks) | - | -| [`getUrl`](#geturl) | - | -| [`setHyperLink`](#sethyperlink) | - | -| [`updateHyperLink`](#updatehyperlink) | - | +| [`getUrl`](#geturl) | Generate a hyperlink URL for the current range | ### @univerjs/sheets-note @@ -169,10 +161,10 @@ to read contents or manipulate the range. | Method | Description | |--------|-------------| -| [`getNumberFormat`](#getnumberformat) | - | -| [`getNumberFormats`](#getnumberformats) | - | -| [`setNumberFormat`](#setnumberformat) | - | -| [`setNumberFormats`](#setnumberformats) | - | +| [`getNumberFormat`](#getnumberformat) | Returns the number format string of the top-left cell in the range | +| [`getNumberFormats`](#getnumberformats) | Returns the number format strings for the cells in the range | +| [`setNumberFormat`](#setnumberformat) | Sets the number format for the cells in the range | +| [`setNumberFormats`](#setnumberformats) | Sets different number formats for each cell in the range | ### @univerjs/sheets-sort @@ -1045,21 +1037,6 @@ fRange.setValues([ ### Style & Format -### `addConditionalFormattingRule` - -**Signature** -```typescript -addConditionalFormattingRule(rule: IConditionFormattingRule): FRange -``` - -**Parameters** -- `rule` `IConditionFormattingRule` — *No description* - -**Returns** -- `FRange` — See signature above. - -Source: `@univerjs/sheets-conditional-formatting` - ### `clearConditionalFormatRules` **Signature** @@ -1107,21 +1084,6 @@ createConditionalFormattingRule(): FConditionalFormattingBuilder Source: `@univerjs/sheets-conditional-formatting` -### `deleteConditionalFormattingRule` - -**Signature** -```typescript -deleteConditionalFormattingRule(cfId: string): FRange -``` - -**Parameters** -- `cfId` `string` — *No description* - -**Returns** -- `FRange` — See signature above. - -Source: `@univerjs/sheets-conditional-formatting` - ### `getBackground` Returns the background color of the top-left cell in the range. @@ -1280,25 +1242,47 @@ console.log(fRange.getFontSize()); ### `getNumberFormat` +Returns the number format string of the top-left cell in the range. + **Signature** ```typescript getNumberFormat(): string ``` **Returns** -- `string` — See signature above. +- `string` — The number format pattern (e.g. `'0.00%'`, `'yyyy-mm-dd'`). + +**Examples** +```ts +const fWorkbook = univerAPI.getActiveWorkbook(); +const fWorksheet = fWorkbook.getActiveSheet(); +const fRange = fWorksheet.getRange('A1'); +fRange.setNumberFormat('0.00%'); +console.log(fRange.getNumberFormat()); // 0.00% +``` Source: `@univerjs/sheets-numfmt` ### `getNumberFormats` +Returns the number format strings for the cells in the range. + **Signature** ```typescript getNumberFormats(): string[][] ``` **Returns** -- `string[][]` — See signature above. +- `string[][]` — A two-dimensional array of number format patterns. + +**Examples** +```ts +const fWorkbook = univerAPI.getActiveWorkbook(); +const fWorksheet = fWorkbook.getActiveSheet(); +const fRange = fWorksheet.getRange('A1:B2'); +const formats = fRange.getNumberFormats(); +console.log(formats); +``` Source: `@univerjs/sheets-numfmt` @@ -1356,23 +1340,6 @@ console.log(fRange.getUsedThemeStyle()); // 'default' Source: `@univerjs/sheets` -### `moveConditionalFormattingRule` - -**Signature** -```typescript -moveConditionalFormattingRule(cfId: string, toCfId: string, type: IAnchor['type'] = 'after'): FRange -``` - -**Parameters** -- `cfId` `string` — *No description* -- `toCfId` `string` — *No description* -- `type` `IAnchor` *(optional)* — *No description* - -**Returns** -- `FRange` — See signature above. - -Source: `@univerjs/sheets-conditional-formatting` - ### `removeThemeStyle` Remove the theme style for the range. @@ -1472,22 +1439,6 @@ fRange.setBorder(univerAPI.Enum.BorderType.ALL, univerAPI.Enum.BorderStyleTypes. Source: `@univerjs/sheets` -### `setConditionalFormattingRule` - -**Signature** -```typescript -setConditionalFormattingRule(cfId: string, rule: IConditionFormattingRule): FRange -``` - -**Parameters** -- `cfId` `string` — *No description* -- `rule` `IConditionFormattingRule` — *No description* - -**Returns** -- `FRange` — See signature above. - -Source: `@univerjs/sheets-conditional-formatting` - ### `setFontColor` Sets the font color in CSS notation (such as '#ffffff' or 'white'). @@ -1640,31 +1591,54 @@ fRange.setFontWeight('bold'); ### `setNumberFormat` +Sets the number format for the cells in the range. + **Signature** ```typescript setNumberFormat(pattern: string): FRange ``` **Parameters** -- `pattern` `string` — *No description* +- `pattern` `string` — The number format pattern (e.g. `'0.00'`, `'yyyy-mm-dd'`, `'$#,##0.00'`). **Returns** -- `FRange` — See signature above. +- `FRange` — This range, for chaining. + +**Examples** +```ts +const fWorkbook = univerAPI.getActiveWorkbook(); +const fWorksheet = fWorkbook.getActiveSheet(); +const fRange = fWorksheet.getRange('A1:B2'); +fRange.setNumberFormat('0.00%'); +``` Source: `@univerjs/sheets-numfmt` ### `setNumberFormats` +Sets different number formats for each cell in the range. The size of the `patterns` array must match the dimensions of the range. + **Signature** ```typescript setNumberFormats(patterns: string[][]): FRange ``` **Parameters** -- `patterns` `string[][]` — *No description* +- `patterns` `string[][]` — A two-dimensional array of number format patterns. **Returns** -- `FRange` — See signature above. +- `FRange` — This range, for chaining. + +**Examples** +```ts +const fWorkbook = univerAPI.getActiveWorkbook(); +const fWorksheet = fWorkbook.getActiveSheet(); +const fRange = fWorksheet.getRange('A1:B2'); +fRange.setNumberFormats([ + ['0.00', '$#,##0.00'], + ['yyyy-mm-dd', '0.00%'], +]); +``` Source: `@univerjs/sheets-numfmt` @@ -2500,21 +2474,6 @@ await fRange.autoFill(fWorksheet.getRange('A1:A20'), 'SERIES') Source: `@univerjs/sheets` -### `cancelHyperLink` - -**Signature** -```typescript -cancelHyperLink(id: string): boolean -``` - -**Parameters** -- `id` `string` — *No description* - -**Returns** -- `boolean` — See signature above. - -Source: `@univerjs/sheets-hyper-link` - ### `createFilter` **Signature** @@ -2707,18 +2666,6 @@ console.log(fRange.getHorizontalAlignments()); Source: `@univerjs/sheets` -### `getHyperLinks` - -**Signature** -```typescript -getHyperLinks(): ICellHyperLink[] -``` - -**Returns** -- `ICellHyperLink[]` — See signature above. - -Source: `@univerjs/sheets-hyper-link` - ### `getNote` **Signature** @@ -2775,7 +2722,7 @@ const fRange = fWorksheet.getRange('A1:B10'); const permission = fRange.getRangePermission(); // Protect the range -await permission.protect({ name: 'Protected Area', allowEdit: false }); +await permission.protect({ name: 'Protected Area', allowViewByOthers: false }); // Check if range is protected const isProtected = permission.isProtected(); @@ -2892,13 +2839,23 @@ console.log(fRange.getUnitId()); ### `getUrl` +Generate a hyperlink URL for the current range. The returned URL can be used to navigate to this range within the workbook. + **Signature** ```typescript getUrl(): string ``` **Returns** -- `string` — See signature above. +- `string` — The generated URL string (e.g. `#gid=sheet1&range=A1:B2`). + +**Examples** +```ts +const fWorkbook = univerAPI.getActiveWorkbook(); +const fWorksheet = fWorkbook.getActiveSheet(); +const fRange = fWorksheet.getRange('A1:B2'); +console.log(fRange.getUrl()); // #gid=...&range=A1:B2 +``` Source: `@univerjs/sheets-hyper-link` @@ -3220,22 +3177,6 @@ fRange.setHorizontalAlignment('left'); Source: `@univerjs/sheets` -### `setHyperLink` - -**Signature** -```typescript -setHyperLink(url: string, label?: string): Promise -``` - -**Parameters** -- `url` `string` — *No description* -- `label` `string` *(optional)* — *No description* - -**Returns** -- `Promise` — See signature above. - -Source: `@univerjs/sheets-hyper-link` - ### `setTextRotation` Set rotation for text in current range. @@ -3369,19 +3310,3 @@ sort(column: SortColumnSpec | SortColumnSpec[]): FRange Source: `@univerjs/sheets-sort` -### `updateHyperLink` - -**Signature** -```typescript -updateHyperLink(id: string, url: string, label?: string): Promise -``` - -**Parameters** -- `id` `string` — *No description* -- `url` `string` — *No description* -- `label` `string` *(optional)* — *No description* - -**Returns** -- `Promise` — See signature above. - -Source: `@univerjs/sheets-hyper-link` diff --git a/content/reference/facade/shape.mdx b/content/reference/facade/shape.mdx index f6f2f77d..2256ce80 100644 --- a/content/reference/facade/shape.mdx +++ b/content/reference/facade/shape.mdx @@ -30,7 +30,7 @@ such as start/end arrow types and sizes. Use `fWorksheet.newConnector()` to crea | [`getSize`](#getsize) | Returns the size of this shape in pixels | | [`getStartConnectInfo`](#getstartconnectinfo) | Returns the start connection info for this connector shape | | [`height`](#height) | - | -| [`isLineShape`](#islineshape) | Returns whether this shape is a line/connector shape (e | +| [`isLineShape`](#islineshape) | Returns whether this shape is a line/connector shape | | [`setAbsolutePosition`](#setabsoluteposition) | Sets the position by absolute pixel coordinates | | [`setEndArrowSize`](#setendarrowsize) | Sets the end arrow size of the connector line | | [`setEndArrowType`](#setendarrowtype) | Sets the end arrow type of the connector line | @@ -1029,7 +1029,7 @@ shapeData: ICxnShapeData **Signature** ```typescript -shapeType: any +shapeType: ShapeTypeEnum | undefined ``` **Returns** diff --git a/content/reference/facade/thread-comment.mdx b/content/reference/facade/thread-comment.mdx index e5f55211..e59533bf 100644 --- a/content/reference/facade/thread-comment.mdx +++ b/content/reference/facade/thread-comment.mdx @@ -20,7 +20,7 @@ A class that represents a thread comment already in the sheet. | [`copy`](#copy) | Copy the comment | | [`create`](#create) | Create a new FTheadCommentItem | | [`delete`](#delete) | - | -| [`deleteAsync`](#deleteasync) | Delete the comment and it's replies | +| [`deleteAsync`](#deleteasync) | Delete the comment and its replies | | [`getCommentData`](#getcommentdata) | Get the comment data | | [`getContent`](#getcontent) | - | | [`getIsRoot`](#getisroot) | Whether the comment is a root comment | @@ -120,7 +120,7 @@ comments.forEach((comment) => { ### `getContent` -Deprecated — use `getRichText` as instead +Deprecated — use `getRichText` instead **Signature** ```typescript @@ -166,7 +166,7 @@ getRange(): FRange | null ``` **Returns** -- `any` — The range of the comment +- `FRange | null` — The range of the comment **Examples** ```ts @@ -174,7 +174,10 @@ const fWorkbook = univerAPI.getActiveWorkbook(); const fWorksheet = fWorkbook.getActiveSheet(); const comments = fWorksheet.getComments(); comments.forEach((comment) => { - console.log(comment.getRange().getA1Notation()); + const range = comment.getRange(); + if (range) { + console.log(range.getA1Notation()); + } }); ``` @@ -200,7 +203,7 @@ const comments = fWorksheet.getComments(); comments.forEach((comment) => { if (comment.getIsRoot()) { const replies = comment.getReplies(); - replies.forEach((reply) => { + replies?.forEach((reply) => { console.log(reply.getCommentData()); }); } @@ -406,7 +409,7 @@ console.log(result); ### `update` -Deprecated — use `updateAsync` as instead +Deprecated — use `updateAsync` instead **Signature** ```typescript @@ -485,7 +488,7 @@ console.log(newCommentBuilder); ### `delete` -Deprecated — use `deleteAsync` as instead. +Deprecated — use `deleteAsync` instead. **Signature** ```typescript @@ -499,7 +502,7 @@ delete(): Promise ### `deleteAsync` -Delete the comment and it's replies +Delete the comment and its replies **Signature** ```typescript @@ -564,7 +567,7 @@ console.log(result); ### `resolve` -Deprecated — use `resolveAsync` as instead +Deprecated — use `resolveAsync` instead **Signature** ```typescript diff --git a/content/reference/facade/workbook.mdx b/content/reference/facade/workbook.mdx index 758e340f..e95a7cde 100644 --- a/content/reference/facade/workbook.mdx +++ b/content/reference/facade/workbook.mdx @@ -89,25 +89,26 @@ Facade API object bounded to a workbook. It provides a set of methods to interac | Method | Description | |--------|-------------| -| [`getAllFormulaError`](#getallformulaerror) | - | +| [`getAllFormulaError`](#getallformulaerror) | Get all formula errors in the workbook | ### @univerjs/sheets-hyper-link | Method | Description | |--------|-------------| +| [`getAllHyperLinks`](#getallhyperlinks) | Get all hyperlinks in the workbook | | [`parseSheetHyperlink`](#parsesheethyperlink) | Parse the hyperlink string to get the hyperlink info | ### @univerjs/sheets-hyper-link-ui | Method | Description | |--------|-------------| -| [`navigateToSheetHyperlink`](#navigatetosheethyperlink) | - | +| [`navigateToSheetHyperlink`](#navigatetosheethyperlink) | Navigate to the specified hyperlink | ### @univerjs/sheets-numfmt | Method | Description | |--------|-------------| -| [`setNumfmtLocal`](#setnumfmtlocal) | - | +| [`setNumfmtLocal`](#setnumfmtlocal) | Set the locale for number format display | ### @univerjs/sheets-table @@ -1153,13 +1154,15 @@ async getAllDataValidationErrorAsync(): Promise ### `getAllFormulaError` +Get all formula errors in the workbook. + **Signature** ```typescript getAllFormulaError(): ISheetFormulaError[] ``` **Returns** -- `ISheetFormulaError[]` — See signature above. +- `ISheetFormulaError[]` — Array of formula errors. Source: `@univerjs/sheets-formula` @@ -1478,13 +1481,21 @@ fWorkbook.moveSheet(sheet, 1); ### `navigateToSheetHyperlink` +Navigate to the specified hyperlink within the workbook. + **Signature** ```typescript navigateToSheetHyperlink(hyperlink: string): void ``` **Parameters** -- `hyperlink` `string` — *No description* +- `hyperlink` `string` — The hyperlink string to navigate to. + +**Examples** +```ts +const fWorkbook = univerAPI.getActiveWorkbook(); +fWorkbook.navigateToSheetHyperlink('#gid=sheet1&range=A1'); +``` Source: `@univerjs/sheets-hyper-link-ui` @@ -1881,10 +1892,36 @@ parseSheetHyperlink(hyperlink: string): ISheetHyperLinkInfo ``` **Parameters** -- `hyperlink` `string` — *No description* +- `hyperlink` `string` — The hyperlink string to parse. + +**Returns** +- `ISheetHyperLinkInfo` — The parsed hyperlink info, including type, name, URL, and search parameters. + +**Examples** +```ts +const fWorkbook = univerAPI.getActiveWorkbook(); +const info = fWorkbook.parseSheetHyperlink('#gid=sheet1&range=A1'); +console.log(info); +``` + +### `getAllHyperLinks` + +Get all hyperlinks in the workbook. + +**Signature** +```typescript +getAllHyperLinks(): ISheetHyperLink[] +``` **Returns** -- `ISheetHyperLinkInfo` — the hyperlink info +- `ISheetHyperLink[]` — An array of all hyperlinks in the workbook, including their position and payload. + +**Examples** +```ts +const fWorkbook = univerAPI.getActiveWorkbook(); +const links = fWorkbook.getAllHyperLinks(); +console.log(links); +``` Source: `@univerjs/sheets-hyper-link` @@ -2096,16 +2133,24 @@ setLocale(locale: LocaleType): void ### `setNumfmtLocal` +Set the locale for number format display. This affects how numbers, dates, and currencies are formatted in the workbook. + **Signature** ```typescript setNumfmtLocal(locale: INumfmtLocaleTag): FWorkbook ``` **Parameters** -- `locale` `INumfmtLocaleTag` — *No description* +- `locale` `INumfmtLocaleTag` — The locale tag to use (e.g. `'en_US'`, `'zh_CN'`, `'de_DE'`). **Returns** -- `FWorkbook` — See signature above. +- `FWorkbook` — The current workbook instance, for chaining. + +**Examples** +```ts +const fWorkbook = univerAPI.getActiveWorkbook(); +fWorkbook.setNumfmtLocal('de_DE'); +``` Source: `@univerjs/sheets-numfmt` diff --git a/content/reference/facade/worksheet-permission.mdx b/content/reference/facade/worksheet-permission.mdx index 6abd9e53..6a9d4b93 100644 --- a/content/reference/facade/worksheet-permission.mdx +++ b/content/reference/facade/worksheet-permission.mdx @@ -297,8 +297,8 @@ await fWorksheet.getWorksheetPermission().setEditable(); ### `setMode` -Set permission mode for the worksheet. -Automatically creates worksheet protection if not already protected. +Set the permission mode for the worksheet. +Creates worksheet protection automatically if it is not already protected. **Signature** ```typescript @@ -323,7 +323,7 @@ await fWorksheet.getWorksheetPermission().setMode('readOnly'); ### `setPoint` Set a specific permission point for the worksheet. -Automatically creates worksheet protection if not already protected. +Creates worksheet protection automatically if it is not already protected. **Signature** ```typescript @@ -400,8 +400,8 @@ console.log(debugInfo); ### `protect` -Create worksheet protection with collaborators support. -This must be called before setting permission points for collaboration to work. +Create worksheet protection with collaborator support. +This must be called before setting permission points in a collaborative scenario. **Signature** ```typescript diff --git a/content/reference/facade/worksheet.mdx b/content/reference/facade/worksheet.mdx index 7da57667..0909db65 100644 --- a/content/reference/facade/worksheet.mdx +++ b/content/reference/facade/worksheet.mdx @@ -130,7 +130,6 @@ A Facade API object bounded to a worksheet. It provides a set of methods to inte |--------|-------------| | [`addConditionalFormattingRule`](#addconditionalformattingrule) | - | | [`clearConditionalFormatRules`](#clearconditionalformatrules) | - | -| [`createConditionalFormattingRule`](#createconditionalformattingrule) | - | | [`deleteConditionalFormattingRule`](#deleteconditionalformattingrule) | - | | [`getConditionalFormattingRules`](#getconditionalformattingrules) | - | | [`moveConditionalFormattingRule`](#moveconditionalformattingrule) | - | @@ -184,7 +183,7 @@ A Facade API object bounded to a worksheet. It provides a set of methods to inte | Method | Description | |--------|-------------| -| [`getUrl`](#geturl) | - | +| [`getUrl`](#geturl) | Generate a hyperlink URL for the current worksheet | ### @univerjs/sheets-note @@ -2815,18 +2814,6 @@ composeSparkline(ranges: IRange[]): void Source: `@univerjs-pro/sheets-sparkline` -### `createConditionalFormattingRule` - -**Signature** -```typescript -createConditionalFormattingRule(): FConditionalFormattingBuilder -``` - -**Returns** -- `FConditionalFormattingBuilder` — See signature above. - -Source: `@univerjs/sheets-conditional-formatting` - ### `deleteConditionalFormattingRule` **Signature** @@ -3456,13 +3443,22 @@ getTableByCell(row: number, column: number): ITableInfoWithUnitId | undefined ### `getUrl` +Generate a hyperlink URL for the current worksheet. + **Signature** ```typescript getUrl(): string ``` **Returns** -- `string` — See signature above. +- `string` — The generated URL string (e.g. `#gid=sheet1`). + +**Examples** +```ts +const fWorkbook = univerAPI.getActiveWorkbook(); +const fWorksheet = fWorkbook.getActiveSheet(); +console.log(fWorksheet.getUrl()); // #gid=... +``` Source: `@univerjs/sheets-hyper-link` @@ -3563,8 +3559,8 @@ const canEdit = permission.canEditCell(0, 0); const range1 = fWorksheet.getRange('A1:B10'); const range2 = fWorksheet.getRange('D1:E10'); await permission.protectRanges([ - { ranges: [range1], options: { name: 'Range 1', allowEdit: false } }, - { ranges: [range2], options: { name: 'Range 2', allowEdit: false } } + { ranges: [range1], options: { name: 'Range 1', allowViewByOthers: false } }, + { ranges: [range2], options: { name: 'Range 2', allowViewByOthers: false } } ]); // Subscribe to permission changes diff --git a/content/reference/packages/plugins/univerjs/sheets-hyper-link-ui.mdx b/content/reference/packages/plugins/univerjs/sheets-hyper-link-ui.mdx index 5dad2b63..d5dc394d 100644 --- a/content/reference/packages/plugins/univerjs/sheets-hyper-link-ui.mdx +++ b/content/reference/packages/plugins/univerjs/sheets-hyper-link-ui.mdx @@ -8,7 +8,9 @@ icon: '#ref/P' // [!code word:IUniverSheetsHyperLinkUIConfig] import { UniverSheetsHyperLinkUIPlugin } from '@univerjs/sheets-hyper-link-ui' -univer.registerPlugin(UniverSheetsHyperLinkUIPlugin, IUniverSheetsHyperLinkUIConfig) +univer.registerPlugin(UniverSheetsHyperLinkUIPlugin, { + // configuration options +}) ``` ## IUniverSheetsHyperLinkUIConfig @@ -19,3 +21,10 @@ univer.registerPlugin(UniverSheetsHyperLinkUIPlugin, IUniverSheetsHyperLinkUICon export { IUniverSheetsHyperLinkUIConfig } from '@univerjs/sheets-hyper-link-ui' `} /> + +### Key Configuration Options + +| Property | Type | Description | +| --- | --- | --- | +| `menu` | `MenuConfig` | Custom menu configuration for the hyperlink UI plugin. | +| `urlHandler` | `IUrlHandler` | Customize how external links are opened. For example: `{ navigateToOtherWebsite: (url) => window.open(url, '_blank') }`. | diff --git a/content/reference/packages/plugins/univerjs/sheets-hyper-link.mdx b/content/reference/packages/plugins/univerjs/sheets-hyper-link.mdx index 448783ad..934777b5 100644 --- a/content/reference/packages/plugins/univerjs/sheets-hyper-link.mdx +++ b/content/reference/packages/plugins/univerjs/sheets-hyper-link.mdx @@ -9,3 +9,7 @@ import { UniverSheetsHyperLinkPlugin } from '@univerjs/sheets-hyper-link' univer.registerPlugin(UniverSheetsHyperLinkPlugin) ``` + +This plugin provides the core hyperlink functionality for Univer Sheets, including hyperlink parsing, navigation, and cell-level hyperlink operations through the Facade API. + +For hyperlink UI features (such as editing hyperlinks in the interface), you also need to register [`@univerjs/sheets-hyper-link-ui`](./sheets-hyper-link-ui). diff --git a/content/reference/packages/plugins/univerjs/sheets-numfmt-ui.mdx b/content/reference/packages/plugins/univerjs/sheets-numfmt-ui.mdx index ed48453c..e7d8d8c6 100644 --- a/content/reference/packages/plugins/univerjs/sheets-numfmt-ui.mdx +++ b/content/reference/packages/plugins/univerjs/sheets-numfmt-ui.mdx @@ -8,7 +8,9 @@ icon: '#ref/P' // [!code word:IUniverSheetsNumfmtUIConfig] import { UniverSheetsNumfmtUIPlugin } from '@univerjs/sheets-numfmt-ui' -univer.registerPlugin(UniverSheetsNumfmtUIPlugin, IUniverSheetsNumfmtUIConfig) +univer.registerPlugin(UniverSheetsNumfmtUIPlugin, { + // configuration options +}) ``` ## IUniverSheetsNumfmtUIConfig @@ -19,3 +21,9 @@ univer.registerPlugin(UniverSheetsNumfmtUIPlugin, IUniverSheetsNumfmtUIConfig) export { IUniverSheetsNumfmtUIConfig } from '@univerjs/sheets-numfmt-ui' `} /> + +### Key Configuration Options + +| Property | Type | Description | +| --- | --- | --- | +| `menu` | `MenuConfig` | Custom menu configuration for the number format UI plugin. | diff --git a/content/reference/packages/plugins/univerjs/sheets-numfmt.mdx b/content/reference/packages/plugins/univerjs/sheets-numfmt.mdx index c5b85ce3..e21dd19a 100644 --- a/content/reference/packages/plugins/univerjs/sheets-numfmt.mdx +++ b/content/reference/packages/plugins/univerjs/sheets-numfmt.mdx @@ -8,7 +8,9 @@ icon: '#ref/P' // [!code word:IUniverSheetsNumfmtConfig] import { UniverSheetsNumfmtPlugin } from '@univerjs/sheets-numfmt' -univer.registerPlugin(UniverSheetsNumfmtPlugin, IUniverSheetsNumfmtConfig) +univer.registerPlugin(UniverSheetsNumfmtPlugin, { + // configuration options +}) ``` ## IUniverSheetsNumfmtConfig @@ -19,3 +21,10 @@ univer.registerPlugin(UniverSheetsNumfmtPlugin, IUniverSheetsNumfmtConfig) export { IUniverSheetsNumfmtConfig } from '@univerjs/sheets-numfmt' `} /> + +### Key Configuration Options + +| Property | Type | Description | +| --- | --- | --- | +| `disableTextFormatAlert` | `boolean` | Whether to disable the text format alert when a number is stored as text. | +| `disableTextFormatMark` | `boolean` | Whether to disable the green mark indicator for cells with numbers stored as text. | diff --git a/content/reference/packages/presets/univerjs/preset-sheets-hyper-link.mdx b/content/reference/packages/presets/univerjs/preset-sheets-hyper-link.mdx index d8fc6200..9b6dc81c 100644 --- a/content/reference/packages/presets/univerjs/preset-sheets-hyper-link.mdx +++ b/content/reference/packages/presets/univerjs/preset-sheets-hyper-link.mdx @@ -9,10 +9,10 @@ import { UniverSheetsHyperLinkPreset } from '@univerjs/preset-sheets-hyper-link' createUniver({ presets: [ // [!code word:UniverSheetsHyperLinkPreset:1] - UniverSheetsHyperLinkPreset( + UniverSheetsHyperLinkPreset({ // [!code word:IUniverSheetsHyperLinkPresetConfig] - IUniverSheetsHyperLinkPresetConfig, - ), + // configuration options + }), ], }) ``` diff --git a/examples/univer-angular/README.md b/examples/univer-angular/README.md index b9aaeda6..fa76d3c0 100644 --- a/examples/univer-angular/README.md +++ b/examples/univer-angular/README.md @@ -1,41 +1,43 @@ -# UniverAngular +# Univer Angular Example -This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.1.2. +This example demonstrates how to integrate Univer Sheets into an Angular application. -## Development server +## Prerequisites -To start a local development server, run: +- Node.js >= 18 +- npm / pnpm / yarn +- Angular CLI -```bash -ng serve -``` - -Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files. +## Getting Started -## Code scaffolding - -Angular CLI includes powerful code scaffolding tools. To generate a new component, run: +Install dependencies: ```bash -ng generate component component-name +npm install ``` -For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run: +Start the development server: ```bash -ng generate --help +ng serve ``` -## Building +The application will be available at `http://localhost:4200` by default. -To build the project run: +## Project Structure -```bash -ng build -``` +| File | Description | +| ------------------ | -------------------------------------------- | +| `src/main.ts` | Application bootstrap entry point | +| `src/app/app.ts` | Root component with Univer integration logic | +| `src/app/app.html` | Root component template | -This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed. +## Key Integration Points -## Additional Resources +- Uses `@univerjs/preset-sheets-core` via the preset mode for quick setup. +- The `App` component creates a Univer instance in `ngOnInit` using a `ViewChild` reference to the container element. +- Disposes the Univer instance in `ngOnDestroy` to avoid memory leaks. +- Remember to import the preset CSS file: `@univerjs/preset-sheets-core/lib/index.css`. +- Call `univerAPI.createWorkbook({})` to initialize an empty workbook. -For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page. +For more details, see the [Univer Sheets Quickstart](https://docs.univer.ai/guides/sheets/getting-started/quickstart) documentation. diff --git a/examples/univer-astro/README.md b/examples/univer-astro/README.md index 692b11c9..27cfefe3 100644 --- a/examples/univer-astro/README.md +++ b/examples/univer-astro/README.md @@ -1,43 +1,40 @@ -# Astro Starter Kit: Minimal +# Univer Astro Example -```sh -pnpm create astro@latest -- --template minimal -``` +This example demonstrates how to integrate Univer Sheets into an Astro application. + +## Prerequisites -> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! +- Node.js >= 18 +- npm / pnpm / yarn -## 🚀 Project Structure +## Getting Started -Inside of your Astro project, you'll see the following folders and files: +Install dependencies: -```text -/ -├── public/ -├── src/ -│ └── pages/ -│ └── index.astro -└── package.json +```bash +npm install ``` -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. +Start the development server: -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. +```bash +npm run dev +``` -Any static assets, like images, can be placed in the `public/` directory. +The application will be available at `http://localhost:4321` by default. -## 🧞 Commands +## Project Structure -All commands are run from the root of the project, from a terminal: +| File | Description | +| ----------------------- | ----------------------------------------- | +| `src/pages/index.astro` | Index page with inline Univer integration | -| Command | Action | -| :--------------------- | :----------------------------------------------- | -| `pnpm install` | Installs dependencies | -| `pnpm dev` | Starts local dev server at `localhost:4321` | -| `pnpm build` | Build your production site to `./dist/` | -| `pnpm preview` | Preview your build locally, before deploying | -| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` | -| `pnpm astro -- --help` | Get help using the Astro CLI | +## Key Integration Points -## 👀 Want to learn more? +- Uses `@univerjs/preset-sheets-core` via the preset mode for quick setup. +- Univer is initialized directly in an inline `