Class CfnDashboard.CustomContentVisualProperty

A visual that contains custom content.

Inheritance

object

CfnDashboard.CustomContentVisualProperty

Implements

CfnDashboard.ICustomContentVisualProperty

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 CfnDashboard.CustomContentVisualProperty : CfnDashboard.ICustomContentVisualProperty

Syntax (vb)

Public Class CfnDashboard.CustomContentVisualProperty Implements CfnDashboard.ICustomContentVisualProperty

Remarks

For more information, see Using custom visual content in the Amazon QuickSight User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentvisual.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 customContentVisualProperty = new CustomContentVisualProperty {
                 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"
                 } },
                 ChartConfiguration = new CustomContentConfigurationProperty {
                     ContentType = "contentType",
                     ContentUrl = "contentUrl",
                     ImageScaling = "imageScaling",
                     Interactions = new VisualInteractionOptionsProperty {
                         ContextMenuOption = new ContextMenuOptionProperty {
                             AvailabilityStatus = "availabilityStatus"
                         },
                         VisualMenuOption = new VisualMenuOptionProperty {
                             AvailabilityStatus = "availabilityStatus"
                         }
                     }
                 },
                 Subtitle = new VisualSubtitleLabelOptionsProperty {
                     FormatText = new LongFormatTextProperty {
                         PlainText = "plainText",
                         RichText = "richText"
                     },
                     Visibility = "visibility"
                 },
                 Title = new VisualTitleLabelOptionsProperty {
                     FormatText = new ShortFormatTextProperty {
                         PlainText = "plainText",
                         RichText = "richText"
                     },
                     Visibility = "visibility"
                 },
                 VisualContentAltText = "visualContentAltText"
             };

Synopsis

Constructors

CustomContentVisualProperty()

A visual that contains custom content.

Properties

Actions	The list of custom actions that are configured for a visual.
ChartConfiguration	The configuration of a CustomContentVisual .
DataSetIdentifier	The dataset that is used to create the custom content visual.
Subtitle	The subtitle that is displayed on the visual.
Title	The title that is displayed on the visual.
VisualContentAltText	The alt text for the visual.
VisualId	The unique identifier of a visual.

Constructors

CustomContentVisualProperty()

A visual that contains custom content.

public CustomContentVisualProperty()

Remarks

For more information, see Using custom visual content in the Amazon QuickSight User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentvisual.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 customContentVisualProperty = new CustomContentVisualProperty {
                 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"
                 } },
                 ChartConfiguration = new CustomContentConfigurationProperty {
                     ContentType = "contentType",
                     ContentUrl = "contentUrl",
                     ImageScaling = "imageScaling",
                     Interactions = new VisualInteractionOptionsProperty {
                         ContextMenuOption = new ContextMenuOptionProperty {
                             AvailabilityStatus = "availabilityStatus"
                         },
                         VisualMenuOption = new VisualMenuOptionProperty {
                             AvailabilityStatus = "availabilityStatus"
                         }
                     }
                 },
                 Subtitle = new VisualSubtitleLabelOptionsProperty {
                     FormatText = new LongFormatTextProperty {
                         PlainText = "plainText",
                         RichText = "richText"
                     },
                     Visibility = "visibility"
                 },
                 Title = new VisualTitleLabelOptionsProperty {
                     FormatText = new ShortFormatTextProperty {
                         PlainText = "plainText",
                         RichText = "richText"
                     },
                     Visibility = "visibility"
                 },
                 VisualContentAltText = "visualContentAltText"
             };

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-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-actions

ChartConfiguration

The configuration of a CustomContentVisual .

public object? ChartConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-chartconfiguration

DataSetIdentifier

The dataset that is used to create the custom content visual.

public string DataSetIdentifier { get; set; }

Property Value

string

Remarks

You can't create a visual without a dataset.

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

Subtitle

The subtitle that is displayed on the visual.

public object? Subtitle { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-subtitle

Title

The title that is displayed on the visual.

public object? Title { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-title

VisualContentAltText

The alt text for the visual.

public string? VisualContentAltText { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-visualcontentalttext

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-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-visualid

Implements

CfnDashboard.ICustomContentVisualProperty