diff --git a/docs/@views/api/references/instance/createIndicator.md b/docs/@views/api/references/instance/createIndicator.md index 5f9c8933..299bec3d 100644 --- a/docs/@views/api/references/instance/createIndicator.md +++ b/docs/@views/api/references/instance/createIndicator.md @@ -2,6 +2,7 @@ ( indicator: string | { name: string + id?: string shortName?: string precision?: number calcParams?: unknown[] diff --git a/docs/@views/api/references/instance/getIndicators.md b/docs/@views/api/references/instance/getIndicators.md index de828569..3c7f4055 100644 --- a/docs/@views/api/references/instance/getIndicators.md +++ b/docs/@views/api/references/instance/getIndicators.md @@ -1,8 +1,9 @@ ```typescript ( filter?: { + id?: string name?: string paneId?: string } -) => Map +) => Indicator[] ``` \ No newline at end of file diff --git a/docs/@views/api/references/instance/getOverlays.md b/docs/@views/api/references/instance/getOverlays.md index 2a66c5a2..cf6e7cc4 100644 --- a/docs/@views/api/references/instance/getOverlays.md +++ b/docs/@views/api/references/instance/getOverlays.md @@ -6,5 +6,5 @@ groupId?: string paneId?: string } -) => Map +) => Overlay[] ``` \ No newline at end of file diff --git a/docs/@views/api/references/instance/overrideIndicator.md b/docs/@views/api/references/instance/overrideIndicator.md index 73702df1..14475070 100644 --- a/docs/@views/api/references/instance/overrideIndicator.md +++ b/docs/@views/api/references/instance/overrideIndicator.md @@ -1,7 +1,9 @@ ```typescript ( indicator: { - name: string + id?: string + paneId?: string + name?: string shortName?: string precision?: number calcParams?: unknown[] @@ -61,7 +63,6 @@ }) draw?: (params: object) => boolean onDataStateChange?: (params: object) => void - }, - paneId?: string + } ) => void ``` \ No newline at end of file diff --git a/docs/@views/api/references/instance/removeIndicator.md b/docs/@views/api/references/instance/removeIndicator.md index 0fecb62c..cc74200e 100644 --- a/docs/@views/api/references/instance/removeIndicator.md +++ b/docs/@views/api/references/instance/removeIndicator.md @@ -1,6 +1,7 @@ ```typescript ( filter?: { + id?: string name?: string paneId?: string } diff --git a/docs/api/instance/createIndicator.md b/docs/api/instance/createIndicator.md index bbfe2ea0..8b3c7882 100644 --- a/docs/api/instance/createIndicator.md +++ b/docs/api/instance/createIndicator.md @@ -11,6 +11,7 @@ outline: deep ### 参数 {#parameters} - `indicator` 指标配置,可以是指标名,也可以是一个对象。对象参数如下。 - `name` 名称。 + - `id` 指标 id 。 - `shortName` 简短名称,用于提示显示。 - `precision` 精度。 - `calcParams` 计算参数。 @@ -56,7 +57,7 @@ outline: deep - `createTicks` 创建分割信息回调方法。 ### 返回值 {#returns} -`createIndicator` 返回窗口id `string` 或者 `null`。 +`createIndicator` 返回指标id `string` 或者 `null`。 ## 用法 {#usage}