Class CfnTopic.TopicColumnProperty
Represents a column in a dataset.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.AWS.QuickSight.dll
Syntax (csharp)
public class TopicColumnProperty : Object, CfnTopic.ITopicColumnProperty
Syntax (vb)
Public Class TopicColumnProperty
Inherits Object
Implements CfnTopic.ITopicColumnProperty
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 topicColumnProperty = new TopicColumnProperty {
ColumnName = "columnName",
// the properties below are optional
Aggregation = "aggregation",
AllowedAggregations = new [] { "allowedAggregations" },
CellValueSynonyms = new [] { new CellValueSynonymProperty {
CellValue = "cellValue",
Synonyms = new [] { "synonyms" }
} },
ColumnDataRole = "columnDataRole",
ColumnDescription = "columnDescription",
ColumnFriendlyName = "columnFriendlyName",
ColumnSynonyms = new [] { "columnSynonyms" },
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
}
},
IsIncludedInTopic = false,
NeverAggregateInFilter = 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
TopicColumnProperty() |
Properties
Aggregation | The type of aggregation that is performed on the column data when it's queried. |
AllowedAggregations | The list of aggregation types that are allowed for the column. |
CellValueSynonyms | The other names or aliases for the column cell value. |
ColumnDataRole | The role of the column in the data. |
ColumnDescription | A description of the column and its contents. |
ColumnFriendlyName | A user-friendly name for the column. |
ColumnName | The name of the column. |
ColumnSynonyms | The other names or aliases for the column. |
ComparativeOrder | The order in which data is displayed for the column when it's used in a comparative context. |
DefaultFormatting | The default formatting used for values in the column. |
IsIncludedInTopic | A Boolean value that indicates whether the column is included in the query results. |
NeverAggregateInFilter | A Boolean value that indicates whether to aggregate the column data when it's used in a filter context. |
NotAllowedAggregations | The list of aggregation types that are not allowed for the column. |
SemanticType | The semantic type of data contained in the column. |
TimeGranularity | The level of time precision that is used to aggregate |
Constructors
TopicColumnProperty()
public TopicColumnProperty()
Properties
Aggregation
The type of aggregation that is performed on the column data when it's queried.
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 column.
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
.
CellValueSynonyms
The other names or aliases for the column cell value.
public object CellValueSynonyms { get; set; }
Property Value
System.Object
Remarks
ColumnDataRole
The role of the column in the data.
public string ColumnDataRole { get; set; }
Property Value
System.String
Remarks
Valid values are DIMENSION
and MEASURE
.
ColumnDescription
A description of the column and its contents.
public string ColumnDescription { get; set; }
Property Value
System.String
Remarks
ColumnFriendlyName
A user-friendly name for the column.
public string ColumnFriendlyName { get; set; }
Property Value
System.String
Remarks
ColumnName
The name of the column.
public string ColumnName { get; set; }
Property Value
System.String
Remarks
ColumnSynonyms
The other names or aliases for the column.
public string[] ColumnSynonyms { get; set; }
Property Value
System.String[]
Remarks
ComparativeOrder
The order in which data is displayed for the column when it's used in a comparative context.
public object ComparativeOrder { get; set; }
Property Value
System.Object
Remarks
DefaultFormatting
The default formatting used for values in the column.
public object DefaultFormatting { get; set; }
Property Value
System.Object
Remarks
IsIncludedInTopic
A Boolean value that indicates whether the column is included in the query results.
public object IsIncludedInTopic { get; set; }
Property Value
System.Object
Remarks
NeverAggregateInFilter
A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.
public object NeverAggregateInFilter { get; set; }
Property Value
System.Object
Remarks
NotAllowedAggregations
The list of aggregation types that are not allowed for the column.
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 of data contained in the column.
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