Class: AWSCDK::QuickSight::CfnTemplate::KPISparklineOptionsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTemplate::KPISparklineOptionsProperty

Defined in:

quick_sight/cfn_template.rb

Overview

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisparklineoptions.html

Instance Attribute Summary

• #color ⇒ String^? readonly

  The color of the sparkline.

• #tooltip_visibility ⇒ String^? readonly

  The tooltip visibility of the sparkline.

• #type ⇒ String readonly

  The type of the sparkline.

• #visibility ⇒ String^? readonly

  The visibility of the sparkline.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(type:, color: nil, tooltip_visibility: nil, visibility: nil) ⇒ KPISparklineOptionsProperty constructor

  A new instance of KPISparklineOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(type:, color: nil, tooltip_visibility: nil, visibility: nil) ⇒ KPISparklineOptionsProperty

Returns a new instance of KPISparklineOptionsProperty.

Parameters:

• type (String) —

  The type of the sparkline.

• color (String, nil) (defaults to: nil) —

  The color of the sparkline.

• tooltip_visibility (String, nil) (defaults to: nil) —

  The tooltip visibility of the sparkline.

• visibility (String, nil) (defaults to: nil) —

  The visibility of the sparkline.

# File 'quick_sight/cfn_template.rb', line 15306

def initialize(type:, color: nil, tooltip_visibility: nil, visibility: nil)
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @color = color
  Jsii::Type.check_type(@color, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "color") unless @color.nil?
  @tooltip_visibility = tooltip_visibility
  Jsii::Type.check_type(@tooltip_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tooltipVisibility") unless @tooltip_visibility.nil?
  @visibility = visibility
  Jsii::Type.check_type(@visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visibility") unless @visibility.nil?
end

Instance Attribute Details

#color ⇒ String^? (readonly)

The color of the sparkline.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisparklineoptions.html#cfn-quicksight-template-kpisparklineoptions-color

# File 'quick_sight/cfn_template.rb', line 15326

def color
  @color
end

#tooltip_visibility ⇒ String^? (readonly)

The tooltip visibility of the sparkline.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisparklineoptions.html#cfn-quicksight-template-kpisparklineoptions-tooltipvisibility

# File 'quick_sight/cfn_template.rb', line 15331

def tooltip_visibility
  @tooltip_visibility
end

#type ⇒ String (readonly)

The type of the sparkline.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisparklineoptions.html#cfn-quicksight-template-kpisparklineoptions-type

# File 'quick_sight/cfn_template.rb', line 15321

def type
  @type
end

#visibility ⇒ String^? (readonly)

The visibility of the sparkline.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisparklineoptions.html#cfn-quicksight-template-kpisparklineoptions-visibility

# File 'quick_sight/cfn_template.rb', line 15336

def visibility
  @visibility
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_template.rb', line 15338

def self.jsii_properties
  {
    :type => "type",
    :color => "color",
    :tooltip_visibility => "tooltipVisibility",
    :visibility => "visibility",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_template.rb', line 15347

def to_jsii
  result = {}
  result.merge!({
    "type" => @type,
    "color" => @color,
    "tooltipVisibility" => @tooltip_visibility,
    "visibility" => @visibility,
  })
  result.compact
end