interface TopBottomFilterProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnTemplate.TopBottomFilterProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_TopBottomFilterProperty
Java	software.amazon.awscdk.services.quicksight.CfnTemplate.TopBottomFilterProperty
Python	aws_cdk.aws_quicksight.CfnTemplate.TopBottomFilterProperty
TypeScript	aws-cdk-lib » aws_quicksight » CfnTemplate » TopBottomFilterProperty

A TopBottomFilter filters values that are at the top or the bottom.

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

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 topBottomFilterProperty: quicksight.CfnTemplate.TopBottomFilterProperty = {
  aggregationSortConfigurations: [{
    column: {
      columnName: 'columnName',
      dataSetIdentifier: 'dataSetIdentifier',
    },
    sortDirection: 'sortDirection',

    // the properties below are optional
    aggregationFunction: {
      attributeAggregationFunction: {
        simpleAttributeAggregation: 'simpleAttributeAggregation',
        valueForMultipleValues: 'valueForMultipleValues',
      },
      categoricalAggregationFunction: 'categoricalAggregationFunction',
      dateAggregationFunction: 'dateAggregationFunction',
      numericalAggregationFunction: {
        percentileAggregation: {
          percentileValue: 123,
        },
        simpleNumericalAggregation: 'simpleNumericalAggregation',
      },
    },
  }],
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  filterId: 'filterId',

  // the properties below are optional
  defaultFilterControlConfiguration: {
    controlOptions: {
      defaultDateTimePickerOptions: {
        commitMode: 'commitMode',
        displayOptions: {
          dateTimeFormat: 'dateTimeFormat',
          infoIconLabelOptions: {
            infoIconText: 'infoIconText',
            visibility: 'visibility',
          },
          titleOptions: {
            customLabel: 'customLabel',
            fontConfiguration: {
              fontColor: 'fontColor',
              fontDecoration: 'fontDecoration',
              fontSize: {
                relative: 'relative',
              },
              fontStyle: 'fontStyle',
              fontWeight: {
                name: 'name',
              },
            },
            visibility: 'visibility',
          },
        },
        type: 'type',
      },
      defaultDropdownOptions: {
        commitMode: 'commitMode',
        displayOptions: {
          infoIconLabelOptions: {
            infoIconText: 'infoIconText',
            visibility: 'visibility',
          },
          selectAllOptions: {
            visibility: 'visibility',
          },
          titleOptions: {
            customLabel: 'customLabel',
            fontConfiguration: {
              fontColor: 'fontColor',
              fontDecoration: 'fontDecoration',
              fontSize: {
                relative: 'relative',
              },
              fontStyle: 'fontStyle',
              fontWeight: {
                name: 'name',
              },
            },
            visibility: 'visibility',
          },
        },
        selectableValues: {
          values: ['values'],
        },
        type: 'type',
      },
      defaultListOptions: {
        displayOptions: {
          infoIconLabelOptions: {
            infoIconText: 'infoIconText',
            visibility: 'visibility',
          },
          searchOptions: {
            visibility: 'visibility',
          },
          selectAllOptions: {
            visibility: 'visibility',
          },
          titleOptions: {
            customLabel: 'customLabel',
            fontConfiguration: {
              fontColor: 'fontColor',
              fontDecoration: 'fontDecoration',
              fontSize: {
                relative: 'relative',
              },
              fontStyle: 'fontStyle',
              fontWeight: {
                name: 'name',
              },
            },
            visibility: 'visibility',
          },
        },
        selectableValues: {
          values: ['values'],
        },
        type: 'type',
      },
      defaultRelativeDateTimeOptions: {
        commitMode: 'commitMode',
        displayOptions: {
          dateTimeFormat: 'dateTimeFormat',
          infoIconLabelOptions: {
            infoIconText: 'infoIconText',
            visibility: 'visibility',
          },
          titleOptions: {
            customLabel: 'customLabel',
            fontConfiguration: {
              fontColor: 'fontColor',
              fontDecoration: 'fontDecoration',
              fontSize: {
                relative: 'relative',
              },
              fontStyle: 'fontStyle',
              fontWeight: {
                name: 'name',
              },
            },
            visibility: 'visibility',
          },
        },
      },
      defaultSliderOptions: {
        maximumValue: 123,
        minimumValue: 123,
        stepSize: 123,

        // the properties below are optional
        displayOptions: {
          infoIconLabelOptions: {
            infoIconText: 'infoIconText',
            visibility: 'visibility',
          },
          titleOptions: {
            customLabel: 'customLabel',
            fontConfiguration: {
              fontColor: 'fontColor',
              fontDecoration: 'fontDecoration',
              fontSize: {
                relative: 'relative',
              },
              fontStyle: 'fontStyle',
              fontWeight: {
                name: 'name',
              },
            },
            visibility: 'visibility',
          },
        },
        type: 'type',
      },
      defaultTextAreaOptions: {
        delimiter: 'delimiter',
        displayOptions: {
          infoIconLabelOptions: {
            infoIconText: 'infoIconText',
            visibility: 'visibility',
          },
          placeholderOptions: {
            visibility: 'visibility',
          },
          titleOptions: {
            customLabel: 'customLabel',
            fontConfiguration: {
              fontColor: 'fontColor',
              fontDecoration: 'fontDecoration',
              fontSize: {
                relative: 'relative',
              },
              fontStyle: 'fontStyle',
              fontWeight: {
                name: 'name',
              },
            },
            visibility: 'visibility',
          },
        },
      },
      defaultTextFieldOptions: {
        displayOptions: {
          infoIconLabelOptions: {
            infoIconText: 'infoIconText',
            visibility: 'visibility',
          },
          placeholderOptions: {
            visibility: 'visibility',
          },
          titleOptions: {
            customLabel: 'customLabel',
            fontConfiguration: {
              fontColor: 'fontColor',
              fontDecoration: 'fontDecoration',
              fontSize: {
                relative: 'relative',
              },
              fontStyle: 'fontStyle',
              fontWeight: {
                name: 'name',
              },
            },
            visibility: 'visibility',
          },
        },
      },
    },
    title: 'title',
  },
  limit: 123,
  parameterName: 'parameterName',
  timeGranularity: 'timeGranularity',
};

Properties

Name	Type	Description
aggregationSortConfigurations	IResolvable | IResolvable | AggregationSortConfigurationProperty[]	The aggregation and sort configuration of the top bottom filter.
column	IResolvable | ColumnIdentifierProperty	The column that the filter is applied to.
filterId	string	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
defaultFilterControlConfiguration?	IResolvable | DefaultFilterControlConfigurationProperty	The default configurations for the associated controls.
limit?	number	The number of items to include in the top bottom filter results.
parameterName?	string	The parameter whose value should be used for the filter value.
timeGranularity?	string	The level of time precision that is used to aggregate DateTime values.

---

aggregationSortConfigurations

Type: IResolvable | IResolvable | AggregationSortConfigurationProperty[]

The aggregation and sort configuration of the top bottom filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-aggregationsortconfigurations

---

column

Type: IResolvable | ColumnIdentifierProperty

The column that the filter is applied to.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-column

---

filterId

Type: string

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-filterid

---

defaultFilterControlConfiguration?

Type: IResolvable | DefaultFilterControlConfigurationProperty (optional)

The default configurations for the associated controls.

This applies only for filters that are scoped to multiple sheets.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-defaultfiltercontrolconfiguration

---

limit?

Type: number (optional)

The number of items to include in the top bottom filter results.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-limit

---

parameterName?

Type: string (optional)

The parameter whose value should be used for the filter value.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-parametername

---

timeGranularity?

Type: string (optional)

The level of time precision that is used to aggregate DateTime values.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-timegranularity