/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace QuickSight { namespace Model { /** *

The options for the legend setup of a visual.

See Also:

AWS * API Reference

*/ class LegendOptions { public: AWS_QUICKSIGHT_API LegendOptions(); AWS_QUICKSIGHT_API LegendOptions(Aws::Utils::Json::JsonView jsonValue); AWS_QUICKSIGHT_API LegendOptions& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_QUICKSIGHT_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

Determines whether or not the legend is visible.

*/ inline const Visibility& GetVisibility() const{ return m_visibility; } /** *

Determines whether or not the legend is visible.

*/ inline bool VisibilityHasBeenSet() const { return m_visibilityHasBeenSet; } /** *

Determines whether or not the legend is visible.

*/ inline void SetVisibility(const Visibility& value) { m_visibilityHasBeenSet = true; m_visibility = value; } /** *

Determines whether or not the legend is visible.

*/ inline void SetVisibility(Visibility&& value) { m_visibilityHasBeenSet = true; m_visibility = std::move(value); } /** *

Determines whether or not the legend is visible.

*/ inline LegendOptions& WithVisibility(const Visibility& value) { SetVisibility(value); return *this;} /** *

Determines whether or not the legend is visible.

*/ inline LegendOptions& WithVisibility(Visibility&& value) { SetVisibility(std::move(value)); return *this;} /** *

The custom title for the legend.

*/ inline const LabelOptions& GetTitle() const{ return m_title; } /** *

The custom title for the legend.

*/ inline bool TitleHasBeenSet() const { return m_titleHasBeenSet; } /** *

The custom title for the legend.

*/ inline void SetTitle(const LabelOptions& value) { m_titleHasBeenSet = true; m_title = value; } /** *

The custom title for the legend.

*/ inline void SetTitle(LabelOptions&& value) { m_titleHasBeenSet = true; m_title = std::move(value); } /** *

The custom title for the legend.

*/ inline LegendOptions& WithTitle(const LabelOptions& value) { SetTitle(value); return *this;} /** *

The custom title for the legend.

*/ inline LegendOptions& WithTitle(LabelOptions&& value) { SetTitle(std::move(value)); return *this;} /** *

The positions for the legend. Choose one of the following options:

    *
  • AUTO

  • RIGHT

  • *
  • BOTTOM

  • LEFT

  • *
*/ inline const LegendPosition& GetPosition() const{ return m_position; } /** *

The positions for the legend. Choose one of the following options:

    *
  • AUTO

  • RIGHT

  • *
  • BOTTOM

  • LEFT

  • *
*/ inline bool PositionHasBeenSet() const { return m_positionHasBeenSet; } /** *

The positions for the legend. Choose one of the following options:

    *
  • AUTO

  • RIGHT

  • *
  • BOTTOM

  • LEFT

  • *
*/ inline void SetPosition(const LegendPosition& value) { m_positionHasBeenSet = true; m_position = value; } /** *

The positions for the legend. Choose one of the following options:

    *
  • AUTO

  • RIGHT

  • *
  • BOTTOM

  • LEFT

  • *
*/ inline void SetPosition(LegendPosition&& value) { m_positionHasBeenSet = true; m_position = std::move(value); } /** *

The positions for the legend. Choose one of the following options:

    *
  • AUTO

  • RIGHT

  • *
  • BOTTOM

  • LEFT

  • *
*/ inline LegendOptions& WithPosition(const LegendPosition& value) { SetPosition(value); return *this;} /** *

The positions for the legend. Choose one of the following options:

    *
  • AUTO

  • RIGHT

  • *
  • BOTTOM

  • LEFT

  • *
*/ inline LegendOptions& WithPosition(LegendPosition&& value) { SetPosition(std::move(value)); return *this;} /** *

The width of the legend. If this value is omitted, a default width is used * when rendering.

*/ inline const Aws::String& GetWidth() const{ return m_width; } /** *

The width of the legend. If this value is omitted, a default width is used * when rendering.

*/ inline bool WidthHasBeenSet() const { return m_widthHasBeenSet; } /** *

The width of the legend. If this value is omitted, a default width is used * when rendering.

*/ inline void SetWidth(const Aws::String& value) { m_widthHasBeenSet = true; m_width = value; } /** *

The width of the legend. If this value is omitted, a default width is used * when rendering.

*/ inline void SetWidth(Aws::String&& value) { m_widthHasBeenSet = true; m_width = std::move(value); } /** *

The width of the legend. If this value is omitted, a default width is used * when rendering.

*/ inline void SetWidth(const char* value) { m_widthHasBeenSet = true; m_width.assign(value); } /** *

The width of the legend. If this value is omitted, a default width is used * when rendering.

*/ inline LegendOptions& WithWidth(const Aws::String& value) { SetWidth(value); return *this;} /** *

The width of the legend. If this value is omitted, a default width is used * when rendering.

*/ inline LegendOptions& WithWidth(Aws::String&& value) { SetWidth(std::move(value)); return *this;} /** *

The width of the legend. If this value is omitted, a default width is used * when rendering.

*/ inline LegendOptions& WithWidth(const char* value) { SetWidth(value); return *this;} /** *

The height of the legend. If this value is omitted, a default height is used * when rendering.

*/ inline const Aws::String& GetHeight() const{ return m_height; } /** *

The height of the legend. If this value is omitted, a default height is used * when rendering.

*/ inline bool HeightHasBeenSet() const { return m_heightHasBeenSet; } /** *

The height of the legend. If this value is omitted, a default height is used * when rendering.

*/ inline void SetHeight(const Aws::String& value) { m_heightHasBeenSet = true; m_height = value; } /** *

The height of the legend. If this value is omitted, a default height is used * when rendering.

*/ inline void SetHeight(Aws::String&& value) { m_heightHasBeenSet = true; m_height = std::move(value); } /** *

The height of the legend. If this value is omitted, a default height is used * when rendering.

*/ inline void SetHeight(const char* value) { m_heightHasBeenSet = true; m_height.assign(value); } /** *

The height of the legend. If this value is omitted, a default height is used * when rendering.

*/ inline LegendOptions& WithHeight(const Aws::String& value) { SetHeight(value); return *this;} /** *

The height of the legend. If this value is omitted, a default height is used * when rendering.

*/ inline LegendOptions& WithHeight(Aws::String&& value) { SetHeight(std::move(value)); return *this;} /** *

The height of the legend. If this value is omitted, a default height is used * when rendering.

*/ inline LegendOptions& WithHeight(const char* value) { SetHeight(value); return *this;} private: Visibility m_visibility; bool m_visibilityHasBeenSet = false; LabelOptions m_title; bool m_titleHasBeenSet = false; LegendPosition m_position; bool m_positionHasBeenSet = false; Aws::String m_width; bool m_widthHasBeenSet = false; Aws::String m_height; bool m_heightHasBeenSet = false; }; } // namespace Model } // namespace QuickSight } // namespace Aws