Package org.pentaho.platform.uifoundation.chart

Class ChartHelper

  • @Deprecated
public class ChartHelper
extends Object
    Deprecated.
    This class provides wrapper functions to make it easier to execute action sequences and generate a widget.

    • Constructor Summary

      Constructors 
      Constructor Description
      ChartHelper()
      Deprecated.
       

    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static boolean doChart​(String actionPath, org.pentaho.platform.api.engine.IParameterProvider parameterProvider, StringBuffer outputStream, org.pentaho.platform.api.engine.IPentahoSession userSession, ArrayList messages, org.pentaho.platform.api.engine.ILogger logger)
      Deprecated.
      static boolean doDial​(String solutionName, String actionPath, String chartName, org.pentaho.platform.api.engine.IParameterProvider parameterProvider, StringBuffer outputStream, org.pentaho.platform.api.engine.IPentahoSession userSession, ArrayList messages, org.pentaho.platform.api.engine.ILogger logger)
      Deprecated.
      use doChart() instead
      static boolean doPieChart​(String actionPath, org.pentaho.platform.api.engine.IParameterProvider parameterProvider, StringBuffer outputStream, org.pentaho.platform.api.engine.IPentahoSession userSession, ArrayList messages, org.pentaho.platform.api.engine.ILogger logger)
      Deprecated.
      use doChart instead

    • Constructor Detail

      • ChartHelper

        public ChartHelper()
        Deprecated.

    • Method Detail

      • doChart

        @Deprecated
public static boolean doChart​(String actionPath,
                              org.pentaho.platform.api.engine.IParameterProvider parameterProvider,
                              StringBuffer outputStream,
                              org.pentaho.platform.api.engine.IPentahoSession userSession,
                              ArrayList messages,
                              org.pentaho.platform.api.engine.ILogger logger)
        Deprecated.
        doChart generates the images and html necessary to render various charts within a web page.
        Parameters:
        actionPath - full path including the name of the action sequence or resource
        parameterProvider - the collection of parameters to customize the chart
        outputStream - the output string buffer for the content
        userSession - the user session object
        messages - a collection to store error and logging messages
        logger - logging object
        Returns:
        true if successful

      • doPieChart

        @Deprecated
public static boolean doPieChart​(String actionPath,
                                 org.pentaho.platform.api.engine.IParameterProvider parameterProvider,
                                 StringBuffer outputStream,
                                 org.pentaho.platform.api.engine.IPentahoSession userSession,
                                 ArrayList messages,
                                 org.pentaho.platform.api.engine.ILogger logger)
        Deprecated.
        use doChart instead
        doPieChart generates the images and html necessary to render pie charts. It provides a simple wrapper around the class org.pentaho.ui.component.charting.PieDatasetChartComponent
        Parameters:
        solutionName - the solution name
        actionPath - the action path
        chartName - the xml file describing the chart
        parameterProvider - the collection of parameters to customize the chart
        outputStream - the output string buffer for the content
        userSession - the user session object
        messages - a collection to store error and logging messages
        logger - logging object
        Returns:
        true if successful

      • doDial

        @Deprecated
public static boolean doDial​(String solutionName,
                             String actionPath,
                             String chartName,
                             org.pentaho.platform.api.engine.IParameterProvider parameterProvider,
                             StringBuffer outputStream,
                             org.pentaho.platform.api.engine.IPentahoSession userSession,
                             ArrayList messages,
                             org.pentaho.platform.api.engine.ILogger logger)
        Deprecated.
        use doChart() instead
        doDial generates the images and html necessary to render dials. It provides a simple wrapper around the class org.pentaho.ui.component.DashboardWidgetComponent
        Parameters:
        solutionName - the solution name
        actionPath - the action path
        chartName - the xml file describing the chart
        parameterProvider - the collection of parameters to customize the chart
        outputStream - the output string buffer for the content
        userSession - the user session object
        messages - a collection to store error and logging messages
        logger - logging object
        Returns:
        true if successful