fix: rename style to stockStyle (#2621)

Co-authored-by: liufu.lf <[email protected]>
antvis · Jun 9, 2021 · eaa2a58 · eaa2a58
1 parent e895e49
commit eaa2a58
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 12 deletions.
diff --git a/__tests__/unit/plots/stock/style-spec.ts b/__tests__/unit/plots/stock/style-spec.ts
@@ -3,14 +3,14 @@ import { createDiv } from '../../../utils/dom';
 import { kdata } from '../../../data/stock';
 
 describe('Stock', () => {
-  it('set style', () => {
+  it('set stock style', () => {
     const k = new Stock(createDiv('x*y'), {
       width: 400,
       height: 500,
       data: kdata,
       xField: 'date',
       yField: ['start', 'end', 'max', 'min'],
-      style: {
+      stockStyle: {
         stroke: 'red',
         lineWidth: 2,
       },

diff --git a/docs/api/plots/stock.en.md b/docs/api/plots/stock.en.md
@@ -40,7 +40,7 @@ Configure the data source. The data source is a collection of objects. For examp
 ];
 ```
 
-#### xField 
+#### xField
 
 <description>**required** _string_</description>
 
@@ -51,7 +51,7 @@ Configure the data source. The data source is a collection of objects. For examp
 - 时间戳，如 1436237115500；
 - 时间字符串： '2015-03-01'，'2015-03-01 12:01:40'，'2015/01/05'，'2015-03-01T16:00:00.000Z'。
 
-#### yField 
+#### yField
 
 <description>**required** _array string_</description>
 
@@ -83,7 +83,7 @@ Falling color configuration.
 
 <playground path="more-plots/stock/demo/custom-color.ts" rid="custom-color"></playground>
 
-#### style
+#### stockStyle
 
 <description>**optional** _StyleAttr | Function_</description>
 

diff --git a/docs/api/plots/stock.zh.md b/docs/api/plots/stock.zh.md
@@ -40,7 +40,7 @@ order: 18
 ];
 ```
 
-#### xField 
+#### xField
 
 <description>**required** _string_</description>
 
@@ -51,7 +51,7 @@ order: 18
 - 时间戳，如 1436237115500；
 - 时间字符串： '2015-03-01'，'2015-03-01 12:01:40'，'2015/01/05'，'2015-03-01T16:00:00.000Z'。
 
-#### yField 
+#### yField
 
 <description>**required** _array string_</description>
 
@@ -83,7 +83,7 @@ order: 18
 
 <playground path="more-plots/stock/demo/custom-color.ts" rid="custom-color"></playground>
 
-#### style
+#### stockStyle
 
 <description>**可选** _StyleAttr | Function_</description>
 

diff --git a/examples/more-plots/stock/demo/custom-style.ts b/examples/more-plots/stock/demo/custom-style.ts
@@ -11,7 +11,7 @@ fetch('https://gw.alipayobjects.com/os/antfincdn/qtQ9nYfYJe/stock-data.json')
         // 关闭 tooltip 悬浮内容
         showContent: false,
       },
-      style: {
+      stockStyle: {
         stroke: '#666',
         lineWidth: 0.5,
       },

diff --git a/src/plots/stock/adaptor.ts b/src/plots/stock/adaptor.ts
@@ -16,7 +16,7 @@ function geometry(params: Params<StockOptions>): Params<StockOptions> {
   const { chart, options } = params;
   const { yField } = options;
 
-  const { data, risingFill, fallingFill, tooltip, style } = options;
+  const { data, risingFill, fallingFill, tooltip, stockStyle } = options;
 
   chart.data(getStockData(data, yField));
 
@@ -31,7 +31,7 @@ function geometry(params: Params<StockOptions>): Params<StockOptions> {
         schema: {
           shape: 'candle',
           color: [risingFill, fallingFill],
-          style,
+          style: stockStyle,
         },
         yField: Y_FIELD,
         seriesField: TREND_FIELD,

diff --git a/src/plots/stock/types.ts b/src/plots/stock/types.ts
@@ -14,5 +14,5 @@ export interface StockOptions extends Options {
   readonly fallingFill?: string;
 
   /** 样式配置 */
-  readonly style?: StyleAttr;
+  readonly stockStyle?: StyleAttr;
 }