Interface CfnTemplate.IFilterControlProperty
The control of a filter that is used to interact with a dashboard or an analysis.
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnTemplate.IFilterControlPropertySyntax (vb)
Public Interface CfnTemplate.IFilterControlPropertyRemarks
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 dateIconVisibility;
var helperTextVisibility;
var filterControlProperty = new FilterControlProperty {
CrossSheet = new FilterCrossSheetControlProperty {
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId",
// the properties below are optional
CascadingControlConfiguration = new CascadingControlConfigurationProperty {
SourceControls = new [] { new CascadingControlSourceProperty {
ColumnToMatch = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
SourceSheetControlId = "sourceSheetControlId"
} }
}
},
DateTimePicker = new FilterDateTimePickerControlProperty {
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId",
Title = "title",
// the properties below are optional
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"
}
},
Type = "type"
},
Dropdown = new FilterDropDownControlProperty {
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId",
Title = "title",
// the properties below are optional
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"
}
},
SelectableValues = new FilterSelectableValuesProperty {
Values = new [] { "values" }
},
Type = "type"
},
List = new FilterListControlProperty {
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId",
Title = "title",
// the properties below are optional
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"
}
},
SelectableValues = new FilterSelectableValuesProperty {
Values = new [] { "values" }
},
Type = "type"
},
RelativeDateTime = new FilterRelativeDateTimeControlProperty {
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId",
Title = "title",
// the properties below are optional
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"
}
}
},
Slider = new FilterSliderControlProperty {
FilterControlId = "filterControlId",
MaximumValue = 123,
MinimumValue = 123,
SourceFilterId = "sourceFilterId",
StepSize = 123,
Title = "title",
// 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",
FontFamily = "fontFamily",
FontSize = new FontSizeProperty {
Absolute = "absolute",
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Visibility = "visibility"
}
},
Type = "type"
},
TextArea = new FilterTextAreaControlProperty {
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId",
Title = "title",
// the properties below are optional
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"
}
}
},
TextField = new FilterTextFieldControlProperty {
FilterControlId = "filterControlId",
SourceFilterId = "sourceFilterId",
Title = "title",
// the properties below are optional
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"
}
}
}
};Synopsis
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. |
Properties
CrossSheet
A control from a filter that is scoped across more than one sheet.
object? CrossSheet { get; }Property Value
Remarks
This represents your filter control on a sheet
DateTimePicker
A control from a date filter that is used to specify date and time.
object? DateTimePicker { get; }Property Value
Remarks
Dropdown
A control to display a dropdown list with buttons that are used to select a single value.
object? Dropdown { get; }Property Value
Remarks
List
A control to display a list of buttons or boxes.
object? List { get; }Property Value
Remarks
This is used to select either a single value or multiple values.
RelativeDateTime
A control from a date filter that is used to specify the relative date.
object? RelativeDateTime { get; }Property Value
Remarks
Slider
A control to display a horizontal toggle bar.
object? Slider { get; }Property Value
Remarks
This is used to change a value by sliding the toggle.
TextArea
A control to display a text box that is used to enter multiple entries.
object? TextArea { get; }Property Value
Remarks
TextField
A control to display a text box that is used to enter a single entry.
object? TextField { get; }