Class CfnAnalysisPropsMixin.LayoutConfigurationProperty
The configuration that determines what the type of layout will be used on a sheet.
Inherited Members
Namespace: Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnAnalysisPropsMixin.LayoutConfigurationProperty : CfnAnalysisPropsMixin.ILayoutConfigurationPropertySyntax (vb)
Public Class CfnAnalysisPropsMixin.LayoutConfigurationProperty Implements CfnAnalysisPropsMixin.ILayoutConfigurationPropertyRemarks
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
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 layoutConfigurationProperty = new LayoutConfigurationProperty {
FreeFormLayout = new FreeFormLayoutConfigurationProperty {
CanvasSizeOptions = new FreeFormLayoutCanvasSizeOptionsProperty {
ScreenCanvasSizeOptions = new FreeFormLayoutScreenCanvasSizeOptionsProperty {
OptimizedViewPortWidth = "optimizedViewPortWidth"
}
},
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"
} }
},
GridLayout = new GridLayoutConfigurationProperty {
CanvasSizeOptions = new GridLayoutCanvasSizeOptionsProperty {
ScreenCanvasSizeOptions = new GridLayoutScreenCanvasSizeOptionsProperty {
OptimizedViewPortWidth = "optimizedViewPortWidth",
ResizeOption = "resizeOption"
}
},
Elements = new [] { new GridLayoutElementProperty {
ColumnIndex = 123,
ColumnSpan = 123,
ElementId = "elementId",
ElementType = "elementType",
RowIndex = 123,
RowSpan = 123
} }
},
SectionBasedLayout = 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
| LayoutConfigurationProperty() | The configuration that determines what the type of layout will be used on a sheet. |
Properties
| FreeFormLayout | A free-form is optimized for a fixed width and has more control over the exact placement of layout elements. |
| GridLayout | A type of layout that can be used on a sheet. |
| SectionBasedLayout | A section based layout organizes visuals into multiple sections and has customized header, footer and page break. |
Constructors
LayoutConfigurationProperty()
The configuration that determines what the type of layout will be used on a sheet.
public LayoutConfigurationProperty()Remarks
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
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 layoutConfigurationProperty = new LayoutConfigurationProperty {
FreeFormLayout = new FreeFormLayoutConfigurationProperty {
CanvasSizeOptions = new FreeFormLayoutCanvasSizeOptionsProperty {
ScreenCanvasSizeOptions = new FreeFormLayoutScreenCanvasSizeOptionsProperty {
OptimizedViewPortWidth = "optimizedViewPortWidth"
}
},
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"
} }
},
GridLayout = new GridLayoutConfigurationProperty {
CanvasSizeOptions = new GridLayoutCanvasSizeOptionsProperty {
ScreenCanvasSizeOptions = new GridLayoutScreenCanvasSizeOptionsProperty {
OptimizedViewPortWidth = "optimizedViewPortWidth",
ResizeOption = "resizeOption"
}
},
Elements = new [] { new GridLayoutElementProperty {
ColumnIndex = 123,
ColumnSpan = 123,
ElementId = "elementId",
ElementType = "elementType",
RowIndex = 123,
RowSpan = 123
} }
},
SectionBasedLayout = 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
FreeFormLayout
A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.
public object? FreeFormLayout { get; set; }Property Value
Remarks
GridLayout
A type of layout that can be used on a sheet.
public object? GridLayout { get; set; }Property Value
Remarks
In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE .
Type union: either IResolvable or CfnAnalysisPropsMixin.IGridLayoutConfigurationProperty
SectionBasedLayout
A section based layout organizes visuals into multiple sections and has customized header, footer and page break.
public object? SectionBasedLayout { get; set; }