Class: AWSCDK::QuickSight::CfnTemplate::AxisLabelOptionsProperty

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

Overview

The label options for a chart axis.

You must specify the field that the label is targeted to.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(apply_to: nil, custom_label: nil, font_configuration: nil) ⇒ AxisLabelOptionsProperty

Returns a new instance of AxisLabelOptionsProperty.

Parameters:



1384
1385
1386
1387
1388
1389
1390
1391
 
# File 'quick_sight/cfn_template.rb', line 1384

def initialize(apply_to: nil, custom_label: nil, font_configuration: nil)
  @apply_to = apply_to.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::AxisLabelReferenceOptionsProperty.new(**apply_to.transform_keys(&:to_sym)) : apply_to
  Jsii::Type.check_type(@apply_to, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkF4aXNMYWJlbFJlZmVyZW5jZU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "applyTo") unless @apply_to.nil?
  @custom_label = custom_label
  Jsii::Type.check_type(@custom_label, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customLabel") unless @custom_label.nil?
  @font_configuration = font_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FontConfigurationProperty.new(**font_configuration.transform_keys(&:to_sym)) : font_configuration
  Jsii::Type.check_type(@font_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZvbnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "fontConfiguration") unless @font_configuration.nil?
end

Instance Attribute Details

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

The options that indicate which field the label belongs to.

Returns:

See Also:



1397
1398
1399
 
# File 'quick_sight/cfn_template.rb', line 1397

def apply_to
  @apply_to
end

#custom_label ⇒ String? (readonly)

The text for the axis label.

Returns:

  • (String, nil)

See Also:



1402
1403
1404
 
# File 'quick_sight/cfn_template.rb', line 1402

def custom_label
  @custom_label
end

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

The font configuration of the axis label.

Returns:

See Also:



1407
1408
1409
 
# File 'quick_sight/cfn_template.rb', line 1407

def font_configuration
  @font_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



1409
1410
1411
1412
1413
1414
1415
 
# File 'quick_sight/cfn_template.rb', line 1409

def self.jsii_properties
  {
    :apply_to => "applyTo",
    :custom_label => "customLabel",
    :font_configuration => "fontConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1417
1418
1419
1420
1421
1422
1423
1424
1425
 
# File 'quick_sight/cfn_template.rb', line 1417

def to_jsii
  result = {}
  result.merge!({
    "applyTo" => @apply_to,
    "customLabel" => @custom_label,
    "fontConfiguration" => @font_configuration,
  })
  result.compact
end