refactor(word-cloud): 优化变量命名

antvis · Oct 27, 2020 · b5993b7 · b5993b7
1 parent daee178
commit b5993b7
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 10 deletions.
diff --git a/docs/manual/plots/word-cloud.en.md b/docs/manual/plots/word-cloud.en.md
@@ -61,7 +61,7 @@ order: 0
 
 默认配置： _'archimedean'_
 
-#### customPlacement
+#### placementStrategy
 
 **可选**, _function_
 

diff --git a/docs/manual/plots/word-cloud.zh.md b/docs/manual/plots/word-cloud.zh.md
@@ -61,7 +61,7 @@ order: 0
 
 默认配置： _'archimedean'_
 
-#### customPlacement
+#### placementStrategy
 
 **可选**, _function_
 

diff --git a/examples/word-cloud/basic/API.en.md b/examples/word-cloud/basic/API.en.md
@@ -56,7 +56,7 @@
 
 默认配置： _'archimedean'_
 
-#### customPlacement
+#### placementStrategy
 
 **可选**, _function_
 

diff --git a/examples/word-cloud/basic/API.zh.md b/examples/word-cloud/basic/API.zh.md
@@ -56,7 +56,7 @@
 
 默认配置： _'archimedean'_
 
-#### customPlacement
+#### placementStrategy
 
 **可选**, _function_
 

diff --git a/examples/word-cloud/basic/demo/meta.json b/examples/word-cloud/basic/demo/meta.json
@@ -61,7 +61,7 @@
       "screenshot": "https://gw.alipayobjects.com/mdn/rms_f5c722/afts/img/A*id4CSZIMCtsAAAAAAAAAAABkARQnAQ"
     },
     {
-      "filename": "custom-placement.ts",
+      "filename": "placement-strategy.ts",
       "title": {
         "zh": "词云图-自定义每个词语位置",
         "en": "Word Cloud chart - custom placement"

diff --git a/...word-cloud/basic/demo/custom-placement.ts → ...rd-cloud/basic/demo/placement-strategy.ts b/...word-cloud/basic/demo/custom-placement.ts → ...rd-cloud/basic/demo/placement-strategy.ts
@@ -14,7 +14,7 @@ const wordCloud = new WordCloud('container', {
     fontSize: 16,
     rotation: 0,
   },
-  customPlacement(word, index, words) {
+  placementStrategy(word, index, words) {
     const width = this.ele.clientWidth;
     const height = this.ele.clientHeight;
     const length = words.length;

diff --git a/src/plots/word-cloud/types.ts b/src/plots/word-cloud/types.ts
@@ -97,6 +97,6 @@ export interface WordCloudOptions extends Options {
    * 自定义每个词语的坐标。
    * 注意：使用该选项时，应配合 `wordStyle` 中的其它选项同时使用。
    */
-  readonly customPlacement?: (word: Word, index?: number, words?: Word[]) => { x: number; y: number };
+  readonly placementStrategy?: (word: Word, index?: number, words?: Word[]) => Partial<Tag> & { x: number; y: number };
   readonly wordStyle?: WordStyle;
 }
diff --git a/src/plots/word-cloud/utils.ts b/src/plots/word-cloud/utils.ts
@@ -22,7 +22,7 @@ export function transform(params: Params<WordCloudOptions>): Tag[] {
     timeInterval,
     random,
     spiral,
-    customPlacement,
+    placementStrategy,
   } = rawOptions;
   if (!data || !data.length) {
     return [];
@@ -56,7 +56,7 @@ export function transform(params: Params<WordCloudOptions>): Tag[] {
   };
 
   // 自定义布局函数
-  if (isFunction(customPlacement)) {
+  if (isFunction(placementStrategy)) {
     return words.map((word: Word, index: number, words: Word[]) => ({
       ...word,
       hasText: !!word.text,
@@ -65,7 +65,7 @@ export function transform(params: Params<WordCloudOptions>): Tag[] {
       rotate: functor(options.rotate)(word, index, words),
       size: functor(options.fontSize)(word, index, words),
       style: 'normal',
-      ...customPlacement.call(chart, word, index, words),
+      ...placementStrategy.call(chart, word, index, words),
     }));
   }