Class: AWSCDK::QuickSight::CfnAnalysis::DataLabelOptionsProperty

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, data_label_types: nil, label_color: nil, label_content: nil, label_font_configuration: nil, measure_label_visibility: nil, overlap: nil, position: nil, totals_visibility: nil, visibility: nil) ⇒ DataLabelOptionsProperty

Returns a new instance of DataLabelOptionsProperty.

Parameters:

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

    Determines the visibility of the category field labels.

  • data_label_types (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnAnalysis::DataLabelTypeProperty>, nil) (defaults to: nil) —

    The option that determines the data label type.

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

    Determines the color of the data labels.

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

    Determines the content of the data labels.

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

    Determines the font configuration of the data labels.

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

    Determines the visibility of the measure field labels.

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

    Determines whether overlap is enabled or disabled for the data labels.

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

    Determines the position of the data labels.

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

    Determines the visibility of the total.

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

    Determines the visibility of the data labels.



6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
 
# File 'quick_sight/cfn_analysis.rb', line 6347

def initialize(category_label_visibility: nil, data_label_types: nil, label_color: nil, label_content: nil, label_font_configuration: nil, measure_label_visibility: nil, overlap: nil, position: nil, totals_visibility: 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?
  @data_label_types = data_label_types
  Jsii::Type.check_type(@data_label_types, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5EYXRhTGFiZWxUeXBlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "dataLabelTypes") unless @data_label_types.nil?
  @label_color = label_color
  Jsii::Type.check_type(@label_color, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "labelColor") unless @label_color.nil?
  @label_content = label_content
  Jsii::Type.check_type(@label_content, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "labelContent") unless @label_content.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_label_visibility = measure_label_visibility
  Jsii::Type.check_type(@measure_label_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "measureLabelVisibility") unless @measure_label_visibility.nil?
  @overlap = overlap
  Jsii::Type.check_type(@overlap, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "overlap") unless @overlap.nil?
  @position = position
  Jsii::Type.check_type(@position, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "position") unless @position.nil?
  @totals_visibility = totals_visibility
  Jsii::Type.check_type(@totals_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "totalsVisibility") unless @totals_visibility.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)

Determines the visibility of the category field labels.

Returns:

  • (String, nil)

See Also:



6374
6375
6376
 
# File 'quick_sight/cfn_analysis.rb', line 6374

def category_label_visibility
  @category_label_visibility
end

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

The option that determines the data label type.

Returns:

See Also:



6379
6380
6381
 
# File 'quick_sight/cfn_analysis.rb', line 6379

def data_label_types
  @data_label_types
end

#label_color ⇒ String? (readonly)

Determines the color of the data labels.

Returns:

  • (String, nil)

See Also:



6384
6385
6386
 
# File 'quick_sight/cfn_analysis.rb', line 6384

def label_color
  @label_color
end

#label_content ⇒ String? (readonly)

Determines the content of the data labels.

Returns:

  • (String, nil)

See Also:



6389
6390
6391
 
# File 'quick_sight/cfn_analysis.rb', line 6389

def label_content
  @label_content
end

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

Determines the font configuration of the data labels.

Returns:

See Also:



6394
6395
6396
 
# File 'quick_sight/cfn_analysis.rb', line 6394

def label_font_configuration
  @label_font_configuration
end

#measure_label_visibility ⇒ String? (readonly)

Determines the visibility of the measure field labels.

Returns:

  • (String, nil)

See Also:



6399
6400
6401
 
# File 'quick_sight/cfn_analysis.rb', line 6399

def measure_label_visibility
  @measure_label_visibility
end

#overlap ⇒ String? (readonly)

Determines whether overlap is enabled or disabled for the data labels.

Returns:

  • (String, nil)

See Also:



6404
6405
6406
 
# File 'quick_sight/cfn_analysis.rb', line 6404

def overlap
  @overlap
end

#position ⇒ String? (readonly)

Determines the position of the data labels.

Returns:

  • (String, nil)

See Also:



6409
6410
6411
 
# File 'quick_sight/cfn_analysis.rb', line 6409

def position
  @position
end

#totals_visibility ⇒ String? (readonly)

Determines the visibility of the total.

Returns:

  • (String, nil)

See Also:



6414
6415
6416
 
# File 'quick_sight/cfn_analysis.rb', line 6414

def totals_visibility
  @totals_visibility
end

#visibility ⇒ String? (readonly)

Determines the visibility of the data labels.

Returns:

  • (String, nil)

See Also:



6419
6420
6421
 
# File 'quick_sight/cfn_analysis.rb', line 6419

def visibility
  @visibility
end

Class Method Details

.jsii_properties ⇒ Object 



6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
 
# File 'quick_sight/cfn_analysis.rb', line 6421

def self.jsii_properties
  {
    :category_label_visibility => "categoryLabelVisibility",
    :data_label_types => "dataLabelTypes",
    :label_color => "labelColor",
    :label_content => "labelContent",
    :label_font_configuration => "labelFontConfiguration",
    :measure_label_visibility => "measureLabelVisibility",
    :overlap => "overlap",
    :position => "position",
    :totals_visibility => "totalsVisibility",
    :visibility => "visibility",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
 
# File 'quick_sight/cfn_analysis.rb', line 6436

def to_jsii
  result = {}
  result.merge!({
    "categoryLabelVisibility" => @category_label_visibility,
    "dataLabelTypes" => @data_label_types,
    "labelColor" => @label_color,
    "labelContent" => @label_content,
    "labelFontConfiguration" => @label_font_configuration,
    "measureLabelVisibility" => @measure_label_visibility,
    "overlap" => @overlap,
    "position" => @position,
    "totalsVisibility" => @totals_visibility,
    "visibility" => @visibility,
  })
  result.compact
end