Class CfnAnalysis.CategoryFilterProperty
A CategoryFilter
filters text values.
Inheritance
System.Object
CfnAnalysis.CategoryFilterProperty
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CategoryFilterProperty : Object, CfnAnalysis.ICategoryFilterProperty
Syntax (vb)
Public Class CategoryFilterProperty
Inherits Object
Implements CfnAnalysis.ICategoryFilterProperty
Remarks
For more information, see Adding text filters 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 categoryFilterProperty = 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" },
NullOption = "nullOption",
SelectAllOptions = "selectAllOptions"
}
},
FilterId = "filterId",
// 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"
}
};
Synopsis
Constructors
CategoryFilterProperty() |
Properties
Column | The column that the filter is applied to. |
Configuration | The configuration for a |
DefaultFilterControlConfiguration | The default configurations for the associated controls. |
FilterId | An identifier that uniquely identifies a filter within a dashboard, analysis, or template. |
Constructors
CategoryFilterProperty()
public CategoryFilterProperty()
Properties
Column
The column that the filter is applied to.
public object Column { get; set; }
Property Value
System.Object
Remarks
Configuration
The configuration for a CategoryFilter
.
public object Configuration { 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.
FilterId
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
public string FilterId { get; set; }
Property Value
System.String