@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class BarChartConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
The configuration of a BarChartVisual
.
Constructor and Description |
---|
BarChartConfiguration() |
Modifier and Type | Method and Description |
---|---|
BarChartConfiguration |
clone() |
boolean |
equals(Object obj) |
String |
getBarsArrangement()
Determines the arrangement of the bars.
|
AxisDisplayOptions |
getCategoryAxis()
The label display options (grid line, range, scale, axis step) for bar chart category.
|
ChartAxisLabelOptions |
getCategoryLabelOptions()
The label options (label text, label visibility and sort icon visibility) for a bar chart.
|
ChartAxisLabelOptions |
getColorLabelOptions()
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar
chart.
|
List<ContributionAnalysisDefault> |
getContributionAnalysisDefaults()
The contribution analysis (anomaly configuration) setup of the visual.
|
DataLabelOptions |
getDataLabels()
The options that determine if visual data labels are displayed.
|
BarChartFieldWells |
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.
|
String |
getOrientation()
The orientation of the bars in a bar chart visual.
|
List<ReferenceLine> |
getReferenceLines()
The reference line setup of the visual.
|
SmallMultiplesOptions |
getSmallMultiplesOptions()
The small multiples setup for the visual.
|
BarChartSortConfiguration |
getSortConfiguration()
The sort configuration of a
BarChartVisual . |
TooltipOptions |
getTooltip()
The tooltip display setup of the visual.
|
AxisDisplayOptions |
getValueAxis()
The label display options (grid line, range, scale, axis step) for a bar chart value.
|
ChartAxisLabelOptions |
getValueLabelOptions()
The label options (label text, label visibility and sort icon visibility) for a bar chart value.
|
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 |
setBarsArrangement(String barsArrangement)
Determines the arrangement of the bars.
|
void |
setCategoryAxis(AxisDisplayOptions categoryAxis)
The label display options (grid line, range, scale, axis step) for bar chart category.
|
void |
setCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)
The label options (label text, label visibility and sort icon visibility) for a bar chart.
|
void |
setColorLabelOptions(ChartAxisLabelOptions colorLabelOptions)
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar
chart.
|
void |
setContributionAnalysisDefaults(Collection<ContributionAnalysisDefault> contributionAnalysisDefaults)
The contribution analysis (anomaly configuration) setup of the visual.
|
void |
setDataLabels(DataLabelOptions dataLabels)
The options that determine if visual data labels are displayed.
|
void |
setFieldWells(BarChartFieldWells 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 |
setOrientation(String orientation)
The orientation of the bars in a bar chart visual.
|
void |
setReferenceLines(Collection<ReferenceLine> referenceLines)
The reference line setup of the visual.
|
void |
setSmallMultiplesOptions(SmallMultiplesOptions smallMultiplesOptions)
The small multiples setup for the visual.
|
void |
setSortConfiguration(BarChartSortConfiguration sortConfiguration)
The sort configuration of a
BarChartVisual . |
void |
setTooltip(TooltipOptions tooltip)
The tooltip display setup of the visual.
|
void |
setValueAxis(AxisDisplayOptions valueAxis)
The label display options (grid line, range, scale, axis step) for a bar chart value.
|
void |
setValueLabelOptions(ChartAxisLabelOptions valueLabelOptions)
The label options (label text, label visibility and sort icon visibility) for a bar chart value.
|
void |
setVisualPalette(VisualPalette visualPalette)
The palette (chart color) display setup of the visual.
|
String |
toString()
Returns a string representation of this object.
|
BarChartConfiguration |
withBarsArrangement(BarsArrangement barsArrangement)
Determines the arrangement of the bars.
|
BarChartConfiguration |
withBarsArrangement(String barsArrangement)
Determines the arrangement of the bars.
|
BarChartConfiguration |
withCategoryAxis(AxisDisplayOptions categoryAxis)
The label display options (grid line, range, scale, axis step) for bar chart category.
|
BarChartConfiguration |
withCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)
The label options (label text, label visibility and sort icon visibility) for a bar chart.
|
BarChartConfiguration |
withColorLabelOptions(ChartAxisLabelOptions colorLabelOptions)
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar
chart.
|
BarChartConfiguration |
withContributionAnalysisDefaults(Collection<ContributionAnalysisDefault> contributionAnalysisDefaults)
The contribution analysis (anomaly configuration) setup of the visual.
|
BarChartConfiguration |
withContributionAnalysisDefaults(ContributionAnalysisDefault... contributionAnalysisDefaults)
The contribution analysis (anomaly configuration) setup of the visual.
|
BarChartConfiguration |
withDataLabels(DataLabelOptions dataLabels)
The options that determine if visual data labels are displayed.
|
BarChartConfiguration |
withFieldWells(BarChartFieldWells fieldWells)
The field wells of the visual.
|
BarChartConfiguration |
withInteractions(VisualInteractionOptions interactions)
The general visual interactions setup for a visual.
|
BarChartConfiguration |
withLegend(LegendOptions legend)
The legend display setup of the visual.
|
BarChartConfiguration |
withOrientation(BarChartOrientation orientation)
The orientation of the bars in a bar chart visual.
|
BarChartConfiguration |
withOrientation(String orientation)
The orientation of the bars in a bar chart visual.
|
BarChartConfiguration |
withReferenceLines(Collection<ReferenceLine> referenceLines)
The reference line setup of the visual.
|
BarChartConfiguration |
withReferenceLines(ReferenceLine... referenceLines)
The reference line setup of the visual.
|
BarChartConfiguration |
withSmallMultiplesOptions(SmallMultiplesOptions smallMultiplesOptions)
The small multiples setup for the visual.
|
BarChartConfiguration |
withSortConfiguration(BarChartSortConfiguration sortConfiguration)
The sort configuration of a
BarChartVisual . |
BarChartConfiguration |
withTooltip(TooltipOptions tooltip)
The tooltip display setup of the visual.
|
BarChartConfiguration |
withValueAxis(AxisDisplayOptions valueAxis)
The label display options (grid line, range, scale, axis step) for a bar chart value.
|
BarChartConfiguration |
withValueLabelOptions(ChartAxisLabelOptions valueLabelOptions)
The label options (label text, label visibility and sort icon visibility) for a bar chart value.
|
BarChartConfiguration |
withVisualPalette(VisualPalette visualPalette)
The palette (chart color) display setup of the visual.
|
public void setFieldWells(BarChartFieldWells fieldWells)
The field wells of the visual.
fieldWells
- The field wells of the visual.public BarChartFieldWells getFieldWells()
The field wells of the visual.
public BarChartConfiguration withFieldWells(BarChartFieldWells fieldWells)
The field wells of the visual.
fieldWells
- The field wells of the visual.public void setSortConfiguration(BarChartSortConfiguration sortConfiguration)
The sort configuration of a BarChartVisual
.
sortConfiguration
- The sort configuration of a BarChartVisual
.public BarChartSortConfiguration getSortConfiguration()
The sort configuration of a BarChartVisual
.
BarChartVisual
.public BarChartConfiguration withSortConfiguration(BarChartSortConfiguration sortConfiguration)
The sort configuration of a BarChartVisual
.
sortConfiguration
- The sort configuration of a BarChartVisual
.public void setOrientation(String orientation)
The orientation of the bars in a bar chart visual. There are two valid values in this structure:
HORIZONTAL
: Used for charts that have horizontal bars. Visuals that use this value are horizontal
bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.
VERTICAL
: Used for charts that have vertical bars. Visuals that use this value are vertical bar
charts, vertical stacked bar charts, and vertical stacked 100% bar charts.
orientation
- The orientation of the bars in a bar chart visual. There are two valid values in this structure:
HORIZONTAL
: Used for charts that have horizontal bars. Visuals that use this value are
horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.
VERTICAL
: Used for charts that have vertical bars. Visuals that use this value are vertical
bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.
BarChartOrientation
public String getOrientation()
The orientation of the bars in a bar chart visual. There are two valid values in this structure:
HORIZONTAL
: Used for charts that have horizontal bars. Visuals that use this value are horizontal
bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.
VERTICAL
: Used for charts that have vertical bars. Visuals that use this value are vertical bar
charts, vertical stacked bar charts, and vertical stacked 100% bar charts.
HORIZONTAL
: Used for charts that have horizontal bars. Visuals that use this value are
horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.
VERTICAL
: Used for charts that have vertical bars. Visuals that use this value are vertical
bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.
BarChartOrientation
public BarChartConfiguration withOrientation(String orientation)
The orientation of the bars in a bar chart visual. There are two valid values in this structure:
HORIZONTAL
: Used for charts that have horizontal bars. Visuals that use this value are horizontal
bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.
VERTICAL
: Used for charts that have vertical bars. Visuals that use this value are vertical bar
charts, vertical stacked bar charts, and vertical stacked 100% bar charts.
orientation
- The orientation of the bars in a bar chart visual. There are two valid values in this structure:
HORIZONTAL
: Used for charts that have horizontal bars. Visuals that use this value are
horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.
VERTICAL
: Used for charts that have vertical bars. Visuals that use this value are vertical
bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.
BarChartOrientation
public BarChartConfiguration withOrientation(BarChartOrientation orientation)
The orientation of the bars in a bar chart visual. There are two valid values in this structure:
HORIZONTAL
: Used for charts that have horizontal bars. Visuals that use this value are horizontal
bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.
VERTICAL
: Used for charts that have vertical bars. Visuals that use this value are vertical bar
charts, vertical stacked bar charts, and vertical stacked 100% bar charts.
orientation
- The orientation of the bars in a bar chart visual. There are two valid values in this structure:
HORIZONTAL
: Used for charts that have horizontal bars. Visuals that use this value are
horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.
VERTICAL
: Used for charts that have vertical bars. Visuals that use this value are vertical
bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.
BarChartOrientation
public void setBarsArrangement(String barsArrangement)
Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.
barsArrangement
- Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar
that is used in the visual.BarsArrangement
public String getBarsArrangement()
Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.
BarsArrangement
public BarChartConfiguration withBarsArrangement(String barsArrangement)
Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.
barsArrangement
- Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar
that is used in the visual.BarsArrangement
public BarChartConfiguration withBarsArrangement(BarsArrangement barsArrangement)
Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.
barsArrangement
- Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar
that is used in the visual.BarsArrangement
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 BarChartConfiguration withVisualPalette(VisualPalette visualPalette)
The palette (chart color) display setup of the visual.
visualPalette
- The palette (chart color) display setup of the visual.public void setSmallMultiplesOptions(SmallMultiplesOptions smallMultiplesOptions)
The small multiples setup for the visual.
smallMultiplesOptions
- The small multiples setup for the visual.public SmallMultiplesOptions getSmallMultiplesOptions()
The small multiples setup for the visual.
public BarChartConfiguration withSmallMultiplesOptions(SmallMultiplesOptions smallMultiplesOptions)
The small multiples setup for the visual.
smallMultiplesOptions
- The small multiples setup for the visual.public void setCategoryAxis(AxisDisplayOptions categoryAxis)
The label display options (grid line, range, scale, axis step) for bar chart category.
categoryAxis
- The label display options (grid line, range, scale, axis step) for bar chart category.public AxisDisplayOptions getCategoryAxis()
The label display options (grid line, range, scale, axis step) for bar chart category.
public BarChartConfiguration withCategoryAxis(AxisDisplayOptions categoryAxis)
The label display options (grid line, range, scale, axis step) for bar chart category.
categoryAxis
- The label display options (grid line, range, scale, axis step) for bar chart category.public void setCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)
The label options (label text, label visibility and sort icon visibility) for a bar chart.
categoryLabelOptions
- The label options (label text, label visibility and sort icon visibility) for a bar chart.public ChartAxisLabelOptions getCategoryLabelOptions()
The label options (label text, label visibility and sort icon visibility) for a bar chart.
public BarChartConfiguration withCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)
The label options (label text, label visibility and sort icon visibility) for a bar chart.
categoryLabelOptions
- The label options (label text, label visibility and sort icon visibility) for a bar chart.public void setValueAxis(AxisDisplayOptions valueAxis)
The label display options (grid line, range, scale, axis step) for a bar chart value.
valueAxis
- The label display options (grid line, range, scale, axis step) for a bar chart value.public AxisDisplayOptions getValueAxis()
The label display options (grid line, range, scale, axis step) for a bar chart value.
public BarChartConfiguration withValueAxis(AxisDisplayOptions valueAxis)
The label display options (grid line, range, scale, axis step) for a bar chart value.
valueAxis
- The label display options (grid line, range, scale, axis step) for a bar chart value.public void setValueLabelOptions(ChartAxisLabelOptions valueLabelOptions)
The label options (label text, label visibility and sort icon visibility) for a bar chart value.
valueLabelOptions
- The label options (label text, label visibility and sort icon visibility) for a bar chart value.public ChartAxisLabelOptions getValueLabelOptions()
The label options (label text, label visibility and sort icon visibility) for a bar chart value.
public BarChartConfiguration withValueLabelOptions(ChartAxisLabelOptions valueLabelOptions)
The label options (label text, label visibility and sort icon visibility) for a bar chart value.
valueLabelOptions
- The label options (label text, label visibility and sort icon visibility) for a bar chart value.public void setColorLabelOptions(ChartAxisLabelOptions colorLabelOptions)
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
colorLabelOptions
- The label options (label text, label visibility and sort icon visibility) for a color that is used in a
bar chart.public ChartAxisLabelOptions getColorLabelOptions()
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
public BarChartConfiguration withColorLabelOptions(ChartAxisLabelOptions colorLabelOptions)
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
colorLabelOptions
- The label options (label text, label visibility and sort icon visibility) for a color that is used in a
bar chart.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 BarChartConfiguration withLegend(LegendOptions legend)
The legend display setup of the visual.
legend
- The legend display setup of the visual.public void setDataLabels(DataLabelOptions dataLabels)
The options that determine if visual data labels are displayed.
dataLabels
- The options that determine if visual data labels are displayed.public DataLabelOptions getDataLabels()
The options that determine if visual data labels are displayed.
public BarChartConfiguration withDataLabels(DataLabelOptions dataLabels)
The options that determine if visual data labels are displayed.
dataLabels
- The options that determine if visual data labels are displayed.public void setTooltip(TooltipOptions tooltip)
The tooltip display setup of the visual.
tooltip
- The tooltip display setup of the visual.public TooltipOptions getTooltip()
The tooltip display setup of the visual.
public BarChartConfiguration withTooltip(TooltipOptions tooltip)
The tooltip display setup of the visual.
tooltip
- The tooltip 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 BarChartConfiguration 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 BarChartConfiguration withReferenceLines(Collection<ReferenceLine> referenceLines)
The reference line setup of the visual.
referenceLines
- The reference line setup of the visual.public List<ContributionAnalysisDefault> getContributionAnalysisDefaults()
The contribution analysis (anomaly configuration) setup of the visual.
public void setContributionAnalysisDefaults(Collection<ContributionAnalysisDefault> contributionAnalysisDefaults)
The contribution analysis (anomaly configuration) setup of the visual.
contributionAnalysisDefaults
- The contribution analysis (anomaly configuration) setup of the visual.public BarChartConfiguration withContributionAnalysisDefaults(ContributionAnalysisDefault... contributionAnalysisDefaults)
The contribution analysis (anomaly configuration) setup of the visual.
NOTE: This method appends the values to the existing list (if any). Use
setContributionAnalysisDefaults(java.util.Collection)
or
withContributionAnalysisDefaults(java.util.Collection)
if you want to override the existing values.
contributionAnalysisDefaults
- The contribution analysis (anomaly configuration) setup of the visual.public BarChartConfiguration withContributionAnalysisDefaults(Collection<ContributionAnalysisDefault> contributionAnalysisDefaults)
The contribution analysis (anomaly configuration) setup of the visual.
contributionAnalysisDefaults
- The contribution analysis (anomaly configuration) 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 BarChartConfiguration 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 BarChartConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.