{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.QuickSight.Types.PieChartVisual
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.QuickSight.Types.PieChartVisual where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import Amazonka.QuickSight.Types.ColumnHierarchy
import Amazonka.QuickSight.Types.PieChartConfiguration
import Amazonka.QuickSight.Types.VisualCustomAction
import Amazonka.QuickSight.Types.VisualSubtitleLabelOptions
import Amazonka.QuickSight.Types.VisualTitleLabelOptions

-- | A pie or donut chart.
--
-- The @PieChartVisual@ structure describes a visual that is a member of
-- the pie chart family.
--
-- The following charts can be described by using this structure:
--
-- -   Pie charts
--
-- -   Donut charts
--
-- For more information, see
-- <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html Using pie charts>
-- in the /Amazon QuickSight User Guide/.
--
-- For more information, see
-- <https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html Using donut charts>
-- in the /Amazon QuickSight User Guide/.
--
-- /See:/ 'newPieChartVisual' smart constructor.
data PieChartVisual = PieChartVisual'
  { -- | The list of custom actions that are configured for a visual.
    PieChartVisual -> Maybe [VisualCustomAction]
actions :: Prelude.Maybe [VisualCustomAction],
    -- | The configuration of a pie chart.
    PieChartVisual -> Maybe PieChartConfiguration
chartConfiguration :: Prelude.Maybe PieChartConfiguration,
    -- | The column hierarchy that is used during drill-downs and drill-ups.
    PieChartVisual -> Maybe [ColumnHierarchy]
columnHierarchies :: Prelude.Maybe [ColumnHierarchy],
    -- | The subtitle that is displayed on the visual.
    PieChartVisual -> Maybe VisualSubtitleLabelOptions
subtitle :: Prelude.Maybe VisualSubtitleLabelOptions,
    -- | The title that is displayed on the visual.
    PieChartVisual -> Maybe VisualTitleLabelOptions
title :: Prelude.Maybe VisualTitleLabelOptions,
    -- | The unique identifier of a visual. This identifier must be unique within
    -- the context of a dashboard, template, or analysis. Two dashboards,
    -- analyses, or templates can have visuals with the same identifiers.
    PieChartVisual -> Text
visualId :: Prelude.Text
  }
  deriving (PieChartVisual -> PieChartVisual -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PieChartVisual -> PieChartVisual -> Bool
$c/= :: PieChartVisual -> PieChartVisual -> Bool
== :: PieChartVisual -> PieChartVisual -> Bool
$c== :: PieChartVisual -> PieChartVisual -> Bool
Prelude.Eq, Int -> PieChartVisual -> ShowS
[PieChartVisual] -> ShowS
PieChartVisual -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PieChartVisual] -> ShowS
$cshowList :: [PieChartVisual] -> ShowS
show :: PieChartVisual -> String
$cshow :: PieChartVisual -> String
showsPrec :: Int -> PieChartVisual -> ShowS
$cshowsPrec :: Int -> PieChartVisual -> ShowS
Prelude.Show, forall x. Rep PieChartVisual x -> PieChartVisual
forall x. PieChartVisual -> Rep PieChartVisual x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PieChartVisual x -> PieChartVisual
$cfrom :: forall x. PieChartVisual -> Rep PieChartVisual x
Prelude.Generic)

-- |
-- Create a value of 'PieChartVisual' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'actions', 'pieChartVisual_actions' - The list of custom actions that are configured for a visual.
--
-- 'chartConfiguration', 'pieChartVisual_chartConfiguration' - The configuration of a pie chart.
--
-- 'columnHierarchies', 'pieChartVisual_columnHierarchies' - The column hierarchy that is used during drill-downs and drill-ups.
--
-- 'subtitle', 'pieChartVisual_subtitle' - The subtitle that is displayed on the visual.
--
-- 'title', 'pieChartVisual_title' - The title that is displayed on the visual.
--
-- 'visualId', 'pieChartVisual_visualId' - The unique identifier of a visual. This identifier must be unique within
-- the context of a dashboard, template, or analysis. Two dashboards,
-- analyses, or templates can have visuals with the same identifiers.
newPieChartVisual ::
  -- | 'visualId'
  Prelude.Text ->
  PieChartVisual
newPieChartVisual :: Text -> PieChartVisual
newPieChartVisual Text
pVisualId_ =
  PieChartVisual'
    { $sel:actions:PieChartVisual' :: Maybe [VisualCustomAction]
actions = forall a. Maybe a
Prelude.Nothing,
      $sel:chartConfiguration:PieChartVisual' :: Maybe PieChartConfiguration
chartConfiguration = forall a. Maybe a
Prelude.Nothing,
      $sel:columnHierarchies:PieChartVisual' :: Maybe [ColumnHierarchy]
columnHierarchies = forall a. Maybe a
Prelude.Nothing,
      $sel:subtitle:PieChartVisual' :: Maybe VisualSubtitleLabelOptions
subtitle = forall a. Maybe a
Prelude.Nothing,
      $sel:title:PieChartVisual' :: Maybe VisualTitleLabelOptions
title = forall a. Maybe a
Prelude.Nothing,
      $sel:visualId:PieChartVisual' :: Text
visualId = Text
pVisualId_
    }

-- | The list of custom actions that are configured for a visual.
pieChartVisual_actions :: Lens.Lens' PieChartVisual (Prelude.Maybe [VisualCustomAction])
pieChartVisual_actions :: Lens' PieChartVisual (Maybe [VisualCustomAction])
pieChartVisual_actions = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PieChartVisual' {Maybe [VisualCustomAction]
actions :: Maybe [VisualCustomAction]
$sel:actions:PieChartVisual' :: PieChartVisual -> Maybe [VisualCustomAction]
actions} -> Maybe [VisualCustomAction]
actions) (\s :: PieChartVisual
s@PieChartVisual' {} Maybe [VisualCustomAction]
a -> PieChartVisual
s {$sel:actions:PieChartVisual' :: Maybe [VisualCustomAction]
actions = Maybe [VisualCustomAction]
a} :: PieChartVisual) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The configuration of a pie chart.
pieChartVisual_chartConfiguration :: Lens.Lens' PieChartVisual (Prelude.Maybe PieChartConfiguration)
pieChartVisual_chartConfiguration :: Lens' PieChartVisual (Maybe PieChartConfiguration)
pieChartVisual_chartConfiguration = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PieChartVisual' {Maybe PieChartConfiguration
chartConfiguration :: Maybe PieChartConfiguration
$sel:chartConfiguration:PieChartVisual' :: PieChartVisual -> Maybe PieChartConfiguration
chartConfiguration} -> Maybe PieChartConfiguration
chartConfiguration) (\s :: PieChartVisual
s@PieChartVisual' {} Maybe PieChartConfiguration
a -> PieChartVisual
s {$sel:chartConfiguration:PieChartVisual' :: Maybe PieChartConfiguration
chartConfiguration = Maybe PieChartConfiguration
a} :: PieChartVisual)

-- | The column hierarchy that is used during drill-downs and drill-ups.
pieChartVisual_columnHierarchies :: Lens.Lens' PieChartVisual (Prelude.Maybe [ColumnHierarchy])
pieChartVisual_columnHierarchies :: Lens' PieChartVisual (Maybe [ColumnHierarchy])
pieChartVisual_columnHierarchies = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PieChartVisual' {Maybe [ColumnHierarchy]
columnHierarchies :: Maybe [ColumnHierarchy]
$sel:columnHierarchies:PieChartVisual' :: PieChartVisual -> Maybe [ColumnHierarchy]
columnHierarchies} -> Maybe [ColumnHierarchy]
columnHierarchies) (\s :: PieChartVisual
s@PieChartVisual' {} Maybe [ColumnHierarchy]
a -> PieChartVisual
s {$sel:columnHierarchies:PieChartVisual' :: Maybe [ColumnHierarchy]
columnHierarchies = Maybe [ColumnHierarchy]
a} :: PieChartVisual) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The subtitle that is displayed on the visual.
pieChartVisual_subtitle :: Lens.Lens' PieChartVisual (Prelude.Maybe VisualSubtitleLabelOptions)
pieChartVisual_subtitle :: Lens' PieChartVisual (Maybe VisualSubtitleLabelOptions)
pieChartVisual_subtitle = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PieChartVisual' {Maybe VisualSubtitleLabelOptions
subtitle :: Maybe VisualSubtitleLabelOptions
$sel:subtitle:PieChartVisual' :: PieChartVisual -> Maybe VisualSubtitleLabelOptions
subtitle} -> Maybe VisualSubtitleLabelOptions
subtitle) (\s :: PieChartVisual
s@PieChartVisual' {} Maybe VisualSubtitleLabelOptions
a -> PieChartVisual
s {$sel:subtitle:PieChartVisual' :: Maybe VisualSubtitleLabelOptions
subtitle = Maybe VisualSubtitleLabelOptions
a} :: PieChartVisual)

-- | The title that is displayed on the visual.
pieChartVisual_title :: Lens.Lens' PieChartVisual (Prelude.Maybe VisualTitleLabelOptions)
pieChartVisual_title :: Lens' PieChartVisual (Maybe VisualTitleLabelOptions)
pieChartVisual_title = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PieChartVisual' {Maybe VisualTitleLabelOptions
title :: Maybe VisualTitleLabelOptions
$sel:title:PieChartVisual' :: PieChartVisual -> Maybe VisualTitleLabelOptions
title} -> Maybe VisualTitleLabelOptions
title) (\s :: PieChartVisual
s@PieChartVisual' {} Maybe VisualTitleLabelOptions
a -> PieChartVisual
s {$sel:title:PieChartVisual' :: Maybe VisualTitleLabelOptions
title = Maybe VisualTitleLabelOptions
a} :: PieChartVisual)

-- | The unique identifier of a visual. This identifier must be unique within
-- the context of a dashboard, template, or analysis. Two dashboards,
-- analyses, or templates can have visuals with the same identifiers.
pieChartVisual_visualId :: Lens.Lens' PieChartVisual Prelude.Text
pieChartVisual_visualId :: Lens' PieChartVisual Text
pieChartVisual_visualId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PieChartVisual' {Text
visualId :: Text
$sel:visualId:PieChartVisual' :: PieChartVisual -> Text
visualId} -> Text
visualId) (\s :: PieChartVisual
s@PieChartVisual' {} Text
a -> PieChartVisual
s {$sel:visualId:PieChartVisual' :: Text
visualId = Text
a} :: PieChartVisual)

instance Data.FromJSON PieChartVisual where
  parseJSON :: Value -> Parser PieChartVisual
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"PieChartVisual"
      ( \Object
x ->
          Maybe [VisualCustomAction]
-> Maybe PieChartConfiguration
-> Maybe [ColumnHierarchy]
-> Maybe VisualSubtitleLabelOptions
-> Maybe VisualTitleLabelOptions
-> Text
-> PieChartVisual
PieChartVisual'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Actions" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"ChartConfiguration")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ( Object
x
                            forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"ColumnHierarchies"
                            forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty
                        )
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Subtitle")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Title")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"VisualId")
      )

instance Prelude.Hashable PieChartVisual where
  hashWithSalt :: Int -> PieChartVisual -> Int
hashWithSalt Int
_salt PieChartVisual' {Maybe [ColumnHierarchy]
Maybe [VisualCustomAction]
Maybe PieChartConfiguration
Maybe VisualSubtitleLabelOptions
Maybe VisualTitleLabelOptions
Text
visualId :: Text
title :: Maybe VisualTitleLabelOptions
subtitle :: Maybe VisualSubtitleLabelOptions
columnHierarchies :: Maybe [ColumnHierarchy]
chartConfiguration :: Maybe PieChartConfiguration
actions :: Maybe [VisualCustomAction]
$sel:visualId:PieChartVisual' :: PieChartVisual -> Text
$sel:title:PieChartVisual' :: PieChartVisual -> Maybe VisualTitleLabelOptions
$sel:subtitle:PieChartVisual' :: PieChartVisual -> Maybe VisualSubtitleLabelOptions
$sel:columnHierarchies:PieChartVisual' :: PieChartVisual -> Maybe [ColumnHierarchy]
$sel:chartConfiguration:PieChartVisual' :: PieChartVisual -> Maybe PieChartConfiguration
$sel:actions:PieChartVisual' :: PieChartVisual -> Maybe [VisualCustomAction]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [VisualCustomAction]
actions
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe PieChartConfiguration
chartConfiguration
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [ColumnHierarchy]
columnHierarchies
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe VisualSubtitleLabelOptions
subtitle
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe VisualTitleLabelOptions
title
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
visualId

instance Prelude.NFData PieChartVisual where
  rnf :: PieChartVisual -> ()
rnf PieChartVisual' {Maybe [ColumnHierarchy]
Maybe [VisualCustomAction]
Maybe PieChartConfiguration
Maybe VisualSubtitleLabelOptions
Maybe VisualTitleLabelOptions
Text
visualId :: Text
title :: Maybe VisualTitleLabelOptions
subtitle :: Maybe VisualSubtitleLabelOptions
columnHierarchies :: Maybe [ColumnHierarchy]
chartConfiguration :: Maybe PieChartConfiguration
actions :: Maybe [VisualCustomAction]
$sel:visualId:PieChartVisual' :: PieChartVisual -> Text
$sel:title:PieChartVisual' :: PieChartVisual -> Maybe VisualTitleLabelOptions
$sel:subtitle:PieChartVisual' :: PieChartVisual -> Maybe VisualSubtitleLabelOptions
$sel:columnHierarchies:PieChartVisual' :: PieChartVisual -> Maybe [ColumnHierarchy]
$sel:chartConfiguration:PieChartVisual' :: PieChartVisual -> Maybe PieChartConfiguration
$sel:actions:PieChartVisual' :: PieChartVisual -> Maybe [VisualCustomAction]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [VisualCustomAction]
actions
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe PieChartConfiguration
chartConfiguration
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [ColumnHierarchy]
columnHierarchies
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe VisualSubtitleLabelOptions
subtitle
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe VisualTitleLabelOptions
title
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
visualId

instance Data.ToJSON PieChartVisual where
  toJSON :: PieChartVisual -> Value
toJSON PieChartVisual' {Maybe [ColumnHierarchy]
Maybe [VisualCustomAction]
Maybe PieChartConfiguration
Maybe VisualSubtitleLabelOptions
Maybe VisualTitleLabelOptions
Text
visualId :: Text
title :: Maybe VisualTitleLabelOptions
subtitle :: Maybe VisualSubtitleLabelOptions
columnHierarchies :: Maybe [ColumnHierarchy]
chartConfiguration :: Maybe PieChartConfiguration
actions :: Maybe [VisualCustomAction]
$sel:visualId:PieChartVisual' :: PieChartVisual -> Text
$sel:title:PieChartVisual' :: PieChartVisual -> Maybe VisualTitleLabelOptions
$sel:subtitle:PieChartVisual' :: PieChartVisual -> Maybe VisualSubtitleLabelOptions
$sel:columnHierarchies:PieChartVisual' :: PieChartVisual -> Maybe [ColumnHierarchy]
$sel:chartConfiguration:PieChartVisual' :: PieChartVisual -> Maybe PieChartConfiguration
$sel:actions:PieChartVisual' :: PieChartVisual -> Maybe [VisualCustomAction]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Actions" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [VisualCustomAction]
actions,
            (Key
"ChartConfiguration" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe PieChartConfiguration
chartConfiguration,
            (Key
"ColumnHierarchies" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [ColumnHierarchy]
columnHierarchies,
            (Key
"Subtitle" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe VisualSubtitleLabelOptions
subtitle,
            (Key
"Title" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe VisualTitleLabelOptions
title,
            forall a. a -> Maybe a
Prelude.Just (Key
"VisualId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
visualId)
          ]
      )