interface EmptyVisualProperty

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

An empty visual.

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.

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 emptyVisualProperty: quicksight.CfnTemplate.EmptyVisualProperty = {
  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',
  }],
};

Properties

Name	Type	Description
dataSetIdentifier	string	The data set that is used in the empty visual.
visualId	string	The unique identifier of a visual.
actions?	IResolvable | IResolvable | VisualCustomActionProperty[]	The list of custom actions that are configured for a visual.

---

dataSetIdentifier

Type: string

The data set that is used in the empty visual.

Every visual requires a dataset to render.

---

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.