Class: Aws::QuickSight::Types::SheetDefinition

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::SheetDefinition

Includes:

Structure

Defined in:

lib/aws-sdk-quicksight/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #content_type ⇒ String

  The layout content type of the sheet.

• #custom_action_defaults ⇒ Types::VisualCustomActionDefaults

  A list of visual custom actions for the sheet.

• #description ⇒ String

  A description of the sheet.

• #filter_controls ⇒ Array<Types::FilterControl>

  The list of filter controls that are on a sheet.

• #images ⇒ Array<Types::SheetImage>

  A list of images on a sheet.

• #layouts ⇒ Array<Types::Layout>

  Layouts define how the components of a sheet are arranged.

• #name ⇒ String

  The name of the sheet.

• #parameter_controls ⇒ Array<Types::ParameterControl>

  The list of parameter controls that are on a sheet.

• #sheet_control_layouts ⇒ Array<Types::SheetControlLayout>

  The control layouts of the sheet.

• #sheet_id ⇒ String

  The unique identifier of a sheet.

• #text_boxes ⇒ Array<Types::SheetTextBox>

  The text boxes that are on a sheet.

• #title ⇒ String

  The title of the sheet.

• #visuals ⇒ Array<Types::Visual>

  A list of the visuals that are on a sheet.

Instance Attribute Details

#content_type ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 35665

class SheetDefinition < Struct.new(
  :sheet_id,
  :title,
  :description,
  :name,
  :parameter_controls,
  :filter_controls,
  :visuals,
  :text_boxes,
  :images,
  :layouts,
  :sheet_control_layouts,
  :content_type,
  :custom_action_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#custom_action_defaults ⇒ Types::VisualCustomActionDefaults

A list of visual custom actions for the sheet.

Returns:

• (Types::VisualCustomActionDefaults)

# File 'lib/aws-sdk-quicksight/types.rb', line 35665

class SheetDefinition < Struct.new(
  :sheet_id,
  :title,
  :description,
  :name,
  :parameter_controls,
  :filter_controls,
  :visuals,
  :text_boxes,
  :images,
  :layouts,
  :sheet_control_layouts,
  :content_type,
  :custom_action_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the sheet.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 35665

class SheetDefinition < Struct.new(
  :sheet_id,
  :title,
  :description,
  :name,
  :parameter_controls,
  :filter_controls,
  :visuals,
  :text_boxes,
  :images,
  :layouts,
  :sheet_control_layouts,
  :content_type,
  :custom_action_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#filter_controls ⇒ Array<Types::FilterControl>

The list of filter controls that are on a sheet.

For more information, see [Adding filter controls to analysis sheets] in the *Amazon Quick Suite User Guide*.

[1]: docs.aws.amazon.com/quicksight/latest/user/filter-controls.html

Returns:

• (Array<Types::FilterControl>)

# File 'lib/aws-sdk-quicksight/types.rb', line 35665

class SheetDefinition < Struct.new(
  :sheet_id,
  :title,
  :description,
  :name,
  :parameter_controls,
  :filter_controls,
  :visuals,
  :text_boxes,
  :images,
  :layouts,
  :sheet_control_layouts,
  :content_type,
  :custom_action_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#images ⇒ Array<Types::SheetImage>

A list of images on a sheet.

Returns:

• (Array<Types::SheetImage>)

# File 'lib/aws-sdk-quicksight/types.rb', line 35665

class SheetDefinition < Struct.new(
  :sheet_id,
  :title,
  :description,
  :name,
  :parameter_controls,
  :filter_controls,
  :visuals,
  :text_boxes,
  :images,
  :layouts,
  :sheet_control_layouts,
  :content_type,
  :custom_action_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#layouts ⇒ Array<Types::Layout>

Layouts define how the components of a sheet are arranged.

For more information, see [Types of layout] in the *Amazon Quick Suite User Guide*.

[1]: docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html

Returns:

• (Array<Types::Layout>)

# File 'lib/aws-sdk-quicksight/types.rb', line 35665

class SheetDefinition < Struct.new(
  :sheet_id,
  :title,
  :description,
  :name,
  :parameter_controls,
  :filter_controls,
  :visuals,
  :text_boxes,
  :images,
  :layouts,
  :sheet_control_layouts,
  :content_type,
  :custom_action_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the sheet. This name is displayed on the sheet’s tab in the Quick console.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 35665

class SheetDefinition < Struct.new(
  :sheet_id,
  :title,
  :description,
  :name,
  :parameter_controls,
  :filter_controls,
  :visuals,
  :text_boxes,
  :images,
  :layouts,
  :sheet_control_layouts,
  :content_type,
  :custom_action_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_controls ⇒ Array<Types::ParameterControl>

The list of parameter controls that are on a sheet.

For more information, see [Using a Control with a Parameter in Amazon Quick Sight] in the *Amazon Quick Suite User Guide*.

[1]: docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html

Returns:

• (Array<Types::ParameterControl>)

# File 'lib/aws-sdk-quicksight/types.rb', line 35665

class SheetDefinition < Struct.new(
  :sheet_id,
  :title,
  :description,
  :name,
  :parameter_controls,
  :filter_controls,
  :visuals,
  :text_boxes,
  :images,
  :layouts,
  :sheet_control_layouts,
  :content_type,
  :custom_action_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#sheet_control_layouts ⇒ Array<Types::SheetControlLayout>

The control layouts of the sheet.

Returns:

• (Array<Types::SheetControlLayout>)

# File 'lib/aws-sdk-quicksight/types.rb', line 35665

class SheetDefinition < Struct.new(
  :sheet_id,
  :title,
  :description,
  :name,
  :parameter_controls,
  :filter_controls,
  :visuals,
  :text_boxes,
  :images,
  :layouts,
  :sheet_control_layouts,
  :content_type,
  :custom_action_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#sheet_id ⇒ String

The unique identifier of a sheet.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 35665

class SheetDefinition < Struct.new(
  :sheet_id,
  :title,
  :description,
  :name,
  :parameter_controls,
  :filter_controls,
  :visuals,
  :text_boxes,
  :images,
  :layouts,
  :sheet_control_layouts,
  :content_type,
  :custom_action_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#text_boxes ⇒ Array<Types::SheetTextBox>

The text boxes that are on a sheet.

Returns:

• (Array<Types::SheetTextBox>)

# File 'lib/aws-sdk-quicksight/types.rb', line 35665

class SheetDefinition < Struct.new(
  :sheet_id,
  :title,
  :description,
  :name,
  :parameter_controls,
  :filter_controls,
  :visuals,
  :text_boxes,
  :images,
  :layouts,
  :sheet_control_layouts,
  :content_type,
  :custom_action_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of the sheet.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 35665

class SheetDefinition < Struct.new(
  :sheet_id,
  :title,
  :description,
  :name,
  :parameter_controls,
  :filter_controls,
  :visuals,
  :text_boxes,
  :images,
  :layouts,
  :sheet_control_layouts,
  :content_type,
  :custom_action_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#visuals ⇒ Array<Types::Visual>

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

Returns:

• (Array<Types::Visual>)

# File 'lib/aws-sdk-quicksight/types.rb', line 35665

class SheetDefinition < Struct.new(
  :sheet_id,
  :title,
  :description,
  :name,
  :parameter_controls,
  :filter_controls,
  :visuals,
  :text_boxes,
  :images,
  :layouts,
  :sheet_control_layouts,
  :content_type,
  :custom_action_defaults)
  SENSITIVE = []
  include Aws::Structure
end