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 IFilterControlProperty

Syntax (vb)

Public Interface IFilterControlProperty

Remarks

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html

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 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 {
            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"
    },
    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",
                    FontSize = new FontSizeProperty {
                        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",
                    FontSize = new FontSizeProperty {
                        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",
                    FontSize = new FontSizeProperty {
                        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",
                    FontSize = new FontSizeProperty {
                        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",
                    FontSize = new FontSizeProperty {
                        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",
                    FontSize = new FontSizeProperty {
                        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.

virtual object CrossSheet { get; }

Property Value

System.Object

Remarks

This represents your filter control on a sheet

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-crosssheet

DateTimePicker

A control from a date filter that is used to specify date and time.

virtual object DateTimePicker { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-datetimepicker

Dropdown

A control to display a dropdown list with buttons that are used to select a single value.

virtual object Dropdown { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-dropdown

List

A control to display a list of buttons or boxes.

virtual object List { get; }

Property Value

System.Object

Remarks

This is used to select either a single value or multiple values.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-list

RelativeDateTime

A control from a date filter that is used to specify the relative date.

virtual object RelativeDateTime { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-relativedatetime

Slider

A control to display a horizontal toggle bar.

virtual object Slider { get; }

Property Value

System.Object

Remarks

This is used to change a value by sliding the toggle.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-slider

TextArea

A control to display a text box that is used to enter multiple entries.

virtual object TextArea { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-textarea

TextField

A control to display a text box that is used to enter a single entry.

virtual object TextField { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-textfield