Class PieChartConfiguration

java.lang.Object
software.amazon.awssdk.services.quicksight.model.PieChartConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PieChartConfiguration.Builder,PieChartConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class PieChartConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PieChartConfiguration.Builder,PieChartConfiguration>

The configuration of a pie chart.

See Also:

  • Method Details

    • fieldWells

      public final PieChartFieldWells fieldWells()

      The field wells of the visual.

      Returns:
      The field wells of the visual.

    • sortConfiguration

      public final PieChartSortConfiguration sortConfiguration()

      The sort configuration of a pie chart.

      Returns:
      The sort configuration of a pie chart.

    • donutOptions

      public final DonutOptions donutOptions()

      The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.

      Returns:
      The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.

    • smallMultiplesOptions

      public final SmallMultiplesOptions smallMultiplesOptions()

      The small multiples setup for the visual.

      Returns:
      The small multiples setup for the visual.

    • categoryLabelOptions

      public final ChartAxisLabelOptions categoryLabelOptions()

      The label options of the group/color that is displayed in a pie chart.

      Returns:
      The label options of the group/color that is displayed in a pie chart.

    • valueLabelOptions

      public final ChartAxisLabelOptions valueLabelOptions()

      The label options for the value that is displayed in a pie chart.

      Returns:
      The label options for the value that is displayed in a pie 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.

    • visualPalette

      public final VisualPalette visualPalette()

      The palette (chart color) display setup of the visual.

      Returns:
      The palette (chart color) display 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 PieChartConfiguration.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<PieChartConfiguration.Builder,PieChartConfiguration>
      Returns:
      a builder for type T

    • builder

      public static PieChartConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PieChartConfiguration.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.