aws-cdk-lib.aws_quicksight.CfnTemplate.FilterTextFieldControlProperty

interface FilterTextFieldControlProperty

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

A control to display a text box that is used to enter a single entry.

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 filterTextFieldControlProperty: quicksight.CfnTemplate.FilterTextFieldControlProperty = {
  filterControlId: 'filterControlId',
  sourceFilterId: 'sourceFilterId',
  title: 'title',

  // the properties below are optional
  displayOptions: {
    placeholderOptions: {
      visibility: 'visibility',
    },
    titleOptions: {
      customLabel: 'customLabel',
      fontConfiguration: {
        fontColor: 'fontColor',
        fontDecoration: 'fontDecoration',
        fontSize: {
          relative: 'relative',
        },
        fontStyle: 'fontStyle',
        fontWeight: {
          name: 'name',
        },
      },
      visibility: 'visibility',
    },
  },
};

Properties

NameTypeDescription
filterControlIdstringThe ID of the FilterTextFieldControl .
sourceFilterIdstringThe source filter ID of the FilterTextFieldControl .
titlestringThe title of the FilterTextFieldControl .
displayOptions?IResolvable | TextFieldControlDisplayOptionsPropertyThe display options of a control.

filterControlId

Type: string

The ID of the FilterTextFieldControl .


sourceFilterId

Type: string

The source filter ID of the FilterTextFieldControl .


title

Type: string

The title of the FilterTextFieldControl .


displayOptions?

Type: IResolvable | TextFieldControlDisplayOptionsProperty (optional)

The display options of a control.