Class: Aws::QuickSight::Types::LegendOptions

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::LegendOptions

Includes:

Structure

Defined in:

lib/aws-sdk-quicksight/types.rb

Overview

The options for the legend setup of a visual.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #height ⇒ String

  The height of the legend.

• #position ⇒ String

  The positions for the legend.

• #title ⇒ Types::LabelOptions

  The custom title for the legend.

• #value_font_configuration ⇒ Types::FontConfiguration

  Configures the display properties of the given text.

• #visibility ⇒ String

  Determines whether or not the legend is visible.

• #width ⇒ String

  The width of the legend.

Instance Attribute Details

#height ⇒ String

The height of the legend. If this value is omitted, a default height is used when rendering.

Returns:

• (String)

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

class LegendOptions < Struct.new(
  :visibility,
  :title,
  :position,
  :width,
  :height,
  :value_font_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#position ⇒ String

The positions for the legend. Choose one of the following options:

• ‘AUTO`

• ‘RIGHT`

• ‘BOTTOM`

• ‘LEFT`

Returns:

• (String)

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

class LegendOptions < Struct.new(
  :visibility,
  :title,
  :position,
  :width,
  :height,
  :value_font_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ Types::LabelOptions

The custom title for the legend.

Returns:

• (Types::LabelOptions)

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

class LegendOptions < Struct.new(
  :visibility,
  :title,
  :position,
  :width,
  :height,
  :value_font_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#value_font_configuration ⇒ Types::FontConfiguration

Configures the display properties of the given text.

Returns:

• (Types::FontConfiguration)

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

class LegendOptions < Struct.new(
  :visibility,
  :title,
  :position,
  :width,
  :height,
  :value_font_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#visibility ⇒ String

Determines whether or not the legend is visible.

Returns:

• (String)

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

class LegendOptions < Struct.new(
  :visibility,
  :title,
  :position,
  :width,
  :height,
  :value_font_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#width ⇒ String

The width of the legend. If this value is omitted, a default width is used when rendering.

Returns:

• (String)

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

class LegendOptions < Struct.new(
  :visibility,
  :title,
  :position,
  :width,
  :height,
  :value_font_configuration)
  SENSITIVE = []
  include Aws::Structure
end