Class: AWSCDK::QuickSight::CfnTemplate::PanelConfigurationProperty

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

Overview

A collection of options that configure how each panel displays in a small multiples chart.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(background_color: nil, background_visibility: nil, border_color: nil, border_style: nil, border_thickness: nil, border_visibility: nil, gutter_spacing: nil, gutter_visibility: nil, title: nil) ⇒ PanelConfigurationProperty

Returns a new instance of PanelConfigurationProperty.

Parameters:

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

    Sets the background color for each panel.

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

    Determines whether or not a background for each small multiples panel is rendered.

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

    Sets the line color of panel borders.

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

    Sets the line style of panel borders.

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

    Sets the line thickness of panel borders.

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

    Determines whether or not each panel displays a border.

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

    Sets the total amount of negative space to display between sibling panels.

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

    Determines whether or not negative space between sibling panels is rendered.

  • title (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::PanelTitleOptionsProperty, nil) (defaults to: nil) —

    Configures the title display within each small multiples panel.



18126
18127
18128
18129
18130
18131
18132
18133
18134
18135
18136
18137
18138
18139
18140
18141
18142
18143
18144
18145
 
# File 'quick_sight/cfn_template.rb', line 18126

def initialize(background_color: nil, background_visibility: nil, border_color: nil, border_style: nil, border_thickness: nil, border_visibility: nil, gutter_spacing: nil, gutter_visibility: nil, title: nil)
  @background_color = background_color
  Jsii::Type.check_type(@background_color, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "backgroundColor") unless @background_color.nil?
  @background_visibility = background_visibility
  Jsii::Type.check_type(@background_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "backgroundVisibility") unless @background_visibility.nil?
  @border_color = border_color
  Jsii::Type.check_type(@border_color, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "borderColor") unless @border_color.nil?
  @border_style = border_style
  Jsii::Type.check_type(@border_style, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "borderStyle") unless @border_style.nil?
  @border_thickness = border_thickness
  Jsii::Type.check_type(@border_thickness, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "borderThickness") unless @border_thickness.nil?
  @border_visibility = border_visibility
  Jsii::Type.check_type(@border_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "borderVisibility") unless @border_visibility.nil?
  @gutter_spacing = gutter_spacing
  Jsii::Type.check_type(@gutter_spacing, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gutterSpacing") unless @gutter_spacing.nil?
  @gutter_visibility = gutter_visibility
  Jsii::Type.check_type(@gutter_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gutterVisibility") unless @gutter_visibility.nil?
  @title = title.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::PanelTitleOptionsProperty.new(**title.transform_keys(&:to_sym)) : title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlBhbmVsVGl0bGVPcHRpb25zUHJvcGVydHkifV19fQ==")), "title") unless @title.nil?
end

Instance Attribute Details

#background_color ⇒ String? (readonly)

Sets the background color for each panel.

Returns:

  • (String, nil)

See Also:



18151
18152
18153
 
# File 'quick_sight/cfn_template.rb', line 18151

def background_color
  @background_color
end

#background_visibility ⇒ String? (readonly)

Determines whether or not a background for each small multiples panel is rendered.

Returns:

  • (String, nil)

See Also:



18156
18157
18158
 
# File 'quick_sight/cfn_template.rb', line 18156

def background_visibility
  @background_visibility
end

#border_color ⇒ String? (readonly)

Sets the line color of panel borders.

Returns:

  • (String, nil)

See Also:



18161
18162
18163
 
# File 'quick_sight/cfn_template.rb', line 18161

def border_color
  @border_color
end

#border_style ⇒ String? (readonly)

Sets the line style of panel borders.

Returns:

  • (String, nil)

See Also:



18166
18167
18168
 
# File 'quick_sight/cfn_template.rb', line 18166

def border_style
  @border_style
end

#border_thickness ⇒ String? (readonly)

Sets the line thickness of panel borders.

Returns:

  • (String, nil)

See Also:



18171
18172
18173
 
# File 'quick_sight/cfn_template.rb', line 18171

def border_thickness
  @border_thickness
end

#border_visibility ⇒ String? (readonly)

Determines whether or not each panel displays a border.

Returns:

  • (String, nil)

See Also:



18176
18177
18178
 
# File 'quick_sight/cfn_template.rb', line 18176

def border_visibility
  @border_visibility
end

#gutter_spacing ⇒ String? (readonly)

Sets the total amount of negative space to display between sibling panels.

Returns:

  • (String, nil)

See Also:



18181
18182
18183
 
# File 'quick_sight/cfn_template.rb', line 18181

def gutter_spacing
  @gutter_spacing
end

#gutter_visibility ⇒ String? (readonly)

Determines whether or not negative space between sibling panels is rendered.

Returns:

  • (String, nil)

See Also:



18186
18187
18188
 
# File 'quick_sight/cfn_template.rb', line 18186

def gutter_visibility
  @gutter_visibility
end

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

Configures the title display within each small multiples panel.

Returns:

See Also:



18191
18192
18193
 
# File 'quick_sight/cfn_template.rb', line 18191

def title
  @title
end

Class Method Details

.jsii_properties ⇒ Object 



18193
18194
18195
18196
18197
18198
18199
18200
18201
18202
18203
18204
18205
 
# File 'quick_sight/cfn_template.rb', line 18193

def self.jsii_properties
  {
    :background_color => "backgroundColor",
    :background_visibility => "backgroundVisibility",
    :border_color => "borderColor",
    :border_style => "borderStyle",
    :border_thickness => "borderThickness",
    :border_visibility => "borderVisibility",
    :gutter_spacing => "gutterSpacing",
    :gutter_visibility => "gutterVisibility",
    :title => "title",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



18207
18208
18209
18210
18211
18212
18213
18214
18215
18216
18217
18218
18219
18220
18221
 
# File 'quick_sight/cfn_template.rb', line 18207

def to_jsii
  result = {}
  result.merge!({
    "backgroundColor" => @background_color,
    "backgroundVisibility" => @background_visibility,
    "borderColor" => @border_color,
    "borderStyle" => @border_style,
    "borderThickness" => @border_thickness,
    "borderVisibility" => @border_visibility,
    "gutterSpacing" => @gutter_spacing,
    "gutterVisibility" => @gutter_visibility,
    "title" => @title,
  })
  result.compact
end