Module org.jooq
Package org.jooq

Class ChartFormat

java.lang.Object
org.jooq.ChartFormat
public final class ChartFormat extends Object
A CSV formatting type, which can be used to configure chart exports.

The type is immutable, meaning calls to setters like width(int) do not modify the original reference, but return a new one instead.

Author:
Lukas Eder

  • Field Details

  • Constructor Details

    • ChartFormat

      public ChartFormat()

  • Method Details

    • output

      public ChartFormat output​(ChartFormat.Output newOutput)
      The new output format, defaulting to ChartFormat.Output.ASCII.

    • output

      public ChartFormat.Output output()
      The output format.

    • type

      public ChartFormat type​(ChartFormat.Type newType)
      The new chart type, defaulting to ChartFormat.Type.AREA.

    • type

      public ChartFormat.Type type()

    • display

      public ChartFormat display​(ChartFormat.Display newDisplay)
      The new display format, defaulting to ChartFormat.Display.STACKED.

    • display

      public ChartFormat.Display display()
      The display format.

    • dimensions

      public ChartFormat dimensions​(int newWidth, int newHeight)
      The new chart dimensions, defaulting to 80 x 25.

    • width

      public ChartFormat width​(int newWidth)
      The new chart width, defaulting to 80.

    • width

      public int width()
      The chart width.

    • height

      public ChartFormat height​(int newHeight)
      The new chart height, defaulting to 25.

    • height

      public int height()
      The chart height.

    • category

      public ChartFormat category​(int newCategory)
      The new category source column number, defaulting to 0.

    • category

      public int category()
      The category source column number.

    • categoryAsText

      public ChartFormat categoryAsText​(boolean newCategoryAsText)
      The new category as text value, defaulting to true.

    • categoryAsText

      public boolean categoryAsText()
      The category as text value.

    • values

      public ChartFormat values​(int... newValues)
      The new value source column numbers, defaulting to { 1 }.

    • values

      public int[] values()
      The value source column numbers.

    • shades

      public ChartFormat shades​(char... newShades)
      The new column shades, defaulting to { 'X' }.

    • shades

      public char[] shades()
      The value column shades.

    • showLegends

      public ChartFormat showLegends​(boolean newShowHorizontalLegend, boolean newShowVerticalLegend)
      Whether to show legends, defaulting to true.

    • showHorizontalLegend

      public ChartFormat showHorizontalLegend​(boolean newShowHorizontalLegend)
      Whether to show the horizontal legend, defaulting to true.

    • showHorizontalLegend

      public boolean showHorizontalLegend()
      Whether to show the horizontal legend.

    • showVerticalLegend

      public ChartFormat showVerticalLegend​(boolean newShowVerticalLegend)
      Whether to show the vertical legend, defaulting to true.

    • showVerticalLegend

      public boolean showVerticalLegend()
      Whether to show the vertical legend.

    • newline

      public ChartFormat newline​(String newNewline)
      The new newline character, defaulting to \n.

    • newline

      public String newline()
      The newline character.

    • numericFormat

      public ChartFormat numericFormat​(DecimalFormat newNumericFormat)
      The new numeric format, defaulting to ###,###.00.

    • numericFormat

      public DecimalFormat numericFormat()
      The numeric format.