Class: AWSCDK::QuickSight::CfnDashboard::AxisDisplayOptionsProperty

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

Overview

The display options for the axis label.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(axis_line_visibility: nil, axis_offset: nil, data_options: nil, grid_line_visibility: nil, scrollbar_options: nil, tick_label_options: nil) ⇒ AxisDisplayOptionsProperty

Returns a new instance of AxisDisplayOptionsProperty.

Parameters:



1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
 
# File 'quick_sight/cfn_dashboard.rb', line 1401

def initialize(axis_line_visibility: nil, axis_offset: nil, data_options: nil, grid_line_visibility: nil, scrollbar_options: nil, tick_label_options: nil)
  @axis_line_visibility = axis_line_visibility
  Jsii::Type.check_type(@axis_line_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "axisLineVisibility") unless @axis_line_visibility.nil?
  @axis_offset = axis_offset
  Jsii::Type.check_type(@axis_offset, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "axisOffset") unless @axis_offset.nil?
  @data_options = data_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::AxisDataOptionsProperty.new(**data_options.transform_keys(&:to_sym)) : data_options
  Jsii::Type.check_type(@data_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5BeGlzRGF0YU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "dataOptions") unless @data_options.nil?
  @grid_line_visibility = grid_line_visibility
  Jsii::Type.check_type(@grid_line_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gridLineVisibility") unless @grid_line_visibility.nil?
  @scrollbar_options = scrollbar_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ScrollBarOptionsProperty.new(**scrollbar_options.transform_keys(&:to_sym)) : scrollbar_options
  Jsii::Type.check_type(@scrollbar_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5TY3JvbGxCYXJPcHRpb25zUHJvcGVydHkifV19fQ==")), "scrollbarOptions") unless @scrollbar_options.nil?
  @tick_label_options = tick_label_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::AxisTickLabelOptionsProperty.new(**tick_label_options.transform_keys(&:to_sym)) : tick_label_options
  Jsii::Type.check_type(@tick_label_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5BeGlzVGlja0xhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "tickLabelOptions") unless @tick_label_options.nil?
end

Instance Attribute Details

#axis_line_visibility ⇒ String? (readonly)

Determines whether or not the axis line is visible.

Returns:

  • (String, nil)

See Also:



1420
1421
1422
 
# File 'quick_sight/cfn_dashboard.rb', line 1420

def axis_line_visibility
  @axis_line_visibility
end

#axis_offset ⇒ String? (readonly)

The offset value that determines the starting placement of the axis within a visual's bounds.

Returns:

  • (String, nil)

See Also:



1425
1426
1427
 
# File 'quick_sight/cfn_dashboard.rb', line 1425

def axis_offset
  @axis_offset
end

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

The data options for an axis.

Returns:

See Also:



1430
1431
1432
 
# File 'quick_sight/cfn_dashboard.rb', line 1430

def data_options
  @data_options
end

#grid_line_visibility ⇒ String? (readonly)

Determines whether or not the grid line is visible.

Returns:

  • (String, nil)

See Also:



1435
1436
1437
 
# File 'quick_sight/cfn_dashboard.rb', line 1435

def grid_line_visibility
  @grid_line_visibility
end

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

The scroll bar options for an axis.

Returns:

See Also:



1440
1441
1442
 
# File 'quick_sight/cfn_dashboard.rb', line 1440

def scrollbar_options
  @scrollbar_options
end

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

The tick label options of an axis.

Returns:

See Also:



1445
1446
1447
 
# File 'quick_sight/cfn_dashboard.rb', line 1445

def tick_label_options
  @tick_label_options
end

Class Method Details

.jsii_properties ⇒ Object 



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
 
# File 'quick_sight/cfn_dashboard.rb', line 1447

def self.jsii_properties
  {
    :axis_line_visibility => "axisLineVisibility",
    :axis_offset => "axisOffset",
    :data_options => "dataOptions",
    :grid_line_visibility => "gridLineVisibility",
    :scrollbar_options => "scrollbarOptions",
    :tick_label_options => "tickLabelOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
 
# File 'quick_sight/cfn_dashboard.rb', line 1458

def to_jsii
  result = {}
  result.merge!({
    "axisLineVisibility" => @axis_line_visibility,
    "axisOffset" => @axis_offset,
    "dataOptions" => @data_options,
    "gridLineVisibility" => @grid_line_visibility,
    "scrollbarOptions" => @scrollbar_options,
    "tickLabelOptions" => @tick_label_options,
  })
  result.compact
end