Class CfnTemplate.FilterGroupProperty
A grouping of individual filters. Filter groups are applied to the same group of visuals.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.AWS.QuickSight.dll
Syntax (csharp)
public class FilterGroupProperty : Object, CfnTemplate.IFilterGroupProperty
Syntax (vb)
Public Class FilterGroupProperty
Inherits Object
Implements CfnTemplate.IFilterGroupProperty
Remarks
For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon QuickSight User Guide .
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 filterGroupProperty = new FilterGroupProperty {
CrossDataset = "crossDataset",
FilterGroupId = "filterGroupId",
Filters = new [] { 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"
}
} },
ScopeConfiguration = new FilterScopeConfigurationProperty {
SelectedSheets = new SelectedSheetsFilterScopeConfigurationProperty {
SheetVisualScopingConfigurations = new [] { new SheetVisualScopingConfigurationProperty {
Scope = "scope",
SheetId = "sheetId",
// the properties below are optional
VisualIds = new [] { "visualIds" }
} }
}
},
// the properties below are optional
Status = "status"
};
Synopsis
Constructors
FilterGroupProperty() |
Properties
CrossDataset | The filter new feature which can apply filter group to all data sets. Choose one of the following options:. |
FilterGroupId | The value that uniquely identifies a |
Filters | The list of filters that are present in a |
ScopeConfiguration | The configuration that specifies what scope to apply to a |
Status | The status of the |
Constructors
FilterGroupProperty()
public FilterGroupProperty()
Properties
CrossDataset
The filter new feature which can apply filter group to all data sets. Choose one of the following options:.
public string CrossDataset { get; set; }
Property Value
System.String
Remarks
FilterGroupId
The value that uniquely identifies a FilterGroup
within a dashboard, template, or analysis.
public string FilterGroupId { get; set; }
Property Value
System.String
Remarks
Filters
The list of filters that are present in a FilterGroup
.
public object Filters { get; set; }
Property Value
System.Object
Remarks
ScopeConfiguration
The configuration that specifies what scope to apply to a FilterGroup
.
public object ScopeConfiguration { get; set; }
Property Value
System.Object
Remarks
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
Status
The status of the FilterGroup
.
public string Status { get; set; }
Property Value
System.String