interface SmallMultiplesOptionsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnDashboard.SmallMultiplesOptionsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_SmallMultiplesOptionsProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnDashboard.SmallMultiplesOptionsProperty`
Python	`aws_cdk.aws_quicksight.CfnDashboard.SmallMultiplesOptionsProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnDashboard` » `SmallMultiplesOptionsProperty`

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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
const smallMultiplesOptionsProperty: quicksight.CfnDashboard.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',
        fontSize: {
          relative: 'relative',
        },
        fontStyle: 'fontStyle',
        fontWeight: {
          name: 'name',
        },
      },
      horizontalTextAlignment: 'horizontalTextAlignment',
      visibility: 'visibility',
    },
  },
  xAxis: {
    placement: 'placement',
    scale: 'scale',
  },
  yAxis: {
    placement: 'placement',
    scale: 'scale',
  },
};

Properties

Name	Type	Description
maxVisibleColumns?	`number`	Sets the maximum number of visible columns to display in the grid of small multiples panels.
maxVisibleRows?	`number`	Sets the maximum number of visible rows to display in the grid of small multiples panels.
panelConfiguration?	`IResolvable` `\|` `PanelConfigurationProperty`	Configures the display options for each small multiples panel.
xAxis?	`IResolvable` `\|` `SmallMultiplesAxisPropertiesProperty`	The properties of a small multiples X axis.
yAxis?	`IResolvable` `\|` `SmallMultiplesAxisPropertiesProperty`	The properties of a small multiples Y axis.

maxVisibleColumns?

Type: number (optional)

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?

Type: number (optional)

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?

Type: IResolvable | PanelConfigurationProperty (optional)

Configures the display options for each small multiples panel.

xAxis?

Type: IResolvable | SmallMultiplesAxisPropertiesProperty (optional)

The properties of a small multiples X axis.

yAxis?

Type: IResolvable | SmallMultiplesAxisPropertiesProperty (optional)

The properties of a small multiples Y axis.