--- schema_version: "1" id: 5ac4a3d6386ce6f374e6ae349ce54964f002d1c0e7a2c8ba3ef8c8be3a31e961 title: Field | Tableau Embedding API collection: tableau version: next locale: en-us portal_url: https://docs.salesforce.com/tableau/next/en-us/api/embedding_api/reference/interfaces/Field.md canonical_url: https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Field.html source_site: help.tableau.com content_type: documentation content_hash: 7eb89f4c4f687ddaadbac19f57f3c2658742c216926d0704d71281dc5c7883a2 description: Documentation for Tableau Embedding API --- - Field # Interface Field A field contains information about what data source it belongs to, its role, and the ability to fetch the domain values. interface Field {     [aggregation](#aggregation): [FieldAggregationType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/FieldAggregationType.html);     [columnType](#columntype): [ColumnType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/ColumnType.html);     [dataFormat](#dataformat)?: [DataFormat](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/types/DataFormat.html);     [dataSource](#datasource): [DataSource](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/DataSource.html);     [dataType](#datatype): undefined | [DataType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/DataType.html);     [description](#description): undefined | string;     [id](#id): string;     [isCalculatedField](#iscalculatedfield): boolean;     [isCombinedField](#iscombinedfield): boolean;     [isGenerated](#isgenerated): boolean;     [isGeospatial](#isgeospatial): boolean;     [isHidden](#ishidden): boolean;     [isPresentOnPublishedDatasource](#ispresentonpublisheddatasource): boolean;     [name](#name): string;     [role](#role): [FieldRoleType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/FieldRoleType.html);     [semanticRole](#semanticrole)?: string; } - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:283 ##### Index ### Properties [aggregation](#aggregation) [columnType](#columntype) [dataFormat?](#dataformat) [dataSource](#datasource) [dataType](#datatype) [description](#description) [id](#id) [isCalculatedField](#iscalculatedfield) [isCombinedField](#iscombinedfield) [isGenerated](#isgenerated) [isGeospatial](#isgeospatial) [isHidden](#ishidden) [isPresentOnPublishedDatasource](#ispresentonpublisheddatasource) [name](#name) [role](#role) [semanticRole?](#semanticrole) ## Properties ### `Readonly`aggregation[](#aggregation) aggregation: [FieldAggregationType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/FieldAggregationType.html) #### Returns[](#returns) The type of aggregation for this field. Inherited from FieldBase.aggregation - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:224 ### `Readonly`columnType[](#columntype) columnType: [ColumnType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/ColumnType.html) #### Returns[](#returns-1) The type of the column, either discrete or continuous. Could hold value 'Unknown'. Inherited from FieldBase.columnType - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:229 ### `Optional`dataFormat[](#dataformat) dataFormat?: [DataFormat](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/types/DataFormat.html) Data formatting options for the field. Inherited from FieldBase.dataFormat - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:276 ### `Readonly`dataSource[](#datasource) dataSource: [DataSource](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/DataSource.html) #### Returns[](#returns-2) The data source to which this field belongs. - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:292 ### `Readonly`dataType[](#datatype) dataType: undefined | [DataType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/DataType.html) #### Returns[](#returns-3) The data type of the field Inherited from FieldBase.dataType - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:214 ### `Readonly`description[](#description) description: undefined | string #### Returns[](#returns-4) User description of field, undefined if there is none. Inherited from FieldBase.description - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:209 ### `Readonly`id[](#id) id: string #### Returns[](#returns-5) Unique string representing this field in this datasource. - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:287 ### `Readonly`isCalculatedField[](#iscalculatedfield) isCalculatedField: boolean #### Returns[](#returns-6) True if this field is a table calculation. Inherited from FieldBase.isCalculatedField - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:234 ### `Readonly`isCombinedField[](#iscombinedfield) isCombinedField: boolean #### Returns[](#returns-7) True if this field is a combination of multiple fields, false otherwise. Inherited from FieldBase.isCombinedField - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:239 ### `Readonly`isGenerated[](#isgenerated) isGenerated: boolean #### Returns[](#returns-8) True if this field is generated by Tableau, false otherwise. Tableau generates a number of fields for a data source, such as Number of Records, or Measure Values. This property can be used to distinguish between those fields and fields that come from the underlying data connection, or were created by a user. Inherited from FieldBase.isGenerated - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:248 ### `Readonly`isGeospatial[](#isgeospatial) isGeospatial: boolean #### Returns[](#returns-9) True if this role has a semantic type of geospatial: e.g latitude, longitude, zipcode, City name... Inherited from FieldBase.isGeospatial - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:253 ### `Readonly`isHidden[](#ishidden) isHidden: boolean #### Returns[](#returns-10) True if this field is hidden, false otherwise. Inherited from FieldBase.isHidden - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:258 ### `Readonly`isPresentOnPublishedDatasource[](#ispresentonpublisheddatasource) isPresentOnPublishedDatasource: boolean #### Returns[](#returns-11) True if this field comes from the published datasource. False if it was created in Tableau (as a calculated field, for example). Inherited from FieldBase.isPresentOnPublishedDatasource - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:263 ### `Readonly`name[](#name) name: string #### Returns[](#returns-12) The name of the field (i.e. the caption). Inherited from FieldBase.name - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:204 ### `Readonly`role[](#role) role: [FieldRoleType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/FieldRoleType.html) #### Returns[](#returns-13) The role of this field. Inherited from FieldBase.role - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:219 ### `Optional`semanticRole[](#semanticrole) semanticRole?: string The semantic role of the field. Can be either a geographic role (e.g. latitude, longitude, city, country, etc...) or an image role Inherited from FieldBase.semanticRole - Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:270 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Properties [aggregation](#aggregation)[columnType](#columntype)[dataFormat](#dataformat)[dataSource](#datasource)[dataType](#datatype)[description](#description)[id](#id)[isCalculatedField](#iscalculatedfield)[isCombinedField](#iscombinedfield)[isGenerated](#isgenerated)[isGeospatial](#isgeospatial)[isHidden](#ishidden)[isPresentOnPublishedDatasource](#ispresentonpublisheddatasource)[name](#name)[role](#role)[semanticRole](#semanticrole)