Class CfnAnalysis.LayoutProperty
A Layout
defines the placement of elements within a sheet.
Inheritance
System.Object
CfnAnalysis.LayoutProperty
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class LayoutProperty : Object, CfnAnalysis.ILayoutProperty
Syntax (vb)
Public Class LayoutProperty
Inherits Object
Implements CfnAnalysis.ILayoutProperty
Remarks
For more information, see Types of layout in the Amazon QuickSight User Guide .
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.AWS.QuickSight;
var layoutProperty = new LayoutProperty {
Configuration = new LayoutConfigurationProperty {
FreeFormLayout = new FreeFormLayoutConfigurationProperty {
Elements = new [] { new FreeFormLayoutElementProperty {
ElementId = "elementId",
ElementType = "elementType",
Height = "height",
Width = "width",
XAxisLocation = "xAxisLocation",
YAxisLocation = "yAxisLocation",
// the properties below are optional
BackgroundStyle = new FreeFormLayoutElementBackgroundStyleProperty {
Color = "color",
Visibility = "visibility"
},
BorderStyle = new FreeFormLayoutElementBorderStyleProperty {
Color = "color",
Visibility = "visibility"
},
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"
} },
// the properties below are optional
CanvasSizeOptions = new FreeFormLayoutCanvasSizeOptionsProperty {
ScreenCanvasSizeOptions = new FreeFormLayoutScreenCanvasSizeOptionsProperty {
OptimizedViewPortWidth = "optimizedViewPortWidth"
}
}
},
GridLayout = new GridLayoutConfigurationProperty {
Elements = new [] { new GridLayoutElementProperty {
ColumnSpan = 123,
ElementId = "elementId",
ElementType = "elementType",
RowSpan = 123,
// the properties below are optional
ColumnIndex = 123,
RowIndex = 123
} },
// the properties below are optional
CanvasSizeOptions = new GridLayoutCanvasSizeOptionsProperty {
ScreenCanvasSizeOptions = new GridLayoutScreenCanvasSizeOptionsProperty {
ResizeOption = "resizeOption",
// the properties below are optional
OptimizedViewPortWidth = "optimizedViewPortWidth"
}
}
},
SectionBasedLayout = new SectionBasedLayoutConfigurationProperty {
BodySections = new [] { new BodySectionConfigurationProperty {
Content = new BodySectionContentProperty {
Layout = new SectionLayoutConfigurationProperty {
FreeFormLayout = new FreeFormSectionLayoutConfigurationProperty {
Elements = new [] { new FreeFormLayoutElementProperty {
ElementId = "elementId",
ElementType = "elementType",
Height = "height",
Width = "width",
XAxisLocation = "xAxisLocation",
YAxisLocation = "yAxisLocation",
// the properties below are optional
BackgroundStyle = new FreeFormLayoutElementBackgroundStyleProperty {
Color = "color",
Visibility = "visibility"
},
BorderStyle = new FreeFormLayoutElementBorderStyleProperty {
Color = "color",
Visibility = "visibility"
},
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"
} }
}
}
},
SectionId = "sectionId",
// the properties below are optional
PageBreakConfiguration = new SectionPageBreakConfigurationProperty {
After = new SectionAfterPageBreakProperty {
Status = "status"
}
},
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 {
ElementId = "elementId",
ElementType = "elementType",
Height = "height",
Width = "width",
XAxisLocation = "xAxisLocation",
YAxisLocation = "yAxisLocation",
// the properties below are optional
BackgroundStyle = new FreeFormLayoutElementBackgroundStyleProperty {
Color = "color",
Visibility = "visibility"
},
BorderStyle = new FreeFormLayoutElementBorderStyleProperty {
Color = "color",
Visibility = "visibility"
},
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"
} }
}
},
SectionId = "sectionId",
// the properties below are optional
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 {
ElementId = "elementId",
ElementType = "elementType",
Height = "height",
Width = "width",
XAxisLocation = "xAxisLocation",
YAxisLocation = "yAxisLocation",
// the properties below are optional
BackgroundStyle = new FreeFormLayoutElementBackgroundStyleProperty {
Color = "color",
Visibility = "visibility"
},
BorderStyle = new FreeFormLayoutElementBorderStyleProperty {
Color = "color",
Visibility = "visibility"
},
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"
} }
}
},
SectionId = "sectionId",
// the properties below are optional
Style = new SectionStyleProperty {
Height = "height",
Padding = new SpacingProperty {
Bottom = "bottom",
Left = "left",
Right = "right",
Top = "top"
}
}
} }
}
}
};
Synopsis
Constructors
LayoutProperty() |
Properties
Configuration | The configuration that determines what the type of layout for a sheet. |
Constructors
LayoutProperty()
public LayoutProperty()
Properties
Configuration
The configuration that determines what the type of layout for a sheet.
public object Configuration { get; set; }
Property Value
System.Object