Class BarChartVisual
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BarChartVisual.Builder,
BarChartVisual>
A bar chart.
The BarChartVisual
structure describes a visual that is a member of the bar chart family. The following
charts can be described using this structure:
-
Horizontal bar chart
-
Vertical bar chart
-
Horizontal stacked bar chart
-
Vertical stacked bar chart
-
Horizontal stacked 100% bar chart
-
Vertical stacked 100% bar chart
For more information, see Using bar charts in the Amazon QuickSight User Guide.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<VisualCustomAction> actions()
The list of custom actions that are configured for a visual.static BarChartVisual.Builder
builder()
final BarChartConfiguration
The configuration settings of the visual.final List
<ColumnHierarchy> The column hierarchy that is used during drill-downs and drill-ups.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Actions property.final boolean
For responses, this returns true if the service returned a value for the ColumnHierarchies property.final int
hashCode()
static Class
<? extends BarChartVisual.Builder> subtitle()
The subtitle that is displayed on the visual.final VisualTitleLabelOptions
title()
The title that is displayed on the visual.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
visualId()
The unique identifier of a visual.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
visualId
The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
- Returns:
- The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
-
title
The title that is displayed on the visual.
- Returns:
- The title that is displayed on the visual.
-
subtitle
The subtitle that is displayed on the visual.
- Returns:
- The subtitle that is displayed on the visual.
-
chartConfiguration
The configuration settings of the visual.
- Returns:
- The configuration settings of the visual.
-
hasActions
public final boolean hasActions()For responses, this returns true if the service returned a value for the Actions 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. -
actions
The list of custom actions that are configured for a 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
hasActions()
method.- Returns:
- The list of custom actions that are configured for a visual.
-
hasColumnHierarchies
public final boolean hasColumnHierarchies()For responses, this returns true if the service returned a value for the ColumnHierarchies 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. -
columnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
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
hasColumnHierarchies()
method.- Returns:
- The column hierarchy that is used during drill-downs and drill-ups.
-
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 interfaceToCopyableBuilder<BarChartVisual.Builder,
BarChartVisual> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-