com.amazonaws.services.quicksight.model

Class HistogramVisual

java.lang.Object

com.amazonaws.services.quicksight.model.HistogramVisual

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HistogramVisual
extends Object
implements Serializable, Cloneable, StructuredPojo

A histogram.

For more information, see Using histograms in the Amazon QuickSight User Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
HistogramVisual()

Method Summary

Modifier and Type	Method and Description
HistogramVisual	clone()
boolean	equals(Object obj)
List<VisualCustomAction>	getActions() The list of custom actions that are configured for a visual.
HistogramConfiguration	getChartConfiguration() The configuration for a HistogramVisual.
VisualSubtitleLabelOptions	getSubtitle() The subtitle that is displayed on the visual.
VisualTitleLabelOptions	getTitle() The title that is displayed on the visual.
String	getVisualId() The unique identifier of a visual.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setActions(Collection<VisualCustomAction> actions) The list of custom actions that are configured for a visual.
void	setChartConfiguration(HistogramConfiguration chartConfiguration) The configuration for a HistogramVisual.
void	setSubtitle(VisualSubtitleLabelOptions subtitle) The subtitle that is displayed on the visual.
void	setTitle(VisualTitleLabelOptions title) The title that is displayed on the visual.
void	setVisualId(String visualId) The unique identifier of a visual.
String	toString() Returns a string representation of this object.
HistogramVisual	withActions(Collection<VisualCustomAction> actions) The list of custom actions that are configured for a visual.
HistogramVisual	withActions(VisualCustomAction... actions) The list of custom actions that are configured for a visual.
HistogramVisual	withChartConfiguration(HistogramConfiguration chartConfiguration) The configuration for a HistogramVisual.
HistogramVisual	withSubtitle(VisualSubtitleLabelOptions subtitle) The subtitle that is displayed on the visual.
HistogramVisual	withTitle(VisualTitleLabelOptions title) The title that is displayed on the visual.
HistogramVisual	withVisualId(String visualId) The unique identifier of a visual.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HistogramVisual

public HistogramVisual()

Method Detail

setVisualId

public void setVisualId(String 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.

Parameters:

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.

getVisualId

public String getVisualId()

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.

withVisualId

public HistogramVisual withVisualId(String 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setTitle

public void setTitle(VisualTitleLabelOptions title)

The title that is displayed on the visual.

Parameters:

title - The title that is displayed on the visual.

getTitle

public VisualTitleLabelOptions getTitle()

The title that is displayed on the visual.

Returns:

The title that is displayed on the visual.

withTitle

public HistogramVisual withTitle(VisualTitleLabelOptions title)

The title that is displayed on the visual.

Parameters:

title - The title that is displayed on the visual.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSubtitle

public void setSubtitle(VisualSubtitleLabelOptions subtitle)

The subtitle that is displayed on the visual.

Parameters:

subtitle - The subtitle that is displayed on the visual.

getSubtitle

public VisualSubtitleLabelOptions getSubtitle()

The subtitle that is displayed on the visual.

Returns:

The subtitle that is displayed on the visual.

withSubtitle

public HistogramVisual withSubtitle(VisualSubtitleLabelOptions subtitle)

The subtitle that is displayed on the visual.

Parameters:

subtitle - The subtitle that is displayed on the visual.

Returns:

Returns a reference to this object so that method calls can be chained together.

setChartConfiguration

public void setChartConfiguration(HistogramConfiguration chartConfiguration)

The configuration for a HistogramVisual.

Parameters:

chartConfiguration - The configuration for a HistogramVisual.

getChartConfiguration

public HistogramConfiguration getChartConfiguration()

The configuration for a HistogramVisual.

Returns:

The configuration for a HistogramVisual.

withChartConfiguration

public HistogramVisual withChartConfiguration(HistogramConfiguration chartConfiguration)

The configuration for a HistogramVisual.

Parameters:

chartConfiguration - The configuration for a HistogramVisual.

Returns:

Returns a reference to this object so that method calls can be chained together.

getActions

public List<VisualCustomAction> getActions()

The list of custom actions that are configured for a visual.

Returns:

The list of custom actions that are configured for a visual.

setActions

public void setActions(Collection<VisualCustomAction> actions)

The list of custom actions that are configured for a visual.

Parameters:

actions - The list of custom actions that are configured for a visual.

withActions

public HistogramVisual withActions(VisualCustomAction... actions)

The list of custom actions that are configured for a visual.

NOTE: This method appends the values to the existing list (if any). Use setActions(java.util.Collection) or withActions(java.util.Collection) if you want to override the existing values.

Parameters:

actions - The list of custom actions that are configured for a visual.

Returns:

Returns a reference to this object so that method calls can be chained together.

withActions

public HistogramVisual withActions(Collection<VisualCustomAction> actions)

The list of custom actions that are configured for a visual.

Parameters:

actions - The list of custom actions that are configured for a visual.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public HistogramVisual clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo