Chart DSL

From OS.bee documentation
Jump to: navigation, search


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.

For more information, visit 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 the jqPlot library.
Currently, dCharts support:

Bar Charts Block Charts Bubble Charts Donut Charts Line Charts
Charts Charts-01.png Charts-02.png Charts-03.png Charts-04.png Charts-05.png
Meter Gauge Charts OHLC, HLC and
Candlestick Charts
Pie Charts Pyramid Charts Waterfall Charts
Charts-06.png Charts-07.png Charts-08.png Charts-09.png Charts-10.png
Events Mouse Enter Mouse Leave Click Right Click


To enable dCharts for use in OSBP, it was necessary to add OSGi capabilities to the addon.

Chart DSL

Chart DSL generates the Vaadin dCharts UI.

The main semantic elements of the Chart DSL 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 - Defines the chart configurations, e.g. chart type, polling time, datamart details, etc.
  • as bar/line/pie/donut/bubble/gauge/tree - Defines the type of chart.
  • using datamart - Defines the data source details for this chart, e.g., row/column configurations, legend details and tooltip settings.


Syntax

package

Syntax:

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

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

chart

Syntax:

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

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

For the tree chart, a <chartname>+<treetype>+JsChart.java file, a <chartname>+<treetype>+JsState.java file and a Treemap+<chartname>+<treetype>.js file are explicitly generated.

The methods collapse(), expand(), change(), update(), click() or posistion() are defined for CollapseTree or TreeMap.

polling time sets chartRefresher.setRefreshInterval to polling time number * 1000 ms in createView(). It is only for bpm.


chart type

Defines the type of chart to be displayed.
Options for the chart type are:

  • bar
  • line
  • pie
  • donut
  • bubble
  • gauge
  • tree

Syntax:

bar [shaded] [animated] [swapped] [stacked]
| line [animated] [showMarker] [trendline] [cursor [zoom] [tooltip]] [fillZero] [filled]
| pie [empty] 
| donut
| bubble [multiplier <value number>] [gradient | transparent]
| gauge [label <label value>] [hasTicks minimum <minValue number> maximum <maxValue number>][ intervals { up to <signed interval value> segmentcolor <rgb string>}]
| tree map|collapsible
bar

Bar charts illustrate values as vertical or horizontal bars, respectively. Multiple data series, that is, two-dimensional data, are shown with thinner bars or columns grouped by their category.

Syntax:

bar [shaded] [animated] [swapped] [stacked]

Notes:

  • The inner axis is the category axis and the outer axis is the data axis.
  • shaded is set with seriesDefaults.setShadow(true).setShadowAlpha(0.05f); in createChart().
  • animated is set with options.setAnimate(true); in createChart().
  • swapped means YX instead of XY as axisPrefix.
  • stacked is set with options.setStackSeries(true); in createChart().

Example:

Barchart Sample



















chart SalesPerRegion described by "Sales per state/province" as bar shaded stacked swapped using datamart SalesByDistrict {
    axis rows renders category
    axis columns renders linear tickangle 25 
    legend inside toggle replot slow
    tooltip east always inside
}
line

Line charts connect the series of data points with lines. In the basic line charts the lines are straight.

Syntax:

line [animated] [showMarker] [trendline] [cursor [zoom] [tooltip]] [fillZero] [filled]

Notes:

  • The inner axis is category the axis and the outer axis is the data axis.
  • animated will be set with options.setAnimate(true); in createChart().
  • showMarker will be set with columnsSeries.addSeries(new XYseries(Yaxes.Y<scaleOrdinal>).setLabel(columnsTitlesArray.get(<measure counter>)).setShowMarker(<true if showMarker is selected>));<(code> in <code>createChart() if multiple axes are defined in datamart, or columnsSeries.addSeries(new XYseries().setLabel(<columnsTitlesArray string>).setShowMarker(<true if showMarker is selected>)); in createChart() if no multiple axes is defined in datamart.
  • trendline will be set with seriesDefaults.setTrendline(new Trendline().setShow( true).setLineWidth(1)); in createChart().
  • cursor will be set with Cursor cursor = new Cursor().setShow(true).setZoom(<true if zoom is selected>).setShowTooltip(<true if tooltip is selected>);options.setCursor(cursor); in createChart().
  • fillZero and filled will be set with seriesDefaults.setFillToZero(<true if fillZero is selected>).setFill(<true if filled is selected>); in createChart().

Example:

Line chart sample



















chart SalesByState described by "Sales by state and time" as line cursor zoom trendLine using datamart SalesByState {
    axis columns renders linear
    axis rows renders category tickangle 20
    legend inside toggle replot normal
    tooltip north-east always inside
}
pie

A pie chart illustrates data values as proportionately sized sectors of a circle.

Syntax:

pie [empty]


Notes:

  • The inner axis is the data axis and the outer axis is the category axis.
  • empty is set with
    seriesDefaults.setRendererOptions(new PieRenderer().setShowDataLabels(true).setFill(true));
    in createChart().

Example:

chart WarehouseFinance described by "Warehouse sales and cost" as pie using datamart WarehouseFinance {
    axis rows renders category
    axis columns renders linear
    legend inside toggle replot slow
    tooltip west inside
}
donut

A donut chart is a special type of pie chart with inner size greater than zero.

Syntax:

donut
Example of a donut chart

Notes:

  • The inner axis is the data axis and the outer axis is the category axis.


Example:

chart StoreSizes described by "Store sizes by state and type of store" 
as donut using datamart StoreSizes {
    axis rows renders category
    axis columns renders linear
    legend inside toggle replot fast
    tooltip north-east always inside
}
bubble

Bubble charts are a special type of scatter chart used for representing three-dimensional data points with different point sizes. Bubble charts make it easier to define the size of a point by its third (z) dimension. The bubble size is scaled automatically, just as for other dimensions. The default point style is also more "bubbly".

Syntax:

bubble [multiplier <value number>] [gradient | transparent]
Bubble Chart Sample














Notes:

  • The inner axis is the data axis and the outer axis is the category axis.
  • multiplier is set with seriesDefaults.setRendererOptions(new BubbleRenderer().setVaryBubbleColors(true).setAutoscaleMultiplier(<value number>f).setShowLabels(false).setAutoscaleBubbles true)); in createChart().
  • gradient is set with seriesDefaults.setRendererOptions(new BubbleRenderer().setVaryBubbleColors(true).setBubbleGradients(true).setShowLabels(false).setAutoscaleBubbles(true)); in createChart().
  • transparent is set with seriesDefaults.setRendererOptions(new BubbleRenderer().setVaryBubbleColors(true).setHighlightAlpha(0.8f).setBubbleAlpha(0.6f).setShowLabels(false).setAutoscaleBubbles(true)); in createChart().


Example:

chart HRExpenses described by "Average salary" as bubble multiplier 1.5 gradient using datamart HRExpenses {
    axis rows renders category
    axis columns renders linear
    tooltip north-east always inside
}
gauge

A gauge is an one-dimensional chart with a circular Y-axis, where a rotating pointer points to a value on the axis. A gauge can, in fact, have multiple Y-axes to display multiple scales.

Syntax:

gauge [label <label value>] [hasTicks minimum <minValue number> 
maximum <maxValue number>][ intervals { up to <signed interval value> segmentcolor <rgb string>}]
Gauge Chart Sample











Notes:

  • The inner axis is the data axis and the outer axis is the category axis.
  • label is set with seriesDefaults.setRendererOptions(new MeterGaugeRenderer().setShowTickLabels(<true if hasTicks is selected>).setLabel(<label value>); in createChart().
  • hasTicks is set with seriesDefaults.setRendererOptions(new MeterGaugeRenderer().setShowTickLabels(<true if hasTicks is selected>); in createChart().
  • intervals is set with seriesDefaults.setRendererOptions(new MeterGaugeRenderer().setShowTickLabels((<true if hasTicks is selected>).setLabel("numOrders").setIntervals(<list of <signed interval value>f >).setIntervalColors(<list of <rgb to Hex string>>)); in createChart().

Example:

chart WarehouseData described by "shipped orders per quarter" as gauge label "numOrders" hasTicks minimum 0 maximum 80000 intervals {
    up to 10000 segmentcolor "230,128,64" /* orange */
    up to 40000 segmentcolor "255,0,0"
    up to 80000 segmentcolor "128,255,0"
    } 
    using datamart WarehouseShipping {
    axis rows renders category
    axis columns renders linear
}
tree

A tree is used to display hierarchical data. It consists of a group of rectangles that contains other rectangles, where the size of a rectangle indicates the item value.

Syntax:

tree map|collapsible
Tree Chart Sample

Notes: For the tree chart, generate explicity a <chartname>+<treetype>+JsChart.java file, a <chartname>+<treetype>+JsState.java file and a Treemap+<chartname>+<treetype>.js file. The methods collapse(), expand(), change(), update(), click() or position() are defined for CollapseTree or TreeMap in the xx.js file.

Example 1:

chart TreemapSales described by "Sales by product" as tree map using datamart TreemapSales {
    axis rows renders category
    axis columns renders linear
}

Example 2:

chart TreemapSales described by "Sales by product" as tree map using datamart TreemapSales {
    axis rows renders category
    axis columns renders linear
}






using datamart

Defines the data source details for this chart, e.g., row/column configurations, legend details and tooltip settings.

Syntax:

using datamart <datamart name> {
    axis rows/columns renders <render type> [shortLabel] 
    [tickangle <angle number>]
    | legend <legend placement> [toggle replot <toggle type>]
    | tooltip <tooltip location> [always] [inside]
}


Notes:

  • <render type> can be category, linear, date, logarithmic or pyramid. If <render type> is logarithmic, linear or pyramid, then the axis is the data axis; for category and date, the axis is the category axis. It is set with
    axes.addAxis(new XYaxis(XYaxes.<axis prefix>).setRenderer(AxisRenderers.<render type>).setLabel(<category axis name>AxisLabel).setTicks(<category axis name>Ticks).setTickOptions(tickRenderer)); in createChart().
  • If shortLabel is configured, use only the last level name in createChart().
  • tickangle is set with
    axes.addAxis(new XYaxis(XYaxes.<axis prefix>).setTickOptions(tickRenderer.setAngle(<angle number>))); and
    axes.addAxis(new XYaxis(XYaxes.<axis prefix>).setTickOptions(axisTickRenderer.setAngle(<angle number>))); in createChart().
  • <legend placement> can be inside, inside-grid, outside or outside-grid. It is set with
    Legend legend = new Legend().setShow(true);
    legend.setPlacement(LegendPlacements.<legend placement>);
    options.setLegend(legend);
    in createChart().
  • <toggle type> can be normal, slow or fast. It is set with EnhancedLegendRenderer renderer = new EnhancedLegendRenderer();
    renderer.setSeriesToggle(SeriesToggles.<toggle type>);
    renderer.setSeriesToggleReplot(true);
    legend.setRendererOptions(renderer);
    in createChart().
  • <tooltip location> can be north, north-east, east, south-east, south, south-west, west or north-west. tooltip location.
    always and inside are set with:
    Highlighter highlighter = new Highlighter().setShow(true);
    highlighter.setShowTooltip(true).setTooltipAlwaysVisible(<true if always is selected>).setKeepTooltipInsideChart(<true if inside is selected>).setTooltipLocation(TooltipLocations.<tooltip location>).setBringSeriesToFront(true).setFadeTooltip(true).setShowMarker(true);
    highlighter.setTooltipAxes(TooltipAxes.<axis prefix><postfix>);
    options.setHighlighter(highlighter);
    in createChart().
  • For each filtered or selected level in the datamart, a corresponding EventHandler is generated in setup().


Example:

chart StoreSizes described by "Store sizes by state and type of store" 
as donut using datamart StoreSizes {
    axis rows renders category
    axis columns renders linear
    legend inside toggle replot fast
    tooltip north-east always inside
}

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) 2019 Compex Systemhaus GmbH