Interface CfnTemplate.IFilterProperty
With a Filter
, you can remove portions of data from a particular visual or view.
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.AWS.QuickSight.dll
Syntax (csharp)
public interface IFilterProperty
Syntax (vb)
Public Interface IFilterProperty
Remarks
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
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 filterProperty = new FilterProperty {
CategoryFilter = new CategoryFilterProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
Configuration = new CategoryFilterConfigurationProperty {
CustomFilterConfiguration = new CustomFilterConfigurationProperty {
MatchOperator = "matchOperator",
NullOption = "nullOption",
// the properties below are optional
CategoryValue = "categoryValue",
ParameterName = "parameterName",
SelectAllOptions = "selectAllOptions"
},
CustomFilterListConfiguration = new CustomFilterListConfigurationProperty {
MatchOperator = "matchOperator",
NullOption = "nullOption",
// the properties below are optional
CategoryValues = new [] { "categoryValues" },
SelectAllOptions = "selectAllOptions"
},
FilterListConfiguration = new FilterListConfigurationProperty {
MatchOperator = "matchOperator",
// the properties below are optional
CategoryValues = new [] { "categoryValues" },
SelectAllOptions = "selectAllOptions"
}
},
FilterId = "filterId"
},
NumericEqualityFilter = new NumericEqualityFilterProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FilterId = "filterId",
MatchOperator = "matchOperator",
NullOption = "nullOption",
// the properties below are optional
AggregationFunction = new AggregationFunctionProperty {
CategoricalAggregationFunction = "categoricalAggregationFunction",
DateAggregationFunction = "dateAggregationFunction",
NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
PercentileAggregation = new PercentileAggregationProperty {
PercentileValue = 123
},
SimpleNumericalAggregation = "simpleNumericalAggregation"
}
},
ParameterName = "parameterName",
SelectAllOptions = "selectAllOptions",
Value = 123
},
NumericRangeFilter = 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"
},
RelativeDatesFilter = 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
ExcludePeriodConfiguration = new ExcludePeriodConfigurationProperty {
Amount = 123,
Granularity = "granularity",
// the properties below are optional
Status = "status"
},
MinimumGranularity = "minimumGranularity",
ParameterName = "parameterName",
RelativeDateValue = 123
},
TimeEqualityFilter = new TimeEqualityFilterProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FilterId = "filterId",
// the properties below are optional
ParameterName = "parameterName",
TimeGranularity = "timeGranularity",
Value = "value"
},
TimeRangeFilter = new TimeRangeFilterProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FilterId = "filterId",
NullOption = "nullOption",
// the properties below are optional
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"
},
TopBottomFilter = new TopBottomFilterProperty {
AggregationSortConfigurations = new [] { new AggregationSortConfigurationProperty {
AggregationFunction = new AggregationFunctionProperty {
CategoricalAggregationFunction = "categoricalAggregationFunction",
DateAggregationFunction = "dateAggregationFunction",
NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
PercentileAggregation = new PercentileAggregationProperty {
PercentileValue = 123
},
SimpleNumericalAggregation = "simpleNumericalAggregation"
}
},
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
SortDirection = "sortDirection"
} },
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FilterId = "filterId",
// the properties below are optional
Limit = 123,
ParameterName = "parameterName",
TimeGranularity = "timeGranularity"
}
};
Synopsis
Properties
CategoryFilter | A |
NumericEqualityFilter | A |
NumericRangeFilter | A |
RelativeDatesFilter | A |
TimeEqualityFilter | A |
TimeRangeFilter | A |
TopBottomFilter | A |
Properties
CategoryFilter
A CategoryFilter
filters text values.
virtual object CategoryFilter { get; }
Property Value
System.Object
Remarks
For more information, see Adding text filters in the Amazon QuickSight User Guide .
NumericEqualityFilter
A NumericEqualityFilter
filters numeric values that equal or do not equal a given numeric value.
virtual object NumericEqualityFilter { get; }
Property Value
System.Object
Remarks
NumericRangeFilter
A NumericRangeFilter
filters numeric values that are either inside or outside a given numeric range.
virtual object NumericRangeFilter { get; }
Property Value
System.Object
Remarks
RelativeDatesFilter
A RelativeDatesFilter
filters date values that are relative to a given date.
virtual object RelativeDatesFilter { get; }
Property Value
System.Object
Remarks
TimeEqualityFilter
A TimeEqualityFilter
filters date-time values that equal or do not equal a given date/time value.
virtual object TimeEqualityFilter { get; }
Property Value
System.Object
Remarks
TimeRangeFilter
A TimeRangeFilter
filters date-time values that are either inside or outside a given date/time range.
virtual object TimeRangeFilter { get; }
Property Value
System.Object
Remarks
TopBottomFilter
A TopBottomFilter
filters data to the top or bottom values for a given column.
virtual object TopBottomFilter { get; }
Property Value
System.Object