Tabular Column Element
X-Ref:
- Ast Tabular Column Node
- Ast Tabular Column Base Node
- Ast Securable Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| Name | String | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property | |
| SourceColumnName | AstTableColumnBaseNode | Specifies a reference to the column in the parent table that this tabular model column will summarize. This is a required reference to an existing definiton. | |
| Alignment | TabularColumnAlignment | Default | Specifies the default alignment that should be used when presenting the value of this tabular column within data cells in a user facing application. |
| DataCategory | TabularDataCategory | Uncategorized | Specifies the category into which this tabular column should be displayed in user facing applications. |
| DataType | TabularDataType | Automatic | Specifies the SSAS tabular data type that should be used for this column. In most cases, the data type can be inferred from the SourceColumn and the SummarizeBy aggregate function. This property is used when that inferred type needs to be overridden. |
| DisplayFolder | String | Specifies the display folder for this tabular column. | |
| DisplayOrdinal | Int32 | 0 | Specifies an integer that will be used to determine the ordering of this column relative to other columns in user facing applications. |
| FormatString | String | Specifies the format to be used when presenting the value of this tabular column in reporting client tools. | |
| InferRelationships | InferRelationshipMode | None | Specifies whether or not to autocreate tabular relationships for this column. |
| IsAvailableInMDX | Boolean | True | Specifies whether or not this column is available for use in MDX queries. |
| IsHidden | Boolean | False | Specifies whether or not this tabular column is hidden from reporting client tools. |
| IsKey | Boolean | False | Specifies whether or not the column is a key of the parent table. |
| IsNullable | Boolean | False | Specifies whether or not the parent column supports null values. |
| IsUnique | Boolean | False | Specifies whether or not the column values are unique amongst themselves. |
| KeepUniqueRows | Boolean | False | Specifies whether or not values in this column should be grouped based on the corresponding values in the IdentifierColumn specified in the parent table. When true, duplicate values will not be aggregated. |
| RefreshedTime | DateTime | 1/1/0001 12:00:00 AM | Specifies the date and time at which the data in this tabular column was last refreshed from the data source. |
| SortByColumnName | AstTableColumnBaseNode | Specifies a different column in the same table that will be used to sort the values in this column. If not specified, the column will be sorted based on its own values. This references an existing definiton. | |
| SummarizeBy | TabularAggregateFunction | Default | Specifies the tabular aggregate function that should be used to summarize the values in this column. |
| TableDetailPosition | Int32 | -1 | Specifies the ordinal position of this column when used in a default field set for the parent table. If set to -1, this column will not be included in the default field set for the parent table. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <Description /> | String | String is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx. |
| <ErrorMessage /> | String | String is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx. |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <Annotations> <Annotation /> </Annotations> | AstAnnotationNode | This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code. |
| <Relationships> <Relationship /> </Relationships> | AstTabularSourcedRelationshipNode | This is a collection of the tabular column references that are defined for the parent source column and a specified target column. |