Package software.amazon.awssdk.services.quicksight.model

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:

  • Method Details

    • 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 return BarChartOrientation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orientationAsString().

      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:

    • 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 return BarChartOrientation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orientationAsString().

      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:

    • 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 return BarsArrangement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from barsArrangementAsString().

      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:

    • 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 return BarsArrangement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from barsArrangementAsString().

      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:

    • 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 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.

    • 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 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.

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<BarChartConfiguration.Builder,BarChartConfiguration>
      Returns:
      a builder for type T

    • builder

      public static BarChartConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BarChartConfiguration.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.