Class CfnAnalysis.SheetImageProperty

An image that is located on a sheet.

Inheritance

object

CfnAnalysis.SheetImageProperty

Implements

CfnAnalysis.ISheetImageProperty

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.SheetImageProperty : CfnAnalysis.ISheetImageProperty

Syntax (vb)

Public Class CfnAnalysis.SheetImageProperty Implements CfnAnalysis.ISheetImageProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimage.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 sheetImageProperty = new SheetImageProperty {
                 SheetImageId = "sheetImageId",
                 Source = new SheetImageSourceProperty {
                     SheetImageStaticFileSource = new SheetImageStaticFileSourceProperty {
                         StaticFileId = "staticFileId"
                     }
                 },

                 // the properties below are optional
                 Actions = new [] { new ImageCustomActionProperty {
                     ActionOperations = new [] { new ImageCustomActionOperationProperty {
                         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"
                 } },
                 ImageContentAltText = "imageContentAltText",
                 Interactions = new ImageInteractionOptionsProperty {
                     ImageMenuOption = new ImageMenuOptionProperty {
                         AvailabilityStatus = "availabilityStatus"
                     }
                 },
                 Scaling = new SheetImageScalingConfigurationProperty {
                     ScalingType = "scalingType"
                 },
                 Tooltip = new SheetImageTooltipConfigurationProperty {
                     TooltipText = new SheetImageTooltipTextProperty {
                         PlainText = "plainText"
                     },
                     Visibility = "visibility"
                 }
             };

Synopsis

Constructors

SheetImageProperty()

An image that is located on a sheet.

Properties

Actions	A list of custom actions that are configured for an image.
ImageContentAltText	The alt text for the image.
Interactions	The general image interactions setup for an image.
Scaling	Determines how the image is scaled.
SheetImageId	The ID of the sheet image.
Source	The source of the image.
Tooltip	The tooltip to be shown when hovering over the image.

Constructors

SheetImageProperty()

An image that is located on a sheet.

public SheetImageProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetimage.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 sheetImageProperty = new SheetImageProperty {
                 SheetImageId = "sheetImageId",
                 Source = new SheetImageSourceProperty {
                     SheetImageStaticFileSource = new SheetImageStaticFileSourceProperty {
                         StaticFileId = "staticFileId"
                     }
                 },

                 // the properties below are optional
                 Actions = new [] { new ImageCustomActionProperty {
                     ActionOperations = new [] { new ImageCustomActionOperationProperty {
                         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"
                 } },
                 ImageContentAltText = "imageContentAltText",
                 Interactions = new ImageInteractionOptionsProperty {
                     ImageMenuOption = new ImageMenuOptionProperty {
                         AvailabilityStatus = "availabilityStatus"
                     }
                 },
                 Scaling = new SheetImageScalingConfigurationProperty {
                     ScalingType = "scalingType"
                 },
                 Tooltip = new SheetImageTooltipConfigurationProperty {
                     TooltipText = new SheetImageTooltipTextProperty {
                         PlainText = "plainText"
                     },
                     Visibility = "visibility"
                 }
             };

Properties

Actions

A list of custom actions that are configured for an image.

public object? Actions { get; set; }

Property Value

object

Remarks

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

ImageContentAltText

The alt text for the image.

public string? ImageContentAltText { get; set; }

Property Value

string

Remarks

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

Interactions

The general image interactions setup for an image.

public object? Interactions { get; set; }

Property Value

object

Remarks

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

Scaling

Determines how the image is scaled.

public object? Scaling { get; set; }

Property Value

object

Remarks

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

SheetImageId

The ID of the sheet image.

public string SheetImageId { get; set; }

Property Value

string

Remarks

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

Source

The source of the image.

public object Source { get; set; }

Property Value

object

Remarks

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

Tooltip

The tooltip to be shown when hovering over the image.

public object? Tooltip { get; set; }

Property Value

object

Remarks

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

Implements

CfnAnalysis.ISheetImageProperty