Class: AWSCDK::QuickSight::CfnTemplate::SmallMultiplesOptionsProperty

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

Overview

Options that determine the layout and display options of a chart's small multiples.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(max_visible_columns: nil, max_visible_rows: nil, panel_configuration: nil, x_axis: nil, y_axis: nil) ⇒ SmallMultiplesOptionsProperty

Returns a new instance of SmallMultiplesOptionsProperty.

Parameters:



25062
25063
25064
25065
25066
25067
25068
25069
25070
25071
25072
25073
 
# File 'quick_sight/cfn_template.rb', line 25062

def initialize(max_visible_columns: nil, max_visible_rows: nil, panel_configuration: nil, x_axis: nil, y_axis: nil)
  @max_visible_columns = max_visible_columns
  Jsii::Type.check_type(@max_visible_columns, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxVisibleColumns") unless @max_visible_columns.nil?
  @max_visible_rows = max_visible_rows
  Jsii::Type.check_type(@max_visible_rows, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxVisibleRows") unless @max_visible_rows.nil?
  @panel_configuration = panel_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::PanelConfigurationProperty.new(**panel_configuration.transform_keys(&:to_sym)) : panel_configuration
  Jsii::Type.check_type(@panel_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlBhbmVsQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "panelConfiguration") unless @panel_configuration.nil?
  @x_axis = x_axis.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::SmallMultiplesAxisPropertiesProperty.new(**x_axis.transform_keys(&:to_sym)) : x_axis
  Jsii::Type.check_type(@x_axis, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlNtYWxsTXVsdGlwbGVzQXhpc1Byb3BlcnRpZXNQcm9wZXJ0eSJ9XX19")), "xAxis") unless @x_axis.nil?
  @y_axis = y_axis.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::SmallMultiplesAxisPropertiesProperty.new(**y_axis.transform_keys(&:to_sym)) : y_axis
  Jsii::Type.check_type(@y_axis, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlNtYWxsTXVsdGlwbGVzQXhpc1Byb3BlcnRpZXNQcm9wZXJ0eSJ9XX19")), "yAxis") unless @y_axis.nil?
end

Instance Attribute Details

#max_visible_columns ⇒ Numeric? (readonly)

Sets the maximum number of visible columns to display in the grid of small multiples panels.

The default is Auto , which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

Returns:

  • (Numeric, nil)

See Also:



25081
25082
25083
 
# File 'quick_sight/cfn_template.rb', line 25081

def max_visible_columns
  @max_visible_columns
end

#max_visible_rows ⇒ Numeric? (readonly)

Sets the maximum number of visible rows to display in the grid of small multiples panels.

The default value is Auto , which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.

Returns:

  • (Numeric, nil)

See Also:



25088
25089
25090
 
# File 'quick_sight/cfn_template.rb', line 25088

def max_visible_rows
  @max_visible_rows
end

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

Configures the display options for each small multiples panel.

Returns:

See Also:



25093
25094
25095
 
# File 'quick_sight/cfn_template.rb', line 25093

def panel_configuration
  @panel_configuration
end

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

The properties of a small multiples X axis.

Returns:

See Also:



25098
25099
25100
 
# File 'quick_sight/cfn_template.rb', line 25098

def x_axis
  @x_axis
end

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

The properties of a small multiples Y axis.

Returns:

See Also:



25103
25104
25105
 
# File 'quick_sight/cfn_template.rb', line 25103

def y_axis
  @y_axis
end

Class Method Details

.jsii_properties ⇒ Object 



25105
25106
25107
25108
25109
25110
25111
25112
25113
 
# File 'quick_sight/cfn_template.rb', line 25105

def self.jsii_properties
  {
    :max_visible_columns => "maxVisibleColumns",
    :max_visible_rows => "maxVisibleRows",
    :panel_configuration => "panelConfiguration",
    :x_axis => "xAxis",
    :y_axis => "yAxis",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



25115
25116
25117
25118
25119
25120
25121
25122
25123
25124
25125
 
# File 'quick_sight/cfn_template.rb', line 25115

def to_jsii
  result = {}
  result.merge!({
    "maxVisibleColumns" => @max_visible_columns,
    "maxVisibleRows" => @max_visible_rows,
    "panelConfiguration" => @panel_configuration,
    "xAxis" => @x_axis,
    "yAxis" => @y_axis,
  })
  result.compact
end