Class CfnDashboard.ParameterControlProperty
The control of a parameter that users can interact with in a dashboard or an analysis.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ParameterControlProperty : Object, CfnDashboard.IParameterControlProperty
Syntax (vb)
Public Class ParameterControlProperty
Inherits Object
Implements CfnDashboard.IParameterControlProperty
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.AWS.QuickSight;
var parameterControlProperty = new ParameterControlProperty {
DateTimePicker = new ParameterDateTimePickerControlProperty {
ParameterControlId = "parameterControlId",
SourceParameterName = "sourceParameterName",
Title = "title",
// the properties below are optional
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"
}
}
},
Dropdown = new ParameterDropDownControlProperty {
ParameterControlId = "parameterControlId",
SourceParameterName = "sourceParameterName",
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 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 ParameterSelectableValuesProperty {
LinkToDataSetColumn = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
Values = new [] { "values" }
},
Type = "type"
},
List = new ParameterListControlProperty {
ParameterControlId = "parameterControlId",
SourceParameterName = "sourceParameterName",
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 ParameterSelectableValuesProperty {
LinkToDataSetColumn = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
Values = new [] { "values" }
},
Type = "type"
},
Slider = new ParameterSliderControlProperty {
MaximumValue = 123,
MinimumValue = 123,
ParameterControlId = "parameterControlId",
SourceParameterName = "sourceParameterName",
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"
}
}
},
TextArea = new ParameterTextAreaControlProperty {
ParameterControlId = "parameterControlId",
SourceParameterName = "sourceParameterName",
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 ParameterTextFieldControlProperty {
ParameterControlId = "parameterControlId",
SourceParameterName = "sourceParameterName",
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
Constructors
ParameterControlProperty() |
Properties
DateTimePicker | A control from a date parameter that specifies 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 with buttons or boxes that are used to select either a single value or multiple values. |
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
ParameterControlProperty()
public ParameterControlProperty()
Properties
DateTimePicker
A control from a date parameter that specifies date and time.
public object DateTimePicker { get; set; }
Property Value
System.Object
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
System.Object
Remarks
List
A control to display a list with buttons or boxes that are used to select either a single value or multiple values.
public object List { get; set; }
Property Value
System.Object
Remarks
Slider
A control to display a horizontal toggle bar.
public object Slider { get; set; }
Property Value
System.Object
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.
public object TextArea { get; set; }
Property Value
System.Object
Remarks
TextField
A control to display a text box that is used to enter a single entry.
public object TextField { get; set; }
Property Value
System.Object