Package net.pricefx.server.dto.calculation

Class ResultFlexChart

Object
AbstractPortletDto
ResultFlexChart
All Implemented Interfaces:
Serializable, Portlet, ComplexCalculationResult
public class ResultFlexChart extends AbstractPortletDto implements ComplexCalculationResult
Holds a FlexChart returned from a logic element.

An instance is created by api.buildFlexChart(baseTemplateToUse, definition). The definition is merged with the options of the FlexChart template named by baseTemplateToUse.

FlexCharts use the outdated Highcharts release 4 and do not support all Highcharts options. Do not use FlexCharts in new projects. Use api.buildHighchart(definition) instead.

See Also:

  • Field Summary

    Fields inherited from class AbstractPortletDto

    dragDropEnabled, layout, messages, resizingEnabled

    Fields inherited from interface Portlet

    UNIT_GRID, UNIT_PX

  • Constructor Summary

    Constructors
    Constructor
    Description
    ResultFlexChart()
    Not intended for public use.
    ResultFlexChart(Object flexChart)
    Not intended for public use.
    ResultFlexChart(String baseTemplateToUse, Object flexChart)
    Not intended for public use.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBaseTemplateToUse()
    Returns the name of the FlexChart template the definition is merged with.
    Object
    getFlexChart()
    Returns the chart options built from the definition.
    String
    getResultType()
    Returns the result type of the FlexChart.
    void
    setBaseTemplateToUse(String template)
    Sets the FlexChart template the definition is merged with.
    void
    setFlexChart(Object flexChart)
    Not intended for public use.

    Methods inherited from class AbstractPortletDto

    getLabelOverride, layout, setLabelOverride, setLayout, value, withDragDrop, withError, withHeight, withHeight, withInfo, withLabelOverride, withLayout, withLayout, withLayout, withResizing, withTab, withWarning, withWidth, withWidth

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • getBaseTemplateToUse

      public String getBaseTemplateToUse()
      Returns the name of the FlexChart template the definition is merged with.
      Returns:
      The name of the FlexChart template.

    • setBaseTemplateToUse

      public void setBaseTemplateToUse(String template)
      Sets the FlexChart template the definition is merged with.
      Parameters:
      template - Name of the template to use as a basis for merging with the definition. If null, the predefined Default template is used.

    • getFlexChart

      public Object getFlexChart()
      Returns the chart options built from the definition.
      Returns:
      The chart options, not the definition object passed to api.buildFlexChart().

    • setFlexChart

      public void setFlexChart(Object flexChart)
      Not intended for public use. Use api.buildFlexChart() instead.
      See Also:

    • getResultType

      public String getResultType()
      Returns the result type of the FlexChart.
      Specified by:
      getResultType in interface ComplexCalculationResult
      Returns:
      Always "FLEXCHART".