ComboChartConfiguration (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.quicksight.model.ComboChartConfiguration

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ComboChartConfiguration.Builder,ComboChartConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class ComboChartConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ComboChartConfiguration.Builder,ComboChartConfiguration>

The configuration of a ComboChartVisual.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ComboChartConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ComboChartConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataLabelOptions`	`barDataLabels()` The options that determine if visual data labels are displayed.
`BarsArrangement`	`barsArrangement()` Determines the bar arrangement in a combo chart.
`String`	`barsArrangementAsString()` Determines the bar arrangement in a combo chart.
`static ComboChartConfiguration.Builder`	`builder()`
`AxisDisplayOptions`	`categoryAxis()` The category axis of a combo chart.
`ChartAxisLabelOptions`	`categoryLabelOptions()` The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.
`ChartAxisLabelOptions`	`colorLabelOptions()` The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`ComboChartFieldWells`	`fieldWells()` The field wells of the visual.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasReferenceLines()` For responses, this returns true if the service returned a value for the ReferenceLines property.
`LegendOptions`	`legend()` The legend display setup of the visual.
`DataLabelOptions`	`lineDataLabels()` The options that determine if visual data labels are displayed.
`AxisDisplayOptions`	`primaryYAxisDisplayOptions()` The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.
`ChartAxisLabelOptions`	`primaryYAxisLabelOptions()` The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.
`List<ReferenceLine>`	`referenceLines()` The reference line setup of the visual.
`List<SdkField<?>>`	`sdkFields()`
`AxisDisplayOptions`	`secondaryYAxisDisplayOptions()` The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.
`ChartAxisLabelOptions`	`secondaryYAxisLabelOptions()` The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.
`static Class<? extends ComboChartConfiguration.Builder>`	`serializableBuilderClass()`
`ComboChartSortConfiguration`	`sortConfiguration()` The sort configuration of a `ComboChartVisual`.
`ComboChartConfiguration.Builder`	`toBuilder()`
`TooltipOptions`	`tooltip()` The legend display setup of the visual.
`String`	`toString()` Returns a string representation of this object.
`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 ComboChartFieldWells fieldWells()
```
    The field wells of the visual.
    
    Returns:
    
    The field wells of the visual.
  - sortConfiguration
```
public final ComboChartSortConfiguration sortConfiguration()
```
    The sort configuration of a ComboChartVisual.
    
    Returns:
    
    The sort configuration of a ComboChartVisual.
  - barsArrangement
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, barsArrangement will return BarsArrangement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from barsArrangementAsString().
    Returns:
    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.
    See Also:
    
    BarsArrangement
  - barsArrangementAsString
```
public final String barsArrangementAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, barsArrangement will return BarsArrangement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from barsArrangementAsString().
    Returns:
    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.
    See Also:
    
    BarsArrangement
  - categoryAxis
```
public final AxisDisplayOptions categoryAxis()
```
    The category axis of a combo chart.
    
    Returns:
    
    The category axis of a combo chart.
  - categoryLabelOptions
```
public final ChartAxisLabelOptions categoryLabelOptions()
```
    The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.
    
    Returns:
    
    The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.
  - primaryYAxisDisplayOptions
```
public final AxisDisplayOptions primaryYAxisDisplayOptions()
```
    The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.
    
    Returns:
    
    The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.
  - primaryYAxisLabelOptions
```
public final ChartAxisLabelOptions primaryYAxisLabelOptions()
```
    The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.
    
    Returns:
    
    The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.
  - secondaryYAxisDisplayOptions
```
public final AxisDisplayOptions secondaryYAxisDisplayOptions()
```
    The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.
    
    Returns:
    
    The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.
  - secondaryYAxisLabelOptions
```
public final ChartAxisLabelOptions secondaryYAxisLabelOptions()
```
    The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.
    
    Returns:
    
    The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.
  - colorLabelOptions
```
public final ChartAxisLabelOptions colorLabelOptions()
```
    The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
    
    Returns:
    
    The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
  - legend
```
public final LegendOptions legend()
```
    The legend display setup of the visual.
    
    Returns:
    
    The legend display setup of the visual.
  - barDataLabels
```
public final DataLabelOptions barDataLabels()
```
    The options that determine if visual data labels are displayed.
    
    The data label options for a bar in a combo chart.
    
    Returns:
    
    The options that determine if visual data labels are displayed.
    
    The data label options for a bar in a combo chart.
  - lineDataLabels
```
public final DataLabelOptions lineDataLabels()
```
    The options that determine if visual data labels are displayed.
    
    The data label options for a line in a combo chart.
    
    Returns:
    
    The options that determine if visual data labels are displayed.
    
    The data label options for a line in a combo chart.
  - tooltip
```
public final TooltipOptions tooltip()
```
    The legend display setup of the visual.
    
    Returns:
    
    The legend 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 the isEmpty() 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.
  - visualPalette
```
public final VisualPalette visualPalette()
```
    The palette (chart color) display setup of the visual.
    
    Returns:
    
    The palette (chart color) display setup of the visual.
  - toBuilder
```
public ComboChartConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ComboChartConfiguration.Builder,ComboChartConfiguration>
  - builder
```
public static ComboChartConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ComboChartConfiguration.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ComboChartConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

fieldWells

sortConfiguration

barsArrangement

barsArrangementAsString

categoryAxis

categoryLabelOptions

primaryYAxisDisplayOptions

primaryYAxisLabelOptions

secondaryYAxisDisplayOptions

secondaryYAxisLabelOptions

colorLabelOptions

legend

barDataLabels

lineDataLabels

tooltip

hasReferenceLines

referenceLines

visualPalette

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields