Class CfnAnalysis.KPIVisualProperty
A key performance indicator (KPI).
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.AWS.QuickSight.dll
Syntax (csharp)
public class KPIVisualProperty : Object, CfnAnalysis.IKPIVisualProperty
Syntax (vb)
Public Class KPIVisualProperty
Inherits Object
Implements CfnAnalysis.IKPIVisualProperty
Remarks
For more information, see Using KPIs in the Amazon QuickSight User Guide .
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 kPIVisualProperty = new KPIVisualProperty {
VisualId = "visualId",
// the properties below are optional
Actions = new [] { new VisualCustomActionProperty {
ActionOperations = new [] { new VisualCustomActionOperationProperty {
FilterOperation = new CustomActionFilterOperationProperty {
SelectedFieldsConfiguration = new FilterOperationSelectedFieldsConfigurationProperty {
SelectedFieldOptions = "selectedFieldOptions",
SelectedFields = new [] { "selectedFields" }
},
TargetVisualsConfiguration = new FilterOperationTargetVisualsConfigurationProperty {
SameSheetTargetVisualConfiguration = new SameSheetTargetVisualConfigurationProperty {
TargetVisualOptions = "targetVisualOptions",
TargetVisuals = new [] { "targetVisuals" }
}
}
},
NavigationOperation = new CustomActionNavigationOperationProperty {
LocalNavigationConfiguration = new LocalNavigationConfigurationProperty {
TargetSheetId = "targetSheetId"
}
},
SetParametersOperation = new CustomActionSetParametersOperationProperty {
ParameterValueConfigurations = new [] { new SetParameterValueConfigurationProperty {
DestinationParameterName = "destinationParameterName",
Value = new DestinationParameterValueConfigurationProperty {
CustomValuesConfiguration = new CustomValuesConfigurationProperty {
CustomValues = new CustomParameterValuesProperty {
DateTimeValues = new [] { "dateTimeValues" },
DecimalValues = new [] { 123 },
IntegerValues = new [] { 123 },
StringValues = new [] { "stringValues" }
},
// the properties below are optional
IncludeNullValue = false
},
SelectAllValueOptions = "selectAllValueOptions",
SourceField = "sourceField",
SourceParameterName = "sourceParameterName"
}
} }
},
UrlOperation = new CustomActionURLOperationProperty {
UrlTarget = "urlTarget",
UrlTemplate = "urlTemplate"
}
} },
CustomActionId = "customActionId",
Name = "name",
Trigger = "trigger",
// the properties below are optional
Status = "status"
} },
ChartConfiguration = new KPIConfigurationProperty {
FieldWells = new KPIFieldWellsProperty {
TargetValues = new [] { new MeasureFieldProperty {
CalculatedMeasureField = new CalculatedMeasureFieldProperty {
Expression = "expression",
FieldId = "fieldId"
},
CategoricalMeasureField = new CategoricalMeasureFieldProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId",
// the properties below are optional
AggregationFunction = "aggregationFunction",
FormatConfiguration = new StringFormatConfigurationProperty {
NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
NullString = "nullString"
},
NumericFormatConfiguration = new NumericFormatConfigurationProperty {
CurrencyDisplayFormatConfiguration = new CurrencyDisplayFormatConfigurationProperty {
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",
Symbol = "symbol"
},
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"
}
}
}
},
DateMeasureField = new DateMeasureFieldProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId",
// the properties below are optional
AggregationFunction = "aggregationFunction",
FormatConfiguration = new DateTimeFormatConfigurationProperty {
DateTimeFormat = "dateTimeFormat",
NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
NullString = "nullString"
},
NumericFormatConfiguration = new NumericFormatConfigurationProperty {
CurrencyDisplayFormatConfiguration = new CurrencyDisplayFormatConfigurationProperty {
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",
Symbol = "symbol"
},
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"
}
}
}
},
NumericalMeasureField = new NumericalMeasureFieldProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId",
// the properties below are optional
AggregationFunction = new NumericalAggregationFunctionProperty {
PercentileAggregation = new PercentileAggregationProperty {
PercentileValue = 123
},
SimpleNumericalAggregation = "simpleNumericalAggregation"
},
FormatConfiguration = new NumberFormatConfigurationProperty {
FormatConfiguration = new NumericFormatConfigurationProperty {
CurrencyDisplayFormatConfiguration = new CurrencyDisplayFormatConfigurationProperty {
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",
Symbol = "symbol"
},
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"
}
}
}
}
} },
TrendGroups = new [] { new DimensionFieldProperty {
CategoricalDimensionField = new CategoricalDimensionFieldProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId",
// the properties below are optional
FormatConfiguration = new StringFormatConfigurationProperty {
NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
NullString = "nullString"
},
NumericFormatConfiguration = new NumericFormatConfigurationProperty {
CurrencyDisplayFormatConfiguration = new CurrencyDisplayFormatConfigurationProperty {
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",
Symbol = "symbol"
},
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"
}
}
},
HierarchyId = "hierarchyId"
},
DateDimensionField = new DateDimensionFieldProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId",
// the properties below are optional
DateGranularity = "dateGranularity",
FormatConfiguration = new DateTimeFormatConfigurationProperty {
DateTimeFormat = "dateTimeFormat",
NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
NullString = "nullString"
},
NumericFormatConfiguration = new NumericFormatConfigurationProperty {
CurrencyDisplayFormatConfiguration = new CurrencyDisplayFormatConfigurationProperty {
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",
Symbol = "symbol"
},
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"
}
}
},
HierarchyId = "hierarchyId"
},
NumericalDimensionField = new NumericalDimensionFieldProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId",
// the properties below are optional
FormatConfiguration = new NumberFormatConfigurationProperty {
FormatConfiguration = new NumericFormatConfigurationProperty {
CurrencyDisplayFormatConfiguration = new CurrencyDisplayFormatConfigurationProperty {
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",
Symbol = "symbol"
},
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"
}
}
},
HierarchyId = "hierarchyId"
}
} },
Values = new [] { new MeasureFieldProperty {
CalculatedMeasureField = new CalculatedMeasureFieldProperty {
Expression = "expression",
FieldId = "fieldId"
},
CategoricalMeasureField = new CategoricalMeasureFieldProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId",
// the properties below are optional
AggregationFunction = "aggregationFunction",
FormatConfiguration = new StringFormatConfigurationProperty {
NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
NullString = "nullString"
},
NumericFormatConfiguration = new NumericFormatConfigurationProperty {
CurrencyDisplayFormatConfiguration = new CurrencyDisplayFormatConfigurationProperty {
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",
Symbol = "symbol"
},
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"
}
}
}
},
DateMeasureField = new DateMeasureFieldProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId",
// the properties below are optional
AggregationFunction = "aggregationFunction",
FormatConfiguration = new DateTimeFormatConfigurationProperty {
DateTimeFormat = "dateTimeFormat",
NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
NullString = "nullString"
},
NumericFormatConfiguration = new NumericFormatConfigurationProperty {
CurrencyDisplayFormatConfiguration = new CurrencyDisplayFormatConfigurationProperty {
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",
Symbol = "symbol"
},
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"
}
}
}
},
NumericalMeasureField = new NumericalMeasureFieldProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
FieldId = "fieldId",
// the properties below are optional
AggregationFunction = new NumericalAggregationFunctionProperty {
PercentileAggregation = new PercentileAggregationProperty {
PercentileValue = 123
},
SimpleNumericalAggregation = "simpleNumericalAggregation"
},
FormatConfiguration = new NumberFormatConfigurationProperty {
FormatConfiguration = new NumericFormatConfigurationProperty {
CurrencyDisplayFormatConfiguration = new CurrencyDisplayFormatConfigurationProperty {
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",
Symbol = "symbol"
},
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"
}
}
}
}
} }
},
KpiOptions = 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"
}
},
TrendArrows = new TrendArrowOptionsProperty {
Visibility = "visibility"
}
},
SortConfiguration = new KPISortConfigurationProperty {
TrendGroupSort = new [] { new FieldSortOptionsProperty {
ColumnSort = new ColumnSortProperty {
Direction = "direction",
SortBy = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
// the properties below are optional
AggregationFunction = new AggregationFunctionProperty {
CategoricalAggregationFunction = "categoricalAggregationFunction",
DateAggregationFunction = "dateAggregationFunction",
NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
PercentileAggregation = new PercentileAggregationProperty {
PercentileValue = 123
},
SimpleNumericalAggregation = "simpleNumericalAggregation"
}
}
},
FieldSort = new FieldSortProperty {
Direction = "direction",
FieldId = "fieldId"
}
} }
}
},
ColumnHierarchies = new [] { new ColumnHierarchyProperty {
DateTimeHierarchy = new DateTimeHierarchyProperty {
HierarchyId = "hierarchyId",
// the properties below are optional
DrillDownFilters = new [] { new DrillDownFilterProperty {
CategoryFilter = new CategoryDrillDownFilterProperty {
CategoryValues = new [] { "categoryValues" },
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
}
},
NumericEqualityFilter = new NumericEqualityDrillDownFilterProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
Value = 123
},
TimeRangeFilter = new TimeRangeDrillDownFilterProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
RangeMaximum = "rangeMaximum",
RangeMinimum = "rangeMinimum",
TimeGranularity = "timeGranularity"
}
} }
},
ExplicitHierarchy = new ExplicitHierarchyProperty {
Columns = new [] { new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
} },
HierarchyId = "hierarchyId",
// the properties below are optional
DrillDownFilters = new [] { new DrillDownFilterProperty {
CategoryFilter = new CategoryDrillDownFilterProperty {
CategoryValues = new [] { "categoryValues" },
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
}
},
NumericEqualityFilter = new NumericEqualityDrillDownFilterProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
Value = 123
},
TimeRangeFilter = new TimeRangeDrillDownFilterProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
RangeMaximum = "rangeMaximum",
RangeMinimum = "rangeMinimum",
TimeGranularity = "timeGranularity"
}
} }
},
PredefinedHierarchy = new PredefinedHierarchyProperty {
Columns = new [] { new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
} },
HierarchyId = "hierarchyId",
// the properties below are optional
DrillDownFilters = new [] { new DrillDownFilterProperty {
CategoryFilter = new CategoryDrillDownFilterProperty {
CategoryValues = new [] { "categoryValues" },
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
}
},
NumericEqualityFilter = new NumericEqualityDrillDownFilterProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
Value = 123
},
TimeRangeFilter = new TimeRangeDrillDownFilterProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
DataSetIdentifier = "dataSetIdentifier"
},
RangeMaximum = "rangeMaximum",
RangeMinimum = "rangeMinimum",
TimeGranularity = "timeGranularity"
}
} }
}
} },
ConditionalFormatting = new KPIConditionalFormattingProperty {
ConditionalFormattingOptions = new [] { new KPIConditionalFormattingOptionProperty {
PrimaryValue = new KPIPrimaryValueConditionalFormattingProperty {
Icon = new ConditionalFormattingIconProperty {
CustomCondition = new ConditionalFormattingCustomIconConditionProperty {
Expression = "expression",
IconOptions = new ConditionalFormattingCustomIconOptionsProperty {
Icon = "icon",
UnicodeIcon = "unicodeIcon"
},
// the properties below are optional
Color = "color",
DisplayConfiguration = new ConditionalFormattingIconDisplayConfigurationProperty {
IconDisplayOption = "iconDisplayOption"
}
},
IconSet = new ConditionalFormattingIconSetProperty {
Expression = "expression",
// the properties below are optional
IconSetType = "iconSetType"
}
},
TextColor = new ConditionalFormattingColorProperty {
Gradient = new ConditionalFormattingGradientColorProperty {
Color = new GradientColorProperty {
Stops = new [] { new GradientStopProperty {
GradientOffset = 123,
// the properties below are optional
Color = "color",
DataValue = 123
} }
},
Expression = "expression"
},
Solid = new ConditionalFormattingSolidColorProperty {
Expression = "expression",
// the properties below are optional
Color = "color"
}
}
},
ProgressBar = new KPIProgressBarConditionalFormattingProperty {
ForegroundColor = new ConditionalFormattingColorProperty {
Gradient = new ConditionalFormattingGradientColorProperty {
Color = new GradientColorProperty {
Stops = new [] { new GradientStopProperty {
GradientOffset = 123,
// the properties below are optional
Color = "color",
DataValue = 123
} }
},
Expression = "expression"
},
Solid = new ConditionalFormattingSolidColorProperty {
Expression = "expression",
// the properties below are optional
Color = "color"
}
}
}
} }
},
Subtitle = new VisualSubtitleLabelOptionsProperty {
FormatText = new LongFormatTextProperty {
PlainText = "plainText",
RichText = "richText"
},
Visibility = "visibility"
},
Title = new VisualTitleLabelOptionsProperty {
FormatText = new ShortFormatTextProperty {
PlainText = "plainText",
RichText = "richText"
},
Visibility = "visibility"
}
};
Synopsis
Constructors
KPIVisualProperty() |
Properties
Actions | The list of custom actions that are configured for a visual. |
ChartConfiguration | The configuration of a KPI visual. |
ColumnHierarchies | The column hierarchy that is used during drill-downs and drill-ups. |
ConditionalFormatting | The conditional formatting of a KPI visual. |
Subtitle | The subtitle that is displayed on the visual. |
Title | The title that is displayed on the visual. |
VisualId | The unique identifier of a visual. |
Constructors
KPIVisualProperty()
public KPIVisualProperty()
Properties
Actions
The list of custom actions that are configured for a visual.
public object Actions { get; set; }
Property Value
System.Object
Remarks
ChartConfiguration
The configuration of a KPI visual.
public object ChartConfiguration { get; set; }
Property Value
System.Object
Remarks
ColumnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
public object ColumnHierarchies { get; set; }
Property Value
System.Object
Remarks
ConditionalFormatting
The conditional formatting of a KPI visual.
public object ConditionalFormatting { get; set; }
Property Value
System.Object
Remarks
Subtitle
The subtitle that is displayed on the visual.
public object Subtitle { get; set; }
Property Value
System.Object
Remarks
Title
The title that is displayed on the visual.
public object Title { get; set; }
Property Value
System.Object
Remarks
VisualId
The unique identifier of a visual.
public string VisualId { get; set; }
Property Value
System.String
Remarks
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.