Class: AWSCDK::QuickSight::CfnAnalysis::FunnelChartDataLabelOptionsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_analysis.rb

Overview

The options that determine the presentation of the data labels.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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::CfnAnalysis::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.



11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
 
# File 'quick_sight/cfn_analysis.rb', line 11891

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::CfnAnalysis::FontConfigurationProperty.new(**label_font_configuration.transform_keys(&:to_sym)) : label_font_configuration
  Jsii::Type.check_type(@label_font_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkZvbnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "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:



11912
11913
11914
 
# File 'quick_sight/cfn_analysis.rb', line 11912

def category_label_visibility
  @category_label_visibility
end

#label_color ⇒ String? (readonly)

The color of the data label text.

Returns:

  • (String, nil)

See Also:



11917
11918
11919
 
# File 'quick_sight/cfn_analysis.rb', line 11917

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:

See Also:



11924
11925
11926
 
# File 'quick_sight/cfn_analysis.rb', line 11924

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:



11929
11930
11931
 
# File 'quick_sight/cfn_analysis.rb', line 11929

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:



11934
11935
11936
 
# File 'quick_sight/cfn_analysis.rb', line 11934

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:



11939
11940
11941
 
# File 'quick_sight/cfn_analysis.rb', line 11939

def position
  @position
end

#visibility ⇒ String? (readonly)

The visibility option that determines if data labels are displayed.

Returns:

  • (String, nil)

See Also:



11944
11945
11946
 
# File 'quick_sight/cfn_analysis.rb', line 11944

def visibility
  @visibility
end

Class Method Details

.jsii_properties ⇒ Object 



11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
 
# File 'quick_sight/cfn_analysis.rb', line 11946

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 



11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
 
# File 'quick_sight/cfn_analysis.rb', line 11958

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