Class: AWSCDK::QuickSight::CfnTemplate::DataFieldSeriesItemProperty

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

Overview

The data field series item configuration of a line chart.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(axis_binding:, field_id:, field_value: nil, settings: nil) ⇒ DataFieldSeriesItemProperty

Returns a new instance of DataFieldSeriesItemProperty.

Parameters:

  • axis_binding (String) —

    The axis that you are binding the field to.

  • field_id (String) —

    The field ID of the field that you are setting the axis binding to.

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

    The field value of the field that you are setting the axis binding to.

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

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



6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
 
# File 'quick_sight/cfn_template.rb', line 6129

def initialize(axis_binding:, field_id:, field_value: nil, 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")
  @field_value = field_value
  Jsii::Type.check_type(@field_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fieldValue") unless @field_value.nil?
  @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:



6144
6145
6146
 
# File 'quick_sight/cfn_template.rb', line 6144

def axis_binding
  @axis_binding
end

#field_id ⇒ String (readonly)

The field ID of the field that you are setting the axis binding to.

Returns:

  • (String)

See Also:



6149
6150
6151
 
# File 'quick_sight/cfn_template.rb', line 6149

def field_id
  @field_id
end

#field_value ⇒ String? (readonly)

The field value of the field that you are setting the axis binding to.

Returns:

  • (String, nil)

See Also:



6154
6155
6156
 
# File 'quick_sight/cfn_template.rb', line 6154

def field_value
  @field_value
end

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

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

Returns:

See Also:



6159
6160
6161
 
# File 'quick_sight/cfn_template.rb', line 6159

def settings
  @settings
end

Class Method Details

.jsii_properties ⇒ Object 



6161
6162
6163
6164
6165
6166
6167
6168
 
# File 'quick_sight/cfn_template.rb', line 6161

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

Instance Method Details

#to_jsii ⇒ Object 



6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
 
# File 'quick_sight/cfn_template.rb', line 6170

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