interface CustomContentVisualProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnTemplate.CustomContentVisualProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_CustomContentVisualProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnTemplate.CustomContentVisualProperty`
Python	`aws_cdk.aws_quicksight.CfnTemplate.CustomContentVisualProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnTemplate` » `CustomContentVisualProperty`

A visual that contains custom content.

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

Example

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

  // the properties below are optional
  actions: [{
    actionOperations: [{
      filterOperation: {
        selectedFieldsConfiguration: {
          selectedColumns: [{
            columnName: 'columnName',
            dataSetIdentifier: 'dataSetIdentifier',
          }],
          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',
            sourceColumn: {
              columnName: 'columnName',
              dataSetIdentifier: 'dataSetIdentifier',
            },
            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',
    interactions: {
      contextMenuOption: {
        availabilityStatus: 'availabilityStatus',
      },
      visualMenuOption: {
        availabilityStatus: 'availabilityStatus',
      },
    },
  },
  subtitle: {
    formatText: {
      plainText: 'plainText',
      richText: 'richText',
    },
    visibility: 'visibility',
  },
  title: {
    formatText: {
      plainText: 'plainText',
      richText: 'richText',
    },
    visibility: 'visibility',
  },
  visualContentAltText: 'visualContentAltText',
};

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.
visualContentAltText?	`string`	The alt text for 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.

visualContentAltText?

Type: string (optional)

The alt text for the visual.