Interface CfnTemplate.ITimeEqualityFilterProperty
A TimeEqualityFilter filters values that are equal to a given value.
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnTemplate.ITimeEqualityFilterPropertySyntax (vb)
Public Interface CfnTemplate.ITimeEqualityFilterPropertyRemarks
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 dateIconVisibility;
var helperTextVisibility;
var timeEqualityFilterProperty = new TimeEqualityFilterProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FilterId = "filterId",
// the properties below are optional
DefaultFilterControlConfiguration = new DefaultFilterControlConfigurationProperty {
ControlOptions = new DefaultFilterControlOptionsProperty {
DefaultDateTimePickerOptions = new DefaultDateTimePickerControlOptionsProperty {
CommitMode = "commitMode",
DisplayOptions = new DateTimePickerControlDisplayOptionsProperty {
DateIconVisibility = dateIconVisibility,
DateTimeFormat = "dateTimeFormat",
HelperTextVisibility = helperTextVisibility,
InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
InfoIconText = "infoIconText",
Visibility = "visibility"
},
TitleOptions = new LabelOptionsProperty {
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
Type = "type"
},
DefaultDropdownOptions = new DefaultFilterDropDownControlOptionsProperty {
CommitMode = "commitMode",
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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
SelectableValues = new FilterSelectableValuesProperty {
Values = new [] { "values" }
},
Type = "type"
},
DefaultRelativeDateTimeOptions = new DefaultRelativeDateTimeControlOptionsProperty {
CommitMode = "commitMode",
DisplayOptions = new RelativeDateTimeControlDisplayOptionsProperty {
DateTimeFormat = "dateTimeFormat",
InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
InfoIconText = "infoIconText",
Visibility = "visibility"
},
TitleOptions = new LabelOptionsProperty {
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
}
}
},
Title = "title"
},
ParameterName = "parameterName",
RollingDate = new RollingDateConfigurationProperty {
Expression = "expression",
// the properties below are optional
DataSetIdentifier = "dataSetIdentifier"
},
TimeGranularity = "timeGranularity",
Value = "value"
};Synopsis
Properties
| Column | The column that the filter is applied to. |
| DefaultFilterControlConfiguration | The default configurations for the associated controls. |
| FilterId | An identifier that uniquely identifies a filter within a dashboard, analysis, or template. |
| ParameterName | The parameter whose value should be used for the filter value. |
| RollingDate | The rolling date input for the |
| TimeGranularity | The level of time precision that is used to aggregate |
| Value | The value of a |
Properties
Column
The column that the filter is applied to.
object Column { get; }Property Value
Remarks
DefaultFilterControlConfiguration
The default configurations for the associated controls.
object? DefaultFilterControlConfiguration { get; }Property Value
Remarks
This applies only for filters that are scoped to multiple sheets.
FilterId
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
string FilterId { get; }Property Value
Remarks
ParameterName
The parameter whose value should be used for the filter value.
string? ParameterName { get; }Property Value
Remarks
This field is mutually exclusive to Value and RollingDate .
RollingDate
The rolling date input for the TimeEquality filter.
object? RollingDate { get; }Property Value
Remarks
This field is mutually exclusive to Value and ParameterName .
TimeGranularity
The level of time precision that is used to aggregate DateTime values.
string? TimeGranularity { get; }Property Value
Remarks
Value
The value of a TimeEquality filter.
string? Value { get; }Property Value
Remarks
This field is mutually exclusive to RollingDate and ParameterName .