Class: AWSCDK::QuickSight::CfnTopic::ComparativeOrderProperty

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

Overview

The order in which data is displayed for the column when it's used in a comparative context.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(specifed_order: nil, treat_undefined_specified_values: nil, use_ordering: nil) ⇒ ComparativeOrderProperty

Returns a new instance of ComparativeOrderProperty.

Parameters:

  • specifed_order (Array<String>, nil) (defaults to: nil)

    The list of columns to be used in the ordering.

  • treat_undefined_specified_values (String, nil) (defaults to: nil)

    The treat of undefined specified values.

  • use_ordering (String, nil) (defaults to: nil)

    The ordering type for a column.



708
709
710
711
712
713
714
715
# File 'quick_sight/cfn_topic.rb', line 708

def initialize(specifed_order: nil, treat_undefined_specified_values: nil, use_ordering: nil)
  @specifed_order = specifed_order
  Jsii::Type.check_type(@specifed_order, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "specifedOrder") unless @specifed_order.nil?
  @treat_undefined_specified_values = treat_undefined_specified_values
  Jsii::Type.check_type(@treat_undefined_specified_values, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "treatUndefinedSpecifiedValues") unless @treat_undefined_specified_values.nil?
  @use_ordering = use_ordering
  Jsii::Type.check_type(@use_ordering, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "useOrdering") unless @use_ordering.nil?
end

Instance Attribute Details

#specifed_orderArray<String>? (readonly)

The list of columns to be used in the ordering.



721
722
723
# File 'quick_sight/cfn_topic.rb', line 721

def specifed_order
  @specifed_order
end

#treat_undefined_specified_valuesString? (readonly)

The treat of undefined specified values.

Valid values for this structure are LEAST and MOST .



728
729
730
# File 'quick_sight/cfn_topic.rb', line 728

def treat_undefined_specified_values
  @treat_undefined_specified_values
end

#use_orderingString? (readonly)

The ordering type for a column.

Valid values for this structure are GREATER_IS_BETTER , LESSER_IS_BETTER and SPECIFIED .



735
736
737
# File 'quick_sight/cfn_topic.rb', line 735

def use_ordering
  @use_ordering
end

Class Method Details

.jsii_propertiesObject



737
738
739
740
741
742
743
# File 'quick_sight/cfn_topic.rb', line 737

def self.jsii_properties
  {
    :specifed_order => "specifedOrder",
    :treat_undefined_specified_values => "treatUndefinedSpecifiedValues",
    :use_ordering => "useOrdering",
  }
end

Instance Method Details

#to_jsiiObject



745
746
747
748
749
750
751
752
753
# File 'quick_sight/cfn_topic.rb', line 745

def to_jsii
  result = {}
  result.merge!({
    "specifedOrder" => @specifed_order,
    "treatUndefinedSpecifiedValues" => @treat_undefined_specified_values,
    "useOrdering" => @use_ordering,
  })
  result.compact
end