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

Class PanelConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.PanelConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PanelConfiguration.Builder,PanelConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class PanelConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PanelConfiguration.Builder,PanelConfiguration>

A collection of options that configure how each panel displays in a small multiples chart.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PanelConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
String	backgroundColor()	Sets the background color for each panel.
Visibility	backgroundVisibility()	Determines whether or not a background for each small multiples panel is rendered.
String	backgroundVisibilityAsString()	Determines whether or not a background for each small multiples panel is rendered.
String	borderColor()	Sets the line color of panel borders.
PanelBorderStyle	borderStyle()	Sets the line style of panel borders.
String	borderStyleAsString()	Sets the line style of panel borders.
String	borderThickness()	Sets the line thickness of panel borders.
Visibility	borderVisibility()	Determines whether or not each panel displays a border.
String	borderVisibilityAsString()	Determines whether or not each panel displays a border.
static PanelConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	gutterSpacing()	Sets the total amount of negative space to display between sibling panels.
Visibility	gutterVisibility()	Determines whether or not negative space between sibling panels is rendered.
String	gutterVisibilityAsString()	Determines whether or not negative space between sibling panels is rendered.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PanelConfiguration.Builder>	serializableBuilderClass()
PanelTitleOptions	title()	Configures the title display within each small multiples panel.
PanelConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

title

public final PanelTitleOptions title()

Configures the title display within each small multiples panel.

Returns:

Configures the title display within each small multiples panel.

borderVisibility

public final Visibility borderVisibility()

Determines whether or not each panel displays a border.

If the service returns an enum value that is not available in the current SDK version, borderVisibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from borderVisibilityAsString().

Returns:

Determines whether or not each panel displays a border.

See Also:

Visibility

borderVisibilityAsString

public final String borderVisibilityAsString()

Determines whether or not each panel displays a border.

If the service returns an enum value that is not available in the current SDK version, borderVisibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from borderVisibilityAsString().

Returns:

Determines whether or not each panel displays a border.

See Also:

Visibility

borderThickness

public final String borderThickness()

Sets the line thickness of panel borders.

Returns:

Sets the line thickness of panel borders.

borderStyle

public final PanelBorderStyle borderStyle()

Sets the line style of panel borders.

If the service returns an enum value that is not available in the current SDK version, borderStyle will return PanelBorderStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from borderStyleAsString().

Returns:

Sets the line style of panel borders.

See Also:

PanelBorderStyle

borderStyleAsString

public final String borderStyleAsString()

Sets the line style of panel borders.

If the service returns an enum value that is not available in the current SDK version, borderStyle will return PanelBorderStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from borderStyleAsString().

Returns:

Sets the line style of panel borders.

See Also:

PanelBorderStyle

borderColor

public final String borderColor()

Sets the line color of panel borders.

Returns:

Sets the line color of panel borders.

gutterVisibility

public final Visibility gutterVisibility()

Determines whether or not negative space between sibling panels is rendered.

If the service returns an enum value that is not available in the current SDK version, gutterVisibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gutterVisibilityAsString().

Returns:

Determines whether or not negative space between sibling panels is rendered.

See Also:

Visibility

gutterVisibilityAsString

public final String gutterVisibilityAsString()

Determines whether or not negative space between sibling panels is rendered.

If the service returns an enum value that is not available in the current SDK version, gutterVisibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gutterVisibilityAsString().

Returns:

Determines whether or not negative space between sibling panels is rendered.

See Also:

Visibility

gutterSpacing

public final String gutterSpacing()

Sets the total amount of negative space to display between sibling panels.

Returns:

Sets the total amount of negative space to display between sibling panels.

backgroundVisibility

public final Visibility backgroundVisibility()

Determines whether or not a background for each small multiples panel is rendered.

If the service returns an enum value that is not available in the current SDK version, backgroundVisibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backgroundVisibilityAsString().

Returns:

Determines whether or not a background for each small multiples panel is rendered.

See Also:

Visibility

backgroundVisibilityAsString

public final String backgroundVisibilityAsString()

Determines whether or not a background for each small multiples panel is rendered.

If the service returns an enum value that is not available in the current SDK version, backgroundVisibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backgroundVisibilityAsString().

Returns:

Determines whether or not a background for each small multiples panel is rendered.

See Also:

Visibility

backgroundColor

public final String backgroundColor()

Sets the background color for each panel.

Returns:

Sets the background color for each panel.

toBuilder

public PanelConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PanelConfiguration.Builder,PanelConfiguration>

builder

public static PanelConfiguration.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo