Class CfnTemplate.NumericRangeFilterProperty
A NumericRangeFilter
filters values that are within the value range.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.AWS.QuickSight.dll
Syntax (csharp)
public class NumericRangeFilterProperty : Object, CfnTemplate.INumericRangeFilterProperty
Syntax (vb)
Public Class NumericRangeFilterProperty
Inherits Object
Implements CfnTemplate.INumericRangeFilterProperty
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 numericRangeFilterProperty = new NumericRangeFilterProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FilterId = "filterId",
NullOption = "nullOption",
// the properties below are optional
AggregationFunction = new AggregationFunctionProperty {
CategoricalAggregationFunction = "categoricalAggregationFunction",
DateAggregationFunction = "dateAggregationFunction",
NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
PercentileAggregation = new PercentileAggregationProperty {
PercentileValue = 123
},
SimpleNumericalAggregation = "simpleNumericalAggregation"
}
},
IncludeMaximum = false,
IncludeMinimum = false,
RangeMaximum = new NumericRangeFilterValueProperty {
Parameter = "parameter",
StaticValue = 123
},
RangeMinimum = new NumericRangeFilterValueProperty {
Parameter = "parameter",
StaticValue = 123
},
SelectAllOptions = "selectAllOptions"
};
Synopsis
Constructors
NumericRangeFilterProperty() |
Properties
AggregationFunction | The aggregation function of the filter. |
Column | The column that the filter is applied to. |
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. |
RangeMaximum | The maximum value for the filter value range. |
RangeMinimum | The minimum value for the filter value range. |
SelectAllOptions | 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.Object
Remarks
Column
The column that the filter is applied to.
public object Column { 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
RangeMaximum
The maximum value for the filter value range.
public object RangeMaximum { get; set; }
Property Value
System.Object
Remarks
RangeMinimum
The minimum value for the filter value range.
public object RangeMinimum { get; set; }
Property Value
System.Object
Remarks
SelectAllOptions
Select all of the values. Null is not the assigned value of select all.
public string SelectAllOptions { get; set; }
Property Value
System.String