aws-cdk-lib.aws_quicksight.CfnTemplate.FreeFormLayoutElementProperty

interface FreeFormLayoutElementProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnTemplate.FreeFormLayoutElementProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_FreeFormLayoutElementProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnTemplate.FreeFormLayoutElementProperty
Pythonaws_cdk.aws_quicksight.CfnTemplate.FreeFormLayoutElementProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnTemplate » FreeFormLayoutElementProperty

An element within a free-form layout.

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 freeFormLayoutElementProperty: quicksight.CfnTemplate.FreeFormLayoutElementProperty = {
  elementId: 'elementId',
  elementType: 'elementType',
  height: 'height',
  width: 'width',
  xAxisLocation: 'xAxisLocation',
  yAxisLocation: 'yAxisLocation',

  // the properties below are optional
  backgroundStyle: {
    color: 'color',
    visibility: 'visibility',
  },
  borderStyle: {
    color: 'color',
    visibility: 'visibility',
  },
  loadingAnimation: {
    visibility: 'visibility',
  },
  renderingRules: [{
    configurationOverrides: {
      visibility: 'visibility',
    },
    expression: 'expression',
  }],
  selectedBorderStyle: {
    color: 'color',
    visibility: 'visibility',
  },
  visibility: 'visibility',
};

Properties

NameTypeDescription
elementIdstringA unique identifier for an element within a free-form layout.
elementTypestringThe type of element.
heightstringThe height of an element within a free-form layout.
widthstringThe width of an element within a free-form layout.
xAxisLocationstringThe x-axis coordinate of the element.
yAxisLocationstringThe y-axis coordinate of the element.
backgroundStyle?IResolvable | FreeFormLayoutElementBackgroundStylePropertyThe background style configuration of a free-form layout element.
borderStyle?IResolvable | FreeFormLayoutElementBorderStylePropertyThe border style configuration of a free-form layout element.
loadingAnimation?IResolvable | LoadingAnimationPropertyThe loading animation configuration of a free-form layout element.
renderingRules?IResolvable | IResolvable | SheetElementRenderingRuleProperty[]The rendering rules that determine when an element should be displayed within a free-form layout.
selectedBorderStyle?IResolvable | FreeFormLayoutElementBorderStylePropertyThe border style configuration of a free-form layout element.
visibility?stringThe visibility of an element within a free-form layout.

elementId

Type: string

A unique identifier for an element within a free-form layout.


elementType

Type: string

The type of element.


height

Type: string

The height of an element within a free-form layout.


width

Type: string

The width of an element within a free-form layout.


xAxisLocation

Type: string

The x-axis coordinate of the element.


yAxisLocation

Type: string

The y-axis coordinate of the element.


backgroundStyle?

Type: IResolvable | FreeFormLayoutElementBackgroundStyleProperty (optional)

The background style configuration of a free-form layout element.


borderStyle?

Type: IResolvable | FreeFormLayoutElementBorderStyleProperty (optional)

The border style configuration of a free-form layout element.


loadingAnimation?

Type: IResolvable | LoadingAnimationProperty (optional)

The loading animation configuration of a free-form layout element.


renderingRules?

Type: IResolvable | IResolvable | SheetElementRenderingRuleProperty[] (optional)

The rendering rules that determine when an element should be displayed within a free-form layout.


selectedBorderStyle?

Type: IResolvable | FreeFormLayoutElementBorderStyleProperty (optional)

The border style configuration of a free-form layout element.

This border style is used when the element is selected.


visibility?

Type: string (optional)

The visibility of an element within a free-form layout.