Class CfnTopic.TopicCalculatedFieldProperty
A structure that represents a calculated field.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class TopicCalculatedFieldProperty : Object, CfnTopic.ITopicCalculatedFieldProperty
Syntax (vb)
Public Class TopicCalculatedFieldProperty
Inherits Object
Implements CfnTopic.ITopicCalculatedFieldProperty
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 topicCalculatedFieldProperty = new TopicCalculatedFieldProperty {
CalculatedFieldName = "calculatedFieldName",
Expression = "expression",
// the properties below are optional
Aggregation = "aggregation",
AllowedAggregations = new [] { "allowedAggregations" },
CalculatedFieldDescription = "calculatedFieldDescription",
CalculatedFieldSynonyms = new [] { "calculatedFieldSynonyms" },
CellValueSynonyms = new [] { new CellValueSynonymProperty {
CellValue = "cellValue",
Synonyms = new [] { "synonyms" }
} },
ColumnDataRole = "columnDataRole",
ComparativeOrder = new ComparativeOrderProperty {
SpecifedOrder = new [] { "specifedOrder" },
TreatUndefinedSpecifiedValues = "treatUndefinedSpecifiedValues",
UseOrdering = "useOrdering"
},
DefaultFormatting = new DefaultFormattingProperty {
DisplayFormat = "displayFormat",
DisplayFormatOptions = new DisplayFormatOptionsProperty {
BlankCellFormat = "blankCellFormat",
CurrencySymbol = "currencySymbol",
DateFormat = "dateFormat",
DecimalSeparator = "decimalSeparator",
FractionDigits = 123,
GroupingSeparator = "groupingSeparator",
NegativeFormat = new NegativeFormatProperty {
Prefix = "prefix",
Suffix = "suffix"
},
Prefix = "prefix",
Suffix = "suffix",
UnitScaler = "unitScaler",
UseBlankCellFormat = false,
UseGrouping = false
}
},
DisableIndexing = false,
IsIncludedInTopic = false,
NeverAggregateInFilter = false,
NonAdditive = false,
NotAllowedAggregations = new [] { "notAllowedAggregations" },
SemanticType = new SemanticTypeProperty {
FalseyCellValue = "falseyCellValue",
FalseyCellValueSynonyms = new [] { "falseyCellValueSynonyms" },
SubTypeName = "subTypeName",
TruthyCellValue = "truthyCellValue",
TruthyCellValueSynonyms = new [] { "truthyCellValueSynonyms" },
TypeName = "typeName",
TypeParameters = new Dictionary<string, string> {
{ "typeParametersKey", "typeParameters" }
}
},
TimeGranularity = "timeGranularity"
};
Synopsis
Constructors
TopicCalculatedFieldProperty() |
Properties
Aggregation | The default aggregation. |
AllowedAggregations | The list of aggregation types that are allowed for the calculated field. |
CalculatedFieldDescription | The calculated field description. |
CalculatedFieldName | The calculated field name. |
CalculatedFieldSynonyms | The other names or aliases for the calculated field. |
CellValueSynonyms | The other names or aliases for the calculated field cell value. |
ColumnDataRole | The column data role for a calculated field. |
ComparativeOrder | The order in which data is displayed for the calculated field when it's used in a comparative context. |
DefaultFormatting | The default formatting definition. |
DisableIndexing | |
Expression | The calculated field expression. |
IsIncludedInTopic | A boolean value that indicates if a calculated field is included in the topic. |
NeverAggregateInFilter | A Boolean value that indicates whether to never aggregate calculated field in filters. |
NonAdditive | The non additive for the table style target. |
NotAllowedAggregations | The list of aggregation types that are not allowed for the calculated field. |
SemanticType | The semantic type. |
TimeGranularity | The level of time precision that is used to aggregate |
Constructors
TopicCalculatedFieldProperty()
public TopicCalculatedFieldProperty()
Properties
Aggregation
The default aggregation.
public string Aggregation { get; set; }
Property Value
System.String
Remarks
Valid values for this structure are SUM
, MAX
, MIN
, COUNT
, DISTINCT_COUNT
, and AVERAGE
.
AllowedAggregations
The list of aggregation types that are allowed for the calculated field.
public string[] AllowedAggregations { get; set; }
Property Value
System.String[]
Remarks
Valid values for this structure are COUNT
, DISTINCT_COUNT
, MIN
, MAX
, MEDIAN
, SUM
, AVERAGE
, STDEV
, STDEVP
, VAR
, VARP
, and PERCENTILE
.
CalculatedFieldDescription
The calculated field description.
public string CalculatedFieldDescription { get; set; }
Property Value
System.String
Remarks
CalculatedFieldName
The calculated field name.
public string CalculatedFieldName { get; set; }
Property Value
System.String
Remarks
CalculatedFieldSynonyms
The other names or aliases for the calculated field.
public string[] CalculatedFieldSynonyms { get; set; }
Property Value
System.String[]
Remarks
CellValueSynonyms
The other names or aliases for the calculated field cell value.
public object CellValueSynonyms { get; set; }
Property Value
System.Object
Remarks
ColumnDataRole
The column data role for a calculated field.
public string ColumnDataRole { get; set; }
Property Value
System.String
Remarks
Valid values for this structure are DIMENSION
and MEASURE
.
ComparativeOrder
The order in which data is displayed for the calculated field when it's used in a comparative context.
public object ComparativeOrder { get; set; }
Property Value
System.Object
Remarks
DefaultFormatting
The default formatting definition.
public object DefaultFormatting { get; set; }
Property Value
System.Object
Remarks
DisableIndexing
public object DisableIndexing { get; set; }
Property Value
System.Object
Remarks
Expression
The calculated field expression.
public string Expression { get; set; }
Property Value
System.String
Remarks
IsIncludedInTopic
A boolean value that indicates if a calculated field is included in the topic.
public object IsIncludedInTopic { get; set; }
Property Value
System.Object
Remarks
NeverAggregateInFilter
A Boolean value that indicates whether to never aggregate calculated field in filters.
public object NeverAggregateInFilter { get; set; }
Property Value
System.Object
Remarks
NonAdditive
The non additive for the table style target.
public object NonAdditive { get; set; }
Property Value
System.Object
Remarks
NotAllowedAggregations
The list of aggregation types that are not allowed for the calculated field.
public string[] NotAllowedAggregations { get; set; }
Property Value
System.String[]
Remarks
Valid values for this structure are COUNT
, DISTINCT_COUNT
, MIN
, MAX
, MEDIAN
, SUM
, AVERAGE
, STDEV
, STDEVP
, VAR
, VARP
, and PERCENTILE
.
SemanticType
The semantic type.
public object SemanticType { get; set; }
Property Value
System.Object
Remarks
TimeGranularity
The level of time precision that is used to aggregate DateTime
values.
public string TimeGranularity { get; set; }
Property Value
System.String