Class CfnDashboard.TimeRangeFilterProperty
A TimeRangeFilter
filters values that are between two specified values.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class TimeRangeFilterProperty : Object, CfnDashboard.ITimeRangeFilterProperty
Syntax (vb)
Public Class TimeRangeFilterProperty
Inherits Object
Implements CfnDashboard.ITimeRangeFilterProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;
var timeRangeFilterProperty = new TimeRangeFilterProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FilterId = "filterId",
NullOption = "nullOption",
// the properties below are optional
DefaultFilterControlConfiguration = new DefaultFilterControlConfigurationProperty {
ControlOptions = new DefaultFilterControlOptionsProperty {
DefaultDateTimePickerOptions = new DefaultDateTimePickerControlOptionsProperty {
DisplayOptions = new DateTimePickerControlDisplayOptionsProperty {
DateTimeFormat = "dateTimeFormat",
InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
InfoIconText = "infoIconText",
Visibility = "visibility"
},
TitleOptions = new LabelOptionsProperty {
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontSize = new FontSizeProperty {
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
Type = "type"
},
DefaultDropdownOptions = new DefaultFilterDropDownControlOptionsProperty {
DisplayOptions = new DropDownControlDisplayOptionsProperty {
InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
InfoIconText = "infoIconText",
Visibility = "visibility"
},
SelectAllOptions = new ListControlSelectAllOptionsProperty {
Visibility = "visibility"
},
TitleOptions = new LabelOptionsProperty {
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontSize = new FontSizeProperty {
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
SelectableValues = new FilterSelectableValuesProperty {
Values = new [] { "values" }
},
Type = "type"
},
DefaultListOptions = new DefaultFilterListControlOptionsProperty {
DisplayOptions = new ListControlDisplayOptionsProperty {
InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
InfoIconText = "infoIconText",
Visibility = "visibility"
},
SearchOptions = new ListControlSearchOptionsProperty {
Visibility = "visibility"
},
SelectAllOptions = new ListControlSelectAllOptionsProperty {
Visibility = "visibility"
},
TitleOptions = new LabelOptionsProperty {
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontSize = new FontSizeProperty {
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
SelectableValues = new FilterSelectableValuesProperty {
Values = new [] { "values" }
},
Type = "type"
},
DefaultRelativeDateTimeOptions = new DefaultRelativeDateTimeControlOptionsProperty {
DisplayOptions = new RelativeDateTimeControlDisplayOptionsProperty {
DateTimeFormat = "dateTimeFormat",
InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
InfoIconText = "infoIconText",
Visibility = "visibility"
},
TitleOptions = new LabelOptionsProperty {
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontSize = new FontSizeProperty {
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
}
},
DefaultSliderOptions = new DefaultSliderControlOptionsProperty {
MaximumValue = 123,
MinimumValue = 123,
StepSize = 123,
// the properties below are optional
DisplayOptions = new SliderControlDisplayOptionsProperty {
InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
InfoIconText = "infoIconText",
Visibility = "visibility"
},
TitleOptions = new LabelOptionsProperty {
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontSize = new FontSizeProperty {
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
Type = "type"
},
DefaultTextAreaOptions = new DefaultTextAreaControlOptionsProperty {
Delimiter = "delimiter",
DisplayOptions = new TextAreaControlDisplayOptionsProperty {
InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
InfoIconText = "infoIconText",
Visibility = "visibility"
},
PlaceholderOptions = new TextControlPlaceholderOptionsProperty {
Visibility = "visibility"
},
TitleOptions = new LabelOptionsProperty {
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontSize = new FontSizeProperty {
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
}
},
DefaultTextFieldOptions = new DefaultTextFieldControlOptionsProperty {
DisplayOptions = new TextFieldControlDisplayOptionsProperty {
InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
InfoIconText = "infoIconText",
Visibility = "visibility"
},
PlaceholderOptions = new TextControlPlaceholderOptionsProperty {
Visibility = "visibility"
},
TitleOptions = new LabelOptionsProperty {
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontSize = new FontSizeProperty {
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
}
}
},
Title = "title"
},
ExcludePeriodConfiguration = new ExcludePeriodConfigurationProperty {
Amount = 123,
Granularity = "granularity",
// the properties below are optional
Status = "status"
},
IncludeMaximum = false,
IncludeMinimum = false,
RangeMaximumValue = new TimeRangeFilterValueProperty {
Parameter = "parameter",
RollingDate = new RollingDateConfigurationProperty {
Expression = "expression",
// the properties below are optional
DataSetIdentifier = "dataSetIdentifier"
},
StaticValue = "staticValue"
},
RangeMinimumValue = new TimeRangeFilterValueProperty {
Parameter = "parameter",
RollingDate = new RollingDateConfigurationProperty {
Expression = "expression",
// the properties below are optional
DataSetIdentifier = "dataSetIdentifier"
},
StaticValue = "staticValue"
},
TimeGranularity = "timeGranularity"
};
Synopsis
Constructors
TimeRangeFilterProperty() |
Properties
Column | The column that the filter is applied to. |
DefaultFilterControlConfiguration | The default configurations for the associated controls. |
ExcludePeriodConfiguration | The exclude period of the time range filter. |
FilterId | An identifier that uniquely identifies a filter within a dashboard, analysis, or template. |
IncludeMaximum | Determines whether the maximum value in the filter value range should be included in the filtered results. |
IncludeMinimum | Determines whether the minimum value in the filter value range should be included in the filtered results. |
NullOption | This option determines how null values should be treated when filtering data. |
RangeMaximumValue | The maximum value for the filter value range. |
RangeMinimumValue | The minimum value for the filter value range. |
TimeGranularity | The level of time precision that is used to aggregate |
Constructors
TimeRangeFilterProperty()
public TimeRangeFilterProperty()
Properties
Column
The column that the filter is applied to.
public object Column { get; set; }
Property Value
System.Object
Remarks
DefaultFilterControlConfiguration
The default configurations for the associated controls.
public object DefaultFilterControlConfiguration { get; set; }
Property Value
System.Object
Remarks
This applies only for filters that are scoped to multiple sheets.
ExcludePeriodConfiguration
The exclude period of the time range filter.
public object ExcludePeriodConfiguration { get; set; }
Property Value
System.Object
Remarks
FilterId
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
public string FilterId { get; set; }
Property Value
System.String
Remarks
IncludeMaximum
Determines whether the maximum value in the filter value range should be included in the filtered results.
public object IncludeMaximum { get; set; }
Property Value
System.Object
Remarks
IncludeMinimum
Determines whether the minimum value in the filter value range should be included in the filtered results.
public object IncludeMinimum { get; set; }
Property Value
System.Object
Remarks
NullOption
This option determines how null values should be treated when filtering data.
public string NullOption { get; set; }
Property Value
System.String
Remarks
RangeMaximumValue
The maximum value for the filter value range.
public object RangeMaximumValue { get; set; }
Property Value
System.Object
Remarks
RangeMinimumValue
The minimum value for the filter value range.
public object RangeMinimumValue { get; set; }
Property Value
System.Object
Remarks
TimeGranularity
The level of time precision that is used to aggregate DateTime
values.
public string TimeGranularity { get; set; }
Property Value
System.String