Class: Aws::QuickSight::Types::KPIVisual

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::KPIVisual

Includes:

Structure

Defined in:

lib/aws-sdk-quicksight/types.rb

Overview

A key performance indicator (KPI).

For more information, see [Using KPIs] in the *Amazon QuickSight User Guide*.

[1]: docs.aws.amazon.com/quicksight/latest/user/kpi.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #actions ⇒ Array<Types::VisualCustomAction>

  The list of custom actions that are configured for a visual.

• #chart_configuration ⇒ Types::KPIConfiguration

  The configuration of a KPI visual.

• #column_hierarchies ⇒ Array<Types::ColumnHierarchy>

  The column hierarchy that is used during drill-downs and drill-ups.

• #conditional_formatting ⇒ Types::KPIConditionalFormatting

  The conditional formatting of a KPI visual.

• #subtitle ⇒ Types::VisualSubtitleLabelOptions

  The subtitle that is displayed on the visual.

• #title ⇒ Types::VisualTitleLabelOptions

  The title that is displayed on the visual.

• #visual_content_alt_text ⇒ String

  The alt text for the visual.

• #visual_id ⇒ String

  The unique identifier of a visual.

Instance Attribute Details

#actions ⇒ Array<Types::VisualCustomAction>

The list of custom actions that are configured for a visual.

Returns:

• (Array<Types::VisualCustomAction>)

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

class KPIVisual < Struct.new(
  :visual_id,
  :title,
  :subtitle,
  :chart_configuration,
  :conditional_formatting,
  :actions,
  :column_hierarchies,
  :visual_content_alt_text)
  SENSITIVE = []
  include Aws::Structure
end

#chart_configuration ⇒ Types::KPIConfiguration

The configuration of a KPI visual.

Returns:

• (Types::KPIConfiguration)

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

class KPIVisual < Struct.new(
  :visual_id,
  :title,
  :subtitle,
  :chart_configuration,
  :conditional_formatting,
  :actions,
  :column_hierarchies,
  :visual_content_alt_text)
  SENSITIVE = []
  include Aws::Structure
end

#column_hierarchies ⇒ Array<Types::ColumnHierarchy>

The column hierarchy that is used during drill-downs and drill-ups.

Returns:

• (Array<Types::ColumnHierarchy>)

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

class KPIVisual < Struct.new(
  :visual_id,
  :title,
  :subtitle,
  :chart_configuration,
  :conditional_formatting,
  :actions,
  :column_hierarchies,
  :visual_content_alt_text)
  SENSITIVE = []
  include Aws::Structure
end

#conditional_formatting ⇒ Types::KPIConditionalFormatting

The conditional formatting of a KPI visual.

Returns:

• (Types::KPIConditionalFormatting)

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

class KPIVisual < Struct.new(
  :visual_id,
  :title,
  :subtitle,
  :chart_configuration,
  :conditional_formatting,
  :actions,
  :column_hierarchies,
  :visual_content_alt_text)
  SENSITIVE = []
  include Aws::Structure
end

#subtitle ⇒ Types::VisualSubtitleLabelOptions

The subtitle that is displayed on the visual.

Returns:

• (Types::VisualSubtitleLabelOptions)

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

class KPIVisual < Struct.new(
  :visual_id,
  :title,
  :subtitle,
  :chart_configuration,
  :conditional_formatting,
  :actions,
  :column_hierarchies,
  :visual_content_alt_text)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ Types::VisualTitleLabelOptions

The title that is displayed on the visual.

Returns:

• (Types::VisualTitleLabelOptions)

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

class KPIVisual < Struct.new(
  :visual_id,
  :title,
  :subtitle,
  :chart_configuration,
  :conditional_formatting,
  :actions,
  :column_hierarchies,
  :visual_content_alt_text)
  SENSITIVE = []
  include Aws::Structure
end

#visual_content_alt_text ⇒ String

The alt text for the visual.

Returns:

• (String)

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

class KPIVisual < Struct.new(
  :visual_id,
  :title,
  :subtitle,
  :chart_configuration,
  :conditional_formatting,
  :actions,
  :column_hierarchies,
  :visual_content_alt_text)
  SENSITIVE = []
  include Aws::Structure
end

#visual_id ⇒ String

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

Returns:

• (String)

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

class KPIVisual < Struct.new(
  :visual_id,
  :title,
  :subtitle,
  :chart_configuration,
  :conditional_formatting,
  :actions,
  :column_hierarchies,
  :visual_content_alt_text)
  SENSITIVE = []
  include Aws::Structure
end