SheetDefinition

import type { SheetDefinition } from "https://aws-api.deno.dev/v0.4/services/quicksight.ts?docs=full";

A sheet is an object that contains a set of visuals that are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.

interface SheetDefinition {

ContentType?: SheetContentType | null;

Description?: string | null;

FilterControls?: FilterControl[] | null;

Layouts?: Layout[] | null;

Name?: string | null;

ParameterControls?: ParameterControl[] | null;

SheetControlLayouts?: SheetControlLayout[] | null;

SheetId: string;

TextBoxes?: SheetTextBox[] | null;

Title?: string | null;

Visuals?: Visual[] | null;

}

§Properties

ContentType?: SheetContentType | null

[src]

The layout content type of the sheet. Choose one of the following options:

PAGINATED: Creates a sheet for a paginated report.
INTERACTIVE: Creates a sheet for an interactive dashboard.

Description?: string | null

[src]

A description of the sheet.

FilterControls?: FilterControl[] | null

[src]

The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.

Layouts?: Layout[] | null

[src]

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon QuickSight User Guide.

Name?: string | null

[src]

The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.

ParameterControls?: ParameterControl[] | null

[src]

The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.

SheetControlLayouts?: SheetControlLayout[] | null

[src]

The control layouts of the sheet.

SheetId: string

[src]

The unique identifier of a sheet.

TextBoxes?: SheetTextBox[] | null

[src]

The text boxes that are on a sheet.

Title?: string | null

[src]

The title of the sheet.

Visuals?: Visual[] | null

[src]

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.