{-# 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.GridLayoutConfiguration
-- 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.GridLayoutConfiguration 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.GridLayoutCanvasSizeOptions
import Amazonka.QuickSight.Types.GridLayoutElement

-- | The configuration for a grid layout. Also called a tiled layout.
--
-- Visuals snap to a grid with standard spacing and alignment. Dashboards
-- are displayed as designed, with options to fit to screen or view at
-- actual size.
--
-- /See:/ 'newGridLayoutConfiguration' smart constructor.
data GridLayoutConfiguration = GridLayoutConfiguration'
  { GridLayoutConfiguration -> Maybe GridLayoutCanvasSizeOptions
canvasSizeOptions :: Prelude.Maybe GridLayoutCanvasSizeOptions,
    -- | The elements that are included in a grid layout.
    GridLayoutConfiguration -> [GridLayoutElement]
elements :: [GridLayoutElement]
  }
  deriving (GridLayoutConfiguration -> GridLayoutConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GridLayoutConfiguration -> GridLayoutConfiguration -> Bool
$c/= :: GridLayoutConfiguration -> GridLayoutConfiguration -> Bool
== :: GridLayoutConfiguration -> GridLayoutConfiguration -> Bool
$c== :: GridLayoutConfiguration -> GridLayoutConfiguration -> Bool
Prelude.Eq, ReadPrec [GridLayoutConfiguration]
ReadPrec GridLayoutConfiguration
Int -> ReadS GridLayoutConfiguration
ReadS [GridLayoutConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GridLayoutConfiguration]
$creadListPrec :: ReadPrec [GridLayoutConfiguration]
readPrec :: ReadPrec GridLayoutConfiguration
$creadPrec :: ReadPrec GridLayoutConfiguration
readList :: ReadS [GridLayoutConfiguration]
$creadList :: ReadS [GridLayoutConfiguration]
readsPrec :: Int -> ReadS GridLayoutConfiguration
$creadsPrec :: Int -> ReadS GridLayoutConfiguration
Prelude.Read, Int -> GridLayoutConfiguration -> ShowS
[GridLayoutConfiguration] -> ShowS
GridLayoutConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GridLayoutConfiguration] -> ShowS
$cshowList :: [GridLayoutConfiguration] -> ShowS
show :: GridLayoutConfiguration -> String
$cshow :: GridLayoutConfiguration -> String
showsPrec :: Int -> GridLayoutConfiguration -> ShowS
$cshowsPrec :: Int -> GridLayoutConfiguration -> ShowS
Prelude.Show, forall x. Rep GridLayoutConfiguration x -> GridLayoutConfiguration
forall x. GridLayoutConfiguration -> Rep GridLayoutConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GridLayoutConfiguration x -> GridLayoutConfiguration
$cfrom :: forall x. GridLayoutConfiguration -> Rep GridLayoutConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'GridLayoutConfiguration' 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:
--
-- 'canvasSizeOptions', 'gridLayoutConfiguration_canvasSizeOptions' - Undocumented member.
--
-- 'elements', 'gridLayoutConfiguration_elements' - The elements that are included in a grid layout.
newGridLayoutConfiguration ::
  GridLayoutConfiguration
newGridLayoutConfiguration :: GridLayoutConfiguration
newGridLayoutConfiguration =
  GridLayoutConfiguration'
    { $sel:canvasSizeOptions:GridLayoutConfiguration' :: Maybe GridLayoutCanvasSizeOptions
canvasSizeOptions =
        forall a. Maybe a
Prelude.Nothing,
      $sel:elements:GridLayoutConfiguration' :: [GridLayoutElement]
elements = forall a. Monoid a => a
Prelude.mempty
    }

-- | Undocumented member.
gridLayoutConfiguration_canvasSizeOptions :: Lens.Lens' GridLayoutConfiguration (Prelude.Maybe GridLayoutCanvasSizeOptions)
gridLayoutConfiguration_canvasSizeOptions :: Lens' GridLayoutConfiguration (Maybe GridLayoutCanvasSizeOptions)
gridLayoutConfiguration_canvasSizeOptions = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GridLayoutConfiguration' {Maybe GridLayoutCanvasSizeOptions
canvasSizeOptions :: Maybe GridLayoutCanvasSizeOptions
$sel:canvasSizeOptions:GridLayoutConfiguration' :: GridLayoutConfiguration -> Maybe GridLayoutCanvasSizeOptions
canvasSizeOptions} -> Maybe GridLayoutCanvasSizeOptions
canvasSizeOptions) (\s :: GridLayoutConfiguration
s@GridLayoutConfiguration' {} Maybe GridLayoutCanvasSizeOptions
a -> GridLayoutConfiguration
s {$sel:canvasSizeOptions:GridLayoutConfiguration' :: Maybe GridLayoutCanvasSizeOptions
canvasSizeOptions = Maybe GridLayoutCanvasSizeOptions
a} :: GridLayoutConfiguration)

-- | The elements that are included in a grid layout.
gridLayoutConfiguration_elements :: Lens.Lens' GridLayoutConfiguration [GridLayoutElement]
gridLayoutConfiguration_elements :: Lens' GridLayoutConfiguration [GridLayoutElement]
gridLayoutConfiguration_elements = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GridLayoutConfiguration' {[GridLayoutElement]
elements :: [GridLayoutElement]
$sel:elements:GridLayoutConfiguration' :: GridLayoutConfiguration -> [GridLayoutElement]
elements} -> [GridLayoutElement]
elements) (\s :: GridLayoutConfiguration
s@GridLayoutConfiguration' {} [GridLayoutElement]
a -> GridLayoutConfiguration
s {$sel:elements:GridLayoutConfiguration' :: [GridLayoutElement]
elements = [GridLayoutElement]
a} :: GridLayoutConfiguration) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Data.FromJSON GridLayoutConfiguration where
  parseJSON :: Value -> Parser GridLayoutConfiguration
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"GridLayoutConfiguration"
      ( \Object
x ->
          Maybe GridLayoutCanvasSizeOptions
-> [GridLayoutElement] -> GridLayoutConfiguration
GridLayoutConfiguration'
            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
"CanvasSizeOptions")
            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
"Elements" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
      )

instance Prelude.Hashable GridLayoutConfiguration where
  hashWithSalt :: Int -> GridLayoutConfiguration -> Int
hashWithSalt Int
_salt GridLayoutConfiguration' {[GridLayoutElement]
Maybe GridLayoutCanvasSizeOptions
elements :: [GridLayoutElement]
canvasSizeOptions :: Maybe GridLayoutCanvasSizeOptions
$sel:elements:GridLayoutConfiguration' :: GridLayoutConfiguration -> [GridLayoutElement]
$sel:canvasSizeOptions:GridLayoutConfiguration' :: GridLayoutConfiguration -> Maybe GridLayoutCanvasSizeOptions
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe GridLayoutCanvasSizeOptions
canvasSizeOptions
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` [GridLayoutElement]
elements

instance Prelude.NFData GridLayoutConfiguration where
  rnf :: GridLayoutConfiguration -> ()
rnf GridLayoutConfiguration' {[GridLayoutElement]
Maybe GridLayoutCanvasSizeOptions
elements :: [GridLayoutElement]
canvasSizeOptions :: Maybe GridLayoutCanvasSizeOptions
$sel:elements:GridLayoutConfiguration' :: GridLayoutConfiguration -> [GridLayoutElement]
$sel:canvasSizeOptions:GridLayoutConfiguration' :: GridLayoutConfiguration -> Maybe GridLayoutCanvasSizeOptions
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe GridLayoutCanvasSizeOptions
canvasSizeOptions
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [GridLayoutElement]
elements

instance Data.ToJSON GridLayoutConfiguration where
  toJSON :: GridLayoutConfiguration -> Value
toJSON GridLayoutConfiguration' {[GridLayoutElement]
Maybe GridLayoutCanvasSizeOptions
elements :: [GridLayoutElement]
canvasSizeOptions :: Maybe GridLayoutCanvasSizeOptions
$sel:elements:GridLayoutConfiguration' :: GridLayoutConfiguration -> [GridLayoutElement]
$sel:canvasSizeOptions:GridLayoutConfiguration' :: GridLayoutConfiguration -> Maybe GridLayoutCanvasSizeOptions
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"CanvasSizeOptions" 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 GridLayoutCanvasSizeOptions
canvasSizeOptions,
            forall a. a -> Maybe a
Prelude.Just (Key
"Elements" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= [GridLayoutElement]
elements)
          ]
      )