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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePieChartConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PieChartConfiguration.Builderbuilder()ChartAxisLabelOptionscategoryLabelOptions()The label options of the group/color that is displayed in a pie chart.List<ContributionAnalysisDefault>contributionAnalysisDefaults()The contribution analysis (anomaly configuration) setup of the visual.DataLabelOptionsdataLabels()The options that determine if visual data labels are displayed.DonutOptionsdonutOptions()The options that determine the shape of the chart.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)PieChartFieldWellsfieldWells()The field wells of the visual.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasContributionAnalysisDefaults()For responses, this returns true if the service returned a value for the ContributionAnalysisDefaults property.inthashCode()LegendOptionslegend()The legend display setup of the visual.List<SdkField<?>>sdkFields()static Class<? extends PieChartConfiguration.Builder>serializableBuilderClass()SmallMultiplesOptionssmallMultiplesOptions()The small multiples setup for the visual.PieChartSortConfigurationsortConfiguration()The sort configuration of a pie chart.PieChartConfiguration.BuildertoBuilder()TooltipOptionstooltip()The tooltip display setup of the visual.StringtoString()Returns a string representation of this object.ChartAxisLabelOptionsvalueLabelOptions()The label options for the value that is displayed in a pie chart.VisualPalettevisualPalette()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 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 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.
-
toBuilder
public PieChartConfiguration.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PieChartConfiguration.Builder,PieChartConfiguration>
-
builder
public static PieChartConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends PieChartConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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.
-
-