From 683acd9a5da5f25762922a9226dfc2881480c017 Mon Sep 17 00:00:00 2001
From: zhangyu <zhangyu@geedgenetworks.com>
Date: Fri, 24 May 2024 10:41:35 +0800
Subject: [PATCH] =?UTF-8?q?fix:=20=E8=B0=83=E6=95=B4chart-docs=E7=9B=AE?=
 =?UTF-8?q?=E5=BD=95=E7=BB=93=E6=9E=84=E4=BB=A5=E5=8F=8A=E6=B7=BB=E5=8A=A0?=
 =?UTF-8?q?chart=E7=BB=84=E4=BB=B6=20=E4=BB=A5=E5=8F=8Achartheader?=
 =?UTF-8?q?=E7=BB=84=E4=BB=B6=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 nezha-docs/docs/.vitepress/sidebar.js         | 22 +++++++-
 nezha-docs/src/__docs__/index.en-US.md        |  5 +-
 nezha-docs/src/__docs__/index.zh-CN.md        |  5 +-
 nezha-docs/src/chart/chart.vue                | 56 +++++++++++++++++++
 .../chartTimeSeries/chartTimeSeries.vue       | 17 ++++++
 .../chart/chartChild/chartTimeSeries/demo.vue |  9 +++
 .../chartChild/chartTimeSeries/index.en-US.md | 10 ++++
 .../chartChild/chartTimeSeries/index.zh-CN.md | 10 ++++
 nezha-docs/src/chart/demo.vue                 |  9 +++
 nezha-docs/src/chart/index.en-US.md           | 34 +++++++++++
 nezha-docs/src/chart/index.zh-CN.md           | 34 +++++++++++
 nezha-docs/src/chartHeader/chartHeader.vue    | 39 +++++++++++++
 nezha-docs/src/chartHeader/demo.vue           |  9 +++
 nezha-docs/src/chartHeader/index.en-US.md     | 17 ++++++
 nezha-docs/src/chartHeader/index.zh-CN.md     | 17 ++++++
 nezha-docs/src/chartList/index.en-US.md       |  9 +++
 nezha-docs/src/chartList/index.zh-CN.md       |  9 +++
 nezha-docs/src/panelChart/index.en-US.md      | 10 ++++
 nezha-docs/src/panelChart/index.zh-CN.md      |  9 +++
 19 files changed, 325 insertions(+), 5 deletions(-)
 create mode 100644 nezha-docs/src/chart/chart.vue
 create mode 100644 nezha-docs/src/chart/chartChild/chartTimeSeries/chartTimeSeries.vue
 create mode 100644 nezha-docs/src/chart/chartChild/chartTimeSeries/demo.vue
 create mode 100644 nezha-docs/src/chart/chartChild/chartTimeSeries/index.en-US.md
 create mode 100644 nezha-docs/src/chart/chartChild/chartTimeSeries/index.zh-CN.md
 create mode 100644 nezha-docs/src/chart/demo.vue
 create mode 100644 nezha-docs/src/chart/index.en-US.md
 create mode 100644 nezha-docs/src/chart/index.zh-CN.md
 create mode 100644 nezha-docs/src/chartHeader/chartHeader.vue
 create mode 100644 nezha-docs/src/chartHeader/demo.vue
 create mode 100644 nezha-docs/src/chartHeader/index.en-US.md
 create mode 100644 nezha-docs/src/chartHeader/index.zh-CN.md

diff --git a/nezha-docs/docs/.vitepress/sidebar.js b/nezha-docs/docs/.vitepress/sidebar.js
index b0c8b4b9e..11dd06901 100644
--- a/nezha-docs/docs/.vitepress/sidebar.js
+++ b/nezha-docs/docs/.vitepress/sidebar.js
@@ -17,8 +17,26 @@ export const sidebar = {
     {
       text: '组件',
       items: [
-        { text: 'chartList', link: '/chartList' },
-        { text: 'panelChart', link: '/panelChart' }
+        {
+          text: 'chartList',
+          link: '/chartList',
+          items: [
+            { text: 'chartHeader', link: '/chartHeader' },
+            {
+              text: 'panelChart',
+              link: '/panelChart',
+              items: [
+                {
+                  text: 'chart',
+                  link: '/chart',
+                  items: [
+                    {text: 'chartTimeSeries', link: '/chartTimeSeries'}
+                  ]
+                }
+              ]
+            },
+          ]
+        },
       ],
     }
   ],
diff --git a/nezha-docs/src/__docs__/index.en-US.md b/nezha-docs/src/__docs__/index.en-US.md
index 1eede05e2..b188d1201 100644
--- a/nezha-docs/src/__docs__/index.en-US.md
+++ b/nezha-docs/src/__docs__/index.en-US.md
@@ -4,5 +4,6 @@ map:
 ---
 
 ## 简介
-
-
+1. 开发规范 https://docs.geedge.net/pages/viewpage.action?pageId=8034494
+2. 思维导图 https://docs.geedge.net/pages/viewpage.action?pageId=67209306 可以查看解压后的纯文字版Html
+3. 字体图标替换 https://docs.geedge.net/pages/viewpage.action?pageId=67214849
\ No newline at end of file
diff --git a/nezha-docs/src/__docs__/index.zh-CN.md b/nezha-docs/src/__docs__/index.zh-CN.md
index 817058603..b188d1201 100644
--- a/nezha-docs/src/__docs__/index.zh-CN.md
+++ b/nezha-docs/src/__docs__/index.zh-CN.md
@@ -3,4 +3,7 @@ map:
   path: /
 ---
 
-## 简介
\ No newline at end of file
+## 简介
+1. 开发规范 https://docs.geedge.net/pages/viewpage.action?pageId=8034494
+2. 思维导图 https://docs.geedge.net/pages/viewpage.action?pageId=67209306 可以查看解压后的纯文字版Html
+3. 字体图标替换 https://docs.geedge.net/pages/viewpage.action?pageId=67214849
\ No newline at end of file
diff --git a/nezha-docs/src/chart/chart.vue b/nezha-docs/src/chart/chart.vue
new file mode 100644
index 000000000..6a2c07e2b
--- /dev/null
+++ b/nezha-docs/src/chart/chart.vue
@@ -0,0 +1,56 @@
+<script lang="ts" setup>
+const props = withDefaults(defineProps<{
+  /**
+   * chart相关信息 主要是要里面的 id 以及 params
+   */
+  chartInfo?: {  },
+ /**
+   * chart数据
+   */
+ chartData?: {  },
+  /**
+   *  需要自定义echarts的option时传入，非必须；传入该值时仍需传对应格式的chartData
+   */
+  customChartOption?: {  },
+  /**
+   *  是否全屏
+   */
+  isFullscreen?: boolean,
+  /**
+   *  是否显示loading
+   */
+  loading?: boolean,
+  /**
+   *  是否锁定
+   */
+  panelLock?: boolean,
+  /**
+   *  是否报错
+   */
+  isError?: boolean,
+  /**
+   *  相对时间
+   */
+  multipleTime?: {},
+  /**
+   *  相差时间
+   */
+  minusTime?: {},
+  /**
+   *  但是否显示全部数据
+   */
+  showAllData?: {},
+  /**
+   *  dashboard 相关变量
+   */
+  globalVariables?: {},
+
+}>(), {
+
+})
+</script>
+
+<template>
+  <div>
+  </div>
+</template>
diff --git a/nezha-docs/src/chart/chartChild/chartTimeSeries/chartTimeSeries.vue b/nezha-docs/src/chart/chartChild/chartTimeSeries/chartTimeSeries.vue
new file mode 100644
index 000000000..713a13427
--- /dev/null
+++ b/nezha-docs/src/chart/chartChild/chartTimeSeries/chartTimeSeries.vue
@@ -0,0 +1,17 @@
+<script lang="ts" setup>
+const props = withDefaults(defineProps<{
+  /**
+   * chart相关信息 主要是要里面的 id 以及 params
+   */
+  chartInfo?: {  },
+
+
+}>(), {
+
+})
+</script>
+
+<template>
+  <div>
+  </div>
+</template>
diff --git a/nezha-docs/src/chart/chartChild/chartTimeSeries/demo.vue b/nezha-docs/src/chart/chartChild/chartTimeSeries/demo.vue
new file mode 100644
index 000000000..bc8216a9c
--- /dev/null
+++ b/nezha-docs/src/chart/chartChild/chartTimeSeries/demo.vue
@@ -0,0 +1,9 @@
+<script lang="ts" setup>
+</script>
+<template>
+  <div></div>
+</template>
+
+<style>
+
+</style>
diff --git a/nezha-docs/src/chart/chartChild/chartTimeSeries/index.en-US.md b/nezha-docs/src/chart/chartChild/chartTimeSeries/index.en-US.md
new file mode 100644
index 000000000..925cf7a35
--- /dev/null
+++ b/nezha-docs/src/chart/chartChild/chartTimeSeries/index.en-US.md
@@ -0,0 +1,10 @@
+---
+map:
+  path: /chartTimeSeries
+---
+时序图 使用了 uplot重构 uplot参考链接 https://github.com/leeoniya/uPlot
+遇到相关问题 可以去他的demo里面查看 相关api 也可以在他的源码里看到
+# 关联组件
+1. chart-legend legend 相关组件
+
+<API src="./chartTimeSeries.vue" lang="en"></API>
diff --git a/nezha-docs/src/chart/chartChild/chartTimeSeries/index.zh-CN.md b/nezha-docs/src/chart/chartChild/chartTimeSeries/index.zh-CN.md
new file mode 100644
index 000000000..01d1381b1
--- /dev/null
+++ b/nezha-docs/src/chart/chartChild/chartTimeSeries/index.zh-CN.md
@@ -0,0 +1,10 @@
+---
+map:
+  path: /chartTimeSeries
+---
+时序图 使用了 uplot重构 uplot参考链接 https://github.com/leeoniya/uPlot
+遇到相关问题 可以去他的demo里面查看 相关api 也可以在他的源码里看到
+# 关联组件
+1. chart-legend legend 相关组件
+
+<API src="./chartTimeSeries.vue" lang="zh"></API>
diff --git a/nezha-docs/src/chart/demo.vue b/nezha-docs/src/chart/demo.vue
new file mode 100644
index 000000000..bc8216a9c
--- /dev/null
+++ b/nezha-docs/src/chart/demo.vue
@@ -0,0 +1,9 @@
+<script lang="ts" setup>
+</script>
+<template>
+  <div></div>
+</template>
+
+<style>
+
+</style>
diff --git a/nezha-docs/src/chart/index.en-US.md b/nezha-docs/src/chart/index.en-US.md
new file mode 100644
index 000000000..098b749b7
--- /dev/null
+++ b/nezha-docs/src/chart/index.en-US.md
@@ -0,0 +1,34 @@
+---
+map:
+  path: /chart
+---
+# 关联组件
+1. chartTimeSeries 时序图
+2. chartAutotopology 自动播放project topology
+3. chartBar  柱状图
+4. chartClock  时钟
+5. chartDiagram topo图
+6. chartEndpointInfo  endpoint详情 关联 dashboard
+7. chartGauge
+8. chartGroup 组
+9. chartLog  日志
+10. chartNoData 没有数据
+11. chartPie  饼图
+12. chartDoughnut
+13. chartRose 玫瑰图
+14. chartStat 单值图
+15. chartTable 表格
+16. chartText  文本
+17.  chartAssetInfo asset详情 关联 dashboard
+18. chartTreemap 树状图
+19. chartUrl 链接
+20. chartHexagonD3 蜂窝图
+21. chartMap 地图
+22. chartTopology 弃用
+23. chartBubble 气泡图
+24. chartRank 排行榜
+25. chartSankey 桑葚图
+26. chartFunnel 漏斗图
+
+
+<API src="./chart.vue" lang="en"></API>
diff --git a/nezha-docs/src/chart/index.zh-CN.md b/nezha-docs/src/chart/index.zh-CN.md
new file mode 100644
index 000000000..217f1a432
--- /dev/null
+++ b/nezha-docs/src/chart/index.zh-CN.md
@@ -0,0 +1,34 @@
+---
+map:
+  path: /chart
+---
+# 关联组件
+1. chartTimeSeries 时序图
+2. chartAutotopology 自动播放project topology
+3. chartBar  柱状图
+4. chartClock  时钟
+5. chartDiagram topo图
+6. chartEndpointInfo  endpoint详情 关联 dashboard
+7. chartGauge 
+8. chartGroup 组
+9. chartLog  日志
+10. chartNoData 没有数据
+11. chartPie  饼图
+12. chartDoughnut 
+13. chartRose 玫瑰图
+14. chartStat 单值图
+15. chartTable 表格
+16. chartText  文本
+17.  chartAssetInfo asset详情 关联 dashboard
+18. chartTreemap 树状图
+19. chartUrl 链接
+20. chartHexagonD3 蜂窝图
+21. chartMap 地图
+22. chartTopology 弃用
+23. chartBubble 气泡图
+24. chartRank 排行榜
+25. chartSankey 桑葚图
+26. chartFunnel 漏斗图
+
+
+<API src="./chart.vue" lang="zh"></API>
diff --git a/nezha-docs/src/chartHeader/chartHeader.vue b/nezha-docs/src/chartHeader/chartHeader.vue
new file mode 100644
index 000000000..7afec817a
--- /dev/null
+++ b/nezha-docs/src/chartHeader/chartHeader.vue
@@ -0,0 +1,39 @@
+<script lang="ts" setup>
+const props = withDefaults(defineProps<{
+  /**
+   * chart相关信息 如id 位置等
+   */
+  chartInfo?: string,
+  /**
+   * 是否报错
+   */
+  isError?: boolean,
+  /**
+   * chart相关数据 若报错 取 item.error
+   */
+  chartData?: {  },
+  /**
+   * 是否显示全部数据
+   */
+  showAllData?: boolean,
+  /**
+   * 全部数据的长度
+   */
+  allDataLength?: number,
+  /**
+   * 是否为快照
+   */
+  isExportHtml?: boolean,
+  /**
+   * 是否为预览
+   */
+  isPreview?: boolean,
+}>(), {
+
+})
+</script>
+
+<template>
+  <div>
+  </div>
+</template>
diff --git a/nezha-docs/src/chartHeader/demo.vue b/nezha-docs/src/chartHeader/demo.vue
new file mode 100644
index 000000000..bc8216a9c
--- /dev/null
+++ b/nezha-docs/src/chartHeader/demo.vue
@@ -0,0 +1,9 @@
+<script lang="ts" setup>
+</script>
+<template>
+  <div></div>
+</template>
+
+<style>
+
+</style>
diff --git a/nezha-docs/src/chartHeader/index.en-US.md b/nezha-docs/src/chartHeader/index.en-US.md
new file mode 100644
index 000000000..b082e6aa6
--- /dev/null
+++ b/nezha-docs/src/chartHeader/index.en-US.md
@@ -0,0 +1,17 @@
+---
+map:
+  path: /chartHeader
+---
+
+ChartScreenHeader props 跟chartHeader是一样的 不一样的只是右侧的工具菜单
+
+# 示例代码
+```
+ <chart-header>
+ </chart-header>
+```
+```
+ <chart-screen-header>
+ </chart-screen-header>
+```
+<API src="./chartHeader.vue" lang="en"></API>
diff --git a/nezha-docs/src/chartHeader/index.zh-CN.md b/nezha-docs/src/chartHeader/index.zh-CN.md
new file mode 100644
index 000000000..0ee478193
--- /dev/null
+++ b/nezha-docs/src/chartHeader/index.zh-CN.md
@@ -0,0 +1,17 @@
+---
+map:
+  path: /chartHeader
+---
+
+ChartScreenHeader props 跟chartHeader是一样的 不一样的只是右侧的工具菜单
+
+# 示例代码
+```
+ <chart-header>
+ </chart-header>
+```
+```
+ <chart-screen-header>
+ </chart-screen-header>
+```
+<API src="./chartHeader.vue" lang="zh"></API>
diff --git a/nezha-docs/src/chartList/index.en-US.md b/nezha-docs/src/chartList/index.en-US.md
index a7032171c..498d6f4ac 100644
--- a/nezha-docs/src/chartList/index.en-US.md
+++ b/nezha-docs/src/chartList/index.en-US.md
@@ -7,5 +7,14 @@ map:
 2. grid-item 拖拽组件 该组件以拉取到本地 修改了高度不支持小数的问题
 3. panel-chart 图表组件实例
 
+# 示例代码
+```
+<grid-layout>
+    <grid-item v-for="item in arr">
+       <panel-chart />    
+    </grid-item>
+</grid-layout>
+```
+
 
 <API src="./chartList.vue" lang="en"></API>
diff --git a/nezha-docs/src/chartList/index.zh-CN.md b/nezha-docs/src/chartList/index.zh-CN.md
index 83c54498b..0c25bf520 100644
--- a/nezha-docs/src/chartList/index.zh-CN.md
+++ b/nezha-docs/src/chartList/index.zh-CN.md
@@ -7,5 +7,14 @@ map:
 2. grid-item 拖拽组件 该组件以拉取到本地 修改了高度不支持小数的问题
 3. panel-chart 图表组件实例
 
+# 示例代码
+```
+<grid-layout>
+    <grid-item v-for="item in arr">
+       <panel-chart />    
+    </grid-item>
+</grid-layout>
+```
+
 
 <API src="./chartList.vue" lang="zh"></API>
diff --git a/nezha-docs/src/panelChart/index.en-US.md b/nezha-docs/src/panelChart/index.en-US.md
index a2754c69c..2d1b32b4b 100644
--- a/nezha-docs/src/panelChart/index.en-US.md
+++ b/nezha-docs/src/panelChart/index.en-US.md
@@ -8,4 +8,14 @@ map:
 3. ChartScreenHeader 全屏chart-header相关设置
 
 
+
+# 示例代码
+```
+ <div>
+    <chart-header v-if= '!isFullscreen' />
+    <chart-screen-header v-if= 'isFullscreen' />
+    <chart />
+ </div>
+```
+
 <API src="./panelChart.vue" lang="zh"></API>
diff --git a/nezha-docs/src/panelChart/index.zh-CN.md b/nezha-docs/src/panelChart/index.zh-CN.md
index a2754c69c..5f05d421f 100644
--- a/nezha-docs/src/panelChart/index.zh-CN.md
+++ b/nezha-docs/src/panelChart/index.zh-CN.md
@@ -8,4 +8,13 @@ map:
 3. ChartScreenHeader 全屏chart-header相关设置
 
 
+# 示例代码
+```
+ <div>
+    <chart-header v-if= '!isFullscreen' />
+    <chart-screen-header v-if= 'isFullscreen' />
+    <chart />
+ </div>
+```
+
 <API src="./panelChart.vue" lang="zh"></API>