aws-cdk-lib.aws_quicksight.CfnAnalysis.SmallMultiplesOptionsProperty

SmallMultiplesOptionsProperty Struct

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

Source

Generated code

Type last changed

v2.95.0 · 7 Sep 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const smallMultiplesOptionsProperty: quicksight.CfnAnalysis.SmallMultiplesOptionsProperty = {
  maxVisibleColumns: 123,
  maxVisibleRows: 123,
  panelConfiguration: {
    backgroundColor: 'backgroundColor',
    backgroundVisibility: 'backgroundVisibility',
    borderColor: 'borderColor',
    borderStyle: 'borderStyle',
    borderThickness: 'borderThickness',
    borderVisibility: 'borderVisibility',
    gutterSpacing: 'gutterSpacing',
    gutterVisibility: 'gutterVisibility',
    title: {
      fontConfiguration: {
        fontColor: 'fontColor',
        fontDecoration: 'fontDecoration',
        fontFamily: 'fontFamily',
        fontSize: {
          absolute: 'absolute',
          relative: 'relative',
        },
        fontStyle: 'fontStyle',
        fontWeight: {
          name: 'name',
        },
      },
      horizontalTextAlignment: 'horizontalTextAlignment',
      visibility: 'visibility',
    },
  },
  xAxis: {
    placement: 'placement',
    scale: 'scale',
  },
  yAxis: {
    placement: 'placement',
    scale: 'scale',
  },
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

small_multiples_options_property = quicksight.CfnAnalysis.SmallMultiplesOptionsProperty(
    max_visible_columns=123,
    max_visible_rows=123,
    panel_configuration=quicksight.CfnAnalysis.PanelConfigurationProperty(
        background_color="backgroundColor",
        background_visibility="backgroundVisibility",
        border_color="borderColor",
        border_style="borderStyle",
        border_thickness="borderThickness",
        border_visibility="borderVisibility",
        gutter_spacing="gutterSpacing",
        gutter_visibility="gutterVisibility",
        title=quicksight.CfnAnalysis.PanelTitleOptionsProperty(
            font_configuration=quicksight.CfnAnalysis.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight.CfnAnalysis.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnAnalysis.FontWeightProperty(
                    name="name"
                )
            ),
            horizontal_text_alignment="horizontalTextAlignment",
            visibility="visibility"
        )
    ),
    x_axis=quicksight.CfnAnalysis.SmallMultiplesAxisPropertiesProperty(
        placement="placement",
        scale="scale"
    ),
    y_axis=quicksight.CfnAnalysis.SmallMultiplesAxisPropertiesProperty(
        placement="placement",
        scale="scale"
    )
)

// 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")
                                .fontFamily("fontFamily")
                                .fontSize(FontSizeProperty.builder()
                                        .absolute("absolute")
                                        .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();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var smallMultiplesOptionsProperty = new SmallMultiplesOptionsProperty {
    MaxVisibleColumns = 123,
    MaxVisibleRows = 123,
    PanelConfiguration = new PanelConfigurationProperty {
        BackgroundColor = "backgroundColor",
        BackgroundVisibility = "backgroundVisibility",
        BorderColor = "borderColor",
        BorderStyle = "borderStyle",
        BorderThickness = "borderThickness",
        BorderVisibility = "borderVisibility",
        GutterSpacing = "gutterSpacing",
        GutterVisibility = "gutterVisibility",
        Title = new PanelTitleOptionsProperty {
            FontConfiguration = new FontConfigurationProperty {
                FontColor = "fontColor",
                FontDecoration = "fontDecoration",
                FontFamily = "fontFamily",
                FontSize = new FontSizeProperty {
                    Absolute = "absolute",
                    Relative = "relative"
                },
                FontStyle = "fontStyle",
                FontWeight = new FontWeightProperty {
                    Name = "name"
                }
            },
            HorizontalTextAlignment = "horizontalTextAlignment",
            Visibility = "visibility"
        }
    },
    XAxis = new SmallMultiplesAxisPropertiesProperty {
        Placement = "placement",
        Scale = "scale"
    },
    YAxis = new SmallMultiplesAxisPropertiesProperty {
        Placement = "placement",
        Scale = "scale"
    }
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

smallMultiplesOptionsProperty := &SmallMultiplesOptionsProperty{
	MaxVisibleColumns: jsii.Number(123),
	MaxVisibleRows: jsii.Number(123),
	PanelConfiguration: &PanelConfigurationProperty{
		BackgroundColor: jsii.String("backgroundColor"),
		BackgroundVisibility: jsii.String("backgroundVisibility"),
		BorderColor: jsii.String("borderColor"),
		BorderStyle: jsii.String("borderStyle"),
		BorderThickness: jsii.String("borderThickness"),
		BorderVisibility: jsii.String("borderVisibility"),
		GutterSpacing: jsii.String("gutterSpacing"),
		GutterVisibility: jsii.String("gutterVisibility"),
		Title: &PanelTitleOptionsProperty{
			FontConfiguration: &FontConfigurationProperty{
				FontColor: jsii.String("fontColor"),
				FontDecoration: jsii.String("fontDecoration"),
				FontFamily: jsii.String("fontFamily"),
				FontSize: &FontSizeProperty{
					Absolute: jsii.String("absolute"),
					Relative: jsii.String("relative"),
				},
				FontStyle: jsii.String("fontStyle"),
				FontWeight: &FontWeightProperty{
					Name: jsii.String("name"),
				},
			},
			HorizontalTextAlignment: jsii.String("horizontalTextAlignment"),
			Visibility: jsii.String("visibility"),
		},
	},
	XAxis: &SmallMultiplesAxisPropertiesProperty{
		Placement: jsii.String("placement"),
		Scale: jsii.String("scale"),
	},
	YAxis: &SmallMultiplesAxisPropertiesProperty{
		Placement: jsii.String("placement"),
		Scale: jsii.String("scale"),
	},
}

Properties

maxVisibleColumns?optionalnumbermax_visible_columns?optionalint | floatmaxVisibleColumns?optionalNumberMaxVisibleColumns?optionaldoubleMaxVisibleColumns?optional*float64#

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.

maxVisibleRows?optionalnumbermax_visible_rows?optionalint | floatmaxVisibleRows?optionalNumberMaxVisibleRows?optionaldoubleMaxVisibleRows?optional*float64#

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.

panelConfiguration?optionalIResolvable | CfnAnalysis.PanelConfigurationPropertypanel_configuration?optionaltyping.Union[IResolvable, PanelConfigurationProperty]panelConfiguration?optionalIResolvablePanelConfiguration?optionalIResolvablePanelConfiguration?optionalinterface{}#

Configures the display options for each small multiples panel.

xAxis?optionalIResolvable | CfnAnalysis.SmallMultiplesAxisPropertiesPropertyx_axis?optionaltyping.Union[IResolvable, SmallMultiplesAxisPropertiesProperty]xAxis?optionalIResolvableXAxis?optionalIResolvableXAxis?optionalinterface{}#

The properties of a small multiples X axis.

yAxis?optionalIResolvable | CfnAnalysis.SmallMultiplesAxisPropertiesPropertyy_axis?optionaltyping.Union[IResolvable, SmallMultiplesAxisPropertiesProperty]yAxis?optionalIResolvableYAxis?optionalIResolvableYAxis?optionalinterface{}#

The properties of a small multiples Y axis.