【仅供内部供应商使用,不提供对外解答和培训】
10.0工程请移步:基于finekit
FineReport除了内置的图表、新特性图表插件外,还提供了第三方图表开发的API,方便进行个性化、第三方的图表开发。但是第三方图表API接口过于复杂,用户很难快速的实现并使用自己想使用的第三方新图表。
...
在原有的图表接口基础之上,对接口进行了简化和修改,让用户可以快速的写出第三方图表插件并使用。
下面介绍下重要的接口,和简单的实现(使用公共的数据配置面板,自定义数据面板参考页面底部链接demo):
| Code Block | ||||
|---|---|---|---|---|
| ||||
package com.fr.chart.fun;
import com.fr.chart.chartattr.Chart;
import com.fr.stable.fun.Level;
/**
* Created by eason on 15/4/21.
* 图表接口
*/
public interface IndependentChartProvider extends Level {
String XML_TAG = "IndependentChartProvider";
int CURRENT_API_LEVEL = 3;
/**
* 图表的国际化的名字的key
*
* @return 图表国际化的名字的key
*/
String getChartName();
/**
* 该种图表所有的图表类型,比如柱形图就有堆积柱形图,百分比堆积柱形图等等
*
* @return 所有的图表类型
*/
Chart[] getChartTypes();
/**
* 图表在web端展现时需要的JS文件
*
* @return JS文件数组
*/
String[] getRequiredJS();
/**
* JS对象名,该对象一般是一个函数,执行后会在给定的dom中绘制图表
*
* @return JS对象名
*/
String getWrapperName();
/**
* 定义在设计器里展现的图的路径
*
* @return 图的路径
*/
String getChartImagePath();
/**
* 当前接口的API等级,用于判断是否需要升级插件
*
* @return API等级
*/
int currentAPILevel();
} |
上述接口您不必实现,只需要继承实现了该接口的抽象类:AbstractIndependentChartProvider4Custom类即可,并实现里面具体的方法,示例如下:上述接口您不必实现,只需要继承实现了该接口的抽象类:AbstractIndependentChartsProvider类即可,并实现里面具体的方法,示例如下:
| Code Block | ||||
|---|---|---|---|---|
| ||||
package com.fr.plugins.democharts.commenDataPanePie; import com.fr.chart.chartattr.Chart; import com.fr.chart.fun.impl.AbstractIndependentChartsProvider; /** * Created by mengo on 16/5/11. * 自定义图表,需要继承AbstractIndependentChartProvider4Custom自定义图表,需要继承AbstractIndependentChartsProvider * 需要实现方法:getChartName * 需要实现方法:getWrapperName * 需要实现方法:getChartTypes * 需要实现方法:getChartImagePath * 需要实现方法:getRequiredJS * 需要实现方法:currentAPILevel */ public class DemoChartsPie extends AbstractIndependentChartsProvider { public static pieChart[] charts = new pieChart[]{ new pieChart(), }; /** * 图表的国际化的名字的key * * @return 图表国际化的名字的key */ @Override public String getChartName() { return "用公共的数据配置面板图表"; } /** * 图表在web端展现时需要的JS文件 * * @return JS文件数组 */ @Override public String[] getRequiredJS() { return new String[]{ "/com/fr/plugins/democharts/common/web/echarts.bridge.js" }; } /** * JS对象名,该对象一般是一个函数,执行后会在给定的dom中绘制图表 * * @return JS对象名 */ @Override public String getWrapperName() { return "EChartsFactory"; } /** * 该种图表所有的图表类型,比如柱形图就有堆积柱形图,百分比堆积柱形图等等 * * @return 所有的图表类型 */ @Override public Chart[] getChartTypes() { return charts; } /** * 定义在设计器里展现的图的路径 * * @return 图的路径 */ @Override public String getChartImagePath() { return "com/fr/plugins/democharts/customDataPanePie/images/pie256.png"; } /** * @return 插件的API等级 */ @Override public int currentAPILevel() { return CURRENT_API_LEVEL; } } |
| Code Block | ||||
|---|---|---|---|---|
| ||||
package com.fr.design.chart.fun;
/**
* Created by eason on 14/12/29.
*
* @since 8.0
* 自定义图表类型设设计界面接口
*/
public interface IndependentChartUIProvider extends Level {
String XML_TAG = "IndependentChartUIProvider";
int CURRENT_API_LEVEL = 3;
/**
* 当前接口的API等级,用于判断是否需要升级插件
*
* @return API等级
*/
int currentAPILevel();
/**
* 图表配置面板
*
* @return图表配置面板
*/
ThirdChartConfigPane getChartConfigPane(String plotID);
......(其他方法不用实现)
} |
此接口您不必实现 ,只需要继承实现了该接口的抽象类: AbstractIndependentChartUI4Custom 类即可,并实现相应方法,示例如下:,只需要继承实现了该接口的抽象类:AbstractIndependentChartsUI类即可,并实现相应方法,示例如下:
| Code Block | ||||
|---|---|---|---|---|
| ||||
package com.fr.plugins.democharts.commenDataPanePie; import com.fr.design.chart.fun.impl.AbstractIndependentChartsUI; import com.fr.design.mainframe.chart.ChartsConfigPane; /** * Created by mengao on 2017/4/26. * 自定义图表类型设设计界面,需要继承AbstractIndependentChartUI4Custom自定义图表类型设设计界面,需要继承AbstractIndependentChartsUI * 需要实现方法:getChartConfigPane * 需要实现方法:currentAPILevel */ public class DemoChartsPieUI extends AbstractIndependentChartsUI { /** * @param plotID * @return 图表样式面板,用户需要实现 */ @Override public ChartsConfigPane getChartConfigPane(String plotID) { return new ChartConfigPane(); } /** * @return 插件的API等级 */ @Override public int currentAPILevel() { return CURRENT_API_LEVEL; } } |
注意:如果您想使用自己的数据配置面板,需要覆写getTableDataSourcePane(Plot plot, ChartDataPane parent)和getReportDataSourcePane(Plot plot, ChartDataPane parent)方法,并自定义数据编辑面板、chartData、Definition等类,具体参考底部链接中的plugins-demoChart插件。
| Code Block | ||||
|---|---|---|---|---|
| ||||
package com.fr.design.mainframe.chart; import com.fr.chart.chartattr.ChartCollection; import com.fr.generalchart.chartattr.InterCharts; import javaxcom.fr.swinggeneral.*Inter; import com.fr.stable.StableUtils; import javax.swing.*; /** * Created by mengao on 2017/5/16. */ public abstract class ChartsConfigPane <T extends Charts> extends AbstractChartAttrPane { public final static String CHART_STYLE_TITLE = Inter.getLocText("Chart-Style_Name"); @Override public abstract Class<? extends publicCharts> void populate(ChartCollection collection) {accptType(); } @Override public void updatepopulate(ChartCollection collection) { } @Override protected JPanel createContentPane()if (StableUtils.classInstanceOf(collection.getSelectedChart().getClass(),accptType())) { return new JPanel( populate(collection, (T)collection.getSelectedChart()); } @Override} protected publicabstract Stringvoid getIconPath() { populate(ChartCollection collection, T selectedChart); @Override public return "com/fr/design/images/chart/ChartStyle.png"; } void update(ChartCollection collection) { @Override public String title4PopupWindow()if (StableUtils.classInstanceOf(collection.getSelectedChart().getClass(),accptType())) { return CHART_STYLE_TITLE; update(collection, (T)collection.getSelectedChart()); } } } } protected abstract void update(ChartCollection collection, T selectedChart); @Override protected JPanel createContentPane() { return new JPanel(); } @Override public String getIconPath() { return "com/fr/design/images/chart/ChartStyle.png"; } @Override public String title4PopupWindow() { return CHART_STYLE_TITLE; } } |
| Code Block | ||||
|---|---|---|---|---|
| ||||
package com.fr.plugins.democharts.commenDataPanePie;
import com.fr.chart.chartattr.ChartCollection;
import com.fr.design.mainframe.chart.ChartsConfigPane;
import javax.swing.*;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
/**
* Created by mengao on 2017/4/26.
* 图表样式面板,需要继承ChartsConfigPane
* 需要实现方法:populate
* 需要实现方法:update
*/
public class ChartConfigPane extends ChartsConfigPane<PieChart> {
private JPanel northJpane = new JPanel();
private JPanel centerJpane = new JPanel();
private JLabel nameJLable = new JLabel("请输入内容:");
private JButton updateButton = new JButton("确定");
protected JTextField value = new JTextField();
protected ChartCollection chartCollection;
public ChartConfigPane() //构造方法
{
this.setLayout(new BorderLayout |
您的图表配置面板需要继承此抽象类,并实现相应的方法,示例如下:
| Code Block | ||||
|---|---|---|---|---|
| ||||
package com.fr.plugins.democharts.commenDataPie; import com.fr.chart.chartattr.ChartCollection; import com.fr.design.mainframe.chart.ThirdChartConfigPane; import javax.swing.*; import java.awt.*; import java.awt.event.ActionEvent; import java.awt.event.ActionListener; /** * Created by mengao on 2017/4/26. * 图表样式面板,需要继承ThirdChartConfigPane * 需要实现方法:populate * 需要实现方法:update */ public class ChartConfigPane extends ThirdChartConfigPane { private ChartCollection chartCollection; JPanel northJpane = new JPanel(); JPanel centerJpane = new JPanel(); JLabel nameJLable = new JLabel("请输入内容:"); JTextField value = new JTextField(); JButton updateButton = new JButton("确定"); public ChartConfigPane() //构造方法 { this.setLayout(new BorderLayout()); northJpane.setLayout(new GridLayout(3, 2)); northJpane.add(nameJLable); northJpane.add(value); this.add(northJpane, BorderLayout.NORTH); centerJpane.add(updateButton, BorderLayout.CENTER); this.add(centerJpane, BorderLayout.CENTER); this.setSize(200, 200); this.setVisible(true); updateButton.addActionListener(new ColorEventListener()); } @OverridenorthJpane.setLayout(new GridLayout(3, 2)); public void populate(ChartCollection collection) {northJpane.add(nameJLable); northJpane.add(value); if (collection.getSelectedChart() instanceof pieChart) {this.add(northJpane, BorderLayout.NORTH); centerJpane.add(updateButton, BorderLayout.CENTER); this.chartCollection = collectionthis.add(centerJpane, BorderLayout.CENTER); this.setSize(200, 200); this.setVisible(true); pieChart pieChart = (pieChart) collection.getSelectedChart(); updateButton.addActionListener(new ColorEventListener()); } // 内部类EventListener,实现ActionListener接口 class ColorEventListener implements ActionListener { @Override value.setText(pieChart.getCustomData());public void actionPerformed(ActionEvent e) { }update(chartCollection, (T)chartCollection.getSelectedChart()); } } @Override public Class<? extends Charts> @OverrideaccptType() { publicreturn PieChart.class; } @Override protected void updatepopulate(ChartCollection collection, PieChart selectedChart) { this.chartCollection=collection; if (collection.getSelectedChart() instanceof pieChart) { pieChart pieChart = (pieChart) collection.getSelectedChart();value.setText(selectedChart.getCustomData()); } @Override protected void update(ChartCollection collection, PieChart selectedChart) { pieChartselectedChart.setCustomData(value.getText()); } } // 内部类EventListener,实现ActionListener接口 class ColorEventListener implements ActionListener { @Override public void actionPerformed(ActionEvent e) { update(chartCollection); } } } } |
| Code Block | ||||
|---|---|---|---|---|
| ||||
package com.fr.chart.chartattr;
import com.fr.base.chart.BaseChartGlyph;
import com.fr.base.chart.chartdata.ChartData;
import com.fr.chart.chartglyph.ChartGlyph;
import com.fr.json.JSONException;
import com.fr.json.JSONObject;
import com.fr.stable.web.Repository;
/**
* Created by mengao on 2017/5/3.
* 用户使用第三方图表需要继承chart父类
*/
public abstract class Charts <T extends ChartData> extends Chart |
| Code Block | ||||
|---|---|---|---|---|
| ||||
package com.fr.chart.chartattr; /** * Created by mengao on 2017/5/3. * 用户使用第三方图表需要继承chart父类 */ public abstract class ThirdChart extends Chart { protected ChartData ChartData; public ChartData getChartData() { return ChartData; } public void setChartData(ChartData chartData) { ChartData = chartData; } protected abstract String getChartID(); public ThirdChart() { ThirdChartPlot thirdChartPlot = new ThirdChartPlot(); thirdChartPlot.setPlotID(getChartID()); this.setPlot(thirdChartPlot); } @Override public BaseChartGlyph createGlyph(ChartData chartData) { protected T ChartData; ChartGlyph chartGlyph =public newT ChartGlyphgetChartData() { return ChartData; public } JSONObject toJSONObject(Repository repo, doublepublic width, double height) throws JSONException void setChartData(T chartData) { ChartData return toJSON(repo)= chartData; } protected abstract String getChartID(); } public Charts() { }; ChartsPlot chartsPlot = new setChartDataChartsPlot(chartData); chartGlyphchartsPlot.setWrapperNamesetPlotID(this.getWrapperNamegetChartID()); chartGlyph.setRequiredJS(this.getRequiredJSsetPlot()chartsPlot); chartGlyph.setChartImagePath(this.getImagePath());} @Override returnpublic chartGlyph; }BaseChartGlyph createGlyph(ChartData chartData) { public abstract JSONObject toJSON (Repository repo) throws JSONException; } |
您的图表配置面板ChartConfig类需要继承此抽象类,并实现相应方法,示例如下:
| title | pieChart extends ThirdChart |
|---|---|
| collapse | true |
ChartGlyph chartGlyph = new ChartGlyph(){ public JSONObject toJSONObject(Repository repo, double width, double height) throws JSONException { return toJSON(repo); } }; |
|
setChartData((T) |
chartData); |
chartGlyph.setWrapperName(this.getWrapperName()); |
chartGlyph.setRequiredJS(this.getRequiredJS()); |
|
chartGlyph.setChartImagePath(this.getImagePath()); |
return chartGlyph; } |
|
public abstract JSONObject toJSON |
( |
Repository |
repo) throws JSONException; } |
您的图表配置面板ChartConfig类需要继承此抽象类,并实现相应方法,示例如下:
| Code Block | ||||
|---|---|---|---|---|
| ||||
package com.fr.plugins.democharts.commonpie; import com.fr.chart.chartattr.Charts; import com.fr.chart.chartdata.NormalChartData; import com.fr.json.JSONArray; import com.fr.json.JSONException; import com.fr.json.JSONObject; import com.fr.stable.web.Repository; import com.fr.stable.xml.XMLPrintWriter; import com.fr.stable.xml.XMLableReader; import java.text.DecimalFormat; import java.text.NumberFormat; /** * Created by mengao on 2017/4/26. * chart类,需要继承Charts * 需要实现方法:getChartID * 需要实现方法:writeXML * 需要实现方法:readXML * 需要实现方法:toJSON */ public class PieChart extends Charts<NormalChartData> { private String customData = "公共数据配置面板demo"; private static final NumberFormat format = new DecimalFormat("##%"); public String getCustomData() { { super.writeXML(xmlPrintWriter); xmlPrintWriter.startTAG("customChartDemo") .attr("custom", getCustomData()) .end(); } @Override public void readXML(XMLableReader xmLableReader) { super.readXML(xmLableReader); if (xmLableReader.isChildNode()) { String tagName = xmLableReader.getTagName(); if(tagName.equals("customChartDemo")) { setCustomData(xmLableReader.getAttrAsString("custom","111"));return customData; } public void setCustomData(String customData) { } this.customData = }customData; } /**@Override public * 读出字符串,然后传到前台 void writeXML(XMLPrintWriter xmlPrintWriter) { * 注意:需要获取数据配置中的数据,使用getChartData()方法 */super.writeXML(xmlPrintWriter); @Override //tojson的时候注意用getChartData()方法获取当前数据集,然后自主拼接成json public JSONObject toJSON(Repository repo) throws JSONException { xmlPrintWriter.startTAG("customChartDemo") //用默认的 NormalChartData 进行数据配置.attr("custom", getCustomData()) JSONObject jsonObject = new JSONObject.end(); } if (this.getChartData() instanceof NormalChartData@Override public void readXML(XMLableReader xmLableReader) { super.readXML(xmLableReader); NormalChartData normalChartData = (NormalChartData) this.getChartData();if (xmLableReader.isChildNode()) { JSONArrayString seriestagName = JSONArrayxmLableReader.creategetTagName(); int len = normalChartData.getCategory_array().length;//获取分类数组的长度 if (tagName.equals("customChartDemo")) { int cn = normalChartData.getSeries_array().length;//获取系列数组的长度 setCustomData(xmLableReader.getAttrAsString("custom", "111")); for (int c = 0; c < cn; c++) { } } } //对系系列循环** * 读出字符串,然后传到前台 JSONObject wrapper = JSONObject.create();* 注意:需要获取数据配置中的数据,使用getChartData()方法 */ @Override series.put(wrapper); //tojson的时候注意用getChartData()方法获取当前数据集,然后自主拼接成json public JSONObject toJSON(Repository repo) throws JSONException { JSONArray JSONObject pointjsonObject = JSONArrayJSONObject.create(); wrapperjsonObject.put("typeseries", "pie");seriesJSONArray()) //将每个系类值给data wrapper.put("title", JSONObject.create().put("datatext", pointgetCustomData())); return jsonObject; } if private JSONArray seriesJSONArray(c) ==throws 1)JSONException { NormalChartData normalChartData = getChartData(); int[] radiusseriesLen = {20,110}; normalChartData.getSeriesCount(); String[] centerradius = {"25%", "50%"} format.format(1.0 / seriesLen); //对系列循环 JSONArray series = wrapperJSONArray.put("radius", radiuscreate(); for (int index = 0; index < seriesLen; wrapper.put("center", center);index++) { JSONObject wrapper }else{= JSONObject.create() int[] radius = {30,110};.put("type", "pie") String[] center = {"75%", "50%"};.put("data", pointJSONArray(index)) //将每个系列值给data wrapper.put("radiusname", radiusnormalChartData.getSeries_array()[index].toString());//将系列名给系列 if (seriesLen > 1) { wrapper.put("center", center); JSONArray center }= JSONArray.create() //将系列名给系列 .put(format.format((float) index / (seriesLen + 1) wrapper.put("name", normalChartData.getSeries_array()[c].toString());+ 0.20)) for (int i = 0; i < len; i++) { .put("55%"); wrapper.put("radius", radius) // String name = normalChartData.getCategory_array()[i].toString(put("center", center); } JSONObject item = JSONObjectseries.createput(wrapper); } return series; point.put(item);} private JSONArray pointJSONArray(int index) throws JSONException { NormalChartData normalChartData //将分类名给name= getChartData(); int categoriesLen = normalChartData.getCategoryLabelCount(); JSONArray point = itemJSONArray.put("name", namecreate(); for (int i = 0; if (normalChartData.getSeries_value_2D().length > 0i < categoriesLen; i++) { JSONObject item = JSONObject.create(); //将点的值给data将分类名给name String item.put("value",normalChartData.getSeries_value_2D()[c][i]name = normalChartData.getCategory_array()[i].toString(); item.put("name", name); } if (normalChartData.getSeries_value_2D().length > 0) { } //将点的值给data } jsonObjectitem.put("series", series); JSONObject title=new JSONObject()value", normalChartData.getSeries_value_2D()[index][i]); title.put("text",getCustomData());} jsonObjectpoint.put("title",titleitem); } return jsonObjectpoint; } @Override public String getChartID() { return "CommenDataDemoChartsPieChartsPieWithCommenDataPane"; } } |
注意:在toJSON中您如果需要获取数据配置中的数据,请使用getChartData()方法获取chartData对象,并将其转化为您需要的格式,具体参考demo
XML关键配置
| Code Block | ||
|---|---|---|
| ||
<extra-core>
<JavaScriptFileHandler class="com.fr.plugins.democharts.common.web.EChartsFileLoader"/>
</extra-core>
<extra-chart>
<IndependentChartProvider class="com.fr.plugins.democharts.pie.DemoChartsPie"
plotID="DemoChartsPiePlot"/>
</extra-chart>
<extra-chart-designer>
<IndependentChartUIProvider class="com.fr.plugins.democharts.pie.DemoChartsPieUI"
plotID="DemoChartsPiePlot"/>
</extra-chart-designer> |
您可以自定义图表数据配置面板,更加灵活。(左:默认数据配置面板,右:自定义的数据配置面板)
您需要自定义图表属性配置面板,让它为您设置图标的各种属性:您需要自定义图表属性配置面板,让它为您设置图表的各种属性:
通过配置面板配置好数据和属性后,您可以预览您图表配置好之后的效果,demo展示效果如下:(左:默认数据配置面板demo,右:自定义数据配置面板demo)
如果您希望看示例源码,您可以看这里:
demo工程:
| View file | ||||
|---|---|---|---|---|
|