Class CfnAnalysis.KPIOptionsProperty
The options that determine the presentation of a KPI visual.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class KPIOptionsProperty : Object, CfnAnalysis.IKPIOptionsProperty
Syntax (vb)
Public Class KPIOptionsProperty
Inherits Object
Implements CfnAnalysis.IKPIOptionsProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;
var kPIOptionsProperty = new KPIOptionsProperty {
Comparison = new ComparisonConfigurationProperty {
ComparisonFormat = new ComparisonFormatConfigurationProperty {
NumberDisplayFormatConfiguration = new NumberDisplayFormatConfigurationProperty {
DecimalPlacesConfiguration = new DecimalPlacesConfigurationProperty {
DecimalPlaces = 123
},
NegativeValueConfiguration = new NegativeValueConfigurationProperty {
DisplayMode = "displayMode"
},
NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
NullString = "nullString"
},
NumberScale = "numberScale",
Prefix = "prefix",
SeparatorConfiguration = new NumericSeparatorConfigurationProperty {
DecimalSeparator = "decimalSeparator",
ThousandsSeparator = new ThousandSeparatorOptionsProperty {
Symbol = "symbol",
Visibility = "visibility"
}
},
Suffix = "suffix"
},
PercentageDisplayFormatConfiguration = new PercentageDisplayFormatConfigurationProperty {
DecimalPlacesConfiguration = new DecimalPlacesConfigurationProperty {
DecimalPlaces = 123
},
NegativeValueConfiguration = new NegativeValueConfigurationProperty {
DisplayMode = "displayMode"
},
NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
NullString = "nullString"
},
Prefix = "prefix",
SeparatorConfiguration = new NumericSeparatorConfigurationProperty {
DecimalSeparator = "decimalSeparator",
ThousandsSeparator = new ThousandSeparatorOptionsProperty {
Symbol = "symbol",
Visibility = "visibility"
}
},
Suffix = "suffix"
}
},
ComparisonMethod = "comparisonMethod"
},
PrimaryValueDisplayType = "primaryValueDisplayType",
PrimaryValueFontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontSize = new FontSizeProperty {
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
ProgressBar = new ProgressBarOptionsProperty {
Visibility = "visibility"
},
SecondaryValue = new SecondaryValueOptionsProperty {
Visibility = "visibility"
},
SecondaryValueFontConfiguration = new FontConfigurationProperty {
FontColor = "fontColor",
FontDecoration = "fontDecoration",
FontSize = new FontSizeProperty {
Relative = "relative"
},
FontStyle = "fontStyle",
FontWeight = new FontWeightProperty {
Name = "name"
}
},
Sparkline = new KPISparklineOptionsProperty {
Type = "type",
// the properties below are optional
Color = "color",
TooltipVisibility = "tooltipVisibility",
Visibility = "visibility"
},
TrendArrows = new TrendArrowOptionsProperty {
Visibility = "visibility"
},
VisualLayoutOptions = new KPIVisualLayoutOptionsProperty {
StandardLayout = new KPIVisualStandardLayoutProperty {
Type = "type"
}
}
};
Synopsis
Constructors
KPIOptionsProperty() |
Properties
Comparison | The comparison configuration of a KPI visual. |
PrimaryValueDisplayType | The options that determine the primary value display type. |
PrimaryValueFontConfiguration | The options that determine the primary value font configuration. |
ProgressBar | The options that determine the presentation of the progress bar of a KPI visual. |
SecondaryValue | The options that determine the presentation of the secondary value of a KPI visual. |
SecondaryValueFontConfiguration | The options that determine the secondary value font configuration. |
Sparkline | The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual. |
TrendArrows | The options that determine the presentation of trend arrows in a KPI visual. |
VisualLayoutOptions | The options that determine the layout a KPI visual. |
Constructors
KPIOptionsProperty()
public KPIOptionsProperty()
Properties
Comparison
The comparison configuration of a KPI visual.
public object Comparison { get; set; }
Property Value
System.Object
Remarks
PrimaryValueDisplayType
The options that determine the primary value display type.
public string PrimaryValueDisplayType { get; set; }
Property Value
System.String
Remarks
PrimaryValueFontConfiguration
The options that determine the primary value font configuration.
public object PrimaryValueFontConfiguration { get; set; }
Property Value
System.Object
Remarks
ProgressBar
The options that determine the presentation of the progress bar of a KPI visual.
public object ProgressBar { get; set; }
Property Value
System.Object
Remarks
SecondaryValue
The options that determine the presentation of the secondary value of a KPI visual.
public object SecondaryValue { get; set; }
Property Value
System.Object
Remarks
SecondaryValueFontConfiguration
The options that determine the secondary value font configuration.
public object SecondaryValueFontConfiguration { get; set; }
Property Value
System.Object
Remarks
Sparkline
The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
public object Sparkline { get; set; }
Property Value
System.Object
Remarks
TrendArrows
The options that determine the presentation of trend arrows in a KPI visual.
public object TrendArrows { get; set; }
Property Value
System.Object
Remarks
VisualLayoutOptions
The options that determine the layout a KPI visual.
public object VisualLayoutOptions { get; set; }
Property Value
System.Object