Skip to content
v2.273.0

EmptyVisualProperty Struct ​

An empty visual.

Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Quick Sight console is considered an EmptyVisual until a visual type is selected.

Example ​

ts
// 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 emptyVisualProperty: quicksight.CfnTemplate.EmptyVisualProperty = {
  visualId: 'visualId',

  // the properties below are optional
  actions: [{
    actionOperations: [{
      filterOperation: {
        selectedFieldsConfiguration: {
          selectedColumns: [{
            columnName: 'columnName',

            // the properties below are optional
            dataSetIdentifier: 'dataSetIdentifier',
            topicIdentifier: 'topicIdentifier',
          }],
          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',

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

    // the properties below are optional
    status: 'status',
  }],
  dataSetIdentifier: 'dataSetIdentifier',
  topicIdentifier: 'topicIdentifier',
};

Properties ​

actionsIResolvable | IResolvable | CfnTemplate.VisualCustomActionProperty[]actionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, VisualCustomActionProperty]]]actionsIResolvableActionsIResolvableActionsinterface{}#
The list of custom actions that are configured for a visual.
dataSetIdentifierstringdata_set_identifierstrdataSetIdentifierStringDataSetIdentifierstringDataSetIdentifier*string= ""#
The data set that is used in the empty visual.

Every visual requires a dataset to render.

topicIdentifierstringtopic_identifierstrtopicIdentifierStringTopicIdentifierstringTopicIdentifier*string#
visualIdstringvisual_idstrvisualIdStringVisualIdstringVisualId*stringrequired#
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.