interface TimeRangeFilterProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.QuickSight.CfnAnalysis.TimeRangeFilterProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_TimeRangeFilterProperty |
![]() | software.amazon.awscdk.services.quicksight.CfnAnalysis.TimeRangeFilterProperty |
![]() | aws_cdk.aws_quicksight.CfnAnalysis.TimeRangeFilterProperty |
![]() | aws-cdk-lib » aws_quicksight » CfnAnalysis » TimeRangeFilterProperty |
A TimeRangeFilter
filters values that are between two specified values.
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 timeRangeFilterProperty: quicksight.CfnAnalysis.TimeRangeFilterProperty = {
column: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
filterId: 'filterId',
nullOption: 'nullOption',
// 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: {
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',
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',
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',
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',
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',
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',
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',
},
includeMaximum: false,
includeMinimum: false,
rangeMaximumValue: {
parameter: 'parameter',
rollingDate: {
expression: 'expression',
// the properties below are optional
dataSetIdentifier: 'dataSetIdentifier',
},
staticValue: 'staticValue',
},
rangeMinimumValue: {
parameter: 'parameter',
rollingDate: {
expression: 'expression',
// the properties below are optional
dataSetIdentifier: 'dataSetIdentifier',
},
staticValue: 'staticValue',
},
timeGranularity: 'timeGranularity',
};
Properties
Name | Type | Description |
---|---|---|
column | IResolvable | Column | The column that the filter is applied to. |
filter | string | An identifier that uniquely identifies a filter within a dashboard, analysis, or template. |
null | string | This option determines how null values should be treated when filtering data. |
default | IResolvable | Default | The default configurations for the associated controls. |
exclude | IResolvable | Exclude | The exclude period of the time range filter. |
include | boolean | IResolvable | Determines whether the maximum value in the filter value range should be included in the filtered results. |
include | boolean | IResolvable | Determines whether the minimum value in the filter value range should be included in the filtered results. |
range | IResolvable | Time | The maximum value for the filter value range. |
range | IResolvable | Time | The minimum value for the filter value range. |
time | string | The level of time precision that is used to aggregate DateTime values. |
column
Type:
IResolvable
|
Column
The column that the filter is applied to.
filterId
Type:
string
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
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.
defaultFilterControlConfiguration?
Type:
IResolvable
|
Default
(optional)
The default configurations for the associated controls.
This applies only for filters that are scoped to multiple sheets.
excludePeriodConfiguration?
Type:
IResolvable
|
Exclude
(optional)
The exclude period of the time range filter.
includeMaximum?
Type:
boolean |
IResolvable
(optional)
Determines whether the maximum value in the filter value range should be included in the filtered results.
includeMinimum?
Type:
boolean |
IResolvable
(optional)
Determines whether the minimum value in the filter value range should be included in the filtered results.
rangeMaximumValue?
Type:
IResolvable
|
Time
(optional)
The maximum value for the filter value range.
rangeMinimumValue?
Type:
IResolvable
|
Time
(optional)
The minimum value for the filter value range.
timeGranularity?
Type:
string
(optional)
The level of time precision that is used to aggregate DateTime
values.