Class CfnDashboardPropsMixin.FilterControlProperty
The control of a filter that is used to interact with a dashboard or an analysis.
Implements
Inherited Members
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.QuickSight
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnDashboardPropsMixin.FilterControlProperty : CfnDashboardPropsMixin.IFilterControlProperty
Syntax (vb)
Public Class CfnDashboardPropsMixin.FilterControlProperty Implements CfnDashboardPropsMixin.IFilterControlProperty
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.CfnPropertyMixins.AWS.QuickSight;
var filterControlProperty = new FilterControlProperty {
CrossSheet = new FilterCrossSheetControlProperty {
CascadingControlConfiguration = new CascadingControlConfigurationProperty {
SourceControls = new [] { new CascadingControlSourceProperty {
ColumnToMatch = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
SourceSheetControlId = "sourceSheetControlId"
} }
},
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId"
},
DateTimePicker = new FilterDateTimePickerControlProperty {
CommitMode = "commitMode",
DisplayOptions = new DateTimePickerControlDisplayOptionsProperty {
DateIconVisibility = "dateIconVisibility",
DateTimeFormat = "dateTimeFormat",
HelperTextVisibility = "helperTextVisibility",
InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
InfoIconText = "infoIconText",
Visibility = "visibility"
},
TitleOptions = new LabelOptionsProperty {
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId",
Title = "title",
Type = "type"
},
Dropdown = new FilterDropDownControlProperty {
CascadingControlConfiguration = new CascadingControlConfigurationProperty {
SourceControls = new [] { new CascadingControlSourceProperty {
ColumnToMatch = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
SourceSheetControlId = "sourceSheetControlId"
} }
},
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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
FilterControlId = "filterControlId",
SelectableValues = new FilterSelectableValuesProperty {
Values = new [] { "values" }
},
SourceFilterId = "sourceFilterId",
Title = "title",
Type = "type"
},
List = new FilterListControlProperty {
CascadingControlConfiguration = new CascadingControlConfigurationProperty {
SourceControls = new [] { new CascadingControlSourceProperty {
ColumnToMatch = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
SourceSheetControlId = "sourceSheetControlId"
} }
},
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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
FilterControlId = "filterControlId",
SelectableValues = new FilterSelectableValuesProperty {
Values = new [] { "values" }
},
SourceFilterId = "sourceFilterId",
Title = "title",
Type = "type"
},
RelativeDateTime = new FilterRelativeDateTimeControlProperty {
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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId",
Title = "title"
},
Slider = new FilterSliderControlProperty {
DisplayOptions = new SliderControlDisplayOptionsProperty {
InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
InfoIconText = "infoIconText",
Visibility = "visibility"
},
TitleOptions = new LabelOptionsProperty {
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
FilterControlId = "filterControlId",
MaximumValue = 123,
MinimumValue = 123,
SourceFilterId = "sourceFilterId",
StepSize = 123,
Title = "title",
Type = "type"
},
TextArea = new FilterTextAreaControlProperty {
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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId",
Title = "title"
},
TextField = new FilterTextFieldControlProperty {
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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId",
Title = "title"
}
};
Synopsis
Constructors
| FilterControlProperty() | The control of a filter that is used to interact with a dashboard or an analysis. |
Properties
| CrossSheet | A control from a filter that is scoped across more than one sheet. |
| DateTimePicker | A control from a date filter that is used to specify date and time. |
| Dropdown | A control to display a dropdown list with buttons that are used to select a single value. |
| List | A control to display a list of buttons or boxes. |
| RelativeDateTime | A control from a date filter that is used to specify the relative date. |
| Slider | A control to display a horizontal toggle bar. |
| TextArea | A control to display a text box that is used to enter multiple entries. |
| TextField | A control to display a text box that is used to enter a single entry. |
Constructors
FilterControlProperty()
The control of a filter that is used to interact with a dashboard or an analysis.
public FilterControlProperty()
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.CfnPropertyMixins.AWS.QuickSight;
var filterControlProperty = new FilterControlProperty {
CrossSheet = new FilterCrossSheetControlProperty {
CascadingControlConfiguration = new CascadingControlConfigurationProperty {
SourceControls = new [] { new CascadingControlSourceProperty {
ColumnToMatch = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
SourceSheetControlId = "sourceSheetControlId"
} }
},
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId"
},
DateTimePicker = new FilterDateTimePickerControlProperty {
CommitMode = "commitMode",
DisplayOptions = new DateTimePickerControlDisplayOptionsProperty {
DateIconVisibility = "dateIconVisibility",
DateTimeFormat = "dateTimeFormat",
HelperTextVisibility = "helperTextVisibility",
InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
InfoIconText = "infoIconText",
Visibility = "visibility"
},
TitleOptions = new LabelOptionsProperty {
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId",
Title = "title",
Type = "type"
},
Dropdown = new FilterDropDownControlProperty {
CascadingControlConfiguration = new CascadingControlConfigurationProperty {
SourceControls = new [] { new CascadingControlSourceProperty {
ColumnToMatch = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
SourceSheetControlId = "sourceSheetControlId"
} }
},
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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
FilterControlId = "filterControlId",
SelectableValues = new FilterSelectableValuesProperty {
Values = new [] { "values" }
},
SourceFilterId = "sourceFilterId",
Title = "title",
Type = "type"
},
List = new FilterListControlProperty {
CascadingControlConfiguration = new CascadingControlConfigurationProperty {
SourceControls = new [] { new CascadingControlSourceProperty {
ColumnToMatch = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
SourceSheetControlId = "sourceSheetControlId"
} }
},
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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
FilterControlId = "filterControlId",
SelectableValues = new FilterSelectableValuesProperty {
Values = new [] { "values" }
},
SourceFilterId = "sourceFilterId",
Title = "title",
Type = "type"
},
RelativeDateTime = new FilterRelativeDateTimeControlProperty {
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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId",
Title = "title"
},
Slider = new FilterSliderControlProperty {
DisplayOptions = new SliderControlDisplayOptionsProperty {
InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
InfoIconText = "infoIconText",
Visibility = "visibility"
},
TitleOptions = new LabelOptionsProperty {
CustomLabel = "customLabel",
FontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
FilterControlId = "filterControlId",
MaximumValue = 123,
MinimumValue = 123,
SourceFilterId = "sourceFilterId",
StepSize = 123,
Title = "title",
Type = "type"
},
TextArea = new FilterTextAreaControlProperty {
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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId",
Title = "title"
},
TextField = new FilterTextFieldControlProperty {
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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId",
Title = "title"
}
};
Properties
CrossSheet
A control from a filter that is scoped across more than one sheet.
public object? CrossSheet { get; set; }
Property Value
Remarks
This represents your filter control on a sheet
Type union: either IResolvable or CfnDashboardPropsMixin.IFilterCrossSheetControlProperty
DateTimePicker
A control from a date filter that is used to specify date and time.
public object? DateTimePicker { get; set; }
Property Value
Remarks
Dropdown
A control to display a dropdown list with buttons that are used to select a single value.
public object? Dropdown { get; set; }
Property Value
Remarks
List
A control to display a list of buttons or boxes.
public object? List { get; set; }
Property Value
Remarks
This is used to select either a single value or multiple values.
Type union: either IResolvable or CfnDashboardPropsMixin.IFilterListControlProperty
RelativeDateTime
A control from a date filter that is used to specify the relative date.
public object? RelativeDateTime { get; set; }
Property Value
Remarks
Slider
A control to display a horizontal toggle bar.
public object? Slider { get; set; }
Property Value
Remarks
This is used to change a value by sliding the toggle.
Type union: either IResolvable or CfnDashboardPropsMixin.IFilterSliderControlProperty
TextArea
A control to display a text box that is used to enter multiple entries.
public object? TextArea { get; set; }
Property Value
Remarks
TextField
A control to display a text box that is used to enter a single entry.
public object? TextField { get; set; }