Class: AWSCDK::QuickSight::CfnTheme::UIColorPaletteProperty

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

Overview

The theme colors that apply to UI and to charts, excluding data colors.

The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with # , for example #37BFF5. For more information, see Using Themes in Amazon Quick in the Amazon Quick User Guide.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(accent: nil, accent_foreground: nil, danger: nil, danger_foreground: nil, dimension: nil, dimension_foreground: nil, measure: nil, measure_foreground: nil, primary_background: nil, primary_foreground: nil, secondary_background: nil, secondary_foreground: nil, success: nil, success_foreground: nil, warning: nil, warning_foreground: nil) ⇒ UIColorPaletteProperty

Returns a new instance of UIColorPaletteProperty.

Parameters:

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

    This color is that applies to selected states and buttons.

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

    The foreground color that applies to any text or other elements that appear over the accent color.

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

    The color that applies to error messages.

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

    The foreground color that applies to any text or other elements that appear over the error color.

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

    The color that applies to the names of fields that are identified as dimensions.

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

    The foreground color that applies to any text or other elements that appear over the dimension color.

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

    The color that applies to the names of fields that are identified as measures.

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

    The foreground color that applies to any text or other elements that appear over the measure color.

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

    The background color that applies to visuals and other high emphasis UI.

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

    The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.

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

    The background color that applies to the sheet background and sheet controls.

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

    The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.

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

    The color that applies to success messages, for example the check mark for a successful download.

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

    The foreground color that applies to any text or other elements that appear over the success color.

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

    This color that applies to warning and informational messages.

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

    The foreground color that applies to any text or other elements that appear over the warning color.



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
 
# File 'quick_sight/cfn_theme.rb', line 1339

def initialize(accent: nil, accent_foreground: nil, danger: nil, danger_foreground: nil, dimension: nil, dimension_foreground: nil, measure: nil, measure_foreground: nil, primary_background: nil, primary_foreground: nil, secondary_background: nil, secondary_foreground: nil, success: nil, success_foreground: nil, warning: nil, warning_foreground: nil)
  @accent = accent
  Jsii::Type.check_type(@accent, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accent") unless @accent.nil?
  @accent_foreground = accent_foreground
  Jsii::Type.check_type(@accent_foreground, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accentForeground") unless @accent_foreground.nil?
  @danger = danger
  Jsii::Type.check_type(@danger, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "danger") unless @danger.nil?
  @danger_foreground = danger_foreground
  Jsii::Type.check_type(@danger_foreground, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dangerForeground") unless @danger_foreground.nil?
  @dimension = dimension
  Jsii::Type.check_type(@dimension, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dimension") unless @dimension.nil?
  @dimension_foreground = dimension_foreground
  Jsii::Type.check_type(@dimension_foreground, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dimensionForeground") unless @dimension_foreground.nil?
  @measure = measure
  Jsii::Type.check_type(@measure, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "measure") unless @measure.nil?
  @measure_foreground = measure_foreground
  Jsii::Type.check_type(@measure_foreground, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "measureForeground") unless @measure_foreground.nil?
  @primary_background = primary_background
  Jsii::Type.check_type(@primary_background, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "primaryBackground") unless @primary_background.nil?
  @primary_foreground = primary_foreground
  Jsii::Type.check_type(@primary_foreground, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "primaryForeground") unless @primary_foreground.nil?
  @secondary_background = secondary_background
  Jsii::Type.check_type(@secondary_background, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secondaryBackground") unless @secondary_background.nil?
  @secondary_foreground = secondary_foreground
  Jsii::Type.check_type(@secondary_foreground, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secondaryForeground") unless @secondary_foreground.nil?
  @success = success
  Jsii::Type.check_type(@success, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "success") unless @success.nil?
  @success_foreground = success_foreground
  Jsii::Type.check_type(@success_foreground, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "successForeground") unless @success_foreground.nil?
  @warning = warning
  Jsii::Type.check_type(@warning, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "warning") unless @warning.nil?
  @warning_foreground = warning_foreground
  Jsii::Type.check_type(@warning_foreground, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "warningForeground") unless @warning_foreground.nil?
end

Instance Attribute Details

#accent ⇒ String? (readonly)

This color is that applies to selected states and buttons.

Returns:

  • (String, nil)

See Also:



1378
1379
1380
 
# File 'quick_sight/cfn_theme.rb', line 1378

def accent
  @accent
end

#accent_foreground ⇒ String? (readonly)

The foreground color that applies to any text or other elements that appear over the accent color.

Returns:

  • (String, nil)

See Also:



1383
1384
1385
 
# File 'quick_sight/cfn_theme.rb', line 1383

def accent_foreground
  @accent_foreground
end

#danger ⇒ String? (readonly)

The color that applies to error messages.

Returns:

  • (String, nil)

See Also:



1388
1389
1390
 
# File 'quick_sight/cfn_theme.rb', line 1388

def danger
  @danger
end

#danger_foreground ⇒ String? (readonly)

The foreground color that applies to any text or other elements that appear over the error color.

Returns:

  • (String, nil)

See Also:



1393
1394
1395
 
# File 'quick_sight/cfn_theme.rb', line 1393

def danger_foreground
  @danger_foreground
end

#dimension ⇒ String? (readonly)

The color that applies to the names of fields that are identified as dimensions.

Returns:

  • (String, nil)

See Also:



1398
1399
1400
 
# File 'quick_sight/cfn_theme.rb', line 1398

def dimension
  @dimension
end

#dimension_foreground ⇒ String? (readonly)

The foreground color that applies to any text or other elements that appear over the dimension color.

Returns:

  • (String, nil)

See Also:



1403
1404
1405
 
# File 'quick_sight/cfn_theme.rb', line 1403

def dimension_foreground
  @dimension_foreground
end

#measure ⇒ String? (readonly)

The color that applies to the names of fields that are identified as measures.

Returns:

  • (String, nil)

See Also:



1408
1409
1410
 
# File 'quick_sight/cfn_theme.rb', line 1408

def measure
  @measure
end

#measure_foreground ⇒ String? (readonly)

The foreground color that applies to any text or other elements that appear over the measure color.

Returns:

  • (String, nil)

See Also:



1413
1414
1415
 
# File 'quick_sight/cfn_theme.rb', line 1413

def measure_foreground
  @measure_foreground
end

#primary_background ⇒ String? (readonly)

The background color that applies to visuals and other high emphasis UI.

Returns:

  • (String, nil)

See Also:



1418
1419
1420
 
# File 'quick_sight/cfn_theme.rb', line 1418

def primary_background
  @primary_background
end

#primary_foreground ⇒ String? (readonly)

The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.

Returns:

  • (String, nil)

See Also:



1423
1424
1425
 
# File 'quick_sight/cfn_theme.rb', line 1423

def primary_foreground
  @primary_foreground
end

#secondary_background ⇒ String? (readonly)

The background color that applies to the sheet background and sheet controls.

Returns:

  • (String, nil)

See Also:



1428
1429
1430
 
# File 'quick_sight/cfn_theme.rb', line 1428

def secondary_background
  @secondary_background
end

#secondary_foreground ⇒ String? (readonly)

The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.

Returns:

  • (String, nil)

See Also:



1433
1434
1435
 
# File 'quick_sight/cfn_theme.rb', line 1433

def secondary_foreground
  @secondary_foreground
end

#success ⇒ String? (readonly)

The color that applies to success messages, for example the check mark for a successful download.

Returns:

  • (String, nil)

See Also:



1438
1439
1440
 
# File 'quick_sight/cfn_theme.rb', line 1438

def success
  @success
end

#success_foreground ⇒ String? (readonly)

The foreground color that applies to any text or other elements that appear over the success color.

Returns:

  • (String, nil)

See Also:



1443
1444
1445
 
# File 'quick_sight/cfn_theme.rb', line 1443

def success_foreground
  @success_foreground
end

#warning ⇒ String? (readonly)

This color that applies to warning and informational messages.

Returns:

  • (String, nil)

See Also:



1448
1449
1450
 
# File 'quick_sight/cfn_theme.rb', line 1448

def warning
  @warning
end

#warning_foreground ⇒ String? (readonly)

The foreground color that applies to any text or other elements that appear over the warning color.

Returns:

  • (String, nil)

See Also:



1453
1454
1455
 
# File 'quick_sight/cfn_theme.rb', line 1453

def warning_foreground
  @warning_foreground
end

Class Method Details

.jsii_properties ⇒ Object 



1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
 
# File 'quick_sight/cfn_theme.rb', line 1455

def self.jsii_properties
  {
    :accent => "accent",
    :accent_foreground => "accentForeground",
    :danger => "danger",
    :danger_foreground => "dangerForeground",
    :dimension => "dimension",
    :dimension_foreground => "dimensionForeground",
    :measure => "measure",
    :measure_foreground => "measureForeground",
    :primary_background => "primaryBackground",
    :primary_foreground => "primaryForeground",
    :secondary_background => "secondaryBackground",
    :secondary_foreground => "secondaryForeground",
    :success => "success",
    :success_foreground => "successForeground",
    :warning => "warning",
    :warning_foreground => "warningForeground",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
 
# File 'quick_sight/cfn_theme.rb', line 1476

def to_jsii
  result = {}
  result.merge!({
    "accent" => @accent,
    "accentForeground" => @accent_foreground,
    "danger" => @danger,
    "dangerForeground" => @danger_foreground,
    "dimension" => @dimension,
    "dimensionForeground" => @dimension_foreground,
    "measure" => @measure,
    "measureForeground" => @measure_foreground,
    "primaryBackground" => @primary_background,
    "primaryForeground" => @primary_foreground,
    "secondaryBackground" => @secondary_background,
    "secondaryForeground" => @secondary_foreground,
    "success" => @success,
    "successForeground" => @success_foreground,
    "warning" => @warning,
    "warningForeground" => @warning_foreground,
  })
  result.compact
end