Skip to content

Commit acaba3b

Browse files
wpxp123456wpxp123456
committed
docs: modify chart and shape docs
1 parent eb541ed commit acaba3b

8 files changed

Lines changed: 82 additions & 90 deletions

File tree

‎content/guides/sheets/features/charts.ja-JP.mdx‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Univer Sheets は以下のチャート種類をサポートしています：
148148

149149
## Facade API
150150

151-
完全な Facade API の型定義は [FacadeAPI](https://reference.univer.ai/en-US) を参照してください。
151+
完全な Facade API の型定義は [FacadeAPI](/reference/facade/univer) を参照してください。
152152

153153
### インポート
154154

@@ -162,9 +162,9 @@ import '@univerjs-pro/sheets-chart/facade'
162162

163163
### チャートの挿入
164164

165-
[`FWorksheet.newChart()`](https://docs.univer.ai/reference/facade/worksheet#newchart) メソッドはチャート ビルダーを作成し、`FChartBuilderBase` のインスタンスを返します。メソッド チェーンでチャートの各種プロパティを設定できます。
165+
`FWorksheet.newChart()` メソッドはチャート ビルダーを作成し、`FChartBuilderBase` のインスタンスを返します。メソッド チェーンでチャートの各種プロパティを設定できます。
166166

167-
その後、`build()` を呼び出して `IChartBuilderInfo` オブジェクトを生成し、[`FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#insertchart) メソッドでワークシートにチャートを挿入します。
167+
その後、`build()` を呼び出して `IChartBuilderInfo` オブジェクトを生成し、`FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)` メソッドでワークシートにチャートを挿入します。
168168

169169
```typescript
170170
const fWorkbook = univerAPI.getActiveWorkbook()
@@ -183,7 +183,7 @@ const chartInfo = fWorksheet.newChart()
183183
await fWorksheet.insertChart(chartInfo)
184184
```
185185

186-
[`FChartBuilderBase`](https://docs.univer.ai/reference/facade/chart) の主なメンバー メソッドは次のとおりです。
186+
`FChartBuilderBase` の主なメンバー メソッドは次のとおりです。
187187

188188
| メソッド | 説明 |
189189
| ------ | ----------- |
@@ -436,7 +436,7 @@ const chartBuilder = fWorkSheet.newChart()
436436
.setChartType(univerAPI.Enum.ChartType.Column)
437437
```
438438

439-
- [LineChartBuilder](https://docs.univer.ai/reference/facade/chart)
439+
- `LineChartBuilder`
440440

441441
| メソッド | 説明 |
442442
| ------ | ----------- |
@@ -446,7 +446,7 @@ const chartBuilder = fWorkSheet.newChart()
446446
| setDataPointSize | データ点のサイズを設定 |
447447
| build | チャート挿入/更新用のビルダー情報を生成 |
448448

449-
- [PieChartBuilder](https://docs.univer.ai/reference/facade/chart)
449+
- `PieChartBuilder`
450450

451451
| メソッド | 説明 |
452452
| ------ | ----------- |
@@ -458,7 +458,7 @@ const chartBuilder = fWorkSheet.newChart()
458458
| setShowLabelLine | ラベル ラインを表示 |
459459
| build | チャート挿入/更新用のビルダー情報を生成 |
460460

461-
- [RadarChartBuilder](https://docs.univer.ai/reference/facade/chart)
461+
- `RadarChartBuilder`
462462

463463
| メソッド | 説明 |
464464
| ------ | ----------- |
@@ -468,7 +468,7 @@ const chartBuilder = fWorkSheet.newChart()
468468

469469
### チャートの取得
470470

471-
[`FWorksheet.getCharts()`](https://docs.univer.ai/reference/facade/worksheet#getcharts) メソッドは、現在のワークシートにあるすべてのチャートを取得し、`FChart` オブジェクトの配列を返します。
471+
`FWorksheet.getCharts()` メソッドは、現在のワークシートにあるすべてのチャートを取得し、`FChart` オブジェクトの配列を返します。
472472

473473
```typescript
474474
const fWorkbook = univerAPI.getActiveWorkbook()
@@ -478,7 +478,7 @@ const fWorksheet = fWorkbook.getActiveSheet()
478478
const charts = fWorksheet.getCharts()
479479
```
480480

481-
[`FChart`](https://docs.univer.ai/reference/facade/chart) の主なメンバー メソッドは次のとおりです。
481+
`FChart` の主なメンバー メソッドは次のとおりです。
482482

483483
| メソッド | 説明 |
484484
| --- | --- |
@@ -489,7 +489,7 @@ const charts = fWorksheet.getCharts()
489489

490490
### チャートの更新
491491

492-
[`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#updatechart) メソッドはチャートを更新します。`IChartBuilderInfo` オブジェクトを渡してチャートの設定を更新します。
492+
`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)` メソッドはチャートを更新します。`IChartBuilderInfo` オブジェクトを渡してチャートの設定を更新します。
493493

494494
```typescript
495495
const fWorkbook = univerAPI.getActiveWorkbook()
@@ -519,7 +519,7 @@ setTimeout(() => {
519519

520520
### チャートの削除
521521

522-
[`FWorksheet.removeChart(chart: FChart)`](https://docs.univer.ai/reference/facade/worksheet#removechart) メソッドはチャートを削除します。`FChart` オブジェクトを渡して指定のチャートを削除します。
522+
`FWorksheet.removeChart(chart: FChart)` メソッドはチャートを削除します。`FChart` オブジェクトを渡して指定のチャートを削除します。
523523

524524
```typescript
525525
const fWorkbook = univerAPI.getActiveWorkbook()
@@ -546,7 +546,7 @@ setTimeout(async () => {
546546

547547
### チャート テーマ
548548

549-
[`FWorksheet.registerChartTheme(themeName: string, theme: IEchartTheme)`](https://docs.univer.ai/reference/facade/worksheet#registercharttheme) メソッドはチャート テーマを登録します。テーマ名とテーマ オブジェクトを渡してカスタム テーマを登録します。
549+
`FWorksheet.registerChartTheme(themeName: string, theme: IEchartTheme)` メソッドはチャート テーマを登録します。テーマ名とテーマ オブジェクトを渡してカスタム テーマを登録します。
550550

551551
Univer のチャートは ECharts ライブラリをベースに実装されています。そのため、ECharts の[テーマ ビルダー ツール](https://echarts.apache.org/en/theme-builder.html)でカスタム テーマを作成できます。
552552
このサイトでテーマを作成し、設定ファイルとしてダウンロードしてください。以下の API を使ってカスタム テーマを適用できます。

‎content/guides/sheets/features/charts.mdx‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Univer Sheets supports the following chart types:
148148

149149
## Facade API
150150

151-
Complete Facade API type definitions can be found in the [FacadeAPI](https://reference.univer.ai/en-US).。
151+
Complete Facade API type definitions can be found in the [FacadeAPI](/reference/facade/univer).
152152

153153
### Importing
154154

@@ -162,9 +162,9 @@ import '@univerjs-pro/sheets-chart/facade'
162162

163163
### Insert Chart
164164

165-
[`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.
165+
`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.
166166

167-
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.
167+
Then call `build()` to generate an `IChartBuilderInfo` object, and use the `FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)` method to insert the chart into the worksheet.
168168

169169
```typescript
170170
const fWorkbook = univerAPI.getActiveWorkbook()
@@ -183,7 +183,7 @@ const chartInfo = fWorksheet.newChart()
183183
await fWorksheet.insertChart(chartInfo)
184184
```
185185

186-
Here are some member methods on [`FChartBuilderBase`](https://docs.univer.ai/reference/facade/chart):
186+
Here are some member methods on `FChartBuilderBase`:
187187

188188
| Method | Description |
189189
| ------ | ----------- |
@@ -436,7 +436,7 @@ const chartBuilder = fWorkSheet.newChart()
436436
.setChartType(univerAPI.Enum.ChartType.Column)
437437
```
438438

439-
- [LineChartBuilder](https://docs.univer.ai/reference/facade/chart)
439+
- `LineChartBuilder`
440440

441441
| Method | Description |
442442
| ------ | ----------- |
@@ -446,7 +446,7 @@ const chartBuilder = fWorkSheet.newChart()
446446
| setDataPointSize | Set the data point size |
447447
| build | Generate builder info for inserting/updating the chart |
448448

449-
- [PieChartBuilder](https://docs.univer.ai/reference/facade/chart)
449+
- `PieChartBuilder`
450450

451451
| Method | Description |
452452
| ------ | ----------- |
@@ -458,7 +458,7 @@ const chartBuilder = fWorkSheet.newChart()
458458
| setShowLabelLine | Show label lines |
459459
| build | Generate builder info for inserting/updating the chart |
460460

461-
- [RadarChartBuilder](https://docs.univer.ai/reference/facade/chart)
461+
- `RadarChartBuilder`
462462

463463
| Method | Description |
464464
| ------ | ----------- |
@@ -468,7 +468,7 @@ const chartBuilder = fWorkSheet.newChart()
468468

469469
### Get Charts
470470

471-
[`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.
471+
`FWorksheet.getCharts()` method is used to get all charts in the current worksheet, returning an array of `FChart` objects.
472472

473473
```typescript
474474
const fWorkbook = univerAPI.getActiveWorkbook()
@@ -478,7 +478,7 @@ const fWorksheet = fWorkbook.getActiveSheet()
478478
const charts = fWorksheet.getCharts()
479479
```
480480

481-
Here are some member methods on [`FChart`](https://docs.univer.ai/reference/facade/chart):
481+
Here are some member methods on `FChart`:
482482

483483
| Method | Description |
484484
| --- | --- |
@@ -489,7 +489,7 @@ Here are some member methods on [`FChart`](https://docs.univer.ai/reference/faca
489489

490490
### Update Chart
491491

492-
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.
492+
The `FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)` method is used to update the chart, passing in an `IChartBuilderInfo` object to update the chart configuration.
493493

494494
```typescript
495495
const fWorkbook = univerAPI.getActiveWorkbook()
@@ -519,7 +519,7 @@ setTimeout(() => {
519519

520520
### Remove Chart
521521

522-
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.
522+
The `FWorksheet.removeChart(chart: FChart)` method is used to remove a chart, passing in an `FChart` object to remove the specified chart.
523523

524524
```typescript
525525
const fWorkbook = univerAPI.getActiveWorkbook()
@@ -546,7 +546,7 @@ setTimeout(async () => {
546546

547547
### Chart Theme
548548

549-
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.
549+
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.
550550

551551
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).
552552
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:

‎content/guides/sheets/features/charts.zh-CN.mdx‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Univer Sheets 支持以下图表类型：
148148

149149
## Facade API
150150

151-
完整 Facade API 类型定义，请查看 [FacadeAPI](https://reference.univer.ai/zh-CN)。
151+
完整 Facade API 类型定义，请查看 [FacadeAPI](/reference/facade/univer)。
152152

153153
### 引入
154154

@@ -162,9 +162,9 @@ import '@univerjs-pro/sheets-chart/facade'
162162

163163
### 插入图表
164164

165-
[`FWorksheet.newChart()`](https://docs.univer.ai/reference/facade/worksheet#newchart) 方法用于创建一个图表构建器，返回一个 `FChartBuilderBase` 实例，你可以通过链式调用方法来设置图表的各种属性。
165+
`FWorksheet.newChart()` 方法用于创建一个图表构建器，返回一个 `FChartBuilderBase` 实例，你可以通过链式调用方法来设置图表的各种属性。
166166

167-
然后调用 `build()` 生成 `IChartBuilderInfo` 对象，通过 [`FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#insertchart) 方法将图表插入到表格中。
167+
然后调用 `build()` 生成 `IChartBuilderInfo` 对象，通过 `FWorksheet.insertChart(chartBuildInfo: IChartBuilderInfo)` 方法将图表插入到表格中。
168168

169169
```typescript
170170
const fWorkbook = univerAPI.getActiveWorkbook()
@@ -183,7 +183,7 @@ const chartInfo = fWorksheet.newChart()
183183
await fWorksheet.insertChart(chartInfo)
184184
```
185185

186-
以下是 [`FChartBuilderBase`](https://docs.univer.ai/reference/facade/chart) 上的一些成员方法：
186+
以下是 `FChartBuilderBase` 上的一些成员方法：
187187

188188
| 方法 | 描述 |
189189
| --- | --- |
@@ -436,7 +436,7 @@ const chartBuilder = fWorkSheet.newChart()
436436
.setChartType(univerAPI.Enum.ChartType.Column)
437437
```
438438

439-
- [LineChartBuilder](https://docs.univer.ai/reference/facade/chart)
439+
- `LineChartBuilder`
440440

441441
| 方法 | 描述 |
442442
| --- | --- |
@@ -446,7 +446,7 @@ const chartBuilder = fWorkSheet.newChart()
446446
| setDataPointSize | 设置数据点大小 |
447447
| build | 生成 builder info，用于插入/更新图表 |
448448

449-
- [PieChartBuilder](https://docs.univer.ai/reference/facade/chart)
449+
- `PieChartBuilder`
450450

451451
| 方法 | 描述 |
452452
| --- | --- |
@@ -458,7 +458,7 @@ const chartBuilder = fWorkSheet.newChart()
458458
| setShowLabelLine | 显示标签线 |
459459
| build | 生成 builder info，用于插入/更新图表 |
460460

461-
- [RadarChartBuilder](https://docs.univer.ai/reference/facade/chart)
461+
- `RadarChartBuilder`
462462

463463
| 方法 | 描述 |
464464
| --- | --- |
@@ -468,7 +468,7 @@ const chartBuilder = fWorkSheet.newChart()
468468

469469
### 获取图表
470470

471-
[`FWorksheet.getCharts()`](https://docs.univer.ai/reference/facade/worksheet#getcharts) 方法用于获取当前工作表中的所有图表，返回一个 `FChart[]` 数组。
471+
`FWorksheet.getCharts()` 方法用于获取当前工作表中的所有图表，返回一个 `FChart[]` 数组。
472472

473473
```typescript
474474
const fWorkbook = univerAPI.getActiveWorkbook()
@@ -478,7 +478,7 @@ const fWorksheet = fWorkbook.getActiveSheet()
478478
const charts = fWorksheet.getCharts()
479479
```
480480

481-
以下是 [`FChart`](https://docs.univer.ai/reference/facade/chart) 上的一些成员方法：
481+
以下是 `FChart` 上的一些成员方法：
482482

483483
| 方法 | 描述 |
484484
| --- | --- |
@@ -489,7 +489,7 @@ const charts = fWorksheet.getCharts()
489489

490490
### 更新图表
491491

492-
[`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)`](https://docs.univer.ai/reference/facade/worksheet#updatechart) 方法用于更新图表，传入一个 `IChartBuilderInfo` 对象，用于更新图表的配置。
492+
`FWorksheet.updateChart(chartBuildInfo: IChartBuilderInfo)` 方法用于更新图表，传入一个 `IChartBuilderInfo` 对象，用于更新图表的配置。
493493

494494
```typescript
495495
const fWorkbook = univerAPI.getActiveWorkbook()
@@ -519,7 +519,7 @@ setTimeout(() => {
519519

520520
### 删除图表
521521

522-
[`FWorksheet.removeChart(chart: FChart)`](https://docs.univer.ai/reference/facade/worksheet#removechart) 方法用于删除图表，传入一个 `FChart` 对象，用于删除指定的图表。
522+
`FWorksheet.removeChart(chart: FChart)` 方法用于删除图表，传入一个 `FChart` 对象，用于删除指定的图表。
523523

524524
```typescript
525525
const fWorkbook = univerAPI.getActiveWorkbook()
@@ -546,7 +546,7 @@ setTimeout(async () => {
546546

547547
### 图表主题
548548

549-
[`FWorksheet.registerChartTheme(themeName: string, theme: IEchartTheme)`](https://docs.univer.ai/reference/facade/worksheet#registercharttheme) 方法用于注册图表主题，传入一个主题名称和主题对象，用于注册自定义主题。
549+
`FWorksheet.registerChartTheme(themeName: string, theme: IEchartTheme)` 方法用于注册图表主题，传入一个主题名称和主题对象，用于注册自定义主题。
550550

551551
Univer chart 是基于 echarts 的图表库实现的，因此可以借助 echart 的主题构建工具来构建你的[自定制主题](https://echarts.apache.org/zh/theme-builder.html)。
552552
你可以在该网站构建你自己的主题并下载成为配置文件，使用以下 API 来使用你的自定义主题：

0 commit comments

Comments
 (0)