Difference between revisions of "Chart DSL"

Revision as of 15:41, 4 August 2016

Copyright Notice

All rights are reserved by Compex Systemhaus GmbH. In particular, duplications, translations, microfilming, saving and processing in electronic systems are protected by copyright. Use of this manual is only authorized with the permission of Compex Systemhaus GmbH. Infringements of the law shall be punished in accordance with civil and penal laws. We have taken utmost care in putting together texts and images. Nevertheless, the possibility of errors cannot be completely ruled out. The Figures and information in this manual are only given as approximations unless expressly indicated as binding. Amendments to the manual due to amendments to the standard software remain reserved. Please note that the latest amendments to the manual can be accessed through our helpdesk at any time. The contractually agreed regulations of the licensing and maintenance of the standard software shall apply with regard to liability for any errors in the documentation. Guarantees, particularly guarantees of quality or durability can only be assumed for the manual insofar as its quality or durability are expressly stipulated as guaranteed. If you would like to make a suggestion, the Compex Team would be very pleased to hear from you.

(c) 2016-2024 Compex Systemhaus GmbH

Introduction

Vaadin

Vaadin is a web application framework for Java. In contrast to Javascript libraries and browser-plugin based solutions, Vaadin features a complete stack that includes a robust server-side programming model as well as client-side development tools based on GWT and HTML5.

More information: https://vaadin.com/home

jqPlot

jqPlot (http://www.jqplot.com) is a plotting and charting plugin for the jQuery Javascript framework and is dual licensed under the MIT and GPL version 2 licenses. jqPlot produces line, bar and pie charts with many features.

dCharts

dCharts is Vaadin add-on for creating charts and is a wrapper for jqPlot library. For now dCharts support:

• Bar Charts
• Block Charts
• Bubble Charts
• Donut Charts
• Line Charts
• Meter Gauge Charts
• OHLC, HLC and Candlestick Charts
• Pie Charts
• Pyramid Charts
• Waterfall Charts

dCharts support following events:

• mouse enter
• mouse leave
• click
• right click

To enable it in OSBP it was neccessary to add OSGi capabilities to the addon.

Chart DSL

Chart DSL generates the vaddin dCharts ui.

The main semantic elements of the ChartDSL are:

• package - the root element that contains all the other elements. A model can contain multiple packages.
• import declarations - used to import external models or even Java classes.
• chart - define the chart configurations, e.g. chart type, polling time, datamart details, etc.
• as bar/line/pie/donut/bubble/gauge/tree - define the type for this chart .
• using datamart - define the data source details for this chart , e.g. row/column configurations, legend details and tooltips configurations.

Syntax

Package

► Syntax:

package <package name>  {
    import <import models/class name>
     ...

    chart... [using datamart <datamart name>
    {
         ...
    }]
...
}
<syntaxhighlight>

==== Chart ====

► '''Syntax''':

<syntaxhighlight lang="java">
chart <char name> [described by <discription>] as 
    <chart type>
    [polling <polling time number>]
    [using datamart <datamart name> {
           ...
    }]
<syntaxhighlight>

Generate a <code><chartame>+Chart.java</code> file, in which a java class named <code><chartname>+Chart</code> extended from java class <code>AbstractHybridVaaclipseView</code> is defined. In this class, chart and chart configurations are defined. 

For the tree chart, generate explicit a <code><chartname>+<treetype>+JsChart.java</code> file, a <code><chartname>+<treetype>+JsState.java</code> file and a <code>Treemap+<chartname>+<treetype>.js</code> file.  The methods collapse(), expand(), change(), update(), click() or posistion() are defined for CollapseTree or TreeMap.

<code>polling time</code> sets chartRefresher.setRefreshInterval as ''polling time number * 1000 ms'' in <code>createView()</code>. It is only for bpm.


===== chart type =====

===== Bar =====

===== Line =====

===== Pie =====

===== Donut =====

===== Bubble =====

===== Gauge =====

===== Tree =====

=== using datamart ===