{-# 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.ScatterPlotVisual
-- 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.ScatterPlotVisual 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.ScatterPlotConfiguration
import Amazonka.QuickSight.Types.VisualCustomAction
import Amazonka.QuickSight.Types.VisualSubtitleLabelOptions
import Amazonka.QuickSight.Types.VisualTitleLabelOptions

-- | A scatter plot.
--
-- For more information, see
-- <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html Using scatter plots>
-- in the /Amazon QuickSight User Guide/.
--
-- /See:/ 'newScatterPlotVisual' smart constructor.
data ScatterPlotVisual = ScatterPlotVisual'
  { -- | The list of custom actions that are configured for a visual.
    ScatterPlotVisual -> Maybe [VisualCustomAction]
actions :: Prelude.Maybe [VisualCustomAction],
    -- | The configuration settings of the visual.
    ScatterPlotVisual -> Maybe ScatterPlotConfiguration
chartConfiguration :: Prelude.Maybe ScatterPlotConfiguration,
    -- | The column hierarchy that is used during drill-downs and drill-ups.
    ScatterPlotVisual -> Maybe [ColumnHierarchy]
columnHierarchies :: Prelude.Maybe [ColumnHierarchy],
    -- | The subtitle that is displayed on the visual.
    ScatterPlotVisual -> Maybe VisualSubtitleLabelOptions
subtitle :: Prelude.Maybe VisualSubtitleLabelOptions,
    -- | The title that is displayed on the visual.
    ScatterPlotVisual -> 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.
    ScatterPlotVisual -> Text
visualId :: Prelude.Text
  }
  deriving (ScatterPlotVisual -> ScatterPlotVisual -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ScatterPlotVisual -> ScatterPlotVisual -> Bool
$c/= :: ScatterPlotVisual -> ScatterPlotVisual -> Bool
== :: ScatterPlotVisual -> ScatterPlotVisual -> Bool
$c== :: ScatterPlotVisual -> ScatterPlotVisual -> Bool
Prelude.Eq, Int -> ScatterPlotVisual -> ShowS
[ScatterPlotVisual] -> ShowS
ScatterPlotVisual -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ScatterPlotVisual] -> ShowS
$cshowList :: [ScatterPlotVisual] -> ShowS
show :: ScatterPlotVisual -> String
$cshow :: ScatterPlotVisual -> String
showsPrec :: Int -> ScatterPlotVisual -> ShowS
$cshowsPrec :: Int -> ScatterPlotVisual -> ShowS
Prelude.Show, forall x. Rep ScatterPlotVisual x -> ScatterPlotVisual
forall x. ScatterPlotVisual -> Rep ScatterPlotVisual x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ScatterPlotVisual x -> ScatterPlotVisual
$cfrom :: forall x. ScatterPlotVisual -> Rep ScatterPlotVisual x
Prelude.Generic)

-- |
-- Create a value of 'ScatterPlotVisual' 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', 'scatterPlotVisual_actions' - The list of custom actions that are configured for a visual.
--
-- 'chartConfiguration', 'scatterPlotVisual_chartConfiguration' - The configuration settings of the visual.
--
-- 'columnHierarchies', 'scatterPlotVisual_columnHierarchies' - The column hierarchy that is used during drill-downs and drill-ups.
--
-- 'subtitle', 'scatterPlotVisual_subtitle' - The subtitle that is displayed on the visual.
--
-- 'title', 'scatterPlotVisual_title' - The title that is displayed on the visual.
--
-- 'visualId', 'scatterPlotVisual_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.
newScatterPlotVisual ::
  -- | 'visualId'
  Prelude.Text ->
  ScatterPlotVisual
newScatterPlotVisual :: Text -> ScatterPlotVisual
newScatterPlotVisual Text
pVisualId_ =
  ScatterPlotVisual'
    { $sel:actions:ScatterPlotVisual' :: Maybe [VisualCustomAction]
actions = forall a. Maybe a
Prelude.Nothing,
      $sel:chartConfiguration:ScatterPlotVisual' :: Maybe ScatterPlotConfiguration
chartConfiguration = forall a. Maybe a
Prelude.Nothing,
      $sel:columnHierarchies:ScatterPlotVisual' :: Maybe [ColumnHierarchy]
columnHierarchies = forall a. Maybe a
Prelude.Nothing,
      $sel:subtitle:ScatterPlotVisual' :: Maybe VisualSubtitleLabelOptions
subtitle = forall a. Maybe a
Prelude.Nothing,
      $sel:title:ScatterPlotVisual' :: Maybe VisualTitleLabelOptions
title = forall a. Maybe a
Prelude.Nothing,
      $sel:visualId:ScatterPlotVisual' :: Text
visualId = Text
pVisualId_
    }

-- | The list of custom actions that are configured for a visual.
scatterPlotVisual_actions :: Lens.Lens' ScatterPlotVisual (Prelude.Maybe [VisualCustomAction])
scatterPlotVisual_actions :: Lens' ScatterPlotVisual (Maybe [VisualCustomAction])
scatterPlotVisual_actions = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScatterPlotVisual' {Maybe [VisualCustomAction]
actions :: Maybe [VisualCustomAction]
$sel:actions:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe [VisualCustomAction]
actions} -> Maybe [VisualCustomAction]
actions) (\s :: ScatterPlotVisual
s@ScatterPlotVisual' {} Maybe [VisualCustomAction]
a -> ScatterPlotVisual
s {$sel:actions:ScatterPlotVisual' :: Maybe [VisualCustomAction]
actions = Maybe [VisualCustomAction]
a} :: ScatterPlotVisual) 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 settings of the visual.
scatterPlotVisual_chartConfiguration :: Lens.Lens' ScatterPlotVisual (Prelude.Maybe ScatterPlotConfiguration)
scatterPlotVisual_chartConfiguration :: Lens' ScatterPlotVisual (Maybe ScatterPlotConfiguration)
scatterPlotVisual_chartConfiguration = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScatterPlotVisual' {Maybe ScatterPlotConfiguration
chartConfiguration :: Maybe ScatterPlotConfiguration
$sel:chartConfiguration:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe ScatterPlotConfiguration
chartConfiguration} -> Maybe ScatterPlotConfiguration
chartConfiguration) (\s :: ScatterPlotVisual
s@ScatterPlotVisual' {} Maybe ScatterPlotConfiguration
a -> ScatterPlotVisual
s {$sel:chartConfiguration:ScatterPlotVisual' :: Maybe ScatterPlotConfiguration
chartConfiguration = Maybe ScatterPlotConfiguration
a} :: ScatterPlotVisual)

-- | The column hierarchy that is used during drill-downs and drill-ups.
scatterPlotVisual_columnHierarchies :: Lens.Lens' ScatterPlotVisual (Prelude.Maybe [ColumnHierarchy])
scatterPlotVisual_columnHierarchies :: Lens' ScatterPlotVisual (Maybe [ColumnHierarchy])
scatterPlotVisual_columnHierarchies = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScatterPlotVisual' {Maybe [ColumnHierarchy]
columnHierarchies :: Maybe [ColumnHierarchy]
$sel:columnHierarchies:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe [ColumnHierarchy]
columnHierarchies} -> Maybe [ColumnHierarchy]
columnHierarchies) (\s :: ScatterPlotVisual
s@ScatterPlotVisual' {} Maybe [ColumnHierarchy]
a -> ScatterPlotVisual
s {$sel:columnHierarchies:ScatterPlotVisual' :: Maybe [ColumnHierarchy]
columnHierarchies = Maybe [ColumnHierarchy]
a} :: ScatterPlotVisual) 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.
scatterPlotVisual_subtitle :: Lens.Lens' ScatterPlotVisual (Prelude.Maybe VisualSubtitleLabelOptions)
scatterPlotVisual_subtitle :: Lens' ScatterPlotVisual (Maybe VisualSubtitleLabelOptions)
scatterPlotVisual_subtitle = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScatterPlotVisual' {Maybe VisualSubtitleLabelOptions
subtitle :: Maybe VisualSubtitleLabelOptions
$sel:subtitle:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe VisualSubtitleLabelOptions
subtitle} -> Maybe VisualSubtitleLabelOptions
subtitle) (\s :: ScatterPlotVisual
s@ScatterPlotVisual' {} Maybe VisualSubtitleLabelOptions
a -> ScatterPlotVisual
s {$sel:subtitle:ScatterPlotVisual' :: Maybe VisualSubtitleLabelOptions
subtitle = Maybe VisualSubtitleLabelOptions
a} :: ScatterPlotVisual)

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

-- | 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.
scatterPlotVisual_visualId :: Lens.Lens' ScatterPlotVisual Prelude.Text
scatterPlotVisual_visualId :: Lens' ScatterPlotVisual Text
scatterPlotVisual_visualId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScatterPlotVisual' {Text
visualId :: Text
$sel:visualId:ScatterPlotVisual' :: ScatterPlotVisual -> Text
visualId} -> Text
visualId) (\s :: ScatterPlotVisual
s@ScatterPlotVisual' {} Text
a -> ScatterPlotVisual
s {$sel:visualId:ScatterPlotVisual' :: Text
visualId = Text
a} :: ScatterPlotVisual)

instance Data.FromJSON ScatterPlotVisual where
  parseJSON :: Value -> Parser ScatterPlotVisual
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ScatterPlotVisual"
      ( \Object
x ->
          Maybe [VisualCustomAction]
-> Maybe ScatterPlotConfiguration
-> Maybe [ColumnHierarchy]
-> Maybe VisualSubtitleLabelOptions
-> Maybe VisualTitleLabelOptions
-> Text
-> ScatterPlotVisual
ScatterPlotVisual'
            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 ScatterPlotVisual where
  hashWithSalt :: Int -> ScatterPlotVisual -> Int
hashWithSalt Int
_salt ScatterPlotVisual' {Maybe [ColumnHierarchy]
Maybe [VisualCustomAction]
Maybe ScatterPlotConfiguration
Maybe VisualSubtitleLabelOptions
Maybe VisualTitleLabelOptions
Text
visualId :: Text
title :: Maybe VisualTitleLabelOptions
subtitle :: Maybe VisualSubtitleLabelOptions
columnHierarchies :: Maybe [ColumnHierarchy]
chartConfiguration :: Maybe ScatterPlotConfiguration
actions :: Maybe [VisualCustomAction]
$sel:visualId:ScatterPlotVisual' :: ScatterPlotVisual -> Text
$sel:title:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe VisualTitleLabelOptions
$sel:subtitle:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe VisualSubtitleLabelOptions
$sel:columnHierarchies:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe [ColumnHierarchy]
$sel:chartConfiguration:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe ScatterPlotConfiguration
$sel:actions:ScatterPlotVisual' :: ScatterPlotVisual -> 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 ScatterPlotConfiguration
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 ScatterPlotVisual where
  rnf :: ScatterPlotVisual -> ()
rnf ScatterPlotVisual' {Maybe [ColumnHierarchy]
Maybe [VisualCustomAction]
Maybe ScatterPlotConfiguration
Maybe VisualSubtitleLabelOptions
Maybe VisualTitleLabelOptions
Text
visualId :: Text
title :: Maybe VisualTitleLabelOptions
subtitle :: Maybe VisualSubtitleLabelOptions
columnHierarchies :: Maybe [ColumnHierarchy]
chartConfiguration :: Maybe ScatterPlotConfiguration
actions :: Maybe [VisualCustomAction]
$sel:visualId:ScatterPlotVisual' :: ScatterPlotVisual -> Text
$sel:title:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe VisualTitleLabelOptions
$sel:subtitle:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe VisualSubtitleLabelOptions
$sel:columnHierarchies:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe [ColumnHierarchy]
$sel:chartConfiguration:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe ScatterPlotConfiguration
$sel:actions:ScatterPlotVisual' :: ScatterPlotVisual -> 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 ScatterPlotConfiguration
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 ScatterPlotVisual where
  toJSON :: ScatterPlotVisual -> Value
toJSON ScatterPlotVisual' {Maybe [ColumnHierarchy]
Maybe [VisualCustomAction]
Maybe ScatterPlotConfiguration
Maybe VisualSubtitleLabelOptions
Maybe VisualTitleLabelOptions
Text
visualId :: Text
title :: Maybe VisualTitleLabelOptions
subtitle :: Maybe VisualSubtitleLabelOptions
columnHierarchies :: Maybe [ColumnHierarchy]
chartConfiguration :: Maybe ScatterPlotConfiguration
actions :: Maybe [VisualCustomAction]
$sel:visualId:ScatterPlotVisual' :: ScatterPlotVisual -> Text
$sel:title:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe VisualTitleLabelOptions
$sel:subtitle:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe VisualSubtitleLabelOptions
$sel:columnHierarchies:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe [ColumnHierarchy]
$sel:chartConfiguration:ScatterPlotVisual' :: ScatterPlotVisual -> Maybe ScatterPlotConfiguration
$sel:actions:ScatterPlotVisual' :: ScatterPlotVisual -> 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 ScatterPlotConfiguration
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)
          ]
      )