interface RelativeDatesFilterProperty

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

A RelativeDatesFilter filters relative dates values.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.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 relativeDatesFilterProperty: quicksight.CfnAnalysis.RelativeDatesFilterProperty = {
  anchorDateConfiguration: {
    anchorOption: 'anchorOption',
    parameterName: 'parameterName',
  },
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  filterId: 'filterId',
  nullOption: 'nullOption',
  relativeDateType: 'relativeDateType',
  timeGranularity: 'timeGranularity',

  // the properties below are optional
  defaultFilterControlConfiguration: {
    controlOptions: {
      defaultDateTimePickerOptions: {
        commitMode: 'commitMode',
        displayOptions: {
          dateIconVisibility: 'dateIconVisibility',
          dateTimeFormat: 'dateTimeFormat',
          helperTextVisibility: 'helperTextVisibility',
          infoIconLabelOptions: {
            infoIconText: 'infoIconText',
            visibility: 'visibility',
          },
          titleOptions: {
            customLabel: 'customLabel',
            fontConfiguration: {
              fontColor: 'fontColor',
              fontDecoration: 'fontDecoration',
              fontFamily: 'fontFamily',
              fontSize: {
                absolute: 'absolute',
                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',
              fontFamily: 'fontFamily',
              fontSize: {
                absolute: 'absolute',
                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',
              fontFamily: 'fontFamily',
              fontSize: {
                absolute: 'absolute',
                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',
              fontFamily: 'fontFamily',
              fontSize: {
                absolute: 'absolute',
                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',
              fontFamily: 'fontFamily',
              fontSize: {
                absolute: 'absolute',
                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',
              fontFamily: 'fontFamily',
              fontSize: {
                absolute: 'absolute',
                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',
              fontFamily: 'fontFamily',
              fontSize: {
                absolute: 'absolute',
                relative: 'relative',
              },
              fontStyle: 'fontStyle',
              fontWeight: {
                name: 'name',
              },
            },
            visibility: 'visibility',
          },
        },
      },
    },
    title: 'title',
  },
  excludePeriodConfiguration: {
    amount: 123,
    granularity: 'granularity',

    // the properties below are optional
    status: 'status',
  },
  minimumGranularity: 'minimumGranularity',
  parameterName: 'parameterName',
  relativeDateValue: 123,
};

Properties

Name	Type	Description
anchorDateConfiguration	IResolvable | AnchorDateConfigurationProperty	The date configuration of the 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.
nullOption	string	This option determines how null values should be treated when filtering data.
relativeDateType	string	The range date type of the filter. Choose one of the options below:.
timeGranularity	string	The level of time precision that is used to aggregate DateTime values.
defaultFilterControlConfiguration?	IResolvable | DefaultFilterControlConfigurationProperty	The default configurations for the associated controls.
excludePeriodConfiguration?	IResolvable | ExcludePeriodConfigurationProperty	The configuration for the exclude period of the filter.
minimumGranularity?	string	The minimum granularity (period granularity) of the relative dates filter.
parameterName?	string	The parameter whose value should be used for the filter value.
relativeDateValue?	number	The date value of the filter.

---

anchorDateConfiguration

Type: IResolvable | AnchorDateConfigurationProperty

The date configuration of the filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-anchordateconfiguration

---

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-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-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-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-filterid

---

nullOption

Type: string

This option determines how null values should be treated when filtering data.

• ALL_VALUES : Include null values in filtered results.
• NULLS_ONLY : Only include null values in filtered results.
• NON_NULLS_ONLY : Exclude null values from filtered results.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-nulloption

---

relativeDateType

Type: string

The range date type of the filter. Choose one of the options below:.

• PREVIOUS
• THIS
• LAST
• NOW
• NEXT

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-relativedatetype

---

timeGranularity

Type: string

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-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-timegranularity

---

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-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-defaultfiltercontrolconfiguration

---

excludePeriodConfiguration?

Type: IResolvable | ExcludePeriodConfigurationProperty (optional)

The configuration for the exclude period of the filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-excludeperiodconfiguration

---

minimumGranularity?

Type: string (optional)

The minimum granularity (period granularity) of the relative dates filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-minimumgranularity

---

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-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-parametername

---

relativeDateValue?

Type: number (optional)

The date value of the filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-relativedatevalue