Show / Hide Table of Contents

Class CfnTemplatePropsMixin.SectionBasedLayoutConfigurationProperty

The configuration for a section-based layout.

Inheritance
object
CfnTemplatePropsMixin.SectionBasedLayoutConfigurationProperty
Implements
CfnTemplatePropsMixin.ISectionBasedLayoutConfigurationProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnTemplatePropsMixin.SectionBasedLayoutConfigurationProperty : CfnTemplatePropsMixin.ISectionBasedLayoutConfigurationProperty
Syntax (vb)
Public Class CfnTemplatePropsMixin.SectionBasedLayoutConfigurationProperty Implements CfnTemplatePropsMixin.ISectionBasedLayoutConfigurationProperty
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins;

             var sectionBasedLayoutConfigurationProperty = new SectionBasedLayoutConfigurationProperty {
                 BodySections = new [] { new BodySectionConfigurationProperty {
                     Content = new BodySectionContentProperty {
                         Layout = new SectionLayoutConfigurationProperty {
                             FreeFormLayout = new FreeFormSectionLayoutConfigurationProperty {
                                 Elements = new [] { new FreeFormLayoutElementProperty {
                                     BackgroundStyle = new FreeFormLayoutElementBackgroundStyleProperty {
                                         Color = "color",
                                         Visibility = "visibility"
                                     },
                                     BorderStyle = new FreeFormLayoutElementBorderStyleProperty {
                                         Color = "color",
                                         Visibility = "visibility"
                                     },
                                     ElementId = "elementId",
                                     ElementType = "elementType",
                                     Height = "height",
                                     LoadingAnimation = new LoadingAnimationProperty {
                                         Visibility = "visibility"
                                     },
                                     RenderingRules = new [] { new SheetElementRenderingRuleProperty {
                                         ConfigurationOverrides = new SheetElementConfigurationOverridesProperty {
                                             Visibility = "visibility"
                                         },
                                         Expression = "expression"
                                     } },
                                     SelectedBorderStyle = new FreeFormLayoutElementBorderStyleProperty {
                                         Color = "color",
                                         Visibility = "visibility"
                                     },
                                     Visibility = "visibility",
                                     Width = "width",
                                     XAxisLocation = "xAxisLocation",
                                     YAxisLocation = "yAxisLocation"
                                 } }
                             }
                         }
                     },
                     PageBreakConfiguration = new SectionPageBreakConfigurationProperty {
                         After = new SectionAfterPageBreakProperty {
                             Status = "status"
                         }
                     },
                     RepeatConfiguration = new BodySectionRepeatConfigurationProperty {
                         DimensionConfigurations = new [] { new BodySectionRepeatDimensionConfigurationProperty {
                             DynamicCategoryDimensionConfiguration = new BodySectionDynamicCategoryDimensionConfigurationProperty {
                                 Column = new ColumnIdentifierProperty {
                                     ColumnName = "columnName",
                                     DataSetIdentifier = "dataSetIdentifier"
                                 },
                                 Limit = 123,
                                 SortByMetrics = new [] { new ColumnSortProperty {
                                     AggregationFunction = new AggregationFunctionProperty {
                                         AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
                                             SimpleAttributeAggregation = "simpleAttributeAggregation",
                                             ValueForMultipleValues = "valueForMultipleValues"
                                         },
                                         CategoricalAggregationFunction = "categoricalAggregationFunction",
                                         DateAggregationFunction = "dateAggregationFunction",
                                         NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
                                             PercentileAggregation = new PercentileAggregationProperty {
                                                 PercentileValue = 123
                                             },
                                             SimpleNumericalAggregation = "simpleNumericalAggregation"
                                         }
                                     },
                                     Direction = "direction",
                                     SortBy = new ColumnIdentifierProperty {
                                         ColumnName = "columnName",
                                         DataSetIdentifier = "dataSetIdentifier"
                                     }
                                 } }
                             },
                             DynamicNumericDimensionConfiguration = new BodySectionDynamicNumericDimensionConfigurationProperty {
                                 Column = new ColumnIdentifierProperty {
                                     ColumnName = "columnName",
                                     DataSetIdentifier = "dataSetIdentifier"
                                 },
                                 Limit = 123,
                                 SortByMetrics = new [] { new ColumnSortProperty {
                                     AggregationFunction = new AggregationFunctionProperty {
                                         AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
                                             SimpleAttributeAggregation = "simpleAttributeAggregation",
                                             ValueForMultipleValues = "valueForMultipleValues"
                                         },
                                         CategoricalAggregationFunction = "categoricalAggregationFunction",
                                         DateAggregationFunction = "dateAggregationFunction",
                                         NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
                                             PercentileAggregation = new PercentileAggregationProperty {
                                                 PercentileValue = 123
                                             },
                                             SimpleNumericalAggregation = "simpleNumericalAggregation"
                                         }
                                     },
                                     Direction = "direction",
                                     SortBy = new ColumnIdentifierProperty {
                                         ColumnName = "columnName",
                                         DataSetIdentifier = "dataSetIdentifier"
                                     }
                                 } }
                             }
                         } },
                         NonRepeatingVisuals = new [] { "nonRepeatingVisuals" },
                         PageBreakConfiguration = new BodySectionRepeatPageBreakConfigurationProperty {
                             After = new SectionAfterPageBreakProperty {
                                 Status = "status"
                             }
                         }
                     },
                     SectionId = "sectionId",
                     Style = new SectionStyleProperty {
                         Height = "height",
                         Padding = new SpacingProperty {
                             Bottom = "bottom",
                             Left = "left",
                             Right = "right",
                             Top = "top"
                         }
                     }
                 } },
                 CanvasSizeOptions = new SectionBasedLayoutCanvasSizeOptionsProperty {
                     PaperCanvasSizeOptions = new SectionBasedLayoutPaperCanvasSizeOptionsProperty {
                         PaperMargin = new SpacingProperty {
                             Bottom = "bottom",
                             Left = "left",
                             Right = "right",
                             Top = "top"
                         },
                         PaperOrientation = "paperOrientation",
                         PaperSize = "paperSize"
                     }
                 },
                 FooterSections = new [] { new HeaderFooterSectionConfigurationProperty {
                     Layout = new SectionLayoutConfigurationProperty {
                         FreeFormLayout = new FreeFormSectionLayoutConfigurationProperty {
                             Elements = new [] { new FreeFormLayoutElementProperty {
                                 BackgroundStyle = new FreeFormLayoutElementBackgroundStyleProperty {
                                     Color = "color",
                                     Visibility = "visibility"
                                 },
                                 BorderStyle = new FreeFormLayoutElementBorderStyleProperty {
                                     Color = "color",
                                     Visibility = "visibility"
                                 },
                                 ElementId = "elementId",
                                 ElementType = "elementType",
                                 Height = "height",
                                 LoadingAnimation = new LoadingAnimationProperty {
                                     Visibility = "visibility"
                                 },
                                 RenderingRules = new [] { new SheetElementRenderingRuleProperty {
                                     ConfigurationOverrides = new SheetElementConfigurationOverridesProperty {
                                         Visibility = "visibility"
                                     },
                                     Expression = "expression"
                                 } },
                                 SelectedBorderStyle = new FreeFormLayoutElementBorderStyleProperty {
                                     Color = "color",
                                     Visibility = "visibility"
                                 },
                                 Visibility = "visibility",
                                 Width = "width",
                                 XAxisLocation = "xAxisLocation",
                                 YAxisLocation = "yAxisLocation"
                             } }
                         }
                     },
                     SectionId = "sectionId",
                     Style = new SectionStyleProperty {
                         Height = "height",
                         Padding = new SpacingProperty {
                             Bottom = "bottom",
                             Left = "left",
                             Right = "right",
                             Top = "top"
                         }
                     }
                 } },
                 HeaderSections = new [] { new HeaderFooterSectionConfigurationProperty {
                     Layout = new SectionLayoutConfigurationProperty {
                         FreeFormLayout = new FreeFormSectionLayoutConfigurationProperty {
                             Elements = new [] { new FreeFormLayoutElementProperty {
                                 BackgroundStyle = new FreeFormLayoutElementBackgroundStyleProperty {
                                     Color = "color",
                                     Visibility = "visibility"
                                 },
                                 BorderStyle = new FreeFormLayoutElementBorderStyleProperty {
                                     Color = "color",
                                     Visibility = "visibility"
                                 },
                                 ElementId = "elementId",
                                 ElementType = "elementType",
                                 Height = "height",
                                 LoadingAnimation = new LoadingAnimationProperty {
                                     Visibility = "visibility"
                                 },
                                 RenderingRules = new [] { new SheetElementRenderingRuleProperty {
                                     ConfigurationOverrides = new SheetElementConfigurationOverridesProperty {
                                         Visibility = "visibility"
                                     },
                                     Expression = "expression"
                                 } },
                                 SelectedBorderStyle = new FreeFormLayoutElementBorderStyleProperty {
                                     Color = "color",
                                     Visibility = "visibility"
                                 },
                                 Visibility = "visibility",
                                 Width = "width",
                                 XAxisLocation = "xAxisLocation",
                                 YAxisLocation = "yAxisLocation"
                             } }
                         }
                     },
                     SectionId = "sectionId",
                     Style = new SectionStyleProperty {
                         Height = "height",
                         Padding = new SpacingProperty {
                             Bottom = "bottom",
                             Left = "left",
                             Right = "right",
                             Top = "top"
                         }
                     }
                 } }
             };

Synopsis

Constructors

SectionBasedLayoutConfigurationProperty()

The configuration for a section-based layout.

Properties

BodySections

A list of body section configurations.

CanvasSizeOptions

The options for the canvas of a section-based layout.

FooterSections

A list of footer section configurations.

HeaderSections

A list of header section configurations.

Constructors

SectionBasedLayoutConfigurationProperty()

The configuration for a section-based layout.

public SectionBasedLayoutConfigurationProperty()
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins;

             var sectionBasedLayoutConfigurationProperty = new SectionBasedLayoutConfigurationProperty {
                 BodySections = new [] { new BodySectionConfigurationProperty {
                     Content = new BodySectionContentProperty {
                         Layout = new SectionLayoutConfigurationProperty {
                             FreeFormLayout = new FreeFormSectionLayoutConfigurationProperty {
                                 Elements = new [] { new FreeFormLayoutElementProperty {
                                     BackgroundStyle = new FreeFormLayoutElementBackgroundStyleProperty {
                                         Color = "color",
                                         Visibility = "visibility"
                                     },
                                     BorderStyle = new FreeFormLayoutElementBorderStyleProperty {
                                         Color = "color",
                                         Visibility = "visibility"
                                     },
                                     ElementId = "elementId",
                                     ElementType = "elementType",
                                     Height = "height",
                                     LoadingAnimation = new LoadingAnimationProperty {
                                         Visibility = "visibility"
                                     },
                                     RenderingRules = new [] { new SheetElementRenderingRuleProperty {
                                         ConfigurationOverrides = new SheetElementConfigurationOverridesProperty {
                                             Visibility = "visibility"
                                         },
                                         Expression = "expression"
                                     } },
                                     SelectedBorderStyle = new FreeFormLayoutElementBorderStyleProperty {
                                         Color = "color",
                                         Visibility = "visibility"
                                     },
                                     Visibility = "visibility",
                                     Width = "width",
                                     XAxisLocation = "xAxisLocation",
                                     YAxisLocation = "yAxisLocation"
                                 } }
                             }
                         }
                     },
                     PageBreakConfiguration = new SectionPageBreakConfigurationProperty {
                         After = new SectionAfterPageBreakProperty {
                             Status = "status"
                         }
                     },
                     RepeatConfiguration = new BodySectionRepeatConfigurationProperty {
                         DimensionConfigurations = new [] { new BodySectionRepeatDimensionConfigurationProperty {
                             DynamicCategoryDimensionConfiguration = new BodySectionDynamicCategoryDimensionConfigurationProperty {
                                 Column = new ColumnIdentifierProperty {
                                     ColumnName = "columnName",
                                     DataSetIdentifier = "dataSetIdentifier"
                                 },
                                 Limit = 123,
                                 SortByMetrics = new [] { new ColumnSortProperty {
                                     AggregationFunction = new AggregationFunctionProperty {
                                         AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
                                             SimpleAttributeAggregation = "simpleAttributeAggregation",
                                             ValueForMultipleValues = "valueForMultipleValues"
                                         },
                                         CategoricalAggregationFunction = "categoricalAggregationFunction",
                                         DateAggregationFunction = "dateAggregationFunction",
                                         NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
                                             PercentileAggregation = new PercentileAggregationProperty {
                                                 PercentileValue = 123
                                             },
                                             SimpleNumericalAggregation = "simpleNumericalAggregation"
                                         }
                                     },
                                     Direction = "direction",
                                     SortBy = new ColumnIdentifierProperty {
                                         ColumnName = "columnName",
                                         DataSetIdentifier = "dataSetIdentifier"
                                     }
                                 } }
                             },
                             DynamicNumericDimensionConfiguration = new BodySectionDynamicNumericDimensionConfigurationProperty {
                                 Column = new ColumnIdentifierProperty {
                                     ColumnName = "columnName",
                                     DataSetIdentifier = "dataSetIdentifier"
                                 },
                                 Limit = 123,
                                 SortByMetrics = new [] { new ColumnSortProperty {
                                     AggregationFunction = new AggregationFunctionProperty {
                                         AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
                                             SimpleAttributeAggregation = "simpleAttributeAggregation",
                                             ValueForMultipleValues = "valueForMultipleValues"
                                         },
                                         CategoricalAggregationFunction = "categoricalAggregationFunction",
                                         DateAggregationFunction = "dateAggregationFunction",
                                         NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
                                             PercentileAggregation = new PercentileAggregationProperty {
                                                 PercentileValue = 123
                                             },
                                             SimpleNumericalAggregation = "simpleNumericalAggregation"
                                         }
                                     },
                                     Direction = "direction",
                                     SortBy = new ColumnIdentifierProperty {
                                         ColumnName = "columnName",
                                         DataSetIdentifier = "dataSetIdentifier"
                                     }
                                 } }
                             }
                         } },
                         NonRepeatingVisuals = new [] { "nonRepeatingVisuals" },
                         PageBreakConfiguration = new BodySectionRepeatPageBreakConfigurationProperty {
                             After = new SectionAfterPageBreakProperty {
                                 Status = "status"
                             }
                         }
                     },
                     SectionId = "sectionId",
                     Style = new SectionStyleProperty {
                         Height = "height",
                         Padding = new SpacingProperty {
                             Bottom = "bottom",
                             Left = "left",
                             Right = "right",
                             Top = "top"
                         }
                     }
                 } },
                 CanvasSizeOptions = new SectionBasedLayoutCanvasSizeOptionsProperty {
                     PaperCanvasSizeOptions = new SectionBasedLayoutPaperCanvasSizeOptionsProperty {
                         PaperMargin = new SpacingProperty {
                             Bottom = "bottom",
                             Left = "left",
                             Right = "right",
                             Top = "top"
                         },
                         PaperOrientation = "paperOrientation",
                         PaperSize = "paperSize"
                     }
                 },
                 FooterSections = new [] { new HeaderFooterSectionConfigurationProperty {
                     Layout = new SectionLayoutConfigurationProperty {
                         FreeFormLayout = new FreeFormSectionLayoutConfigurationProperty {
                             Elements = new [] { new FreeFormLayoutElementProperty {
                                 BackgroundStyle = new FreeFormLayoutElementBackgroundStyleProperty {
                                     Color = "color",
                                     Visibility = "visibility"
                                 },
                                 BorderStyle = new FreeFormLayoutElementBorderStyleProperty {
                                     Color = "color",
                                     Visibility = "visibility"
                                 },
                                 ElementId = "elementId",
                                 ElementType = "elementType",
                                 Height = "height",
                                 LoadingAnimation = new LoadingAnimationProperty {
                                     Visibility = "visibility"
                                 },
                                 RenderingRules = new [] { new SheetElementRenderingRuleProperty {
                                     ConfigurationOverrides = new SheetElementConfigurationOverridesProperty {
                                         Visibility = "visibility"
                                     },
                                     Expression = "expression"
                                 } },
                                 SelectedBorderStyle = new FreeFormLayoutElementBorderStyleProperty {
                                     Color = "color",
                                     Visibility = "visibility"
                                 },
                                 Visibility = "visibility",
                                 Width = "width",
                                 XAxisLocation = "xAxisLocation",
                                 YAxisLocation = "yAxisLocation"
                             } }
                         }
                     },
                     SectionId = "sectionId",
                     Style = new SectionStyleProperty {
                         Height = "height",
                         Padding = new SpacingProperty {
                             Bottom = "bottom",
                             Left = "left",
                             Right = "right",
                             Top = "top"
                         }
                     }
                 } },
                 HeaderSections = new [] { new HeaderFooterSectionConfigurationProperty {
                     Layout = new SectionLayoutConfigurationProperty {
                         FreeFormLayout = new FreeFormSectionLayoutConfigurationProperty {
                             Elements = new [] { new FreeFormLayoutElementProperty {
                                 BackgroundStyle = new FreeFormLayoutElementBackgroundStyleProperty {
                                     Color = "color",
                                     Visibility = "visibility"
                                 },
                                 BorderStyle = new FreeFormLayoutElementBorderStyleProperty {
                                     Color = "color",
                                     Visibility = "visibility"
                                 },
                                 ElementId = "elementId",
                                 ElementType = "elementType",
                                 Height = "height",
                                 LoadingAnimation = new LoadingAnimationProperty {
                                     Visibility = "visibility"
                                 },
                                 RenderingRules = new [] { new SheetElementRenderingRuleProperty {
                                     ConfigurationOverrides = new SheetElementConfigurationOverridesProperty {
                                         Visibility = "visibility"
                                     },
                                     Expression = "expression"
                                 } },
                                 SelectedBorderStyle = new FreeFormLayoutElementBorderStyleProperty {
                                     Color = "color",
                                     Visibility = "visibility"
                                 },
                                 Visibility = "visibility",
                                 Width = "width",
                                 XAxisLocation = "xAxisLocation",
                                 YAxisLocation = "yAxisLocation"
                             } }
                         }
                     },
                     SectionId = "sectionId",
                     Style = new SectionStyleProperty {
                         Height = "height",
                         Padding = new SpacingProperty {
                             Bottom = "bottom",
                             Left = "left",
                             Right = "right",
                             Top = "top"
                         }
                     }
                 } }
             };

Properties

BodySections

A list of body section configurations.

public object? BodySections { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutconfiguration.html#cfn-quicksight-template-sectionbasedlayoutconfiguration-bodysections

Type union: either IResolvable or (either IResolvable or CfnTemplatePropsMixin.IBodySectionConfigurationProperty)[]

CanvasSizeOptions

The options for the canvas of a section-based layout.

public object? CanvasSizeOptions { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutconfiguration.html#cfn-quicksight-template-sectionbasedlayoutconfiguration-canvassizeoptions

Type union: either IResolvable or CfnTemplatePropsMixin.ISectionBasedLayoutCanvasSizeOptionsProperty

FooterSections

A list of footer section configurations.

public object? FooterSections { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutconfiguration.html#cfn-quicksight-template-sectionbasedlayoutconfiguration-footersections

Type union: either IResolvable or (either IResolvable or CfnTemplatePropsMixin.IHeaderFooterSectionConfigurationProperty)[]

HeaderSections

A list of header section configurations.

public object? HeaderSections { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutconfiguration.html#cfn-quicksight-template-sectionbasedlayoutconfiguration-headersections

Type union: either IResolvable or (either IResolvable or CfnTemplatePropsMixin.IHeaderFooterSectionConfigurationProperty)[]

Implements

CfnTemplatePropsMixin.ISectionBasedLayoutConfigurationProperty
Back to top Generated by DocFX