Class: AWSCDK::QuickSight::CfnDashboard::AxisLabelOptionsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_dashboard.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:



1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'quick_sight/cfn_dashboard.rb', line 1528

def initialize(apply_to: nil, custom_label: nil, font_configuration: nil)
  @apply_to = apply_to.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::AxisLabelReferenceOptionsProperty.new(**apply_to.transform_keys(&:to_sym)) : apply_to
  Jsii::Type.check_type(@apply_to, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5BeGlzTGFiZWxSZWZlcmVuY2VPcHRpb25zUHJvcGVydHkifV19fQ==")), "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::CfnDashboard::FontConfigurationProperty.new(**font_configuration.transform_keys(&:to_sym)) : font_configuration
  Jsii::Type.check_type(@font_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Gb250Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "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:



1541
1542
1543
 
# File 'quick_sight/cfn_dashboard.rb', line 1541

def apply_to
  @apply_to
end

#custom_label ⇒ String? (readonly)

The text for the axis label.

Returns:

  • (String, nil)

See Also:



1546
1547
1548
 
# File 'quick_sight/cfn_dashboard.rb', line 1546

def custom_label
  @custom_label
end

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

The font configuration of the axis label.

Returns:

See Also:



1551
1552
1553
 
# File 'quick_sight/cfn_dashboard.rb', line 1551

def font_configuration
  @font_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



1553
1554
1555
1556
1557
1558
1559
 
# File 'quick_sight/cfn_dashboard.rb', line 1553

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

Instance Method Details

#to_jsii ⇒ Object 



1561
1562
1563
1564
1565
1566
1567
1568
1569
 
# File 'quick_sight/cfn_dashboard.rb', line 1561

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