Package software.amazon.awscdk.services.quicksight

Interface CfnAnalysis.SmallMultiplesOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnalysis.SmallMultiplesOptionsProperty.Jsii$Proxy

Enclosing class:

CfnAnalysis

@Stability(Stable)
public static interface CfnAnalysis.SmallMultiplesOptionsProperty
extends software.amazon.jsii.JsiiSerializable

Options that determine the layout and display options of a chart's small multiples.

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.*;
 SmallMultiplesOptionsProperty smallMultiplesOptionsProperty = SmallMultiplesOptionsProperty.builder()
         .maxVisibleColumns(123)
         .maxVisibleRows(123)
         .panelConfiguration(PanelConfigurationProperty.builder()
                 .backgroundColor("backgroundColor")
                 .backgroundVisibility("backgroundVisibility")
                 .borderColor("borderColor")
                 .borderStyle("borderStyle")
                 .borderThickness("borderThickness")
                 .borderVisibility("borderVisibility")
                 .gutterSpacing("gutterSpacing")
                 .gutterVisibility("gutterVisibility")
                 .title(PanelTitleOptionsProperty.builder()
                         .fontConfiguration(FontConfigurationProperty.builder()
                                 .fontColor("fontColor")
                                 .fontDecoration("fontDecoration")
                                 .fontSize(FontSizeProperty.builder()
                                         .relative("relative")
                                         .build())
                                 .fontStyle("fontStyle")
                                 .fontWeight(FontWeightProperty.builder()
                                         .name("name")
                                         .build())
                                 .build())
                         .horizontalTextAlignment("horizontalTextAlignment")
                         .visibility("visibility")
                         .build())
                 .build())
         .xAxis(SmallMultiplesAxisPropertiesProperty.builder()
                 .placement("placement")
                 .scale("scale")
                 .build())
         .yAxis(SmallMultiplesAxisPropertiesProperty.builder()
                 .placement("placement")
                 .scale("scale")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAnalysis.SmallMultiplesOptionsProperty.Builder	builder()
default Number	getMaxVisibleColumns()	Sets the maximum number of visible columns to display in the grid of small multiples panels.
default Number	getMaxVisibleRows()	Sets the maximum number of visible rows to display in the grid of small multiples panels.
default Object	getPanelConfiguration()	Configures the display options for each small multiples panel.
default Object	getXAxis()	The properties of a small multiples X axis.
default Object	getYAxis()	The properties of a small multiples Y axis.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaxVisibleColumns

@Stability(Stable)
@Nullable
default Number getMaxVisibleColumns()

Sets the maximum number of visible columns to display in the grid of small multiples panels.

The default is Auto , which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-smallmultiplesoptions.html#cfn-quicksight-analysis-smallmultiplesoptions-maxvisiblecolumns

getMaxVisibleRows

@Stability(Stable)
@Nullable
default Number getMaxVisibleRows()

Sets the maximum number of visible rows to display in the grid of small multiples panels.

The default value is Auto , which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-smallmultiplesoptions.html#cfn-quicksight-analysis-smallmultiplesoptions-maxvisiblerows

getPanelConfiguration

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

Configures the display options for each small multiples panel.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-smallmultiplesoptions.html#cfn-quicksight-analysis-smallmultiplesoptions-panelconfiguration

getXAxis

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

The properties of a small multiples X axis.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-smallmultiplesoptions.html#cfn-quicksight-analysis-smallmultiplesoptions-xaxis

getYAxis

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

The properties of a small multiples Y axis.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-smallmultiplesoptions.html#cfn-quicksight-analysis-smallmultiplesoptions-yaxis

builder

@Stability(Stable)
static CfnAnalysis.SmallMultiplesOptionsProperty.Builder builder()

Returns:

a CfnAnalysis.SmallMultiplesOptionsProperty.Builder of CfnAnalysis.SmallMultiplesOptionsProperty