@visactor/vseed 0.0.36 → 0.0.38

package/dist/types/chartType/area/area.d.ts

@@ -1,12 +1,12 @@
 import type { Locale } from '../../i18n';
 import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, AnnotationVerticalLine, AreaStyle, BackgroundColor, Color, Dataset, Dimensions, Label, Legend, LineStyle, PointStyle, Theme, Tooltip, XBandAxis, YLinearAxis, CrosshairLine, MeasureTree, Sort, SortLegend } from '../../properties';
 /**
- * 面积图类型定义
  * @description 面积图, 适用于展示数据随时间变化的趋势及累积关系, 通过填充区域增强数据对比. X轴为类目轴(分类数据), Y轴为数值轴(连续数据).
  * 适用场景:
  * - 展示单一数据系列的趋势变化
  * - 强调总量随时间的累积效果
  * - 对比多个数据系列的总量差异
+ * @warning
  * 数据要求:
  * - 至少1个指标字段（度量）
  * - 第一个维度字段映射到X轴，其余维度字段会与指标名称(存在多个指标时)合并, 作为图例项展示.
@@ -14,13 +14,22 @@ import type { AnnotationArea, AnnotationHorizontalLine, AnnotationPoint, Annotat
  * 默认开启的功能:
  * - 模块开启堆叠
  * - 默认开启图例、坐标轴、区域填充、数据标签、提示信息
+ * @recommend
+ * - 推荐字段配置: `1`个指标, `2`个维度
+ * - 支持数据重塑: 至少`1`个指标, `0`个维度
  */
 export interface Area {
     /**
      * 面积图
      * @description 面积图，展示数据趋势及累积关系的图表类型
      * @type {'area'}
-     * @example 'area'
+     * @example
+     * ```js {2}
+     * {
+     *   chartType: 'area',
+     *   dataset: [{month:'1月', value:100}, {month:'2月', value:150}, {month:'3月', value:120}],
+     * }
+     * ```
      */
     chartType: 'area';
     /**