Class: AWSCDK::QuickSight::CfnTopic::DisplayFormatOptionsProperty

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

Overview

A structure that represents additional options for display formatting.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(blank_cell_format: nil, currency_symbol: nil, date_format: nil, decimal_separator: nil, fraction_digits: nil, grouping_separator: nil, negative_format: nil, prefix: nil, suffix: nil, unit_scaler: nil, use_blank_cell_format: nil, use_grouping: nil) ⇒ DisplayFormatOptionsProperty

Returns a new instance of DisplayFormatOptionsProperty.

Parameters:

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

    Determines the blank cell format.

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

    The currency symbol, such as USD .

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

    Determines the DateTime format.

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

    Determines the decimal separator.

  • fraction_digits (Numeric, nil) (defaults to: nil) —

    Determines the number of fraction digits.

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

    Determines the grouping separator.

  • negative_format (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::NegativeFormatProperty, nil) (defaults to: nil) —

    The negative format.

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

    The prefix value for a display format.

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

    The suffix value for a display format.

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

    The unit scaler.

  • use_blank_cell_format (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A Boolean value that indicates whether to use blank cell format.

  • use_grouping (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A Boolean value that indicates whether to use grouping.



994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'quick_sight/cfn_topic.rb', line 994

def initialize(blank_cell_format: nil, currency_symbol: nil, date_format: nil, decimal_separator: nil, fraction_digits: nil, grouping_separator: nil, negative_format: nil, prefix: nil, suffix: nil, unit_scaler: nil, use_blank_cell_format: nil, use_grouping: nil)
  @blank_cell_format = blank_cell_format
  Jsii::Type.check_type(@blank_cell_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "blankCellFormat") unless @blank_cell_format.nil?
  @currency_symbol = currency_symbol
  Jsii::Type.check_type(@currency_symbol, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "currencySymbol") unless @currency_symbol.nil?
  @date_format = date_format
  Jsii::Type.check_type(@date_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dateFormat") unless @date_format.nil?
  @decimal_separator = decimal_separator
  Jsii::Type.check_type(@decimal_separator, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "decimalSeparator") unless @decimal_separator.nil?
  @fraction_digits = fraction_digits
  Jsii::Type.check_type(@fraction_digits, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "fractionDigits") unless @fraction_digits.nil?
  @grouping_separator = grouping_separator
  Jsii::Type.check_type(@grouping_separator, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "groupingSeparator") unless @grouping_separator.nil?
  @negative_format = negative_format.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::NegativeFormatProperty.new(**negative_format.transform_keys(&:to_sym)) : negative_format
  Jsii::Type.check_type(@negative_format, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLk5lZ2F0aXZlRm9ybWF0UHJvcGVydHkifV19fQ==")), "negativeFormat") unless @negative_format.nil?
  @prefix = prefix
  Jsii::Type.check_type(@prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefix") unless @prefix.nil?
  @suffix = suffix
  Jsii::Type.check_type(@suffix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "suffix") unless @suffix.nil?
  @unit_scaler = unit_scaler
  Jsii::Type.check_type(@unit_scaler, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "unitScaler") unless @unit_scaler.nil?
  @use_blank_cell_format = use_blank_cell_format
  Jsii::Type.check_type(@use_blank_cell_format, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useBlankCellFormat") unless @use_blank_cell_format.nil?
  @use_grouping = use_grouping
  Jsii::Type.check_type(@use_grouping, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useGrouping") unless @use_grouping.nil?
end

Instance Attribute Details

#blank_cell_format ⇒ String? (readonly)

Determines the blank cell format.

Returns:

  • (String, nil)

See Also:



1025
1026
1027
 
# File 'quick_sight/cfn_topic.rb', line 1025

def blank_cell_format
  @blank_cell_format
end

#currency_symbol ⇒ String? (readonly)

The currency symbol, such as USD .

Returns:

  • (String, nil)

See Also:



1030
1031
1032
 
# File 'quick_sight/cfn_topic.rb', line 1030

def currency_symbol
  @currency_symbol
end

#date_format ⇒ String? (readonly)

Determines the DateTime format.

Returns:

  • (String, nil)

See Also:



1035
1036
1037
 
# File 'quick_sight/cfn_topic.rb', line 1035

def date_format
  @date_format
end

#decimal_separator ⇒ String? (readonly)

Determines the decimal separator.

Returns:

  • (String, nil)

See Also:



1040
1041
1042
 
# File 'quick_sight/cfn_topic.rb', line 1040

def decimal_separator
  @decimal_separator
end

#fraction_digits ⇒ Numeric? (readonly)

Note:

Default: - 0

Determines the number of fraction digits.

Returns:

  • (Numeric, nil)

See Also:



1046
1047
1048
 
# File 'quick_sight/cfn_topic.rb', line 1046

def fraction_digits
  @fraction_digits
end

#grouping_separator ⇒ String? (readonly)

Determines the grouping separator.

Returns:

  • (String, nil)

See Also:



1051
1052
1053
 
# File 'quick_sight/cfn_topic.rb', line 1051

def grouping_separator
  @grouping_separator
end

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

The negative format.

Returns:

See Also:



1056
1057
1058
 
# File 'quick_sight/cfn_topic.rb', line 1056

def negative_format
  @negative_format
end

#prefix ⇒ String? (readonly)

The prefix value for a display format.

Returns:

  • (String, nil)

See Also:



1061
1062
1063
 
# File 'quick_sight/cfn_topic.rb', line 1061

def prefix
  @prefix
end

#suffix ⇒ String? (readonly)

The suffix value for a display format.

Returns:

  • (String, nil)

See Also:



1066
1067
1068
 
# File 'quick_sight/cfn_topic.rb', line 1066

def suffix
  @suffix
end

#unit_scaler ⇒ String? (readonly)

The unit scaler.

Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .

Returns:

  • (String, nil)

See Also:



1073
1074
1075
 
# File 'quick_sight/cfn_topic.rb', line 1073

def unit_scaler
  @unit_scaler
end

#use_blank_cell_format ⇒ Boolean, ... (readonly)

Note:

Default: - false

A Boolean value that indicates whether to use blank cell format.

Returns:

See Also:



1079
1080
1081
 
# File 'quick_sight/cfn_topic.rb', line 1079

def use_blank_cell_format
  @use_blank_cell_format
end

#use_grouping ⇒ Boolean, ... (readonly)

Note:

Default: - false

A Boolean value that indicates whether to use grouping.

Returns:

See Also:



1085
1086
1087
 
# File 'quick_sight/cfn_topic.rb', line 1085

def use_grouping
  @use_grouping
end

Class Method Details

.jsii_properties ⇒ Object 



1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
 
# File 'quick_sight/cfn_topic.rb', line 1087

def self.jsii_properties
  {
    :blank_cell_format => "blankCellFormat",
    :currency_symbol => "currencySymbol",
    :date_format => "dateFormat",
    :decimal_separator => "decimalSeparator",
    :fraction_digits => "fractionDigits",
    :grouping_separator => "groupingSeparator",
    :negative_format => "negativeFormat",
    :prefix => "prefix",
    :suffix => "suffix",
    :unit_scaler => "unitScaler",
    :use_blank_cell_format => "useBlankCellFormat",
    :use_grouping => "useGrouping",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'quick_sight/cfn_topic.rb', line 1104

def to_jsii
  result = {}
  result.merge!({
    "blankCellFormat" => @blank_cell_format,
    "currencySymbol" => @currency_symbol,
    "dateFormat" => @date_format,
    "decimalSeparator" => @decimal_separator,
    "fractionDigits" => @fraction_digits,
    "groupingSeparator" => @grouping_separator,
    "negativeFormat" => @negative_format,
    "prefix" => @prefix,
    "suffix" => @suffix,
    "unitScaler" => @unit_scaler,
    "useBlankCellFormat" => @use_blank_cell_format,
    "useGrouping" => @use_grouping,
  })
  result.compact
end