Class CfnTemplate.EmptyVisualProperty
An empty visual.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EmptyVisualProperty : Object, CfnTemplate.IEmptyVisualProperty
Syntax (vb)
Public Class EmptyVisualProperty
Inherits Object
Implements CfnTemplate.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.
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
Empty |
Properties
Actions | The list of custom actions that are configured for a visual. |
Data |
The data set that is used in the empty visual. |
Visual |
The unique identifier of a visual. |
Constructors
EmptyVisualProperty()
public EmptyVisualProperty()
Properties
Actions
The list of custom actions that are configured for a visual.
public object Actions { get; set; }
Property Value
System.
Remarks
DataSetIdentifier
The data set that is used in the empty visual.
public string DataSetIdentifier { get; set; }
Property Value
System.
Remarks
Every visual requires a dataset to render.
VisualId
The unique identifier of a visual.
public string VisualId { get; set; }
Property Value
System.
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.