{-# 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.GridLayoutElement
-- 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.GridLayoutElement 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.LayoutElementType

-- | An element within a grid layout.
--
-- /See:/ 'newGridLayoutElement' smart constructor.
data GridLayoutElement = GridLayoutElement'
  { -- | The column index for the upper left corner of an element.
    GridLayoutElement -> Maybe Natural
columnIndex :: Prelude.Maybe Prelude.Natural,
    -- | The row index for the upper left corner of an element.
    GridLayoutElement -> Maybe Natural
rowIndex :: Prelude.Maybe Prelude.Natural,
    -- | A unique identifier for an element within a grid layout.
    GridLayoutElement -> Text
elementId :: Prelude.Text,
    -- | The type of element.
    GridLayoutElement -> LayoutElementType
elementType :: LayoutElementType,
    -- | The width of a grid element expressed as a number of grid columns.
    GridLayoutElement -> Natural
columnSpan :: Prelude.Natural,
    -- | The height of a grid element expressed as a number of grid rows.
    GridLayoutElement -> Natural
rowSpan :: Prelude.Natural
  }
  deriving (GridLayoutElement -> GridLayoutElement -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GridLayoutElement -> GridLayoutElement -> Bool
$c/= :: GridLayoutElement -> GridLayoutElement -> Bool
== :: GridLayoutElement -> GridLayoutElement -> Bool
$c== :: GridLayoutElement -> GridLayoutElement -> Bool
Prelude.Eq, ReadPrec [GridLayoutElement]
ReadPrec GridLayoutElement
Int -> ReadS GridLayoutElement
ReadS [GridLayoutElement]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GridLayoutElement]
$creadListPrec :: ReadPrec [GridLayoutElement]
readPrec :: ReadPrec GridLayoutElement
$creadPrec :: ReadPrec GridLayoutElement
readList :: ReadS [GridLayoutElement]
$creadList :: ReadS [GridLayoutElement]
readsPrec :: Int -> ReadS GridLayoutElement
$creadsPrec :: Int -> ReadS GridLayoutElement
Prelude.Read, Int -> GridLayoutElement -> ShowS
[GridLayoutElement] -> ShowS
GridLayoutElement -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GridLayoutElement] -> ShowS
$cshowList :: [GridLayoutElement] -> ShowS
show :: GridLayoutElement -> String
$cshow :: GridLayoutElement -> String
showsPrec :: Int -> GridLayoutElement -> ShowS
$cshowsPrec :: Int -> GridLayoutElement -> ShowS
Prelude.Show, forall x. Rep GridLayoutElement x -> GridLayoutElement
forall x. GridLayoutElement -> Rep GridLayoutElement x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GridLayoutElement x -> GridLayoutElement
$cfrom :: forall x. GridLayoutElement -> Rep GridLayoutElement x
Prelude.Generic)

-- |
-- Create a value of 'GridLayoutElement' 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:
--
-- 'columnIndex', 'gridLayoutElement_columnIndex' - The column index for the upper left corner of an element.
--
-- 'rowIndex', 'gridLayoutElement_rowIndex' - The row index for the upper left corner of an element.
--
-- 'elementId', 'gridLayoutElement_elementId' - A unique identifier for an element within a grid layout.
--
-- 'elementType', 'gridLayoutElement_elementType' - The type of element.
--
-- 'columnSpan', 'gridLayoutElement_columnSpan' - The width of a grid element expressed as a number of grid columns.
--
-- 'rowSpan', 'gridLayoutElement_rowSpan' - The height of a grid element expressed as a number of grid rows.
newGridLayoutElement ::
  -- | 'elementId'
  Prelude.Text ->
  -- | 'elementType'
  LayoutElementType ->
  -- | 'columnSpan'
  Prelude.Natural ->
  -- | 'rowSpan'
  Prelude.Natural ->
  GridLayoutElement
newGridLayoutElement :: Text
-> LayoutElementType -> Natural -> Natural -> GridLayoutElement
newGridLayoutElement
  Text
pElementId_
  LayoutElementType
pElementType_
  Natural
pColumnSpan_
  Natural
pRowSpan_ =
    GridLayoutElement'
      { $sel:columnIndex:GridLayoutElement' :: Maybe Natural
columnIndex = forall a. Maybe a
Prelude.Nothing,
        $sel:rowIndex:GridLayoutElement' :: Maybe Natural
rowIndex = forall a. Maybe a
Prelude.Nothing,
        $sel:elementId:GridLayoutElement' :: Text
elementId = Text
pElementId_,
        $sel:elementType:GridLayoutElement' :: LayoutElementType
elementType = LayoutElementType
pElementType_,
        $sel:columnSpan:GridLayoutElement' :: Natural
columnSpan = Natural
pColumnSpan_,
        $sel:rowSpan:GridLayoutElement' :: Natural
rowSpan = Natural
pRowSpan_
      }

-- | The column index for the upper left corner of an element.
gridLayoutElement_columnIndex :: Lens.Lens' GridLayoutElement (Prelude.Maybe Prelude.Natural)
gridLayoutElement_columnIndex :: Lens' GridLayoutElement (Maybe Natural)
gridLayoutElement_columnIndex = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GridLayoutElement' {Maybe Natural
columnIndex :: Maybe Natural
$sel:columnIndex:GridLayoutElement' :: GridLayoutElement -> Maybe Natural
columnIndex} -> Maybe Natural
columnIndex) (\s :: GridLayoutElement
s@GridLayoutElement' {} Maybe Natural
a -> GridLayoutElement
s {$sel:columnIndex:GridLayoutElement' :: Maybe Natural
columnIndex = Maybe Natural
a} :: GridLayoutElement)

-- | The row index for the upper left corner of an element.
gridLayoutElement_rowIndex :: Lens.Lens' GridLayoutElement (Prelude.Maybe Prelude.Natural)
gridLayoutElement_rowIndex :: Lens' GridLayoutElement (Maybe Natural)
gridLayoutElement_rowIndex = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GridLayoutElement' {Maybe Natural
rowIndex :: Maybe Natural
$sel:rowIndex:GridLayoutElement' :: GridLayoutElement -> Maybe Natural
rowIndex} -> Maybe Natural
rowIndex) (\s :: GridLayoutElement
s@GridLayoutElement' {} Maybe Natural
a -> GridLayoutElement
s {$sel:rowIndex:GridLayoutElement' :: Maybe Natural
rowIndex = Maybe Natural
a} :: GridLayoutElement)

-- | A unique identifier for an element within a grid layout.
gridLayoutElement_elementId :: Lens.Lens' GridLayoutElement Prelude.Text
gridLayoutElement_elementId :: Lens' GridLayoutElement Text
gridLayoutElement_elementId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GridLayoutElement' {Text
elementId :: Text
$sel:elementId:GridLayoutElement' :: GridLayoutElement -> Text
elementId} -> Text
elementId) (\s :: GridLayoutElement
s@GridLayoutElement' {} Text
a -> GridLayoutElement
s {$sel:elementId:GridLayoutElement' :: Text
elementId = Text
a} :: GridLayoutElement)

-- | The type of element.
gridLayoutElement_elementType :: Lens.Lens' GridLayoutElement LayoutElementType
gridLayoutElement_elementType :: Lens' GridLayoutElement LayoutElementType
gridLayoutElement_elementType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GridLayoutElement' {LayoutElementType
elementType :: LayoutElementType
$sel:elementType:GridLayoutElement' :: GridLayoutElement -> LayoutElementType
elementType} -> LayoutElementType
elementType) (\s :: GridLayoutElement
s@GridLayoutElement' {} LayoutElementType
a -> GridLayoutElement
s {$sel:elementType:GridLayoutElement' :: LayoutElementType
elementType = LayoutElementType
a} :: GridLayoutElement)

-- | The width of a grid element expressed as a number of grid columns.
gridLayoutElement_columnSpan :: Lens.Lens' GridLayoutElement Prelude.Natural
gridLayoutElement_columnSpan :: Lens' GridLayoutElement Natural
gridLayoutElement_columnSpan = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GridLayoutElement' {Natural
columnSpan :: Natural
$sel:columnSpan:GridLayoutElement' :: GridLayoutElement -> Natural
columnSpan} -> Natural
columnSpan) (\s :: GridLayoutElement
s@GridLayoutElement' {} Natural
a -> GridLayoutElement
s {$sel:columnSpan:GridLayoutElement' :: Natural
columnSpan = Natural
a} :: GridLayoutElement)

-- | The height of a grid element expressed as a number of grid rows.
gridLayoutElement_rowSpan :: Lens.Lens' GridLayoutElement Prelude.Natural
gridLayoutElement_rowSpan :: Lens' GridLayoutElement Natural
gridLayoutElement_rowSpan = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GridLayoutElement' {Natural
rowSpan :: Natural
$sel:rowSpan:GridLayoutElement' :: GridLayoutElement -> Natural
rowSpan} -> Natural
rowSpan) (\s :: GridLayoutElement
s@GridLayoutElement' {} Natural
a -> GridLayoutElement
s {$sel:rowSpan:GridLayoutElement' :: Natural
rowSpan = Natural
a} :: GridLayoutElement)

instance Data.FromJSON GridLayoutElement where
  parseJSON :: Value -> Parser GridLayoutElement
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"GridLayoutElement"
      ( \Object
x ->
          Maybe Natural
-> Maybe Natural
-> Text
-> LayoutElementType
-> Natural
-> Natural
-> GridLayoutElement
GridLayoutElement'
            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
"ColumnIndex")
            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
"RowIndex")
            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
"ElementId")
            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
"ElementType")
            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
"ColumnSpan")
            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
"RowSpan")
      )

instance Prelude.Hashable GridLayoutElement where
  hashWithSalt :: Int -> GridLayoutElement -> Int
hashWithSalt Int
_salt GridLayoutElement' {Natural
Maybe Natural
Text
LayoutElementType
rowSpan :: Natural
columnSpan :: Natural
elementType :: LayoutElementType
elementId :: Text
rowIndex :: Maybe Natural
columnIndex :: Maybe Natural
$sel:rowSpan:GridLayoutElement' :: GridLayoutElement -> Natural
$sel:columnSpan:GridLayoutElement' :: GridLayoutElement -> Natural
$sel:elementType:GridLayoutElement' :: GridLayoutElement -> LayoutElementType
$sel:elementId:GridLayoutElement' :: GridLayoutElement -> Text
$sel:rowIndex:GridLayoutElement' :: GridLayoutElement -> Maybe Natural
$sel:columnIndex:GridLayoutElement' :: GridLayoutElement -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
columnIndex
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
rowIndex
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
elementId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` LayoutElementType
elementType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Natural
columnSpan
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Natural
rowSpan

instance Prelude.NFData GridLayoutElement where
  rnf :: GridLayoutElement -> ()
rnf GridLayoutElement' {Natural
Maybe Natural
Text
LayoutElementType
rowSpan :: Natural
columnSpan :: Natural
elementType :: LayoutElementType
elementId :: Text
rowIndex :: Maybe Natural
columnIndex :: Maybe Natural
$sel:rowSpan:GridLayoutElement' :: GridLayoutElement -> Natural
$sel:columnSpan:GridLayoutElement' :: GridLayoutElement -> Natural
$sel:elementType:GridLayoutElement' :: GridLayoutElement -> LayoutElementType
$sel:elementId:GridLayoutElement' :: GridLayoutElement -> Text
$sel:rowIndex:GridLayoutElement' :: GridLayoutElement -> Maybe Natural
$sel:columnIndex:GridLayoutElement' :: GridLayoutElement -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
columnIndex
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
rowIndex
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
elementId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf LayoutElementType
elementType
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Natural
columnSpan
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Natural
rowSpan

instance Data.ToJSON GridLayoutElement where
  toJSON :: GridLayoutElement -> Value
toJSON GridLayoutElement' {Natural
Maybe Natural
Text
LayoutElementType
rowSpan :: Natural
columnSpan :: Natural
elementType :: LayoutElementType
elementId :: Text
rowIndex :: Maybe Natural
columnIndex :: Maybe Natural
$sel:rowSpan:GridLayoutElement' :: GridLayoutElement -> Natural
$sel:columnSpan:GridLayoutElement' :: GridLayoutElement -> Natural
$sel:elementType:GridLayoutElement' :: GridLayoutElement -> LayoutElementType
$sel:elementId:GridLayoutElement' :: GridLayoutElement -> Text
$sel:rowIndex:GridLayoutElement' :: GridLayoutElement -> Maybe Natural
$sel:columnIndex:GridLayoutElement' :: GridLayoutElement -> Maybe Natural
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"ColumnIndex" 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 Natural
columnIndex,
            (Key
"RowIndex" 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 Natural
rowIndex,
            forall a. a -> Maybe a
Prelude.Just (Key
"ElementId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
elementId),
            forall a. a -> Maybe a
Prelude.Just (Key
"ElementType" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= LayoutElementType
elementType),
            forall a. a -> Maybe a
Prelude.Just (Key
"ColumnSpan" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Natural
columnSpan),
            forall a. a -> Maybe a
Prelude.Just (Key
"RowSpan" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Natural
rowSpan)
          ]
      )