interface CustomContentVisualProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnAnalysis.CustomContentVisualProperty
Java	software.amazon.awscdk.services.quicksight.CfnAnalysis.CustomContentVisualProperty
Python	aws_cdk.aws_quicksight.CfnAnalysis.CustomContentVisualProperty
TypeScript	@aws-cdk/aws-quicksight » CfnAnalysis » CustomContentVisualProperty

A visual that contains custom content.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const customContentVisualProperty: quicksight.CfnAnalysis.CustomContentVisualProperty = {
  dataSetIdentifier: 'dataSetIdentifier',
  visualId: 'visualId',

  // the properties below are optional
  actions: [{
    actionOperations: [{
      filterOperation: {
        selectedFieldsConfiguration: {
          selectedFieldOptions: 'selectedFieldOptions',
          selectedFields: ['selectedFields'],
        },
        targetVisualsConfiguration: {
          sameSheetTargetVisualConfiguration: {
            targetVisualOptions: 'targetVisualOptions',
            targetVisuals: ['targetVisuals'],
          },
        },
      },
      navigationOperation: {
        localNavigationConfiguration: {
          targetSheetId: 'targetSheetId',
        },
      },
      setParametersOperation: {
        parameterValueConfigurations: [{
          destinationParameterName: 'destinationParameterName',
          value: {
            customValuesConfiguration: {
              customValues: {
                dateTimeValues: ['dateTimeValues'],
                decimalValues: [123],
                integerValues: [123],
                stringValues: ['stringValues'],
              },

              // the properties below are optional
              includeNullValue: false,
            },
            selectAllValueOptions: 'selectAllValueOptions',
            sourceField: 'sourceField',
            sourceParameterName: 'sourceParameterName',
          },
        }],
      },
      urlOperation: {
        urlTarget: 'urlTarget',
        urlTemplate: 'urlTemplate',
      },
    }],
    customActionId: 'customActionId',
    name: 'name',
    trigger: 'trigger',

    // the properties below are optional
    status: 'status',
  }],
  chartConfiguration: {
    contentType: 'contentType',
    contentUrl: 'contentUrl',
    imageScaling: 'imageScaling',
  },
  subtitle: {
    formatText: {
      plainText: 'plainText',
      richText: 'richText',
    },
    visibility: 'visibility',
  },
  title: {
    formatText: {
      plainText: 'plainText',
      richText: 'richText',
    },
    visibility: 'visibility',
  },
};

Properties

Name	Type	Description
dataSetIdentifier	string	The dataset that is used to create the custom content visual.
visualId	string	The unique identifier of a visual.
actions?	IResolvable | IResolvable | VisualCustomActionProperty[]	The list of custom actions that are configured for a visual.
chartConfiguration?	IResolvable | CustomContentConfigurationProperty	The configuration of a CustomContentVisual .
subtitle?	IResolvable | VisualSubtitleLabelOptionsProperty	The subtitle that is displayed on the visual.
title?	IResolvable | VisualTitleLabelOptionsProperty	The title that is displayed on the visual.

---

dataSetIdentifier

Type: string

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

You can't create a visual without a dataset.

---

visualId

Type: string

The unique identifier of a visual.

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.

---

actions?

Type: IResolvable | IResolvable | VisualCustomActionProperty[] (optional)

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

---

chartConfiguration?

Type: IResolvable | CustomContentConfigurationProperty (optional)

The configuration of a CustomContentVisual .

---

subtitle?

Type: IResolvable | VisualSubtitleLabelOptionsProperty (optional)

The subtitle that is displayed on the visual.

---

title?

Type: IResolvable | VisualTitleLabelOptionsProperty (optional)

The title that is displayed on the visual.