diff --git a/content/guides/sheets/features/charts.ja-JP.mdx b/content/guides/sheets/features/charts.ja-JP.mdx index d99eff2..67da9d0 100644 --- a/content/guides/sheets/features/charts.ja-JP.mdx +++ b/content/guides/sheets/features/charts.ja-JP.mdx @@ -148,7 +148,7 @@ Univer Sheets は以下のチャート種類をサポートしています: ## Facade API -完全な Facade API の型定義は [FacadeAPI](https://reference.univer.ai/en-US) を参照してください。 +完全な Facade API の型定義は [FacadeAPI](/reference/facade/univer) を参照してください。 ### インポート @@ -162,9 +162,9 @@ import '@univerjs-pro/sheets-chart/facade' ### チャートの挿入 -[`FWorksheet.newChart()`](https://docs.univer.ai/reference/facade/worksheet#newchart) メソッドはチャート ビルダーを作成し、`FChartBuilderBase` のインスタンスを返します。メソッド チェーンでチャートの各種プロパティを設定できます。 +`FWorksheet.newChart()` メソッドはチャート ビルダーを作成し、`FChartBuilderBase` のインスタンスを返します。メソッド チェーンでチャートの各種プロパティを設定できます。 -その後、`build()` を呼び出して `IChartBuilderInfo` オブジェクトを生成し、[`FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#insertchart) メソッドでワークシートにチャートを挿入します。 +その後、`build()` を呼び出して `IChartBuilderInfo` オブジェクトを生成し、`FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)` メソッドでワークシートにチャートを挿入します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -183,7 +183,7 @@ const chartInfo = fWorksheet.newChart() await fWorksheet.insertChart(chartInfo) ``` -[`FChartBuilderBase`](https://docs.univer.ai/reference/facade/chart) の主なメンバー メソッドは次のとおりです。 +`FChartBuilderBase` の主なメンバー メソッドは次のとおりです。 | メソッド | 説明 | | ------ | ----------- | @@ -436,7 +436,7 @@ const chartBuilder = fWorkSheet.newChart() .setChartType(univerAPI.Enum.ChartType.Column) ``` -- [LineChartBuilder](https://docs.univer.ai/reference/facade/chart) +- `LineChartBuilder` | メソッド | 説明 | | ------ | ----------- | @@ -446,7 +446,7 @@ const chartBuilder = fWorkSheet.newChart() | setDataPointSize | データ点のサイズを設定 | | build | チャート挿入/更新用のビルダー情報を生成 | -- [PieChartBuilder](https://docs.univer.ai/reference/facade/chart) +- `PieChartBuilder` | メソッド | 説明 | | ------ | ----------- | @@ -458,7 +458,7 @@ const chartBuilder = fWorkSheet.newChart() | setShowLabelLine | ラベル ラインを表示 | | build | チャート挿入/更新用のビルダー情報を生成 | -- [RadarChartBuilder](https://docs.univer.ai/reference/facade/chart) +- `RadarChartBuilder` | メソッド | 説明 | | ------ | ----------- | @@ -468,7 +468,7 @@ const chartBuilder = fWorkSheet.newChart() ### チャートの取得 -[`FWorksheet.getCharts()`](https://docs.univer.ai/reference/facade/worksheet#getcharts) メソッドは、現在のワークシートにあるすべてのチャートを取得し、`FChart` オブジェクトの配列を返します。 +`FWorksheet.getCharts()` メソッドは、現在のワークシートにあるすべてのチャートを取得し、`FChart` オブジェクトの配列を返します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -478,7 +478,7 @@ const fWorksheet = fWorkbook.getActiveSheet() const charts = fWorksheet.getCharts() ``` -[`FChart`](https://docs.univer.ai/reference/facade/chart) の主なメンバー メソッドは次のとおりです。 +`FChart` の主なメンバー メソッドは次のとおりです。 | メソッド | 説明 | | --- | --- | @@ -489,7 +489,7 @@ const charts = fWorksheet.getCharts() ### チャートの更新 -[`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#updatechart) メソッドはチャートを更新します。`IChartBuilderInfo` オブジェクトを渡してチャートの設定を更新します。 +`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)` メソッドはチャートを更新します。`IChartBuilderInfo` オブジェクトを渡してチャートの設定を更新します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -519,7 +519,7 @@ setTimeout(() => { ### チャートの削除 -[`FWorksheet.removeChart(chart: FChart)`](https://docs.univer.ai/reference/facade/worksheet#removechart) メソッドはチャートを削除します。`FChart` オブジェクトを渡して指定のチャートを削除します。 +`FWorksheet.removeChart(chart: FChart)` メソッドはチャートを削除します。`FChart` オブジェクトを渡して指定のチャートを削除します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -546,7 +546,7 @@ setTimeout(async () => { ### チャート テーマ -[`FWorksheet.registerChartTheme(themeName: string, theme: IEchartTheme)`](https://docs.univer.ai/reference/facade/worksheet#registercharttheme) メソッドはチャート テーマを登録します。テーマ名とテーマ オブジェクトを渡してカスタム テーマを登録します。 +`FWorksheet.registerChartTheme(themeName: string, theme: IEchartTheme)` メソッドはチャート テーマを登録します。テーマ名とテーマ オブジェクトを渡してカスタム テーマを登録します。 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 24c0761..2d77573 100644 --- a/content/guides/sheets/features/charts.mdx +++ b/content/guides/sheets/features/charts.mdx @@ -148,7 +148,7 @@ Univer Sheets supports the following chart types: ## Facade API -Complete Facade API type definitions can be found in the [FacadeAPI](https://reference.univer.ai/en-US).。 +Complete Facade API type definitions can be found in the [FacadeAPI](/reference/facade/univer). ### Importing @@ -162,9 +162,9 @@ import '@univerjs-pro/sheets-chart/facade' ### Insert 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. +`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. -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. +Then call `build()` to generate an `IChartBuilderInfo` object, and use the `FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)` method to insert the chart into the worksheet. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -183,7 +183,7 @@ const chartInfo = fWorksheet.newChart() await fWorksheet.insertChart(chartInfo) ``` -Here are some member methods on [`FChartBuilderBase`](https://docs.univer.ai/reference/facade/chart): +Here are some member methods on `FChartBuilderBase`: | Method | Description | | ------ | ----------- | @@ -436,7 +436,7 @@ const chartBuilder = fWorkSheet.newChart() .setChartType(univerAPI.Enum.ChartType.Column) ``` -- [LineChartBuilder](https://docs.univer.ai/reference/facade/chart) +- `LineChartBuilder` | Method | Description | | ------ | ----------- | @@ -446,7 +446,7 @@ const chartBuilder = fWorkSheet.newChart() | setDataPointSize | Set the data point size | | build | Generate builder info for inserting/updating the chart | -- [PieChartBuilder](https://docs.univer.ai/reference/facade/chart) +- `PieChartBuilder` | Method | Description | | ------ | ----------- | @@ -458,7 +458,7 @@ const chartBuilder = fWorkSheet.newChart() | setShowLabelLine | Show label lines | | build | Generate builder info for inserting/updating the chart | -- [RadarChartBuilder](https://docs.univer.ai/reference/facade/chart) +- `RadarChartBuilder` | Method | Description | | ------ | ----------- | @@ -468,7 +468,7 @@ const chartBuilder = fWorkSheet.newChart() ### Get Charts -[`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. +`FWorksheet.getCharts()` method is used to get all charts in the current worksheet, returning an array of `FChart` objects. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -478,7 +478,7 @@ const fWorksheet = fWorkbook.getActiveSheet() const charts = fWorksheet.getCharts() ``` -Here are some member methods on [`FChart`](https://docs.univer.ai/reference/facade/chart): +Here are some member methods on `FChart`: | Method | Description | | --- | --- | @@ -489,7 +489,7 @@ Here are some member methods on [`FChart`](https://docs.univer.ai/reference/faca ### Update Chart -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. +The `FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)` method is used to update the chart, passing in an `IChartBuilderInfo` object to update the chart configuration. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -519,7 +519,7 @@ setTimeout(() => { ### Remove 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. +The `FWorksheet.removeChart(chart: FChart)` method is used to remove a chart, passing in an `FChart` object to remove the specified chart. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -546,7 +546,7 @@ setTimeout(async () => { ### Chart Theme -The [`FWorksheet.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. +The `FWorksheet.registerChartTheme(themeName: string, theme: IEchartTheme)` 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 349d03f..82c4c73 100644 --- a/content/guides/sheets/features/charts.zh-CN.mdx +++ b/content/guides/sheets/features/charts.zh-CN.mdx @@ -148,7 +148,7 @@ Univer Sheets 支持以下图表类型: ## Facade API -完整 Facade API 类型定义,请查看 [FacadeAPI](https://reference.univer.ai/zh-CN)。 +完整 Facade API 类型定义,请查看 [FacadeAPI](/reference/facade/univer)。 ### 引入 @@ -162,9 +162,9 @@ import '@univerjs-pro/sheets-chart/facade' ### 插入图表 -[`FWorksheet.newChart()`](https://docs.univer.ai/reference/facade/worksheet#newchart) 方法用于创建一个图表构建器,返回一个 `FChartBuilderBase` 实例,你可以通过链式调用方法来设置图表的各种属性。 +`FWorksheet.newChart()` 方法用于创建一个图表构建器,返回一个 `FChartBuilderBase` 实例,你可以通过链式调用方法来设置图表的各种属性。 -然后调用 `build()` 生成 `IChartBuilderInfo` 对象,通过 [`FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#insertchart) 方法将图表插入到表格中。 +然后调用 `build()` 生成 `IChartBuilderInfo` 对象,通过 `FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)` 方法将图表插入到表格中。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -183,7 +183,7 @@ const chartInfo = fWorksheet.newChart() await fWorksheet.insertChart(chartInfo) ``` -以下是 [`FChartBuilderBase`](https://docs.univer.ai/reference/facade/chart) 上的一些成员方法: +以下是 `FChartBuilderBase` 上的一些成员方法: | 方法 | 描述 | | --- | --- | @@ -436,7 +436,7 @@ const chartBuilder = fWorkSheet.newChart() .setChartType(univerAPI.Enum.ChartType.Column) ``` -- [LineChartBuilder](https://docs.univer.ai/reference/facade/chart) +- `LineChartBuilder` | 方法 | 描述 | | --- | --- | @@ -446,7 +446,7 @@ const chartBuilder = fWorkSheet.newChart() | setDataPointSize | 设置数据点大小 | | build | 生成 builder info,用于插入/更新图表 | -- [PieChartBuilder](https://docs.univer.ai/reference/facade/chart) +- `PieChartBuilder` | 方法 | 描述 | | --- | --- | @@ -458,7 +458,7 @@ const chartBuilder = fWorkSheet.newChart() | setShowLabelLine | 显示标签线 | | build | 生成 builder info,用于插入/更新图表 | -- [RadarChartBuilder](https://docs.univer.ai/reference/facade/chart) +- `RadarChartBuilder` | 方法 | 描述 | | --- | --- | @@ -468,7 +468,7 @@ const chartBuilder = fWorkSheet.newChart() ### 获取图表 -[`FWorksheet.getCharts()`](https://docs.univer.ai/reference/facade/worksheet#getcharts) 方法用于获取当前工作表中的所有图表,返回一个 `FChart[]` 数组。 +`FWorksheet.getCharts()` 方法用于获取当前工作表中的所有图表,返回一个 `FChart[]` 数组。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -478,7 +478,7 @@ const fWorksheet = fWorkbook.getActiveSheet() const charts = fWorksheet.getCharts() ``` -以下是 [`FChart`](https://docs.univer.ai/reference/facade/chart) 上的一些成员方法: +以下是 `FChart` 上的一些成员方法: | 方法 | 描述 | | --- | --- | @@ -489,7 +489,7 @@ const charts = fWorksheet.getCharts() ### 更新图表 -[`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#updatechart) 方法用于更新图表,传入一个 `IChartBuilderInfo` 对象,用于更新图表的配置。 +`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)` 方法用于更新图表,传入一个 `IChartBuilderInfo` 对象,用于更新图表的配置。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -519,7 +519,7 @@ setTimeout(() => { ### 删除图表 -[`FWorksheet.removeChart(chart: FChart)`](https://docs.univer.ai/reference/facade/worksheet#removechart) 方法用于删除图表,传入一个 `FChart` 对象,用于删除指定的图表。 +`FWorksheet.removeChart(chart: FChart)` 方法用于删除图表,传入一个 `FChart` 对象,用于删除指定的图表。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -546,7 +546,7 @@ setTimeout(async () => { ### 图表主题 -[`FWorksheet.registerChartTheme(themeName: string, theme: IEchartTheme)`](https://docs.univer.ai/reference/facade/worksheet#registercharttheme) 方法用于注册图表主题,传入一个主题名称和主题对象,用于注册自定义主题。 +`FWorksheet.registerChartTheme(themeName: string, theme: IEchartTheme)` 方法用于注册图表主题,传入一个主题名称和主题对象,用于注册自定义主题。 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 4df8e5b..5146f8d 100644 --- a/content/guides/sheets/features/charts.zh-TW.mdx +++ b/content/guides/sheets/features/charts.zh-TW.mdx @@ -148,7 +148,7 @@ Univer Sheets 支援以下圖表類型: ## Facade API -完整 Facade API 類型定義,請查看 [FacadeAPI](https://reference.univer.ai/zh-TW)。 +完整 Facade API 類型定義,請查看 [FacadeAPI](/reference/facade/univer)。 ### 導入 @@ -162,9 +162,9 @@ import '@univerjs-pro/sheets-chart/facade' ### 插入圖表 -[`FWorksheet.newChart()`](https://docs.univer.ai/reference/facade/worksheet#newchart) 方法用於建立一個圖表建構器,回傳一個 `FChartBuilderBase` 實例,你可以透過鏈式呼叫方法來設定圖表的各種屬性。 +`FWorksheet.newChart()` 方法用於建立一個圖表建構器,回傳一個 `FChartBuilderBase` 實例,你可以透過鏈式呼叫方法來設定圖表的各種屬性。 -然後呼叫 `build()` 產生 `IChartBuilderInfo` 物件,透過 [`FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#insertchart) 方法將圖表插入到表格中。 +然後呼叫 `build()` 產生 `IChartBuilderInfo` 物件,透過 `FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)` 方法將圖表插入到表格中。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -183,7 +183,7 @@ const chartInfo = fWorksheet.newChart() await fWorksheet.insertChart(chartInfo) ``` -以下是 [`FChartBuilderBase`](https://docs.univer.ai/reference/facade/chart) 上的一些成員方法: +以下是 `FChartBuilderBase` 上的一些成員方法: | 方法 | 描述 | | --- | --- | @@ -436,7 +436,7 @@ const chartBuilder = fWorkSheet.newChart() .setChartType(univerAPI.Enum.ChartType.Column) ``` -- [LineChartBuilder](https://docs.univer.ai/reference/facade/chart) +- `LineChartBuilder` | 方法 | 描述 | | --- | --- | @@ -446,7 +446,7 @@ const chartBuilder = fWorkSheet.newChart() | setDataPointSize | 設定資料點大小 | | build | 產生 builder info,用於插入/更新圖表 | -- [PieChartBuilder](https://docs.univer.ai/reference/facade/chart) +- `PieChartBuilder` | 方法 | 描述 | | --- | --- | @@ -458,7 +458,7 @@ const chartBuilder = fWorkSheet.newChart() | setShowLabelLine | 顯示標籤線 | | build | 產生 builder info,用於插入/更新圖表 | -- [RadarChartBuilder](https://docs.univer.ai/reference/facade/chart) +- `RadarChartBuilder` | 方法 | 描述 | | --- | --- | @@ -468,7 +468,7 @@ const chartBuilder = fWorkSheet.newChart() ### 獲取圖表 -[`FWorksheet.getCharts()`](https://docs.univer.ai/reference/facade/worksheet#getcharts) 方法用於獲取目前工作表中的所有圖表,回傳一個 `FChart[]` 陣列。 +`FWorksheet.getCharts()` 方法用於獲取目前工作表中的所有圖表,回傳一個 `FChart[]` 陣列。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -478,7 +478,7 @@ const fWorksheet = fWorkbook.getActiveSheet() const charts = fWorksheet.getCharts() ``` -以下是 [`FChart`](https://docs.univer.ai/reference/facade/chart) 上的一些成員方法: +以下是 `FChart` 上的一些成員方法: | 方法 | 描述 | | --- | --- | @@ -489,7 +489,7 @@ const charts = fWorksheet.getCharts() ### 更新圖表 -[`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#updatechart) 方法用於更新圖表,傳入一個 `IChartBuilderInfo` 物件,用於更新圖表的配置。 +`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)` 方法用於更新圖表,傳入一個 `IChartBuilderInfo` 物件,用於更新圖表的配置。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -519,7 +519,7 @@ setTimeout(() => { ### 刪除圖表 -[`FWorksheet.removeChart(chart: FChart)`](https://docs.univer.ai/reference/facade/worksheet#removechart) 方法用於刪除圖表,傳入一個 `FChart` 物件,用於刪除指定的圖表。 +`FWorksheet.removeChart(chart: FChart)` 方法用於刪除圖表,傳入一個 `FChart` 物件,用於刪除指定的圖表。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -546,7 +546,7 @@ setTimeout(async () => { ### 圖表主題 -[`FWorksheet.registerChartTheme(themeName: string, theme: IEchartTheme)`](https://docs.univer.ai/reference/facade/worksheet#registercharttheme) 方法用於註冊圖表主題,傳入一個主題名稱和主題物件,用於註冊自訂主題。 +`FWorksheet.registerChartTheme(themeName: string, theme: IEchartTheme)` 方法用於註冊圖表主題,傳入一個主題名稱和主題物件,用於註冊自訂主題。 Univer chart 是基於 echarts 的圖表庫實作的,因此可以借助 echart 的主題建構工具來建構你的[自訂主題](https://echarts.apache.org/zh/theme-builder.html)。 你可以在該網站建構你自己的主題並下載成為配置檔案,使用以下 API 來使用你的自訂主題: diff --git a/content/guides/sheets/features/shapes.ja-JP.mdx b/content/guides/sheets/features/shapes.ja-JP.mdx index 84ef13e..ae04f93 100644 --- a/content/guides/sheets/features/shapes.ja-JP.mdx +++ b/content/guides/sheets/features/shapes.ja-JP.mdx @@ -84,6 +84,10 @@ Univer の商用ライセンスをお持ちの場合は、[クライアントで npm install @univerjs-pro/sheets-shape @univerjs-pro/sheets-shape-ui ``` + + 図形プラグインは描画プラグインに依存しています。図形プラグインを登録する前に、`UniverDrawingPlugin`、`UniverSheetsDrawingPlugin`、`UniverDrawingUIPlugin`、および `UniverSheetsDrawingUIPlugin` を先に登録する必要があります。 + + ### 使い方 ```typescript @@ -113,6 +117,8 @@ Univer の商用ライセンスをお持ちの場合は、[クライアントで ## Facade API +完全な Facade API の型定義は [FacadeAPI](/reference/facade/univer) を参照してください。 + ### インポート @@ -125,7 +131,7 @@ import '@univerjs-pro/sheets-shape/facade' ### 基本図形の挿入 -[`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) で挿入します。 +`FWorksheet.newShape` で図形ビルダーを作成し、`FWorksheet.insertShape` で挿入します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -146,7 +152,7 @@ await fWorksheet.insertShape(rectShape) ### コネクタ図形の挿入と接続 -[`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) で両端を図形の接続点に接続します。 +`FWorksheet.newConnector` でコネクタを作成し、`FWorksheet.connectShapes` で両端を図形の接続点に接続します。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -199,7 +205,7 @@ if (connectorShape && basicShapes.length >= 2) { ### 図形の更新と削除 -既存図形の更新には [`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) を使います。 +既存図形の更新には `FWorksheet.updateShape`、削除には `FWorksheet.removeShape` を使います。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -221,10 +227,3 @@ if (firstShape) { await fWorksheet.removeShape(firstShape) } ``` - -### 関連 Facade オブジェクト - -- [`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 96eb721..c1c7864 100644 --- a/content/guides/sheets/features/shapes.mdx +++ b/content/guides/sheets/features/shapes.mdx @@ -117,6 +117,8 @@ If you have a commercial license for Univer, please refer to [Using License in C ## Facade API +Complete Facade API type definitions can be found in the [FacadeAPI](/reference/facade/univer). + ### Importing @@ -129,7 +131,7 @@ import '@univerjs-pro/sheets-shape/facade' ### Insert Basic Shapes -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. +Use `FWorksheet.newShape` to create a shape builder, then call `FWorksheet.insertShape` to insert it. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -150,7 +152,7 @@ await fWorksheet.insertShape(rectShape) ### Insert and Connect Connector Shapes -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. +Use `FWorksheet.newConnector` to create connector lines, and `FWorksheet.connectShapes` to attach both ends to shape connection sites. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -203,7 +205,7 @@ if (connectorShape && basicShapes.length >= 2) { ### Update and Remove Shapes -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. +Use `FWorksheet.updateShape` to update an existing shape and `FWorksheet.removeShape` to remove it. ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -225,10 +227,3 @@ if (firstShape) { await fWorksheet.removeShape(firstShape) } ``` - -### Related Facade Objects - -- [`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 078e403..f75a340 100644 --- a/content/guides/sheets/features/shapes.zh-CN.mdx +++ b/content/guides/sheets/features/shapes.zh-CN.mdx @@ -84,6 +84,10 @@ const { univerAPI } = createUniver({ npm install @univerjs-pro/sheets-shape @univerjs-pro/sheets-shape-ui ``` + + 形状插件依赖绘图插件,注册形状插件前必须先注册 `UniverDrawingPlugin`、`UniverSheetsDrawingPlugin`、`UniverDrawingUIPlugin` 和 `UniverSheetsDrawingUIPlugin`。 + + ### 使用 ```typescript @@ -113,7 +117,9 @@ univer.registerPlugin(UniverSheetsShapeUIPlugin) // [!code ++] ## Facade API -### 导入 +完整 Facade API 类型定义,请查看 [FacadeAPI](/reference/facade/univer)。 + +### 引入 只有插件模式需要手动导入 Facade 包。预设模式已经内置对应 Facade,无需额外导入。 @@ -125,7 +131,7 @@ import '@univerjs-pro/sheets-shape/facade' ### 插入基础形状 -通过 [`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) 插入形状。 +通过 `FWorksheet.newShape` 创建形状构建器,然后调用 `FWorksheet.insertShape` 插入形状。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -146,7 +152,7 @@ await fWorksheet.insertShape(rectShape) ### 插入并连接连接线形状 -通过 [`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) 将连接线两端挂接到目标形状的连接点。 +通过 `FWorksheet.newConnector` 创建连接线,再使用 `FWorksheet.connectShapes` 将连接线两端挂接到目标形状的连接点。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -199,7 +205,7 @@ if (connectorShape && basicShapes.length >= 2) { ### 更新和删除形状 -通过 [`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) 删除形状。 +通过 `FWorksheet.updateShape` 更新已有形状,通过 `FWorksheet.removeShape` 删除形状。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -221,10 +227,3 @@ if (firstShape) { await fWorksheet.removeShape(firstShape) } ``` - -### 相关 Facade 对象 - -- [`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 d931694..645b35b 100644 --- a/content/guides/sheets/features/shapes.zh-TW.mdx +++ b/content/guides/sheets/features/shapes.zh-TW.mdx @@ -84,6 +84,10 @@ const { univerAPI } = createUniver({ npm install @univerjs-pro/sheets-shape @univerjs-pro/sheets-shape-ui ``` + + 形狀插件依賴繪圖插件,註冊形狀插件前必須先註冊 `UniverDrawingPlugin`、`UniverSheetsDrawingPlugin`、`UniverDrawingUIPlugin` 和 `UniverSheetsDrawingUIPlugin`。 + + ### 使用 ```typescript @@ -113,7 +117,9 @@ univer.registerPlugin(UniverSheetsShapeUIPlugin) // [!code ++] ## Facade API -### 匯入 +完整 Facade API 類型定義,請查看 [FacadeAPI](/reference/facade/univer)。 + +### 導入 僅插件模式需要手動匯入 Facade 套件。預設模式已內建對應 Facade,無需額外匯入。 @@ -125,7 +131,7 @@ import '@univerjs-pro/sheets-shape/facade' ### 插入基礎形狀 -透過 [`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) 插入形狀。 +透過 `FWorksheet.newShape` 建立形狀建構器,再呼叫 `FWorksheet.insertShape` 插入形狀。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -146,7 +152,7 @@ await fWorksheet.insertShape(rectShape) ### 插入並連接連接線形狀 -透過 [`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) 將連接線兩端連到目標形狀的連接點。 +透過 `FWorksheet.newConnector` 建立連接線,再使用 `FWorksheet.connectShapes` 將連接線兩端連到目標形狀的連接點。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -199,7 +205,7 @@ if (connectorShape && basicShapes.length >= 2) { ### 更新與刪除形狀 -使用 [`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) 刪除形狀。 +使用 `FWorksheet.updateShape` 更新既有形狀,使用 `FWorksheet.removeShape` 刪除形狀。 ```typescript const fWorkbook = univerAPI.getActiveWorkbook() @@ -221,10 +227,3 @@ if (firstShape) { await fWorksheet.removeShape(firstShape) } ``` - -### 相關 Facade 物件 - -- [`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):工作表層級的形狀操作方法。