---
schema_version: "1"
id: 33eff3f180a7c6accafc99f3a2936cc7906d250175f9c07d2960d552a7cc882d
title: FieldInstance | Tableau Embedding API
collection: tableau
version: current
locale: en-us
portal_url: https://docs.salesforce.com/tableau/current/en-us/api/embedding_api/reference/interfaces/FieldInstance.md
canonical_url: https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/FieldInstance.html
source_site: help.tableau.com
content_type: documentation
content_hash: 468da0add37baa8f29d2feafd18a651b02462e3008c7ba946782bade95f8addb
description: Documentation for Tableau Embedding API
---
- FieldInstance

# Interface FieldInstance

interface FieldInstance {  
    [aggregation](#aggregation): [FieldAggregationType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FieldAggregationType.html);  
    [columnType](#columntype): [ColumnType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/ColumnType.html);  
    [dataFormat](#dataformat)?: [DataFormat](https://help.tableau.com/current/api/embedding_api/en-us/reference/types/DataFormat.html);  
    [dataType](#datatype): undefined | [DataType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/DataType.html);  
    [description](#description): undefined | string;  
    [fieldId](#fieldid): 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/current/api/embedding_api/en-us/reference/enums/FieldRoleType.html);  
    [semanticRole](#semanticrole)?: string;  
}

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/VisualModelInterface.ts:56

##### Index

### Properties

[aggregation](#aggregation) [columnType](#columntype) [dataFormat?](#dataformat) [dataType](#datatype) [description](#description) [fieldId](#fieldid) [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/current/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/current/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/current/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`dataType[](#datatype)

dataType: undefined | [DataType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/DataType.html)

#### Returns[](#returns-2)

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-3)

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`fieldId[](#fieldid)

fieldId: string

#### Returns[](#returns-4)

The unique representation of the field across all data sources in the workbook. In summary data, this includes aggregation. Note that the fieldId could change if you change the data source. For example after replacing the data source \[Clipboard\_20210305T164000\].\[sum:Sales:qk\] could become \[federated.12usuoq1171o1b1ebdyh60fjnev1\].\[sum:Sales:qk\].

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/VisualModelInterface.ts:63

### `Readonly`isCalculatedField[](#iscalculatedfield)

isCalculatedField: boolean

#### Returns[](#returns-5)

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-6)

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-7)

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-8)

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-9)

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-10)

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-11)

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/current/api/embedding_api/en-us/reference/enums/FieldRoleType.html)

#### Returns[](#returns-12)

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)[dataType](#datatype)[description](#description)[fieldId](#fieldid)[isCalculatedField](#iscalculatedfield)[isCombinedField](#iscombinedfield)[isGenerated](#isgenerated)[isGeospatial](#isgeospatial)[isHidden](#ishidden)[isPresentOnPublishedDatasource](#ispresentonpublisheddatasource)[name](#name)[role](#role)[semanticRole](#semanticrole)