Class: AWSCDK::QuickSight::CfnDashboard::DataLabelOptionsProperty

Inherits:

Jsii::Struct

Object
Jsii::Struct
AWSCDK::QuickSight::CfnDashboard::DataLabelOptionsProperty

show all

Defined in:: quick_sight/cfn_dashboard.rb

Overview

The options that determine the presentation of the data labels.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html

Instance Attribute Summary collapse

#category_label_visibility ⇒ String^? readonly
Determines the visibility of the category field labels.
#data_label_types ⇒ AWSCDK::IResolvable, ... readonly
The option that determines the data label type.
#label_color ⇒ String^? readonly
Determines the color of the data labels.
#label_content ⇒ String^? readonly
Determines the content of the data labels.
#label_font_configuration ⇒ AWSCDK::IResolvable, ... readonly
Determines the font configuration of the data labels.
#measure_label_visibility ⇒ String^? readonly
Determines the visibility of the measure field labels.
#overlap ⇒ String^? readonly
Determines whether overlap is enabled or disabled for the data labels.
#position ⇒ String^? readonly
Determines the position of the data labels.
#totals_visibility ⇒ String^? readonly
Determines the visibility of the total.
#visibility ⇒ String^? readonly
Determines the visibility of the data labels.

Class Method Summary collapse

.jsii_properties ⇒ Object

Instance Method Summary collapse

#initialize(category_label_visibility: nil, data_label_types: nil, label_color: nil, label_content: nil, label_font_configuration: nil, measure_label_visibility: nil, overlap: nil, position: nil, totals_visibility: nil, visibility: nil) ⇒ DataLabelOptionsProperty constructor
A new instance of DataLabelOptionsProperty.
#to_jsii ⇒ Object

Constructor Details

#initialize(category_label_visibility: nil, data_label_types: nil, label_color: nil, label_content: nil, label_font_configuration: nil, measure_label_visibility: nil, overlap: nil, position: nil, totals_visibility: nil, visibility: nil) ⇒ `DataLabelOptionsProperty`

Returns a new instance of DataLabelOptionsProperty.

Parameters:

category_label_visibility (String, nil) (defaults to: nil) —
Determines the visibility of the category field labels.
data_label_types (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::DataLabelTypeProperty>, nil) (defaults to: nil) —
The option that determines the data label type.
label_color (String, nil) (defaults to: nil) —
Determines the color of the data labels.
label_content (String, nil) (defaults to: nil) —
Determines the content of the data labels.
label_font_configuration (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::FontConfigurationProperty, nil) (defaults to: nil) —
Determines the font configuration of the data labels.
measure_label_visibility (String, nil) (defaults to: nil) —
Determines the visibility of the measure field labels.
overlap (String, nil) (defaults to: nil) —
Determines whether overlap is enabled or disabled for the data labels.
position (String, nil) (defaults to: nil) —
Determines the position of the data labels.
totals_visibility (String, nil) (defaults to: nil) —
Determines the visibility of the total.
visibility (String, nil) (defaults to: nil) —
Determines the visibility of the data labels.

# File 'quick_sight/cfn_dashboard.rb', line 6801

def initialize(category_label_visibility: nil, data_label_types: nil, label_color: nil, label_content: nil, label_font_configuration: nil, measure_label_visibility: nil, overlap: nil, position: nil, totals_visibility: nil, visibility: nil)
  @category_label_visibility = category_label_visibility
  Jsii::Type.check_type(@category_label_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "categoryLabelVisibility") unless @category_label_visibility.nil?
  @data_label_types = data_label_types
  Jsii::Type.check_type(@data_label_types, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuRGF0YUxhYmVsVHlwZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "dataLabelTypes") unless @data_label_types.nil?
  @label_color = label_color
  Jsii::Type.check_type(@label_color, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "labelColor") unless @label_color.nil?
  @label_content = label_content
  Jsii::Type.check_type(@label_content, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "labelContent") unless @label_content.nil?
  @label_font_configuration = label_font_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::FontConfigurationProperty.new(**label_font_configuration.transform_keys(&:to_sym)) : label_font_configuration
  Jsii::Type.check_type(@label_font_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Gb250Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "labelFontConfiguration") unless @label_font_configuration.nil?
  @measure_label_visibility = measure_label_visibility
  Jsii::Type.check_type(@measure_label_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "measureLabelVisibility") unless @measure_label_visibility.nil?
  @overlap = overlap
  Jsii::Type.check_type(@overlap, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "overlap") unless @overlap.nil?
  @position = position
  Jsii::Type.check_type(@position, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "position") unless @position.nil?
  @totals_visibility = totals_visibility
  Jsii::Type.check_type(@totals_visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "totalsVisibility") unless @totals_visibility.nil?
  @visibility = visibility
  Jsii::Type.check_type(@visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visibility") unless @visibility.nil?
end

Instance Attribute Details

#category_label_visibility ⇒ `String`^? (readonly)

Determines the visibility of the category field labels.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-categorylabelvisibility



6828
6829
6830

# File 'quick_sight/cfn_dashboard.rb', line 6828

def category_label_visibility
  @category_label_visibility
end

#data_label_types ⇒ `AWSCDK::IResolvable`, ... (readonly)

The option that determines the data label type.

Returns:

(AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::DataLabelTypeProperty>, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-datalabeltypes



6833
6834
6835

# File 'quick_sight/cfn_dashboard.rb', line 6833

def data_label_types
  @data_label_types
end

#label_color ⇒ `String`^? (readonly)

Determines the color of the data labels.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-labelcolor



6838
6839
6840

# File 'quick_sight/cfn_dashboard.rb', line 6838

def label_color
  @label_color
end

#label_content ⇒ `String`^? (readonly)

Determines the content of the data labels.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-labelcontent



6843
6844
6845

# File 'quick_sight/cfn_dashboard.rb', line 6843

def label_content
  @label_content
end

#label_font_configuration ⇒ `AWSCDK::IResolvable`, ... (readonly)

Determines the font configuration of the data labels.

Returns:

(AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::FontConfigurationProperty, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-labelfontconfiguration



6848
6849
6850

# File 'quick_sight/cfn_dashboard.rb', line 6848

def label_font_configuration
  @label_font_configuration
end

#measure_label_visibility ⇒ `String`^? (readonly)

Determines the visibility of the measure field labels.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-measurelabelvisibility



6853
6854
6855

# File 'quick_sight/cfn_dashboard.rb', line 6853

def measure_label_visibility
  @measure_label_visibility
end

#overlap ⇒ `String`^? (readonly)

Determines whether overlap is enabled or disabled for the data labels.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-overlap



6858
6859
6860

# File 'quick_sight/cfn_dashboard.rb', line 6858

def overlap
  @overlap
end

#position ⇒ `String`^? (readonly)

Determines the position of the data labels.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-position



6863
6864
6865

# File 'quick_sight/cfn_dashboard.rb', line 6863

def position
  @position
end

#totals_visibility ⇒ `String`^? (readonly)

Determines the visibility of the total.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-totalsvisibility



6868
6869
6870

# File 'quick_sight/cfn_dashboard.rb', line 6868

def totals_visibility
  @totals_visibility
end

#visibility ⇒ `String`^? (readonly)

Determines the visibility of the data labels.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-visibility



6873
6874
6875

# File 'quick_sight/cfn_dashboard.rb', line 6873

def visibility
  @visibility
end

Class Method Details

.jsii_properties ⇒ `Object`

# File 'quick_sight/cfn_dashboard.rb', line 6875

def self.jsii_properties
  {
    :category_label_visibility => "categoryLabelVisibility",
    :data_label_types => "dataLabelTypes",
    :label_color => "labelColor",
    :label_content => "labelContent",
    :label_font_configuration => "labelFontConfiguration",
    :measure_label_visibility => "measureLabelVisibility",
    :overlap => "overlap",
    :position => "position",
    :totals_visibility => "totalsVisibility",
    :visibility => "visibility",
  }
end

Instance Method Details

#to_jsii ⇒ `Object`

# File 'quick_sight/cfn_dashboard.rb', line 6890

def to_jsii
  result = {}
  result.merge!({
    "categoryLabelVisibility" => @category_label_visibility,
    "dataLabelTypes" => @data_label_types,
    "labelColor" => @label_color,
    "labelContent" => @label_content,
    "labelFontConfiguration" => @label_font_configuration,
    "measureLabelVisibility" => @measure_label_visibility,
    "overlap" => @overlap,
    "position" => @position,
    "totalsVisibility" => @totals_visibility,
    "visibility" => @visibility,
  })
  result.compact
end

Class: AWSCDK::QuickSight::CfnDashboard::DataLabelOptionsProperty

Overview

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(category_label_visibility: nil, data_label_types: nil, label_color: nil, label_content: nil, label_font_configuration: nil, measure_label_visibility: nil, overlap: nil, position: nil, totals_visibility: nil, visibility: nil) ⇒ DataLabelOptionsProperty

Instance Attribute Details

#category_label_visibility ⇒ String? (readonly)

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

#label_color ⇒ String? (readonly)

#label_content ⇒ String? (readonly)

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

#measure_label_visibility ⇒ String? (readonly)

#overlap ⇒ String? (readonly)

#position ⇒ String? (readonly)

#totals_visibility ⇒ String? (readonly)

#visibility ⇒ String? (readonly)

Class Method Details

.jsii_properties ⇒ Object

Instance Method Details

#to_jsii ⇒ Object

#initialize(category_label_visibility: nil, data_label_types: nil, label_color: nil, label_content: nil, label_font_configuration: nil, measure_label_visibility: nil, overlap: nil, position: nil, totals_visibility: nil, visibility: nil) ⇒ `DataLabelOptionsProperty`

#category_label_visibility ⇒ `String`^? (readonly)

#data_label_types ⇒ `AWSCDK::IResolvable`, ... (readonly)

#label_color ⇒ `String`^? (readonly)

#label_content ⇒ `String`^? (readonly)

#label_font_configuration ⇒ `AWSCDK::IResolvable`, ... (readonly)

#measure_label_visibility ⇒ `String`^? (readonly)

#overlap ⇒ `String`^? (readonly)

#position ⇒ `String`^? (readonly)

#totals_visibility ⇒ `String`^? (readonly)

#visibility ⇒ `String`^? (readonly)

.jsii_properties ⇒ `Object`

#to_jsii ⇒ `Object`