Class CfnTemplate.NumericRangeFilterProperty
A NumericRangeFilter filters values that are within the value range.
Inheritance
System.Object
CfnTemplate.NumericRangeFilterProperty
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class NumericRangeFilterProperty : Object, CfnTemplate.INumericRangeFilterPropertySyntax (vb)
Public Class NumericRangeFilterProperty
Inherits Object
Implements CfnTemplate.INumericRangeFilterPropertyRemarks
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 numericRangeFilterProperty = new NumericRangeFilterProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FilterId = "filterId",
NullOption = "nullOption",
// the properties below are optional
AggregationFunction = new AggregationFunctionProperty {
AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
SimpleAttributeAggregation = "simpleAttributeAggregation",
ValueForMultipleValues = "valueForMultipleValues"
},
CategoricalAggregationFunction = "categoricalAggregationFunction",
DateAggregationFunction = "dateAggregationFunction",
NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
PercentileAggregation = new PercentileAggregationProperty {
PercentileValue = 123
},
SimpleNumericalAggregation = "simpleNumericalAggregation"
}
},
DefaultFilterControlConfiguration = new DefaultFilterControlConfigurationProperty {
ControlOptions = new DefaultFilterControlOptionsProperty {
DefaultDateTimePickerOptions = new DefaultDateTimePickerControlOptionsProperty {
CommitMode = "commitMode",
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 {
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",
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 {
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",
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"
},
IncludeMaximum = false,
IncludeMinimum = false,
RangeMaximum = new NumericRangeFilterValueProperty {
Parameter = "parameter",
StaticValue = 123
},
RangeMinimum = new NumericRangeFilterValueProperty {
Parameter = "parameter",
StaticValue = 123
},
SelectAllOptions = "selectAllOptions"
};Synopsis
Constructors
| Numeric |
Properties
| Aggregation |
The aggregation function of the filter. |
| Column | The column that the filter is applied to. |
| Default |
The default configurations for the associated controls. |
| Filter |
An identifier that uniquely identifies a filter within a dashboard, analysis, or template. |
| Include |
Determines whether the maximum value in the filter value range should be included in the filtered results. |
| Include |
Determines whether the minimum value in the filter value range should be included in the filtered results. |
| Null |
This option determines how null values should be treated when filtering data. |
| Range |
The maximum value for the filter value range. |
| Range |
The minimum value for the filter value range. |
| Select |
Select all of the values. Null is not the assigned value of select all. |
Constructors
NumericRangeFilterProperty()
public NumericRangeFilterProperty()Properties
AggregationFunction
The aggregation function of the filter.
public object AggregationFunction { get; set; }Property Value
System.
Remarks
Column
The column that the filter is applied to.
public object Column { get; set; }Property Value
System.
Remarks
DefaultFilterControlConfiguration
The default configurations for the associated controls.
public object DefaultFilterControlConfiguration { get; set; }Property Value
System.
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.
public string FilterId { get; set; }Property Value
System.
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.
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.
Remarks
NullOption
This option determines how null values should be treated when filtering data.
public string NullOption { get; set; }Property Value
System.
Remarks
RangeMaximum
The maximum value for the filter value range.
public object RangeMaximum { get; set; }Property Value
System.
Remarks
RangeMinimum
The minimum value for the filter value range.
public object RangeMinimum { get; set; }Property Value
System.
Remarks
SelectAllOptions
Select all of the values. Null is not the assigned value of select all.
public string SelectAllOptions { get; set; }Property Value
System.