Package org.dashbuilder.displayer

Interface MetricSettingsBuilder<T extends MetricSettingsBuilder>

All Superinterfaces:

ChartSettingsBuilder<T>, org.dashbuilder.dataset.DataSetLookupBuilder<T>, DisplayerSettingsBuilder<T>

All Known Implementing Classes:

MetricSettingsBuilderImpl

public interface MetricSettingsBuilder<T extends MetricSettingsBuilder>
extends ChartSettingsBuilder<T>

A displayer settings builder for meter charts

   DisplayerSettingsFactory.newMetricSettings()
   .dataset("sales")
   .column("amount", "sum", "Total amount")
   .title("Total Sales")
   .titleVisible(true)
   .titlePosition("bottom")
   .width(250).height(200)
   .metric(0, 0, 0, 100000)
   .buildSettings());
 

Method Summary

Modifier and Type	Method	Description
T	metric(long start, long warning, long critical, long end)	Set specific the configuration parameters for this metric chart.

Methods inherited from interface org.dashbuilder.displayer.ChartSettingsBuilder

height, legendOff, legendOn, legendOn, margins, resizableOff, resizableOn, width

Methods inherited from interface org.dashbuilder.dataset.DataSetLookupBuilder

asc, buildLookup, column, column, column, column, column, dataset, desc, dynamic, dynamic, dynamic, filter, filter, firstDay, firstMonth, fixed, group, group, group, join, rowNumber, rowOffset, select, sort, sort

Methods inherited from interface org.dashbuilder.displayer.DisplayerSettingsBuilder

backgroundColor, buildSettings, dataset, expression, expression, filterOff, filterOn, format, format, format, htmlTemplate, jsTemplate, refreshOff, refreshOn, refreshOn, renderer, subtype, title, titleVisible, uuid

Method Detail

metric

T metric(long start,
         long warning,
         long critical,
         long end)

Set specific the configuration parameters for this metric chart.

All the reference values specified start, warning, critical, and end can be used to customize how the metric is displayed according its current value.

Returns:

The DisplayerSettingsBuilder instance that is being used to configure a Meter data displayer.