Examples of org.pentaho.platform.uifoundation.chart.DialWidgetDefinition

org.pentaho.platform.uifoundation.chart.DialWidgetDefinition

This class represents the definition of a dashboard dial. It holds:

The value to be displayed on the dial
Minimum value of the dial
Maximum value of the dial
A list of intervals with the dial. Each interval specifies a minimum, maximum and information about how the interval should be painted.
Painting information
- Background paint
- Dial paint
- Needle paint

This class does not generate an image of the dial, it just defines the properties of the dial.

Dial definitions are stored in xml documents in the solution folders with *.dial.xml extensions. These definition files store XML representations of all the settings here. Typically the value to be displayed is provided at runtime by a query or business rule, but the value can also read from the definition file.

The definitions are read by org.pentaho.core.ui.component.DashboardWidgetComponent objects, which create instances of this object and set the properties defined here.

The DashboardWidgetComponent objects pass this, now populated, object to The dial image is generated by {@link org.pentaho.core.ui.component.JFreeChartEngine}

Example Dial

        dataDefinition = new TimeSeriesCollectionChartDefinition( data, byRow, chartAttributes, getSession() );
      }
    } else if ( ChartDefinition.PIE_CHART_STR.equalsIgnoreCase( chartType ) ) {
      dataDefinition = new PieDatasetChartDefinition( data, byRow, chartAttributes, getSession() );
    } else if ( ChartDefinition.DIAL_CHART_STR.equalsIgnoreCase( chartType ) ) {
      dataDefinition = new DialWidgetDefinition( data, byRow, chartAttributes, width, height, getSession() );
    } else if ( ChartDefinition.BAR_LINE_CHART_STR.equalsIgnoreCase( chartType ) ) {
      dataDefinition = new BarLineChartDefinition( data, byRow, chartAttributes, getSession() );
    } else if ( ChartDefinition.BUBBLE_CHART_STR.equalsIgnoreCase( chartType ) ) {
      dataDefinition = new XYZSeriesCollectionChartDefinition( data, byRow, chartAttributes, getSession() );
    } else {

      // XML document can't be read. We'll just return a null document.
    }


    // create a dial definition from the XML definition
    WidgetDefinition widgetDefinition =
        new DialWidgetDefinition( dialDefinition, 0, widgetWidth, widgetHeight, getSession() );


    return createDials( resultSet, widgetDefinition );
  }

Examples of org.pentaho.platform.uifoundation.chart.DialWidgetDefinition

Related Classes of org.pentaho.platform.uifoundation.chart.DialWidgetDefinition