TooltipSheetDefinition
A tooltip sheet is an object that contains a set of visuals that are used as a tooltip. Every analysis and dashboard must contain at least one non-tooltip sheet.
Contents
Note
In the following list, the required parameters are described first.
- SheetId
-
The unique identifier of a tooltip sheet.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+Required: Yes
- Images
-
A list of images on a tooltip sheet.
Type: Array of SheetImage objects
Array Members: Maximum number of 5 items.
Required: No
- Layouts
-
Layouts define how the components of a tooltip sheet are arranged.
For more information, see Types of layout in the Amazon Quick Suite User Guide.
Type: Array of Layout objects
Array Members: Fixed number of 1 item.
Required: No
- Name
-
The name of the tooltip sheet. This name is displayed on the sheet's tab in the Quick console.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- TextBoxes
-
The text boxes that are on a tooltip sheet.
Type: Array of SheetTextBox objects
Array Members: Maximum number of 5 items.
Required: No
- Visuals
-
A list of the visuals that are on a tooltip sheet.
Type: Array of Visual objects
Array Members: Maximum number of 5 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
