Class: AWSCDK::QuickSight::CfnTemplate::FieldSeriesItemProperty

Inherits:

Jsii::Struct

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

Defined in:

quick_sight/cfn_template.rb

Overview

The field series item configuration of a line chart.

See Also:

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

Instance Attribute Summary

• #axis_binding ⇒ String readonly

  The axis that you are binding the field to.

• #field_id ⇒ String readonly

  The field ID of the field for which you are setting the axis binding.

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

  The options that determine the presentation of line series associated to the field.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(axis_binding:, field_id:, settings: nil) ⇒ FieldSeriesItemProperty constructor

  A new instance of FieldSeriesItemProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(axis_binding:, field_id:, settings: nil) ⇒ FieldSeriesItemProperty

Returns a new instance of FieldSeriesItemProperty.

Parameters:

• axis_binding (String) —

  The axis that you are binding the field to.

• field_id (String) —

  The field ID of the field for which you are setting the axis binding.

• settings (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::LineChartSeriesSettingsProperty, nil) (defaults to: nil) —

  The options that determine the presentation of line series associated to the field.

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

def initialize(axis_binding:, field_id:, settings: nil)
  @axis_binding = axis_binding
  Jsii::Type.check_type(@axis_binding, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "axisBinding")
  @field_id = field_id
  Jsii::Type.check_type(@field_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fieldId")
  @settings = settings.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::LineChartSeriesSettingsProperty.new(**settings.transform_keys(&:to_sym)) : settings
  Jsii::Type.check_type(@settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkxpbmVDaGFydFNlcmllc1NldHRpbmdzUHJvcGVydHkifV19fQ==")), "settings") unless @settings.nil?
end

Instance Attribute Details

#axis_binding ⇒ String (readonly)

The axis that you are binding the field to.

Returns:

• (String)

See Also:

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

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

def axis_binding
  @axis_binding
end

#field_id ⇒ String (readonly)

The field ID of the field for which you are setting the axis binding.

Returns:

• (String)

See Also:

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

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

def field_id
  @field_id
end

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

The options that determine the presentation of line series associated to the field.

Returns:

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

See Also:

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

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

def settings
  @settings
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :axis_binding => "axisBinding",
    :field_id => "fieldId",
    :settings => "settings",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "axisBinding" => @axis_binding,
    "fieldId" => @field_id,
    "settings" => @settings,
  })
  result.compact
end