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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#content_typeString

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)


25488
25489
25490
25491
25492
25493
25494
25495
25496
25497
25498
25499
25500
25501
25502
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 25488

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

#descriptionString

A description of the sheet.

Returns:

  • (String)


25488
25489
25490
25491
25492
25493
25494
25495
25496
25497
25498
25499
25500
25501
25502
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 25488

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

#filter_controlsArray<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 QuickSight User Guide.

Returns:



25488
25489
25490
25491
25492
25493
25494
25495
25496
25497
25498
25499
25500
25501
25502
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 25488

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

#layoutsArray<Types::Layout>

Layouts define how the components of a sheet are arranged.

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

Returns:



25488
25489
25490
25491
25492
25493
25494
25495
25496
25497
25498
25499
25500
25501
25502
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 25488

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

#nameString

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

Returns:

  • (String)


25488
25489
25490
25491
25492
25493
25494
25495
25496
25497
25498
25499
25500
25501
25502
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 25488

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

#parameter_controlsArray<Types::ParameterControl>

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.

Returns:



25488
25489
25490
25491
25492
25493
25494
25495
25496
25497
25498
25499
25500
25501
25502
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 25488

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

#sheet_control_layoutsArray<Types::SheetControlLayout>

The control layouts of the sheet.

Returns:



25488
25489
25490
25491
25492
25493
25494
25495
25496
25497
25498
25499
25500
25501
25502
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 25488

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

#sheet_idString

The unique identifier of a sheet.

Returns:

  • (String)


25488
25489
25490
25491
25492
25493
25494
25495
25496
25497
25498
25499
25500
25501
25502
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 25488

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

#text_boxesArray<Types::SheetTextBox>

The text boxes that are on a sheet.

Returns:



25488
25489
25490
25491
25492
25493
25494
25495
25496
25497
25498
25499
25500
25501
25502
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 25488

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

#titleString

The title of the sheet.

Returns:

  • (String)


25488
25489
25490
25491
25492
25493
25494
25495
25496
25497
25498
25499
25500
25501
25502
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 25488

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

#visualsArray<Types::Visual>

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

Returns:



25488
25489
25490
25491
25492
25493
25494
25495
25496
25497
25498
25499
25500
25501
25502
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 25488

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