Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.TotalOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.TotalOptionsProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.TotalOptionsProperty
extends software.amazon.jsii.JsiiSerializable

The total options for a table visual.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 TotalOptionsProperty totalOptionsProperty = TotalOptionsProperty.builder()
         .customLabel("customLabel")
         .placement("placement")
         .scrollStatus("scrollStatus")
         .totalAggregationOptions(List.of(TotalAggregationOptionProperty.builder()
                 .fieldId("fieldId")
                 .totalAggregationFunction(TotalAggregationFunctionProperty.builder()
                         .simpleTotalAggregationFunction("simpleTotalAggregationFunction")
                         .build())
                 .build()))
         .totalCellStyle(TableCellStyleProperty.builder()
                 .backgroundColor("backgroundColor")
                 .border(GlobalTableBorderOptionsProperty.builder()
                         .sideSpecificBorder(TableSideBorderOptionsProperty.builder()
                                 .bottom(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .innerHorizontal(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .innerVertical(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .left(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .right(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .top(TableBorderOptionsProperty.builder()
                                         .color("color")
                                         .style("style")
                                         .thickness(123)
                                         .build())
                                 .build())
                         .uniformBorder(TableBorderOptionsProperty.builder()
                                 .color("color")
                                 .style("style")
                                 .thickness(123)
                                 .build())
                         .build())
                 .fontConfiguration(FontConfigurationProperty.builder()
                         .fontColor("fontColor")
                         .fontDecoration("fontDecoration")
                         .fontFamily("fontFamily")
                         .fontSize(FontSizeProperty.builder()
                                 .absolute("absolute")
                                 .relative("relative")
                                 .build())
                         .fontStyle("fontStyle")
                         .fontWeight(FontWeightProperty.builder()
                                 .name("name")
                                 .build())
                         .build())
                 .height(123)
                 .horizontalTextAlignment("horizontalTextAlignment")
                 .textWrap("textWrap")
                 .verticalTextAlignment("verticalTextAlignment")
                 .visibility("visibility")
                 .build())
         .totalsVisibility("totalsVisibility")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTemplate.TotalOptionsProperty.Builder	A builder for CfnTemplate.TotalOptionsProperty
static final class	CfnTemplate.TotalOptionsProperty.Jsii$Proxy	An implementation for CfnTemplate.TotalOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.TotalOptionsProperty.Builder	builder()
default String	getCustomLabel()	The custom label string for the total cells.
default String	getPlacement()	The placement (start, end) for the total cells.
default String	getScrollStatus()	The scroll status (pinned, scrolled) for the total cells.
default Object	getTotalAggregationOptions()	The total aggregation settings for each value field.
default Object	getTotalCellStyle()	Cell styling options for the total cells.
default String	getTotalsVisibility()	The visibility configuration for the total cells.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCustomLabel

@Stability(Stable)
@Nullable
default String getCustomLabel()

The custom label string for the total cells.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-customlabel

getPlacement

@Stability(Stable)
@Nullable
default String getPlacement()

The placement (start, end) for the total cells.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-placement

getScrollStatus

@Stability(Stable)
@Nullable
default String getScrollStatus()

The scroll status (pinned, scrolled) for the total cells.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-scrollstatus

getTotalAggregationOptions

@Stability(Stable)
@Nullable
default Object getTotalAggregationOptions()

The total aggregation settings for each value field.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTemplate.TotalAggregationOptionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-totalaggregationoptions

getTotalCellStyle

@Stability(Stable)
@Nullable
default Object getTotalCellStyle()

Cell styling options for the total cells.

Returns union: either IResolvable or CfnTemplate.TableCellStyleProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-totalcellstyle

getTotalsVisibility

@Stability(Stable)
@Nullable
default String getTotalsVisibility()

The visibility configuration for the total cells.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-totalsvisibility

builder

@Stability(Stable)
static CfnTemplate.TotalOptionsProperty.Builder builder()

Returns:

a CfnTemplate.TotalOptionsProperty.Builder of CfnTemplate.TotalOptionsProperty