docs: 给复合图层文档分类 (#245)

antvis · Nov 10, 2022 · fc59965 · fc59965
1 parent 1e2d173
commit fc59965
Show file tree

Hide file tree

Showing 79 changed files with 214 additions and 206 deletions.
diff --git a/website/docs/api/base-layers/heatmap-layer.en.md b/website/docs/api/base-layers/heatmap-layer.en.md
@@ -0,0 +1,6 @@
+---
+title: HeatmapLayer
+order: 5
+---
+
+`markdown:docs/api/base-layers/heatmap-layer.zh.md`
diff --git a/website/docs/api/base-layers/heatmap-layer.zh.md b/website/docs/api/base-layers/heatmap-layer.zh.md
@@ -0,0 +1,38 @@
+---
+title: 热力图层 - HeatmapLayer
+order: 5
+---
+
+<tag color="blue" text="Core Layer">Core Layer</tag>
+
+`HeatmapLayer` 是基于 [L7-HeatmapLayer](https://l7.antv.vision/zh/docs/api/heatmap_layer/heatmap) 封装的配置式 API。
+
+```ts
+new HeatmapLayer(options: HeatmapLayerOptions)
+```
+
+## 一、配置
+
+`markdown:docs/common/base-layers/base-common/options.zh.md`
+
+`markdown:docs/common/base-layers/point-layer/source.zh.md`
+
+`markdown:docs/common/base-layers/heatmap-layer/shape.zh.md`
+
+`markdown:docs/common/attribute/color.zh.md`
+
+`markdown:docs/common/attribute/size.zh.md`
+
+`markdown:docs/common/base-layers/heatmap-layer/style.zh.md`
+
+## 二、属性
+
+`markdown:docs/common/base-layers/base-common/attribute.zh.md`
+
+## 三、方法
+
+`markdown:docs/common/base-layers/base-common/method.zh.md`
+
+## 四、事件
+
+`markdown:docs/common/base-layers/base-common/event.zh.md`
diff --git a/website/docs/api/base-layers/image-layer.en.md b/website/docs/api/base-layers/image-layer.en.md
@@ -0,0 +1,6 @@
+---
+title: ImageLayer
+order: 6
+---
+
+`markdown:docs/api/base-layers/image-layer.zh.md`
diff --git a/...cs/api/composite-layers/image-layer.zh.md → ...te/docs/api/base-layers/image-layer.zh.md b/...cs/api/composite-layers/image-layer.zh.md → ...te/docs/api/base-layers/image-layer.zh.md
@@ -66,18 +66,18 @@ new ImageLayer(options: ImageLayerOptions)
 - subtractive：相减模式
 - max：最大值
 
-`markdown:docs/common/composite-layers/image-layer/source.zh.md`
+`markdown:docs/common/base-layers/image-layer/source.zh.md`
 
-`markdown:docs/common/composite-layers/image-layer/style.zh.md`
+`markdown:docs/common/base-layers/image-layer/style.zh.md`
 
 ## 二、属性
 
-`markdown:docs/common/composite-layers/core-common/attribute.zh.md`
+`markdown:docs/common/base-layers/base-common/attribute.zh.md`
 
 ## 三、方法
 
-`markdown:docs/common/composite-layers/core-common/method.zh.md`
+`markdown:docs/common/base-layers/base-common/method.zh.md`
 
 ## 四、事件
 
-`markdown:docs/common/composite-layers/core-common/event.zh.md`
+`markdown:docs/common/base-layers/base-common/event.zh.md`
diff --git a/website/docs/api/base-layers/line-layer.en.md b/website/docs/api/base-layers/line-layer.en.md
@@ -0,0 +1,6 @@
+---
+title: LineLayer
+order: 1
+---
+
+`markdown:docs/api/base-layers/line-layer.zh.md`
diff --git a/website/docs/api/base-layers/line-layer.zh.md b/website/docs/api/base-layers/line-layer.zh.md
@@ -0,0 +1,42 @@
+---
+title: 线图层 - LineLayer
+order: 1
+---
+
+<tag color="blue" text="Core Layer">Core Layer</tag>
+
+`LineLayer` 是基于 [L7-LineLayer](https://l7.antv.vision/zh/docs/api/line_layer/linelayer) 封装的配置式 API。
+
+```ts
+new LineLayer(options: LineLayerOptions)
+```
+
+## 一、配置
+
+`markdown:docs/common/base-layers/base-common/options.zh.md`
+
+`markdown:docs/common/base-layers/line-layer/source.zh.md`
+
+`markdown:docs/common/base-layers/line-layer/shape.zh.md`
+
+`markdown:docs/common/attribute/color.zh.md`
+
+`markdown:docs/common/attribute/size.zh.md`
+
+`markdown:docs/common/base-layers/line-layer/style.zh.md`
+
+`markdown:docs/common/attribute/state.zh.md`
+
+`markdown:docs/common/base-layers/line-layer/animate.zh.md`
+
+## 二、属性
+
+`markdown:docs/common/base-layers/base-common/attribute.zh.md`
+
+## 三、方法
+
+`markdown:docs/common/base-layers/base-common/method.zh.md`
+
+## 四、事件
+
+`markdown:docs/common/base-layers/base-common/event.zh.md`
diff --git a/website/docs/api/base-layers/point-layer.en.md b/website/docs/api/base-layers/point-layer.en.md
@@ -0,0 +1,6 @@
+---
+title: PointLayer
+order: 0
+---
+
+`markdown:docs/api/base-layers/point-layer.zh.md`
diff --git a/website/docs/api/base-layers/point-layer.zh.md b/website/docs/api/base-layers/point-layer.zh.md
@@ -0,0 +1,42 @@
+---
+title: 点图层 - PointLayer
+order: 0
+---
+
+<tag color="blue" text="Core Layer">Core Layer</tag>
+
+`PointLayer` 是基于 [L7-PointLayer](https://l7.antv.vision/zh/docs/api/point_layer/pointlayer) 封装的配置式 API。
+
+```ts
+new PointLayer(options: PointLayerOptions)
+```
+
+## 一、配置
+
+`markdown:docs/common/base-layers/base-common/options.zh.md`
+
+`markdown:docs/common/base-layers/point-layer/source.zh.md`
+
+`markdown:docs/common/base-layers/point-layer/shape.zh.md`
+
+`markdown:docs/common/attribute/color.zh.md`
+
+`markdown:docs/common/attribute/size.zh.md`
+
+`markdown:docs/common/base-layers/point-layer/style.zh.md`
+
+`markdown:docs/common/attribute/state.zh.md`
+
+`markdown:docs/common/base-layers/point-layer/animate.zh.md`
+
+## 二、属性
+
+`markdown:docs/common/base-layers/base-common/attribute.zh.md`
+
+## 三、方法
+
+`markdown:docs/common/base-layers/base-common/method.zh.md`
+
+## 四、事件
+
+`markdown:docs/common/base-layers/base-common/event.zh.md`
diff --git a/website/docs/api/base-layers/polygon-layer.en.md b/website/docs/api/base-layers/polygon-layer.en.md
@@ -0,0 +1,6 @@
+---
+title: PolygonLayer
+order: 3
+---
+
+`markdown:docs/api/base-layers/polygon-layer.zh.md`
diff --git a/.../api/composite-layers/polygon-layer.zh.md → .../docs/api/base-layers/polygon-layer.zh.md b/.../api/composite-layers/polygon-layer.zh.md → .../docs/api/base-layers/polygon-layer.zh.md
@@ -13,28 +13,28 @@ new PolygonLayer(options: PolygonLayerOptions)
 
 ## 一、配置
 
-`markdown:docs/common/composite-layers/core-common/options.zh.md`
+`markdown:docs/common/base-layers/base-common/options.zh.md`
 
-`markdown:docs/common/composite-layers/polygon-layer/source.zh.md`
+`markdown:docs/common/base-layers/polygon-layer/source.zh.md`
 
-`markdown:docs/common/composite-layers/polygon-layer/shape.zh.md`
+`markdown:docs/common/base-layers/polygon-layer/shape.zh.md`
 
 `markdown:docs/common/attribute/color.zh.md`
 
 `markdown:docs/common/attribute/size.zh.md`
 
-`markdown:docs/common/composite-layers/polygon-layer/style.zh.md`
+`markdown:docs/common/base-layers/polygon-layer/style.zh.md`
 
 `markdown:docs/common/attribute/state.zh.md`
 
 ## 二、属性
 
-`markdown:docs/common/composite-layers/core-common/attribute.zh.md`
+`markdown:docs/common/base-layers/base-common/attribute.zh.md`
 
 ## 三、方法
 
-`markdown:docs/common/composite-layers/core-common/method.zh.md`
+`markdown:docs/common/base-layers/base-common/method.zh.md`
 
 ## 四、事件
 
-`markdown:docs/common/composite-layers/core-common/event.zh.md`
+`markdown:docs/common/base-layers/base-common/event.zh.md`
diff --git a/website/docs/api/base-layers/raster-layer.en.md b/website/docs/api/base-layers/raster-layer.en.md
@@ -0,0 +1,6 @@
+---
+title: RasterLayer
+order: 7
+---
+
+`markdown:docs/api/base-layers/raster-layer.zh.md`
diff --git a/...s/api/composite-layers/raster-layer.zh.md → ...e/docs/api/base-layers/raster-layer.zh.md b/...s/api/composite-layers/raster-layer.zh.md → ...e/docs/api/base-layers/raster-layer.zh.md
@@ -66,18 +66,18 @@ new RasterLayer(options: RasterLayerOptions)
 - subtractive：相减模式
 - max：最大值
 
-`markdown:docs/common/composite-layers/raster-layer/source.zh.md`
+`markdown:docs/common/base-layers/raster-layer/source.zh.md`
 
-`markdown:docs/common/composite-layers/raster-layer/style.zh.md`
+`markdown:docs/common/base-layers/raster-layer/style.zh.md`
 
 ## 二、属性
 
-`markdown:docs/common/composite-layers/core-common/attribute.zh.md`
+`markdown:docs/common/base-layers/base-common/attribute.zh.md`
 
 ## 三、方法
 
-`markdown:docs/common/composite-layers/core-common/method.zh.md`
+`markdown:docs/common/base-layers/base-common/method.zh.md`
 
 ## 四、事件
 
-`markdown:docs/common/composite-layers/core-common/event.zh.md`
+`markdown:docs/common/base-layers/base-common/event.zh.md`
diff --git a/website/docs/api/base-layers/text-layer.en.md b/website/docs/api/base-layers/text-layer.en.md
@@ -0,0 +1,6 @@
+---
+title: 文本图层 - TextLayer
+order: 4
+---
+
+`markdown:docs/api/base-layers/text-layer.zh.md`
diff --git a/...ocs/api/composite-layers/text-layer.zh.md → ...ite/docs/api/base-layers/text-layer.zh.md b/...ocs/api/composite-layers/text-layer.zh.md → ...ite/docs/api/base-layers/text-layer.zh.md
@@ -13,9 +13,9 @@ new TextLayer(options: TextLayerOptions)
 
 ## 一、配置
 
-`markdown:docs/common/composite-layers/core-common/options.zh.md`
+`markdown:docs/common/base-layers/base-common/options.zh.md`
 
-`markdown:docs/common/composite-layers/point-layer/source.zh.md`
+`markdown:docs/common/base-layers/point-layer/source.zh.md`
 
 ### `options.`field
 
@@ -25,18 +25,18 @@ new TextLayer(options: TextLayerOptions)
 
 ### `options.`style
 
-`markdown:docs/common/composite-layers/text-layer/style.zh.md`
+`markdown:docs/common/base-layers/text-layer/style.zh.md`
 
 `markdown:docs/common/attribute/state.zh.md`
 
 ## 二、属性
 
-`markdown:docs/common/composite-layers/core-common/attribute.zh.md`
+`markdown:docs/common/base-layers/base-common/attribute.zh.md`
 
 ## 三、方法
 
-`markdown:docs/common/composite-layers/core-common/method.zh.md`
+`markdown:docs/common/base-layers/base-common/method.zh.md`
 
 ## 四、事件
 
-`markdown:docs/common/composite-layers/core-common/event.zh.md`
+`markdown:docs/common/base-layers/base-common/event.zh.md`
diff --git a/website/docs/api/composite-layers/bubble-layer.en.md b/website/docs/api/composite-layers/bubble-layer.en.md
@@ -1,6 +1,6 @@
 ---
 title: BubbleLayer
-order: 8
+order: 0
 ---
 
 `markdown:docs/api/composite-layers/bubble-layer.zh.md`
diff --git a/website/docs/api/composite-layers/bubble-layer.zh.md b/website/docs/api/composite-layers/bubble-layer.zh.md
@@ -1,6 +1,6 @@
 ---
 title: 气泡图层 - BubbleLayer
-order: 8
+order: 0
 ---
 
 <tag color="cyan" text="Composite Layer">Composite Layer</tag>
@@ -11,7 +11,7 @@ order: 8
 
 `markdown:docs/common/composite-layers/composite-common/options.zh.md`
 
-`markdown:docs/common/composite-layers/point-layer/source.zh.md`
+`markdown:docs/common/base-layers/point-layer/source.zh.md`
 
 ### `options.`radius
 
@@ -171,7 +171,7 @@ order: 8
 
 #### `label.`style
 
-标签样式详细配置见 [TextLayerStyleOptions](/zh/docs/api/composite-layers/text-layer#code-classlanguage-textoptionscodestyle)。
+标签样式详细配置见 [TextLayerStyleOptions](/zh/docs/api/base-layers/text-layer#code-classlanguage-textoptionscodestyle)。
 
 ### `options.`state
 

diff --git a/website/docs/api/composite-layers/choropleth-layer.en.md b/website/docs/api/composite-layers/choropleth-layer.en.md
@@ -1,6 +1,6 @@
 ---
 title: ChoroplethLayer
-order: 9
+order: 1
 ---
 
 `markdown:docs/api/composite-layers/choropleth-layer.zh.md`
diff --git a/website/docs/api/composite-layers/choropleth-layer.zh.md b/website/docs/api/composite-layers/choropleth-layer.zh.md
@@ -1,6 +1,6 @@
 ---
 title: 区域图层 - ChoroplethLayer
-order: 9
+order: 1
 ---
 
 <tag color="cyan" text="Composite Layer">Composite Layer</tag>
@@ -11,7 +11,7 @@ order: 9
 
 `markdown:docs/common/composite-layers/composite-common/options.zh.md`
 
-`markdown:docs/common/composite-layers/polygon-layer/source.zh.md`
+`markdown:docs/common/base-layers/polygon-layer/source.zh.md`
 
 ### `options.`fillColor
 
@@ -126,7 +126,7 @@ order: 9
 
 #### `label.`style
 
-标签样式详细配置见 [TextLayerStyleOptions](/zh/docs/api/composite-layers/text-layer#code-classlanguage-textoptionscodestyle)。
+标签样式详细配置见 [TextLayerStyleOptions](/zh/docs/api/base-layers/text-layer#code-classlanguage-textoptionscodestyle)。
 
 `markdown:docs/common/composite-layers/choropleth-layer/state.zh.md`
 

diff --git a/website/docs/api/composite-layers/heatmap-layer.en.md b/website/docs/api/composite-layers/heatmap-layer.en.md