@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ComboChartConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
The configuration of a ComboChartVisual
.
Constructor and Description |
---|
ComboChartConfiguration() |
Modifier and Type | Method and Description |
---|---|
ComboChartConfiguration |
clone() |
boolean |
equals(Object obj) |
DataLabelOptions |
getBarDataLabels()
The options that determine if visual data labels are displayed.
|
String |
getBarsArrangement()
Determines the bar arrangement in a combo chart.
|
AxisDisplayOptions |
getCategoryAxis()
The category axis of a combo chart.
|
ChartAxisLabelOptions |
getCategoryLabelOptions()
The label options (label text, label visibility, and sort icon visibility) of a combo chart category
(group/color) field well.
|
ChartAxisLabelOptions |
getColorLabelOptions()
The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
|
ComboChartFieldWells |
getFieldWells()
The field wells of the visual.
|
VisualInteractionOptions |
getInteractions()
The general visual interactions setup for a visual.
|
LegendOptions |
getLegend()
The legend display setup of the visual.
|
DataLabelOptions |
getLineDataLabels()
The options that determine if visual data labels are displayed.
|
AxisDisplayOptions |
getPrimaryYAxisDisplayOptions()
The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field
well.
|
ChartAxisLabelOptions |
getPrimaryYAxisLabelOptions()
The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis
(bar) field well.
|
List<ReferenceLine> |
getReferenceLines()
The reference line setup of the visual.
|
AxisDisplayOptions |
getSecondaryYAxisDisplayOptions()
The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field
well.
|
ChartAxisLabelOptions |
getSecondaryYAxisLabelOptions()
The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary
y-axis(line) field well.
|
SingleAxisOptions |
getSingleAxisOptions() |
ComboChartSortConfiguration |
getSortConfiguration()
The sort configuration of a
ComboChartVisual . |
TooltipOptions |
getTooltip()
The legend display setup of the visual.
|
VisualPalette |
getVisualPalette()
The palette (chart color) display setup of the visual.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setBarDataLabels(DataLabelOptions barDataLabels)
The options that determine if visual data labels are displayed.
|
void |
setBarsArrangement(String barsArrangement)
Determines the bar arrangement in a combo chart.
|
void |
setCategoryAxis(AxisDisplayOptions categoryAxis)
The category axis of a combo chart.
|
void |
setCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart category
(group/color) field well.
|
void |
setColorLabelOptions(ChartAxisLabelOptions colorLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
|
void |
setFieldWells(ComboChartFieldWells fieldWells)
The field wells of the visual.
|
void |
setInteractions(VisualInteractionOptions interactions)
The general visual interactions setup for a visual.
|
void |
setLegend(LegendOptions legend)
The legend display setup of the visual.
|
void |
setLineDataLabels(DataLabelOptions lineDataLabels)
The options that determine if visual data labels are displayed.
|
void |
setPrimaryYAxisDisplayOptions(AxisDisplayOptions primaryYAxisDisplayOptions)
The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field
well.
|
void |
setPrimaryYAxisLabelOptions(ChartAxisLabelOptions primaryYAxisLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis
(bar) field well.
|
void |
setReferenceLines(Collection<ReferenceLine> referenceLines)
The reference line setup of the visual.
|
void |
setSecondaryYAxisDisplayOptions(AxisDisplayOptions secondaryYAxisDisplayOptions)
The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field
well.
|
void |
setSecondaryYAxisLabelOptions(ChartAxisLabelOptions secondaryYAxisLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary
y-axis(line) field well.
|
void |
setSingleAxisOptions(SingleAxisOptions singleAxisOptions) |
void |
setSortConfiguration(ComboChartSortConfiguration sortConfiguration)
The sort configuration of a
ComboChartVisual . |
void |
setTooltip(TooltipOptions tooltip)
The legend display setup of the visual.
|
void |
setVisualPalette(VisualPalette visualPalette)
The palette (chart color) display setup of the visual.
|
String |
toString()
Returns a string representation of this object.
|
ComboChartConfiguration |
withBarDataLabels(DataLabelOptions barDataLabels)
The options that determine if visual data labels are displayed.
|
ComboChartConfiguration |
withBarsArrangement(BarsArrangement barsArrangement)
Determines the bar arrangement in a combo chart.
|
ComboChartConfiguration |
withBarsArrangement(String barsArrangement)
Determines the bar arrangement in a combo chart.
|
ComboChartConfiguration |
withCategoryAxis(AxisDisplayOptions categoryAxis)
The category axis of a combo chart.
|
ComboChartConfiguration |
withCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart category
(group/color) field well.
|
ComboChartConfiguration |
withColorLabelOptions(ChartAxisLabelOptions colorLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
|
ComboChartConfiguration |
withFieldWells(ComboChartFieldWells fieldWells)
The field wells of the visual.
|
ComboChartConfiguration |
withInteractions(VisualInteractionOptions interactions)
The general visual interactions setup for a visual.
|
ComboChartConfiguration |
withLegend(LegendOptions legend)
The legend display setup of the visual.
|
ComboChartConfiguration |
withLineDataLabels(DataLabelOptions lineDataLabels)
The options that determine if visual data labels are displayed.
|
ComboChartConfiguration |
withPrimaryYAxisDisplayOptions(AxisDisplayOptions primaryYAxisDisplayOptions)
The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field
well.
|
ComboChartConfiguration |
withPrimaryYAxisLabelOptions(ChartAxisLabelOptions primaryYAxisLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis
(bar) field well.
|
ComboChartConfiguration |
withReferenceLines(Collection<ReferenceLine> referenceLines)
The reference line setup of the visual.
|
ComboChartConfiguration |
withReferenceLines(ReferenceLine... referenceLines)
The reference line setup of the visual.
|
ComboChartConfiguration |
withSecondaryYAxisDisplayOptions(AxisDisplayOptions secondaryYAxisDisplayOptions)
The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field
well.
|
ComboChartConfiguration |
withSecondaryYAxisLabelOptions(ChartAxisLabelOptions secondaryYAxisLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary
y-axis(line) field well.
|
ComboChartConfiguration |
withSingleAxisOptions(SingleAxisOptions singleAxisOptions) |
ComboChartConfiguration |
withSortConfiguration(ComboChartSortConfiguration sortConfiguration)
The sort configuration of a
ComboChartVisual . |
ComboChartConfiguration |
withTooltip(TooltipOptions tooltip)
The legend display setup of the visual.
|
ComboChartConfiguration |
withVisualPalette(VisualPalette visualPalette)
The palette (chart color) display setup of the visual.
|
public void setFieldWells(ComboChartFieldWells fieldWells)
The field wells of the visual.
fieldWells
- The field wells of the visual.public ComboChartFieldWells getFieldWells()
The field wells of the visual.
public ComboChartConfiguration withFieldWells(ComboChartFieldWells fieldWells)
The field wells of the visual.
fieldWells
- The field wells of the visual.public void setSortConfiguration(ComboChartSortConfiguration sortConfiguration)
The sort configuration of a ComboChartVisual
.
sortConfiguration
- The sort configuration of a ComboChartVisual
.public ComboChartSortConfiguration getSortConfiguration()
The sort configuration of a ComboChartVisual
.
ComboChartVisual
.public ComboChartConfiguration withSortConfiguration(ComboChartSortConfiguration sortConfiguration)
The sort configuration of a ComboChartVisual
.
sortConfiguration
- The sort configuration of a ComboChartVisual
.public void setBarsArrangement(String barsArrangement)
Determines the bar arrangement in a combo chart. The following are valid values in this structure:
CLUSTERED
: For clustered bar combo charts.
STACKED
: For stacked bar combo charts.
STACKED_PERCENT
: Do not use. If you use this value, the operation returns a validation error.
barsArrangement
- Determines the bar arrangement in a combo chart. The following are valid values in this structure:
CLUSTERED
: For clustered bar combo charts.
STACKED
: For stacked bar combo charts.
STACKED_PERCENT
: Do not use. If you use this value, the operation returns a validation error.
BarsArrangement
public String getBarsArrangement()
Determines the bar arrangement in a combo chart. The following are valid values in this structure:
CLUSTERED
: For clustered bar combo charts.
STACKED
: For stacked bar combo charts.
STACKED_PERCENT
: Do not use. If you use this value, the operation returns a validation error.
CLUSTERED
: For clustered bar combo charts.
STACKED
: For stacked bar combo charts.
STACKED_PERCENT
: Do not use. If you use this value, the operation returns a validation
error.
BarsArrangement
public ComboChartConfiguration withBarsArrangement(String barsArrangement)
Determines the bar arrangement in a combo chart. The following are valid values in this structure:
CLUSTERED
: For clustered bar combo charts.
STACKED
: For stacked bar combo charts.
STACKED_PERCENT
: Do not use. If you use this value, the operation returns a validation error.
barsArrangement
- Determines the bar arrangement in a combo chart. The following are valid values in this structure:
CLUSTERED
: For clustered bar combo charts.
STACKED
: For stacked bar combo charts.
STACKED_PERCENT
: Do not use. If you use this value, the operation returns a validation error.
BarsArrangement
public ComboChartConfiguration withBarsArrangement(BarsArrangement barsArrangement)
Determines the bar arrangement in a combo chart. The following are valid values in this structure:
CLUSTERED
: For clustered bar combo charts.
STACKED
: For stacked bar combo charts.
STACKED_PERCENT
: Do not use. If you use this value, the operation returns a validation error.
barsArrangement
- Determines the bar arrangement in a combo chart. The following are valid values in this structure:
CLUSTERED
: For clustered bar combo charts.
STACKED
: For stacked bar combo charts.
STACKED_PERCENT
: Do not use. If you use this value, the operation returns a validation error.
BarsArrangement
public void setCategoryAxis(AxisDisplayOptions categoryAxis)
The category axis of a combo chart.
categoryAxis
- The category axis of a combo chart.public AxisDisplayOptions getCategoryAxis()
The category axis of a combo chart.
public ComboChartConfiguration withCategoryAxis(AxisDisplayOptions categoryAxis)
The category axis of a combo chart.
categoryAxis
- The category axis of a combo chart.public void setCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.
categoryLabelOptions
- The label options (label text, label visibility, and sort icon visibility) of a combo chart category
(group/color) field well.public ChartAxisLabelOptions getCategoryLabelOptions()
The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.
public ComboChartConfiguration withCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.
categoryLabelOptions
- The label options (label text, label visibility, and sort icon visibility) of a combo chart category
(group/color) field well.public void setPrimaryYAxisDisplayOptions(AxisDisplayOptions primaryYAxisDisplayOptions)
The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.
primaryYAxisDisplayOptions
- The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar)
field well.public AxisDisplayOptions getPrimaryYAxisDisplayOptions()
The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.
public ComboChartConfiguration withPrimaryYAxisDisplayOptions(AxisDisplayOptions primaryYAxisDisplayOptions)
The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.
primaryYAxisDisplayOptions
- The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar)
field well.public void setPrimaryYAxisLabelOptions(ChartAxisLabelOptions primaryYAxisLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.
primaryYAxisLabelOptions
- The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary
y-axis (bar) field well.public ChartAxisLabelOptions getPrimaryYAxisLabelOptions()
The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.
public ComboChartConfiguration withPrimaryYAxisLabelOptions(ChartAxisLabelOptions primaryYAxisLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.
primaryYAxisLabelOptions
- The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary
y-axis (bar) field well.public void setSecondaryYAxisDisplayOptions(AxisDisplayOptions secondaryYAxisDisplayOptions)
The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.
secondaryYAxisDisplayOptions
- The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line)
field well.public AxisDisplayOptions getSecondaryYAxisDisplayOptions()
The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.
public ComboChartConfiguration withSecondaryYAxisDisplayOptions(AxisDisplayOptions secondaryYAxisDisplayOptions)
The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.
secondaryYAxisDisplayOptions
- The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line)
field well.public void setSecondaryYAxisLabelOptions(ChartAxisLabelOptions secondaryYAxisLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.
secondaryYAxisLabelOptions
- The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary
y-axis(line) field well.public ChartAxisLabelOptions getSecondaryYAxisLabelOptions()
The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.
public ComboChartConfiguration withSecondaryYAxisLabelOptions(ChartAxisLabelOptions secondaryYAxisLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.
secondaryYAxisLabelOptions
- The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary
y-axis(line) field well.public void setSingleAxisOptions(SingleAxisOptions singleAxisOptions)
singleAxisOptions
- public SingleAxisOptions getSingleAxisOptions()
public ComboChartConfiguration withSingleAxisOptions(SingleAxisOptions singleAxisOptions)
singleAxisOptions
- public void setColorLabelOptions(ChartAxisLabelOptions colorLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
colorLabelOptions
- The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field
well.public ChartAxisLabelOptions getColorLabelOptions()
The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
public ComboChartConfiguration withColorLabelOptions(ChartAxisLabelOptions colorLabelOptions)
The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
colorLabelOptions
- The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field
well.public void setLegend(LegendOptions legend)
The legend display setup of the visual.
legend
- The legend display setup of the visual.public LegendOptions getLegend()
The legend display setup of the visual.
public ComboChartConfiguration withLegend(LegendOptions legend)
The legend display setup of the visual.
legend
- The legend display setup of the visual.public void setBarDataLabels(DataLabelOptions barDataLabels)
The options that determine if visual data labels are displayed.
The data label options for a bar in a combo chart.
barDataLabels
- The options that determine if visual data labels are displayed.
The data label options for a bar in a combo chart.
public DataLabelOptions getBarDataLabels()
The options that determine if visual data labels are displayed.
The data label options for a bar in a combo chart.
The data label options for a bar in a combo chart.
public ComboChartConfiguration withBarDataLabels(DataLabelOptions barDataLabels)
The options that determine if visual data labels are displayed.
The data label options for a bar in a combo chart.
barDataLabels
- The options that determine if visual data labels are displayed.
The data label options for a bar in a combo chart.
public void setLineDataLabels(DataLabelOptions lineDataLabels)
The options that determine if visual data labels are displayed.
The data label options for a line in a combo chart.
lineDataLabels
- The options that determine if visual data labels are displayed.
The data label options for a line in a combo chart.
public DataLabelOptions getLineDataLabels()
The options that determine if visual data labels are displayed.
The data label options for a line in a combo chart.
The data label options for a line in a combo chart.
public ComboChartConfiguration withLineDataLabels(DataLabelOptions lineDataLabels)
The options that determine if visual data labels are displayed.
The data label options for a line in a combo chart.
lineDataLabels
- The options that determine if visual data labels are displayed.
The data label options for a line in a combo chart.
public void setTooltip(TooltipOptions tooltip)
The legend display setup of the visual.
tooltip
- The legend display setup of the visual.public TooltipOptions getTooltip()
The legend display setup of the visual.
public ComboChartConfiguration withTooltip(TooltipOptions tooltip)
The legend display setup of the visual.
tooltip
- The legend display setup of the visual.public List<ReferenceLine> getReferenceLines()
The reference line setup of the visual.
public void setReferenceLines(Collection<ReferenceLine> referenceLines)
The reference line setup of the visual.
referenceLines
- The reference line setup of the visual.public ComboChartConfiguration withReferenceLines(ReferenceLine... referenceLines)
The reference line setup of the visual.
NOTE: This method appends the values to the existing list (if any). Use
setReferenceLines(java.util.Collection)
or withReferenceLines(java.util.Collection)
if you want
to override the existing values.
referenceLines
- The reference line setup of the visual.public ComboChartConfiguration withReferenceLines(Collection<ReferenceLine> referenceLines)
The reference line setup of the visual.
referenceLines
- The reference line setup of the visual.public void setVisualPalette(VisualPalette visualPalette)
The palette (chart color) display setup of the visual.
visualPalette
- The palette (chart color) display setup of the visual.public VisualPalette getVisualPalette()
The palette (chart color) display setup of the visual.
public ComboChartConfiguration withVisualPalette(VisualPalette visualPalette)
The palette (chart color) display setup of the visual.
visualPalette
- The palette (chart color) display setup of the visual.public void setInteractions(VisualInteractionOptions interactions)
The general visual interactions setup for a visual.
interactions
- The general visual interactions setup for a visual.public VisualInteractionOptions getInteractions()
The general visual interactions setup for a visual.
public ComboChartConfiguration withInteractions(VisualInteractionOptions interactions)
The general visual interactions setup for a visual.
interactions
- The general visual interactions setup for a visual.public String toString()
toString
in class Object
Object.toString()
public ComboChartConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.