interface SheetProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.QuickSight.CfnDashboard.SheetProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_SheetProperty |
![]() | software.amazon.awscdk.services.quicksight.CfnDashboard.SheetProperty |
![]() | aws_cdk.aws_quicksight.CfnDashboard.SheetProperty |
![]() | aws-cdk-lib » aws_quicksight » CfnDashboard » SheetProperty |
A sheet , which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight.
Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.
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 sheetProperty: quicksight.CfnDashboard.SheetProperty = {
images: [{
sheetImageId: 'sheetImageId',
source: {
sheetImageStaticFileSource: {
staticFileId: 'staticFileId',
},
},
// the properties below are optional
actions: [{
actionOperations: [{
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',
}],
imageContentAltText: 'imageContentAltText',
interactions: {
imageMenuOption: {
availabilityStatus: 'availabilityStatus',
},
},
scaling: {
scalingType: 'scalingType',
},
tooltip: {
tooltipText: {
plainText: 'plainText',
},
visibility: 'visibility',
},
}],
name: 'name',
sheetId: 'sheetId',
};
Properties
Name | Type | Description |
---|---|---|
images? | IResolvable | IResolvable | Sheet [] | A list of images on a sheet. |
name? | string | The name of a sheet. |
sheet | string | The unique identifier associated with a sheet. |
images?
Type:
IResolvable
|
IResolvable
|
Sheet
[]
(optional)
A list of images on a sheet.
name?
Type:
string
(optional)
The name of a sheet.
This name is displayed on the sheet's tab in the Amazon QuickSight console.
sheetId?
Type:
string
(optional)
The unique identifier associated with a sheet.