Class BarChartConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.quicksight.model.BarChartConfiguration
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BarChartConfiguration.Builder,BarChartConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class BarChartConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BarChartConfiguration.Builder,BarChartConfiguration>
The configuration of a
BarChartVisual
.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
BarChartConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BarsArrangement
barsArrangement()
Determines the arrangement of the bars.String
barsArrangementAsString()
Determines the arrangement of the bars.static BarChartConfiguration.Builder
builder()
AxisDisplayOptions
categoryAxis()
The label display options (grid line, range, scale, axis step) for bar chart category.ChartAxisLabelOptions
categoryLabelOptions()
The label options (label text, label visibility and sort icon visibility) for a bar chart.ChartAxisLabelOptions
colorLabelOptions()
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.List<ContributionAnalysisDefault>
contributionAnalysisDefaults()
The contribution analysis (anomaly configuration) setup of the visual.DataLabelOptions
dataLabels()
The options that determine if visual data labels are displayed.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
BarChartFieldWells
fieldWells()
The field wells of the visual.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasContributionAnalysisDefaults()
For responses, this returns true if the service returned a value for the ContributionAnalysisDefaults property.int
hashCode()
boolean
hasReferenceLines()
For responses, this returns true if the service returned a value for the ReferenceLines property.VisualInteractionOptions
interactions()
The general visual interactions setup for a visual.LegendOptions
legend()
The legend display setup of the visual.BarChartOrientation
orientation()
The orientation of the bars in a bar chart visual.String
orientationAsString()
The orientation of the bars in a bar chart visual.List<ReferenceLine>
referenceLines()
The reference line setup of the visual.List<SdkField<?>>
sdkFields()
static Class<? extends BarChartConfiguration.Builder>
serializableBuilderClass()
SmallMultiplesOptions
smallMultiplesOptions()
The small multiples setup for the visual.BarChartSortConfiguration
sortConfiguration()
The sort configuration of aBarChartVisual
.BarChartConfiguration.Builder
toBuilder()
TooltipOptions
tooltip()
The tooltip display setup of the visual.String
toString()
Returns a string representation of this object.AxisDisplayOptions
valueAxis()
The label display options (grid line, range, scale, axis step) for a bar chart value.ChartAxisLabelOptions
valueLabelOptions()
The label options (label text, label visibility and sort icon visibility) for a bar chart value.VisualPalette
visualPalette()
The palette (chart color) display setup of the visual.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
fieldWells
public final BarChartFieldWells fieldWells()
The field wells of the visual.
- Returns:
- The field wells of the visual.
-
sortConfiguration
public final BarChartSortConfiguration sortConfiguration()
The sort configuration of a
BarChartVisual
.- Returns:
- The sort configuration of a
BarChartVisual
.
-
orientation
public final 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.
If the service returns an enum value that is not available in the current SDK version,
orientation
will returnBarChartOrientation.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromorientationAsString()
.- Returns:
- 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.
-
- See Also:
BarChartOrientation
-
-
orientationAsString
public final String orientationAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
orientation
will returnBarChartOrientation.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromorientationAsString()
.- Returns:
- 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.
-
- See Also:
BarChartOrientation
-
-
barsArrangement
public final 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.
If the service returns an enum value that is not available in the current SDK version,
barsArrangement
will returnBarsArrangement.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombarsArrangementAsString()
.- Returns:
- Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.
- See Also:
BarsArrangement
-
barsArrangementAsString
public final String barsArrangementAsString()
Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.
If the service returns an enum value that is not available in the current SDK version,
barsArrangement
will returnBarsArrangement.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombarsArrangementAsString()
.- Returns:
- Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.
- See Also:
BarsArrangement
-
visualPalette
public final VisualPalette visualPalette()
The palette (chart color) display setup of the visual.
- Returns:
- The palette (chart color) display setup of the visual.
-
smallMultiplesOptions
public final SmallMultiplesOptions smallMultiplesOptions()
The small multiples setup for the visual.
- Returns:
- The small multiples setup for the visual.
-
categoryAxis
public final AxisDisplayOptions categoryAxis()
The label display options (grid line, range, scale, axis step) for bar chart category.
- Returns:
- The label display options (grid line, range, scale, axis step) for bar chart category.
-
categoryLabelOptions
public final ChartAxisLabelOptions categoryLabelOptions()
The label options (label text, label visibility and sort icon visibility) for a bar chart.
- Returns:
- The label options (label text, label visibility and sort icon visibility) for a bar chart.
-
valueAxis
public final AxisDisplayOptions valueAxis()
The label display options (grid line, range, scale, axis step) for a bar chart value.
- Returns:
- The label display options (grid line, range, scale, axis step) for a bar chart value.
-
valueLabelOptions
public final ChartAxisLabelOptions valueLabelOptions()
The label options (label text, label visibility and sort icon visibility) for a bar chart value.
- Returns:
- The label options (label text, label visibility and sort icon visibility) for a bar chart value.
-
colorLabelOptions
public final ChartAxisLabelOptions colorLabelOptions()
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
- Returns:
- The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
-
legend
public final LegendOptions legend()
The legend display setup of the visual.
- Returns:
- The legend display setup of the visual.
-
dataLabels
public final DataLabelOptions dataLabels()
The options that determine if visual data labels are displayed.
- Returns:
- The options that determine if visual data labels are displayed.
-
tooltip
public final TooltipOptions tooltip()
The tooltip display setup of the visual.
- Returns:
- The tooltip display setup of the visual.
-
hasReferenceLines
public final boolean hasReferenceLines()
For responses, this returns true if the service returned a value for the ReferenceLines property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
referenceLines
public final List<ReferenceLine> referenceLines()
The reference line setup of the visual.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasReferenceLines()
method.- Returns:
- The reference line setup of the visual.
-
hasContributionAnalysisDefaults
public final boolean hasContributionAnalysisDefaults()
For responses, this returns true if the service returned a value for the ContributionAnalysisDefaults property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
contributionAnalysisDefaults
public final List<ContributionAnalysisDefault> contributionAnalysisDefaults()
The contribution analysis (anomaly configuration) setup of the visual.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasContributionAnalysisDefaults()
method.- Returns:
- The contribution analysis (anomaly configuration) setup of the visual.
-
interactions
public final VisualInteractionOptions interactions()
The general visual interactions setup for a visual.
- Returns:
- The general visual interactions setup for a visual.
-
toBuilder
public BarChartConfiguration.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<BarChartConfiguration.Builder,BarChartConfiguration>
-
builder
public static BarChartConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends BarChartConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-