Skip to content

Commit 919495b

Browse files
committed
docs: update docs
1 parent b3efc11 commit 919495b

File tree

17 files changed

+65
-15
lines changed

17 files changed

+65
-15
lines changed

docs/@views/api/references/instance/createIndicator.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
(
33
indicator: string | {
44
name: string
5+
id?: string
56
shortName?: string
67
precision?: number
78
calcParams?: unknown[]
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
```typescript
22
(
33
filter?: {
4+
id?: string
45
name?: string
56
paneId?: string
67
}
7-
) => Map<string, Indicator[]>
8+
) => Indicator[]
89
```

docs/@views/api/references/instance/getOverlays.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@
66
groupId?: string
77
paneId?: string
88
}
9-
) => Map<string, Overlay[]>
9+
) => Overlay[]
1010
```

docs/@views/api/references/instance/overrideIndicator.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
```typescript
22
(
33
indicator: {
4-
name: string
4+
id?: string
5+
paneId?: string
6+
name?: string
57
shortName?: string
68
precision?: number
79
calcParams?: unknown[]
@@ -61,7 +63,6 @@
6163
})
6264
draw?: (params: object) => boolean
6365
onDataStateChange?: (params: object) => void
64-
},
65-
paneId?: string
66+
}
6667
) => void
6768
```

docs/@views/api/references/instance/removeIndicator.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
```typescript
22
(
33
filter?: {
4+
id?: string
45
name?: string
56
paneId?: string
67
}

docs/api/instance/createIndicator.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ outline: deep
1111
### 参数 {#parameters}
1212
- `indicator` 指标配置,可以是指标名,也可以是一个对象。对象参数如下。
1313
- `name` 名称。
14+
- `id` 指标 id 。
1415
- `shortName` 简短名称,用于提示显示。
1516
- `precision` 精度。
1617
- `calcParams` 计算参数。
@@ -56,7 +57,7 @@ outline: deep
5657
- `createTicks` 创建分割信息回调方法。
5758

5859
### 返回值 {#returns}
59-
`createIndicator` 返回窗口id `string` 或者 `null`
60+
`createIndicator` 返回指标id `string` 或者 `null`
6061

6162
## 用法 {#usage}
6263
<script setup>

docs/api/instance/getIndicators.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@ outline: deep
1010

1111
### 参数 {#parameters}
1212
- `filter` 过滤参数。
13+
- `id` 指标id。
1314
- `name` 指标名称。
1415
- `paneId` 窗口id。
1516

1617

1718
### 返回值 {#returns}
18-
`getIndicators` 返回 `Map<string, Indicator[]>`
19+
`getIndicators` 返回 `Indicator[]`
1920

2021
## 用法 {#usage}
2122
<script setup>

docs/api/instance/getOverlays.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ outline: deep
1717

1818

1919
### 返回值 {#returns}
20-
`getOverlays` 返回 `Map<string, Overlay[]>`
20+
`getOverlays` 返回 `Overlay[]`
2121

2222
## 用法 {#usage}
2323
<script setup>

docs/api/instance/overrideIndicator.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22
outline: deep
33
---
44

5-
# overrideIndicator(indicator, paneId?)
5+
# overrideIndicator(indicator)
66
`overrideIndicator` 覆盖指标属性。
77

88
## 参考 {#reference}
99
<!-- @include: @/@views/api/references/instance/overrideIndicator.md -->
1010

1111
### 参数 {#parameters}
1212
- `indicator` 指标配置。
13+
- `id` 指标id。
14+
- `paneId` 窗口id。
1315
- `name` 名称。
1416
- `shortName` 简短名称,用于提示显示。
1517
- `precision` 精度。
@@ -35,7 +37,10 @@ outline: deep
3537
- `createTooltipDataSource` 创建自定义的提示信息。
3638
- `draw` 自定义绘制方法,如果返回值是 `true` ,则会覆盖默认的绘制。
3739
- `onDataStateChange` 数据变化回调通知。
38-
- `paneId` 窗口id。
40+
41+
::: tip 提示
42+
其中 `id``paneId``name` 是索引,如果入参包含这三个参数,会根据这三个参数查找符合条件的指标来覆盖。
43+
:::
3944

4045
### 返回值 {#returns}
4146
`overrideIndicator` 返回 `undefined`

docs/api/instance/removeIndicator.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ outline: deep
1010

1111
### 参数 {#parameters}
1212
- `filter` 过滤参数。
13+
- `id` 指标id。
1314
- `name` 指标名称。
1415
- `paneId` 窗口id。
1516

0 commit comments

Comments
 (0)