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

Interface TreeMapVisual.Builder

All Superinterfaces:

Buildable, CopyableBuilder<TreeMapVisual.Builder,TreeMapVisual>, SdkBuilder<TreeMapVisual.Builder,TreeMapVisual>, SdkPojo

Enclosing class:

TreeMapVisual

public static interface TreeMapVisual.Builder
extends SdkPojo, CopyableBuilder<TreeMapVisual.Builder,TreeMapVisual>

Method Summary

Modifier and Type	Method	Description
TreeMapVisual.Builder	actions(Collection<VisualCustomAction> actions)	The list of custom actions that are configured for a visual.
TreeMapVisual.Builder	actions(Consumer<VisualCustomAction.Builder>... actions)	The list of custom actions that are configured for a visual.
TreeMapVisual.Builder	actions(VisualCustomAction... actions)	The list of custom actions that are configured for a visual.
default TreeMapVisual.Builder	chartConfiguration(Consumer<TreeMapConfiguration.Builder> chartConfiguration)	The configuration settings of the visual.
TreeMapVisual.Builder	chartConfiguration(TreeMapConfiguration chartConfiguration)	The configuration settings of the visual.
TreeMapVisual.Builder	columnHierarchies(Collection<ColumnHierarchy> columnHierarchies)	The column hierarchy that is used during drill-downs and drill-ups.
TreeMapVisual.Builder	columnHierarchies(Consumer<ColumnHierarchy.Builder>... columnHierarchies)	The column hierarchy that is used during drill-downs and drill-ups.
TreeMapVisual.Builder	columnHierarchies(ColumnHierarchy... columnHierarchies)	The column hierarchy that is used during drill-downs and drill-ups.
default TreeMapVisual.Builder	subtitle(Consumer<VisualSubtitleLabelOptions.Builder> subtitle)	The subtitle that is displayed on the visual.
TreeMapVisual.Builder	subtitle(VisualSubtitleLabelOptions subtitle)	The subtitle that is displayed on the visual.
default TreeMapVisual.Builder	title(Consumer<VisualTitleLabelOptions.Builder> title)	The title that is displayed on the visual.
TreeMapVisual.Builder	title(VisualTitleLabelOptions title)	The title that is displayed on the visual.
TreeMapVisual.Builder	visualContentAltText(String visualContentAltText)	The alt text for the visual.
TreeMapVisual.Builder	visualId(String visualId)	The unique identifier of a visual.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

visualId

TreeMapVisual.Builder visualId(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.

title

TreeMapVisual.Builder title(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.

title

default TreeMapVisual.Builder title(Consumer<VisualTitleLabelOptions.Builder> title)

The title that is displayed on the visual.

This is a convenience method that creates an instance of the VisualTitleLabelOptions.Builder avoiding the need to create one manually via VisualTitleLabelOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to title(VisualTitleLabelOptions).

Parameters:

title - a consumer that will call methods on VisualTitleLabelOptions.Builder

Returns:

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

See Also:

title(VisualTitleLabelOptions)

subtitle

TreeMapVisual.Builder subtitle(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.

subtitle

default TreeMapVisual.Builder subtitle(Consumer<VisualSubtitleLabelOptions.Builder> subtitle)

The subtitle that is displayed on the visual.

This is a convenience method that creates an instance of the VisualSubtitleLabelOptions.Builder avoiding the need to create one manually via VisualSubtitleLabelOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to subtitle(VisualSubtitleLabelOptions).

Parameters:

subtitle - a consumer that will call methods on VisualSubtitleLabelOptions.Builder

Returns:

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

See Also:

subtitle(VisualSubtitleLabelOptions)

chartConfiguration

TreeMapVisual.Builder chartConfiguration(TreeMapConfiguration chartConfiguration)

The configuration settings of the visual.

Parameters:

chartConfiguration - The configuration settings of the visual.

Returns:

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

chartConfiguration

default TreeMapVisual.Builder chartConfiguration(Consumer<TreeMapConfiguration.Builder> chartConfiguration)

The configuration settings of the visual.

This is a convenience method that creates an instance of the TreeMapConfiguration.Builder avoiding the need to create one manually via TreeMapConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to chartConfiguration(TreeMapConfiguration).

Parameters:

chartConfiguration - a consumer that will call methods on TreeMapConfiguration.Builder

Returns:

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

See Also:

chartConfiguration(TreeMapConfiguration)

actions

TreeMapVisual.Builder actions(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.

actions

TreeMapVisual.Builder actions(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.

actions

TreeMapVisual.Builder actions(Consumer<VisualCustomAction.Builder>... actions)

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

This is a convenience method that creates an instance of the VisualCustomAction.Builder avoiding the need to create one manually via VisualCustomAction.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #actions(List).

Parameters:

actions - a consumer that will call methods on VisualCustomAction.Builder

Returns:

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

See Also:

#actions(java.util.Collection)

columnHierarchies

TreeMapVisual.Builder columnHierarchies(Collection<ColumnHierarchy> columnHierarchies)

The column hierarchy that is used during drill-downs and drill-ups.

Parameters:

columnHierarchies - The column hierarchy that is used during drill-downs and drill-ups.

Returns:

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

columnHierarchies

TreeMapVisual.Builder columnHierarchies(ColumnHierarchy... columnHierarchies)

The column hierarchy that is used during drill-downs and drill-ups.

Parameters:

columnHierarchies - The column hierarchy that is used during drill-downs and drill-ups.

Returns:

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

columnHierarchies

TreeMapVisual.Builder columnHierarchies(Consumer<ColumnHierarchy.Builder>... columnHierarchies)

The column hierarchy that is used during drill-downs and drill-ups.

This is a convenience method that creates an instance of the ColumnHierarchy.Builder avoiding the need to create one manually via ColumnHierarchy.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #columnHierarchies(List).

Parameters:

columnHierarchies - a consumer that will call methods on ColumnHierarchy.Builder

Returns:

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

See Also:

#columnHierarchies(java.util.Collection)

visualContentAltText

TreeMapVisual.Builder visualContentAltText(String visualContentAltText)

The alt text for the visual.

Parameters:

visualContentAltText - The alt text for the visual.

Returns:

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