Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/pepstock-org/Charba

J2CL and GWT Charts library based on CHART.JS
https://github.com/pepstock-org/Charba

chart-library chartjs elemental2 elemento gwt gwt-charts-library gwt-library gwt-widget j2cl java javascript jsinterop

Last synced: 3 months ago
JSON representation

J2CL and GWT Charts library based on CHART.JS

Host: GitHub
URL: https://github.com/pepstock-org/Charba
Owner: pepstock-org
License: apache-2.0
Created: 2017-10-11T15:03:37.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-02-10T15:13:41.000Z (4 months ago)
Last Synced: 2024-02-11T15:55:25.882Z (4 months ago)
Topics: chart-library, chartjs, elemental2, elemento, gwt, gwt-charts-library, gwt-library, gwt-widget, j2cl, java, javascript, jsinterop
Language: Java
Homepage: https://pepstock-org.github.io/Charba-Wiki/docs
Size: 662 MB
Stars: 59
Watchers: 13
Forks: 6
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome - charba

README

        Charba - J2CL and GWT Charts library based on CHART.JS

======================================================



  

  

  

  

  

  

  

  

  

  



What's Charba

--------

[GWT Web toolkit](http://www.gwtproject.org/) doesn't have charting library available out of the box.

There are some open source charting libraries for GWT available to be used but with some constraints or unclear items:

 * internet connection needed

 * open source license not completely clear, sometimes with some obligations like to add specific labels

 * old packages not longer maintained

For all these reasons, **Charba** has been developed, leveraging on [Chart.JS](http://www.chartjs.org/) capabilities which are now available to GWT developers.

Not only GWT

------------

Even if **Charba** was born only as GWT chart library, as of version 3, **Charba** has been changed in order to be used not only in GWT but also with other DOM frameworks, based on [J2CL - JavaToClosure](https://github.com/google/j2cl), like [Google Elemental2](https://github.com/google/elemental2) or [Elemento](https://github.com/hal/elemento).

**Charba** has got an own DOM manager which allows to it to be independent from any other DOM frameworks (i.e. GWT, Elemental2 or Elemento) but it is providing a set of hooks in order to use it also over those frameworks.

[![CharbaDiagram](https://github.com/pepstock-org/Charba-Wiki/blob/master/static/img/charbaDiagram.png)](https://pepstock-org.github.io/Charba-Wiki/docs/getting-started/Integration)

    

Building

--------

To build **Charba**, you can check out the project and to run [Ant build.xml](https://github.com/pepstock-org/Charba/blob/6.5/build.xml).

The [Ant build.xml](https://github.com/pepstock-org/Charba/blob/6.5/build.xml) is able to build the 2 artifacts, related to the 2 distributions available.

The first distribution is a **Charba** file without any GWT dependency (but working on GWT anyway), consumable also in other [J2CL - JavaToClosure](https://github.com/google/j2cl) frameworks, like [Google Elemental2](https://github.com/google/elemental2) and [Elemento](https://github.com/hal/elemento).

To build the project, execute `buildBinary` target.

It creates a `charba-[version.release].jar` file in `dist` folder, ready to be included in your project.

The second distribution is a **Charba** file with a hard GWT dependency which contains charts widgets and code splitting capabilities.

To build the project, execute `buildBinaryGwt` target.

It creates a `charba-[version.release]-gwt.jar` file in `dist` folder, ready to be included in your project.

[![Charba](https://github.com/pepstock-org/Charba-Wiki/blob/master/static/img/charba_jar_trend_65.png)](https://github.com/pepstock-org/Charba-Showcase/blob/6.5/src/org/pepstock/charba/showcase/client/views/HomeView.java)

Installation

------------

Currently **Charba** is available on [MVN repository](https://mvnrepository.com/artifact/org.pepstock/charba).

It is available also on [GitHub releases](https://github.com/pepstock-org/Charba/releases).

If you are using [Apache Maven](https://maven.apache.org/):

```xml

    org.pepstock

    charba

    6.5

    

    6.5-gwt

```

If you are using [Apache Ivy](http://ant.apache.org/ivy/):

```xml

```

To install in your GWT project, both for GWT and for J2CL artifacts, you must the following configuration in your GWT project module configuration:

```xml

...

    

...

```

**Charba** is based on [JSINTEROP](http://www.gwtproject.org/doc/latest/DevGuideCodingBasicsJsInterop.html) method to integrate java script objects.

As the name suggests, JsInterop is a way of interoperating Java with JavaScript. It offers a better way of communication between the two using annotations instead of having to write java script in your classes (using JSNI).

Gallery

--------

  

    

      

        

      

    

    

      

        

      

    

    

      

        

      

    

    

      

        

      

    

  

  

    Bar

	Horizontal bar

	Line

	Vertical line

  

  

    

      

        

      

      

    

      

        

      

      

    

      

        

      

      

    

      

        

      

      

  

  

    Scatter

	Doughnut

	Pie

	Polar area

  

  

    

      

        

      

      

    

      

        

      

          

    

      

        

      

          

    

      

        

      

          

    

  

    Radar

	Bubble

	Time series

	Stacked

  

  

    

      

        

      

          

    

      

        

      

          

    

      

        

      

          

    

      

        

      

          

    

  

    Meter

	Gauge

	Choropleth

	Bubble map

  

  

    

      

        

      

          

    

      

        

      

          

    

      

        

      

          

    

      

        

      

          

    

  

    Area

	Treemap

	Matrix

	Sankey

  

Documentation

-------------

**Charba** documentation is published [here](https://pepstock-org.github.io/Charba-Wiki).

All **Charba** documentation will be maintained in [Charba-Wiki](https://github.com/pepstock-org/Charba-Wiki) project.

API JavaDoc for version **6.5** is published [here](https://pepstock-org.github.io/Charba/6.5/index.html).

You can also access the previous API JavaDoc, because every version is published to `https://pepstock-org.github.io/Charba/[version.release]`.

The API JavaDoc of the `master` branch is published [here](https://pepstock-org.github.io/Charba/next/).

Showcase

--------

See [Charba showcase on GWT](https://pepstock-org.github.io/Charba-Showcase) to have a look what you can do with it.

See also [Charba showcase GWT source code](https://github.com/pepstock-org/Charba-Showcase) on GitHub as starting point, if you are going to use on GWT.

See [Charba showcase built by J2CL](https://pepstock-org.github.io/Charba-Showcase-J2CL) and based on [Google Elemental2](https://github.com/google/elemental2), to have a look what you can do with it.

See also [Charba showcase J2CL source code](https://github.com/pepstock-org/Charba-Showcase-J2CL) on GitHub as starting point, if you are going to use on J2CL.

The samples are going to reflect what CHART.JS samples are showing [here](http://www.chartjs.org/samples/latest/).

Continuous integration and quality gate

---------------------------------------

**Charba** is continuously built at every commit and merge in `master` by [GitHub Action](https://github.com/pepstock-org/Charba/actions?query=workflow%3ABuild).

At every build, **Charba** is also checked by [Sonar.io](https://sonarcloud.io/dashboard?id=pepstock-org_Charba) in order to have the pulse of its quality.

License

-------

**Charba** is available under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).