From 232fe60210f8c5d4996bcdf65c575e433f4a864c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ivan=2EGuo-=E9=83=AD=E4=B8=80=E5=87=A1?=
 <Ivan.Guo@fanruan.com>
Date: Mon, 15 Apr 2024 14:00:20 +0800
Subject: [PATCH] README

---
 README.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 90 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6fb3823
--- /dev/null
+++ b/README.md
@@ -0,0 +1,90 @@
+# BI6新图表接口
+
+com.finebi.provider.api.component.CustomComponentProvider
+
+com.finebi.provider.api.component.AbstractCustomComponentProvider
+
+```java
+package com.finebi.provider.api.component;
+
+import com.finebi.common.context.OperationContext;
+import com.finebi.provider.api.component.data.DataModel;
+import com.fr.common.annotations.Open;
+import com.fr.stable.fun.mark.Mutable;
+import com.fr.web.struct.AssembleComponent;
+import java.util.List;
+
+@Open
+public interface CustomComponentProvider extends Mutable {
+    String XML_TAG = "CustomComponentProvider";
+    int CURRENT_LEVEL = 1;
+
+    /**
+     * 图表名称
+     */
+    String getName();
+
+    /**
+     * 图表类型
+     */
+    String getType();
+
+    /**
+     * 图表Icon
+     */
+    String getIcon();
+
+    /**
+     * 空自定义图表提示，不写默认取 icon
+     */
+    String getPreviewIcon();
+
+    /**
+     * 编辑界面HTML
+     */
+    String getEditPageHTML(OperationContext var1);
+
+    /**
+     * 编辑组件
+     */
+    AssembleComponent editClient(OperationContext var1);
+
+    /**
+     * 预览界面HTML
+     */
+    String getPreviewPageHTML(OperationContext var1);
+
+    /**
+     * 预览组件
+     */
+    AssembleComponent previewClient(OperationContext var1);
+
+    /**
+     * 配置
+     */
+    String config();
+
+    /**
+     * 是否需要进行数据处理
+     */
+    boolean needDataProcess(CustomComponentContext var1);
+
+    /**
+     * 后端数据处理方法，needDataProcess为true时调用
+     */
+    List<DataModel> process(List<DataModel> var1, CustomComponentContext var2);
+}
+```
+
+# 代码
+
+* DEMO源码及插件: [说明](说明)
+* 0.0.1: 图表DEMO_EK: [0.0.1](说明/0.0.1)
+* 0.0.2: 图表DEMO_EK 数据处理接口: [0.0.2](说明/0.0.2)
+* 0.0.3: 图表DEMO_EK 页面刷新接口: [0.0.3](说明/0.0.3)
+* 0.0.4: 图表DEMO_EK 保存配置接口: [0.0.4](说明/0.0.4)
+* 0.0.5: 图表DEMO_EK Click联动: [0.0.5](说明/0.0.5)
+* 0.0.6: 图表DEMO_EK dimensionSelected、pointSelected联动: [0.0.6](说明/0.0.6)
+
+
+