Package com.orchestranetworks.addon.dqid.chart

Class DisplayOptions

  • public class DisplayOptions
extends java.lang.Object
    Represents the chart's display options.

    It is used to specify the size of the chart as well as the size of the legend.
    It can be also used to set an optional CSS class to the HTML container allowing further chart customization.

    See Also:
    Chart, Size

    • Constructor Summary

      Constructors 
      Constructor Description
      DisplayOptions()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void setChartSize​(Size size)
      Sets the size used to display a chart.
      void setCSSClassName​(java.lang.String name)
      The optional CSS class name that will be applied to the plot container.
      void setLegendSize​(Size size)
      Sets the chart's legend size.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DisplayOptions

        public DisplayOptions()

    • Method Detail

      • setChartSize

        public void setChartSize​(Size size)
        Sets the size used to display a chart.

        If no size is provided, the default size is 230X234.

        See Also:
        Size

      • setLegendSize

        public void setLegendSize​(Size size)
        Sets the chart's legend size.

        If no size is provided then the default size is width/2 * height/2, where width and height are the dimensions of the chart.
        Note: If the legend is close to the container size it might lead to overlapping with the axis and/or grid.

        See Also:
        Size

      • setCSSClassName

        public void setCSSClassName​(java.lang.String name)
        The optional CSS class name that will be applied to the plot container.

        This can be useful if a specific plot container style is required.