Class CfnAnalysis.EmptyVisualProperty

An empty visual.

Inheritance

object

CfnAnalysis.EmptyVisualProperty

Implements

CfnAnalysis.IEmptyVisualProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.QuickSight

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAnalysis.EmptyVisualProperty : CfnAnalysis.IEmptyVisualProperty

Syntax (vb)

Public Class CfnAnalysis.EmptyVisualProperty Implements CfnAnalysis.IEmptyVisualProperty

Remarks

Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Amazon QuickSight console is considered an EmptyVisual until a visual type is selected.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-emptyvisual.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 emptyVisualProperty = new EmptyVisualProperty {
                 DataSetIdentifier = "dataSetIdentifier",
                 VisualId = "visualId",

                 // the properties below are optional
                 Actions = new [] { new VisualCustomActionProperty {
                     ActionOperations = new [] { new VisualCustomActionOperationProperty {
                         FilterOperation = new CustomActionFilterOperationProperty {
                             SelectedFieldsConfiguration = new FilterOperationSelectedFieldsConfigurationProperty {
                                 SelectedColumns = new [] { new ColumnIdentifierProperty {
                                     ColumnName = "columnName",
                                     DataSetIdentifier = "dataSetIdentifier"
                                 } },
                                 SelectedFieldOptions = "selectedFieldOptions",
                                 SelectedFields = new [] { "selectedFields" }
                             },
                             TargetVisualsConfiguration = new FilterOperationTargetVisualsConfigurationProperty {
                                 SameSheetTargetVisualConfiguration = new SameSheetTargetVisualConfigurationProperty {
                                     TargetVisualOptions = "targetVisualOptions",
                                     TargetVisuals = new [] { "targetVisuals" }
                                 }
                             }
                         },
                         NavigationOperation = new CustomActionNavigationOperationProperty {
                             LocalNavigationConfiguration = new LocalNavigationConfigurationProperty {
                                 TargetSheetId = "targetSheetId"
                             }
                         },
                         SetParametersOperation = new CustomActionSetParametersOperationProperty {
                             ParameterValueConfigurations = new [] { new SetParameterValueConfigurationProperty {
                                 DestinationParameterName = "destinationParameterName",
                                 Value = new DestinationParameterValueConfigurationProperty {
                                     CustomValuesConfiguration = new CustomValuesConfigurationProperty {
                                         CustomValues = new CustomParameterValuesProperty {
                                             DateTimeValues = new [] { "dateTimeValues" },
                                             DecimalValues = new [] { 123 },
                                             IntegerValues = new [] { 123 },
                                             StringValues = new [] { "stringValues" }
                                         },

                                         // the properties below are optional
                                         IncludeNullValue = false
                                     },
                                     SelectAllValueOptions = "selectAllValueOptions",
                                     SourceColumn = new ColumnIdentifierProperty {
                                         ColumnName = "columnName",
                                         DataSetIdentifier = "dataSetIdentifier"
                                     },
                                     SourceField = "sourceField",
                                     SourceParameterName = "sourceParameterName"
                                 }
                             } }
                         },
                         UrlOperation = new CustomActionURLOperationProperty {
                             UrlTarget = "urlTarget",
                             UrlTemplate = "urlTemplate"
                         }
                     } },
                     CustomActionId = "customActionId",
                     Name = "name",
                     Trigger = "trigger",

                     // the properties below are optional
                     Status = "status"
                 } }
             };

Synopsis

Constructors

EmptyVisualProperty()

An empty visual.

Properties

Actions	The list of custom actions that are configured for a visual.
DataSetIdentifier	The data set that is used in the empty visual.
VisualId	The unique identifier of a visual.

Constructors

EmptyVisualProperty()

An empty visual.

public EmptyVisualProperty()

Remarks

Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Amazon QuickSight console is considered an EmptyVisual until a visual type is selected.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-emptyvisual.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 emptyVisualProperty = new EmptyVisualProperty {
                 DataSetIdentifier = "dataSetIdentifier",
                 VisualId = "visualId",

                 // the properties below are optional
                 Actions = new [] { new VisualCustomActionProperty {
                     ActionOperations = new [] { new VisualCustomActionOperationProperty {
                         FilterOperation = new CustomActionFilterOperationProperty {
                             SelectedFieldsConfiguration = new FilterOperationSelectedFieldsConfigurationProperty {
                                 SelectedColumns = new [] { new ColumnIdentifierProperty {
                                     ColumnName = "columnName",
                                     DataSetIdentifier = "dataSetIdentifier"
                                 } },
                                 SelectedFieldOptions = "selectedFieldOptions",
                                 SelectedFields = new [] { "selectedFields" }
                             },
                             TargetVisualsConfiguration = new FilterOperationTargetVisualsConfigurationProperty {
                                 SameSheetTargetVisualConfiguration = new SameSheetTargetVisualConfigurationProperty {
                                     TargetVisualOptions = "targetVisualOptions",
                                     TargetVisuals = new [] { "targetVisuals" }
                                 }
                             }
                         },
                         NavigationOperation = new CustomActionNavigationOperationProperty {
                             LocalNavigationConfiguration = new LocalNavigationConfigurationProperty {
                                 TargetSheetId = "targetSheetId"
                             }
                         },
                         SetParametersOperation = new CustomActionSetParametersOperationProperty {
                             ParameterValueConfigurations = new [] { new SetParameterValueConfigurationProperty {
                                 DestinationParameterName = "destinationParameterName",
                                 Value = new DestinationParameterValueConfigurationProperty {
                                     CustomValuesConfiguration = new CustomValuesConfigurationProperty {
                                         CustomValues = new CustomParameterValuesProperty {
                                             DateTimeValues = new [] { "dateTimeValues" },
                                             DecimalValues = new [] { 123 },
                                             IntegerValues = new [] { 123 },
                                             StringValues = new [] { "stringValues" }
                                         },

                                         // the properties below are optional
                                         IncludeNullValue = false
                                     },
                                     SelectAllValueOptions = "selectAllValueOptions",
                                     SourceColumn = new ColumnIdentifierProperty {
                                         ColumnName = "columnName",
                                         DataSetIdentifier = "dataSetIdentifier"
                                     },
                                     SourceField = "sourceField",
                                     SourceParameterName = "sourceParameterName"
                                 }
                             } }
                         },
                         UrlOperation = new CustomActionURLOperationProperty {
                             UrlTarget = "urlTarget",
                             UrlTemplate = "urlTemplate"
                         }
                     } },
                     CustomActionId = "customActionId",
                     Name = "name",
                     Trigger = "trigger",

                     // the properties below are optional
                     Status = "status"
                 } }
             };

Properties

Actions

The list of custom actions that are configured for a visual.

public object? Actions { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-emptyvisual.html#cfn-quicksight-analysis-emptyvisual-actions

DataSetIdentifier

The data set that is used in the empty visual.

public string DataSetIdentifier { get; set; }

Property Value

string

Remarks

Every visual requires a dataset to render.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-emptyvisual.html#cfn-quicksight-analysis-emptyvisual-datasetidentifier

VisualId

The unique identifier of a visual.

public string VisualId { get; set; }

Property Value

string

Remarks

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-emptyvisual.html#cfn-quicksight-analysis-emptyvisual-visualid

Implements

CfnAnalysis.IEmptyVisualProperty