Difference between revisions of "Adding new advanced chart types in BIRT"

Latest revision as of 18:48, 16 August 2009

My project for this year's Google Sommer of Code will be to contribute new chart types for the BIRT project.

Personal Details

Name: Karsten Knese

E-mail: Karsten.Knese@web.de

Skype: kook1987

Mentor: Ahti Kitsik

Full proposal: Proposal

Abstract

As there were some request about new chart types for BIRT the goal of my project is to add three new chart types.

donut chart
venn diagram
radar diagram

Description

BIRT already provides several chart types for designing customs reports. I found some open bugs and help-wanted entries in bugzilla.

Donut chart

This chart will be implemented based on the existing pie chart.

example: [1]
bugzilla: [2]

Radar diagram

This chart shows data information grouped by categories.

example: [3]
bugzilla: [4]

Venn diagram

This chart shows similarities and differences of several datasets.

example: [5]
bugzilla: [6]

Project plan

Here you can find the timeline for this project including all milestones.

Milestone	Date	Description
M1	June 07	Getting organizational things done like SVN repository etc.
M2	June 10	Creating base frame for all three chart types. Interface and associated implementation class
M3	June 14	Clear which classes of the existing BIRT source have to be patched
M4	July 5	Implementing donut chart based on the existing pie chart
M5	July 13	Testing donut chart - 'Pencil down' for midterm evaluation
M6	July 26	Implementing radar chart
M7	August 10	Implementing venn diagram
Pencil down	August 17	Integrating source into BIRT source, do final documentation

Availuable Features

M1 SVN Repository	Source code is hosted at google code for eclipse foundation project. Later it will be integrated in BIRT. Here you can find the repository and additional information.
M2 Base frame	Source contains interfaces and implementation classes for the base series definition of all three types. TODO: Check howto write plugin in a way, it is totally independent and can be connected with extension points.
new chart types
M3 Rendering classes	This is a list of classes which has to be implemented. Cause the first chart - donut chart - is based on the existing pie chart, the list shows the existing classes of the pie chart. org.eclipse.birt.chart.ui.swt.series.PieSeriesUIProvider org.eclipse.birt.chart.ui.swt.type org.eclipse.birt.chart.ui.swt.wizard.format.popup.series.PieTitleSheet org.eclipse.birt.chart.ui.swt.series org.eclipse.birt.chart.render.Pie org.eclipse.birt.chart.render.
M3 Donut Chart	A few screenshots of the implemented donut chart. Functions are the same as the already existing Pie chart.
Donut chart compilation
M3 Venn diagram	A few screenshots of the implemented venn diagram <br\> There are a few restrictions: restricted to three datasets datasets have to be lists of datatypes There are a few featues: Intersection color will be generated of additive or subtractive colormixing. Intersection areas in charts with three datasets that aren't real will be colored in a transparent way.
2D Venn with 3 Datasets
2D Venn with one intersection
2D Venn with two intersections
2D Venn with three intersections
2D Venn with 3 Datasets

Next steps

Fixing dataset implementation labeling datasets

Comments, suggestions, ideas

I'm proud to take part in GSoC 2009. As it is my first project I'm happy about every help.
So feel free writing every comments you have. :)

@@ Line 55: / Line 55: @@
 ! M3
 | June 14
-|align="left"|Inline Clear which classes of the existing BIRT source have to be patched
+|align="left"| Clear which classes of the existing BIRT source have to be patched
 |- style="background:lightgrey;"
 ! M4
@@ Line 77: / Line 77: @@
 |align="left"| Integrating source into BIRT source, do final documentation
 |}
 == Availuable Features ==
@@ Line 83: / Line 82: @@
 {| style="width:75%;
 |- valign="top"
-| '''SVN Repository''' <br />
+| '''M1 <br />SVN Repository'''
-| '''M1'''
 || Source code is hosted at google code for eclipse foundation project. Later it will be integrated in BIRT. <br />
 [http://code.google.com/p/eclipse-soc/source/browse/#svn/trunk/2009-newBirtCharts Here] you can find the repository and additional information.
+----
 |- valign="top"
-| '''Which classes have to be created? ''' <br />
+| '''M2 <br/>Base frame'''
-| '''M2'''
+|| Source contains interfaces and implementation classes for the base series definition of all three types. <br />
-|| If you have a look at source located like it is in M1 descripted, you see that now that are an interface and an implementation class. <br />
+TODO: Check howto write plugin in a way, it is totally independent and can be connected with extension points.
 |- valign="top"
-| '''interface package'''
+| '''new chart types '''
-|| [[Image:birt-type-package.png|Set of all the different existing birt charts.]]
+|| [[Image:newTypePackages.png| Set of the chart type classes.]]
+----
 |- valign="top"
-| '''implementation package'''
+| '''M3 <br/>Rendering classes'''
-|| [[Image:birt-typeimpl-package.png|Set of all associated implementation classes.]]
+|| This is a list of classes which has to be implemented. Cause the first chart - donut chart - is based on the existing pie chart, the list shows the existing classes of the pie chart.
+* org.eclipse.birt.chart.ui.swt.series.PieSeriesUIProvider
+* org.eclipse.birt.chart.ui.swt.type
+* org.eclipse.birt.chart.ui.swt.wizard.format.popup.series.PieTitleSheet
+* org.eclipse.birt.chart.ui.swt.series
+* org.eclipse.birt.chart.render.Pie
+* org.eclipse.birt.chart.render.
+----
 |- valign="top"
-| '''new chart types '''
+| '''M3 <br/>Donut Chart'''
-|| [[Image:newTypePackages.png| Set of the chart type classes.]]
+|| A few screenshots of the implemented donut chart. Functions are the same as the already existing Pie chart.
-|}
-As there are almost every classes are located, there will be an information left how to create a new plugin, extending existing BIRT code without patching any line of code. For example, the PIE chart will be rendered in die generator.render-phase. This is a hard coded piece of BIRT. But the question will be how to insert new chart types.
+|- valign="top"
+| Donut chart compilation
+||[[Image:BIRT DonutCompilation.jpg| Donut Compilation]]<br/>
+----
+|- valign="top"
+| '''M3 <br/>Venn diagram'''
+|| '''A few screenshots of the implemented venn diagram''' <br\>
+There are a few restrictions:
+* restricted to three datasets
+* datasets have to be lists of datatypes
+There are a few featues:
+* Intersection color will be generated of additive or subtractive colormixing.
+* Intersection areas in charts with three datasets that aren't real will be colored in a transparent way.
+|- valign="top"
+| 2D Venn with 3 Datasets
+||[[Image:BIRT 2dVennWithoutIntersectionCompilation.jpg| 2D Venn without intersection compilation]]
+|- valign="top"
+| 2D Venn with one intersection
+||[[Image:BIRT 2dVennWithOneIntersectionCompilation.jpg| 2D Venn with one intersection]]
+|- valign="top"
+| 2D Venn with two intersections
+||[[Image:BIRT 2dVennWithTwoIntersectionCompilation.jpg| 2D Venn with two intersections]]
+|- valign="top"
+| 2D Venn with three intersections
+||[[Image:BIRT 2dVennWithThreeIntersectionCompilation.jpg| 2D Venn with three intersections]]
+|- valign="top"
+| 2D Venn with 3 Datasets
+||[[Image:BIRT-VennAdditveWheel.png]]
+|}
 === Next steps ===
-Next step will be to locate all required classes. Therefore you can decide how to create a new chart type.<br />
+Fixing dataset implementation
-List every class which has to be implemented. Clear how to combine new chart types with extension points of existing BIRT Framework.
+labeling datasets
 == Comments, suggestions, ideas ==

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Difference between revisions of "Adding new advanced chart types in BIRT"

Latest revision as of 18:48, 16 August 2009

Contents

Personal Details

Abstract