Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.Types.KPIVisual

Description

Documentation

data KPIVisual Source #

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon QuickSight User Guide.

See: newKPIVisual smart constructor.

Constructors

KPIVisual'

Fields

actions :: Maybe [VisualCustomAction]
The list of custom actions that are configured for a visual.
chartConfiguration :: Maybe KPIConfiguration
The configuration of a KPI visual.
columnHierarchies :: Maybe [ColumnHierarchy]
The column hierarchy that is used during drill-downs and drill-ups.
conditionalFormatting :: Maybe KPIConditionalFormatting
The conditional formatting of a KPI visual.
subtitle :: Maybe VisualSubtitleLabelOptions
The subtitle that is displayed on the visual.
title :: Maybe VisualTitleLabelOptions
The title that is displayed on the visual.
visualId :: Text
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.

Instances

Instances details

FromJSON KPIVisual Source #
Instance details Defined in Amazonka.QuickSight.Types.KPIVisual Methods parseJSON :: Value -> Parser KPIVisual # parseJSONList :: Value -> Parser [KPIVisual] #
ToJSON KPIVisual Source #
Instance details Defined in Amazonka.QuickSight.Types.KPIVisual Methods toJSON :: KPIVisual -> Value # toEncoding :: KPIVisual -> Encoding # toJSONList :: [KPIVisual] -> Value # toEncodingList :: [KPIVisual] -> Encoding #
Generic KPIVisual Source #
Instance details Defined in Amazonka.QuickSight.Types.KPIVisual Associated Types type Rep KPIVisual :: Type -> Type # Methods from :: KPIVisual -> Rep KPIVisual x # to :: Rep KPIVisual x -> KPIVisual #
Show KPIVisual Source #
Instance details Defined in Amazonka.QuickSight.Types.KPIVisual Methods showsPrec :: Int -> KPIVisual -> ShowS # show :: KPIVisual -> String # showList :: [KPIVisual] -> ShowS #
NFData KPIVisual Source #
Instance details Defined in Amazonka.QuickSight.Types.KPIVisual Methods rnf :: KPIVisual -> () #
Eq KPIVisual Source #
Instance details Defined in Amazonka.QuickSight.Types.KPIVisual Methods (==) :: KPIVisual -> KPIVisual -> Bool # (/=) :: KPIVisual -> KPIVisual -> Bool #
Hashable KPIVisual Source #
Instance details Defined in Amazonka.QuickSight.Types.KPIVisual Methods hashWithSalt :: Int -> KPIVisual -> Int # hash :: KPIVisual -> Int #
type Rep KPIVisual Source #
Instance details Defined in Amazonka.QuickSight.Types.KPIVisual type Rep KPIVisual = D1 ('MetaData "KPIVisual" "Amazonka.QuickSight.Types.KPIVisual" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "KPIVisual'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VisualCustomAction])) :: (S1 ('MetaSel ('Just "chartConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KPIConfiguration)) :: S1 ('MetaSel ('Just "columnHierarchies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ColumnHierarchy])))) :: ((S1 ('MetaSel ('Just "conditionalFormatting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KPIConditionalFormatting)) :: S1 ('MetaSel ('Just "subtitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VisualSubtitleLabelOptions))) :: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VisualTitleLabelOptions)) :: S1 ('MetaSel ('Just "visualId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newKPIVisual Source #

Arguments

:: Text	`$sel:visualId:KPIVisual'`
-> KPIVisual

Create a value of KPIVisual with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:actions:KPIVisual', kPIVisual_actions - The list of custom actions that are configured for a visual.

$sel:chartConfiguration:KPIVisual', kPIVisual_chartConfiguration - The configuration of a KPI visual.

$sel:columnHierarchies:KPIVisual', kPIVisual_columnHierarchies - The column hierarchy that is used during drill-downs and drill-ups.

$sel:conditionalFormatting:KPIVisual', kPIVisual_conditionalFormatting - The conditional formatting of a KPI visual.

$sel:subtitle:KPIVisual', kPIVisual_subtitle - The subtitle that is displayed on the visual.

$sel:title:KPIVisual', kPIVisual_title - The title that is displayed on the visual.

$sel:visualId:KPIVisual', kPIVisual_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.

kPIVisual_actions :: Lens' KPIVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

kPIVisual_chartConfiguration :: Lens' KPIVisual (Maybe KPIConfiguration) Source #

The configuration of a KPI visual.

kPIVisual_columnHierarchies :: Lens' KPIVisual (Maybe [ColumnHierarchy]) Source #

The column hierarchy that is used during drill-downs and drill-ups.

kPIVisual_conditionalFormatting :: Lens' KPIVisual (Maybe KPIConditionalFormatting) Source #

The conditional formatting of a KPI visual.

kPIVisual_subtitle :: Lens' KPIVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

kPIVisual_title :: Lens' KPIVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

kPIVisual_visualId :: Lens' KPIVisual Text Source #

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.