Class CfnTemplate.RelativeDatesFilterProperty
A RelativeDatesFilter
filters relative dates values.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class RelativeDatesFilterProperty : Object, CfnTemplate.IRelativeDatesFilterProperty
Syntax (vb)
Public Class RelativeDatesFilterProperty
Inherits Object
Implements CfnTemplate.IRelativeDatesFilterProperty
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 relativeDatesFilterProperty = new RelativeDatesFilterProperty {
AnchorDateConfiguration = new AnchorDateConfigurationProperty {
AnchorOption = "anchorOption",
ParameterName = "parameterName"
},
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FilterId = "filterId",
NullOption = "nullOption",
RelativeDateType = "relativeDateType",
TimeGranularity = "timeGranularity",
// 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"
},
MinimumGranularity = "minimumGranularity",
ParameterName = "parameterName",
RelativeDateValue = 123
};
Synopsis
Constructors
RelativeDatesFilterProperty() |
Properties
AnchorDateConfiguration | The date configuration of the filter. |
Column | The column that the filter is applied to. |
DefaultFilterControlConfiguration | The default configurations for the associated controls. |
ExcludePeriodConfiguration | The configuration for the exclude period of the filter. |
FilterId | An identifier that uniquely identifies a filter within a dashboard, analysis, or template. |
MinimumGranularity | The minimum granularity (period granularity) of the relative dates filter. |
NullOption | This option determines how null values should be treated when filtering data. |
ParameterName | The parameter whose value should be used for the filter value. |
RelativeDateType | The range date type of the filter. Choose one of the options below:. |
RelativeDateValue | The date value of the filter. |
TimeGranularity | The level of time precision that is used to aggregate |
Constructors
RelativeDatesFilterProperty()
public RelativeDatesFilterProperty()
Properties
AnchorDateConfiguration
The date configuration of the filter.
public object AnchorDateConfiguration { get; set; }
Property Value
System.Object
Remarks
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 configuration for the exclude period of the 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
MinimumGranularity
The minimum granularity (period granularity) of the relative dates filter.
public string MinimumGranularity { get; set; }
Property Value
System.String
Remarks
NullOption
This option determines how null values should be treated when filtering data.
public string NullOption { get; set; }
Property Value
System.String
Remarks
ParameterName
The parameter whose value should be used for the filter value.
public string ParameterName { get; set; }
Property Value
System.String
Remarks
RelativeDateType
The range date type of the filter. Choose one of the options below:.
public string RelativeDateType { get; set; }
Property Value
System.String
Remarks
RelativeDateValue
The date value of the filter.
public Nullable<double> RelativeDateValue { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
TimeGranularity
The level of time precision that is used to aggregate DateTime
values.
public string TimeGranularity { get; set; }
Property Value
System.String