java.lang.Object
org.jooq.ChartFormat
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
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static enum
The chart output format.static enum
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
category()
The category source column number.@NotNull ChartFormat
category
(int newCategory) The new category source column number, defaulting to0
.boolean
The category as text value.@NotNull ChartFormat
categoryAsText
(boolean newCategoryAsText) The new category as text value, defaulting totrue
.@NotNull ChartFormat
dimensions
(int newWidth, int newHeight) The new chart dimensions, defaulting to80 x 25
.@NotNull ChartFormat.Display
display()
The display format.@NotNull ChartFormat
display
(ChartFormat.Display newDisplay) The new display format, defaulting toChartFormat.Display.STACKED
.int
height()
The chart height.@NotNull ChartFormat
height
(int newHeight) The new chart height, defaulting to25
.@NotNull String
newline()
The newline character.@NotNull ChartFormat
The new newline character, defaulting to\n
.@NotNull DecimalFormat
The numeric format.@NotNull ChartFormat
numericFormat
(DecimalFormat newNumericFormat) The new numeric format, defaulting to###,###.00
.@NotNull ChartFormat.Output
output()
The output format.@NotNull ChartFormat
output
(ChartFormat.Output newOutput) The new output format, defaulting toChartFormat.Output.ASCII
.@NotNull DecimalFormat
The numeric format for percentages.@NotNull ChartFormat
percentFormat
(DecimalFormat newPercentFormat) The new numeric format for percentages, defaulting to###.00'%'
.char @NotNull []
shades()
The value column shades.@NotNull ChartFormat
shades
(char... newShades) The new column shades, defaulting to{ 'X' }
.boolean
Whether to show the horizontal legend.@NotNull ChartFormat
showHorizontalLegend
(boolean newShowHorizontalLegend) Whether to show the horizontal legend, defaulting totrue
.@NotNull ChartFormat
showLegends
(boolean newShowHorizontalLegend, boolean newShowVerticalLegend) Whether to show legends, defaulting totrue
.boolean
Whether to show the vertical legend.@NotNull ChartFormat
showVerticalLegend
(boolean newShowVerticalLegend) Whether to show the vertical legend, defaulting totrue
.@NotNull ChartFormat.Type
type()
@NotNull ChartFormat
type
(ChartFormat.Type newType) The new chart type, defaulting toChartFormat.Type.AREA
.int @NotNull []
values()
The value source column numbers.@NotNull ChartFormat
values
(int... newValues) The new value source column numbers, defaulting to{ 1 }
.int
width()
The chart width.@NotNull ChartFormat
width
(int newWidth) The new chart width, defaulting to80
.
-
Field Details
-
DEFAULT
-
-
Constructor Details
-
ChartFormat
public ChartFormat()
-
-
Method Details
-
output
The new output format, defaulting toChartFormat.Output.ASCII
. -
output
The output format. -
type
The new chart type, defaulting toChartFormat.Type.AREA
. -
type
-
display
The new display format, defaulting toChartFormat.Display.STACKED
. -
display
The display format. -
dimensions
The new chart dimensions, defaulting to80 x 25
. -
width
The new chart width, defaulting to80
. -
width
public int width()The chart width. -
height
The new chart height, defaulting to25
. -
height
public int height()The chart height. -
category
The new category source column number, defaulting to0
. -
category
public int category()The category source column number. -
categoryAsText
The new category as text value, defaulting totrue
. -
categoryAsText
public boolean categoryAsText()The category as text value. -
values
The new value source column numbers, defaulting to{ 1 }
. -
values
public int @NotNull [] values()The value source column numbers. -
shades
The new column shades, defaulting to{ 'X' }
. -
shades
public char @NotNull [] shades()The value column shades. -
showLegends
@NotNull public @NotNull ChartFormat showLegends(boolean newShowHorizontalLegend, boolean newShowVerticalLegend) Whether to show legends, defaulting totrue
. -
showHorizontalLegend
Whether to show the horizontal legend, defaulting totrue
. -
showHorizontalLegend
public boolean showHorizontalLegend()Whether to show the horizontal legend. -
showVerticalLegend
Whether to show the vertical legend, defaulting totrue
. -
showVerticalLegend
public boolean showVerticalLegend()Whether to show the vertical legend. -
newline
The new newline character, defaulting to\n
. -
newline
The newline character. -
numericFormat
The new numeric format, defaulting to###,###.00
. -
numericFormat
The numeric format. -
percentFormat
The new numeric format for percentages, defaulting to###.00'%'
. -
percentFormat
The numeric format for percentages.
-