Class: AWSCDK::QuickSight::CfnTemplate::FunnelChartDataLabelOptionsProperty

Inherits:

Jsii::Struct

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

Defined in:

quick_sight/cfn_template.rb

Overview

The options that determine the presentation of the data labels.

See Also:

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

Instance Attribute Summary

• #category_label_visibility ⇒ String^? readonly

  The visibility of the category labels within the data labels.

• #label_color ⇒ String^? readonly

  The color of the data label text.

• #label_font_configuration ⇒ AWSCDK::IResolvable, ... readonly

  The font configuration for the data labels.

• #measure_data_label_style ⇒ String^? readonly

  Determines the style of the metric labels.

• #measure_label_visibility ⇒ String^? readonly

  The visibility of the measure labels within the data labels.

• #position ⇒ String^? readonly

  Determines the positioning of the data label relative to a section of the funnel.

• #visibility ⇒ String^? readonly

  The visibility option that determines if data labels are displayed.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(category_label_visibility: nil, label_color: nil, label_font_configuration: nil, measure_data_label_style: nil, measure_label_visibility: nil, position: nil, visibility: nil) ⇒ FunnelChartDataLabelOptionsProperty constructor

  A new instance of FunnelChartDataLabelOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(category_label_visibility: nil, label_color: nil, label_font_configuration: nil, measure_data_label_style: nil, measure_label_visibility: nil, position: nil, visibility: nil) ⇒ FunnelChartDataLabelOptionsProperty

Returns a new instance of FunnelChartDataLabelOptionsProperty.

Parameters:

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

  The visibility of the category labels within the data labels.

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

  The color of the data label text.

• label_font_configuration (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::FontConfigurationProperty, nil) (defaults to: nil) —

  The font configuration for the data labels.

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

  Determines the style of the metric labels.

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

  The visibility of the measure labels within the data labels.

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

  Determines the positioning of the data label relative to a section of the funnel.

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

  The visibility option that determines if data labels are displayed.

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

def initialize(category_label_visibility: nil, label_color: nil, label_font_configuration: nil, measure_data_label_style: nil, measure_label_visibility: nil, position: nil, visibility: nil)
  @category_label_visibility = category_label_visibility
  Jsii::Type.check_type(@category_label_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "categoryLabelVisibility") unless @category_label_visibility.nil?
  @label_color = label_color
  Jsii::Type.check_type(@label_color, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "labelColor") unless @label_color.nil?
  @label_font_configuration = label_font_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FontConfigurationProperty.new(**label_font_configuration.transform_keys(&:to_sym)) : label_font_configuration
  Jsii::Type.check_type(@label_font_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZvbnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "labelFontConfiguration") unless @label_font_configuration.nil?
  @measure_data_label_style = measure_data_label_style
  Jsii::Type.check_type(@measure_data_label_style, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "measureDataLabelStyle") unless @measure_data_label_style.nil?
  @measure_label_visibility = measure_label_visibility
  Jsii::Type.check_type(@measure_label_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "measureLabelVisibility") unless @measure_label_visibility.nil?
  @position = position
  Jsii::Type.check_type(@position, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "position") unless @position.nil?
  @visibility = visibility
  Jsii::Type.check_type(@visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visibility") unless @visibility.nil?
end

Instance Attribute Details

#category_label_visibility ⇒ String^? (readonly)

The visibility of the category labels within the data labels.

Returns:

• (String, nil)

See Also:

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

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

def category_label_visibility
  @category_label_visibility
end

#label_color ⇒ String^? (readonly)

The color of the data label text.

Returns:

• (String, nil)

See Also:

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

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

def label_color
  @label_color
end

#label_font_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The font configuration for the data labels.

Only the FontSize attribute of the font configuration is used for data labels.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::FontConfigurationProperty, nil)

See Also:

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

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

def label_font_configuration
  @label_font_configuration
end

#measure_data_label_style ⇒ String^? (readonly)

Determines the style of the metric labels.

Returns:

• (String, nil)

See Also:

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

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

def measure_data_label_style
  @measure_data_label_style
end

#measure_label_visibility ⇒ String^? (readonly)

The visibility of the measure labels within the data labels.

Returns:

• (String, nil)

See Also:

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

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

def measure_label_visibility
  @measure_label_visibility
end

#position ⇒ String^? (readonly)

Determines the positioning of the data label relative to a section of the funnel.

Returns:

• (String, nil)

See Also:

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

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

def position
  @position
end

#visibility ⇒ String^? (readonly)

The visibility option that determines if data labels are displayed.

Returns:

• (String, nil)

See Also:

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

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

def visibility
  @visibility
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :category_label_visibility => "categoryLabelVisibility",
    :label_color => "labelColor",
    :label_font_configuration => "labelFontConfiguration",
    :measure_data_label_style => "measureDataLabelStyle",
    :measure_label_visibility => "measureLabelVisibility",
    :position => "position",
    :visibility => "visibility",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "categoryLabelVisibility" => @category_label_visibility,
    "labelColor" => @label_color,
    "labelFontConfiguration" => @label_font_configuration,
    "measureDataLabelStyle" => @measure_data_label_style,
    "measureLabelVisibility" => @measure_label_visibility,
    "position" => @position,
    "visibility" => @visibility,
  })
  result.compact
end