Salesforce Docs Portal

FieldInstance | Tableau Embedding API

Interface FieldInstance

interface FieldInstance {
    aggregation: FieldAggregationType;
    columnType: ColumnType;
    dataFormat?: DataFormat;
    dataType: undefined | DataType;
    description: undefined | string;
    fieldId: string;
    isCalculatedField: boolean;
    isCombinedField: boolean;
    isGenerated: boolean;
    isGeospatial: boolean;
    isHidden: boolean;
    isPresentOnPublishedDatasource: boolean;
    name: string;
    role: FieldRoleType;
    semanticRole?: string;
}
Index

Properties

aggregation columnType dataFormat? dataType description fieldId isCalculatedField isCombinedField isGenerated isGeospatial isHidden isPresentOnPublishedDatasource name role semanticRole?

Properties

aggregation: FieldAggregationType

The type of aggregation for this field.

columnType: ColumnType

The type of the column, either discrete or continuous. Could hold value 'Unknown'.

dataFormat?: DataFormat

Data formatting options for the field.

dataType: undefined | DataType

The data type of the field

description: undefined | string

User description of field, undefined if there is none.

fieldId: string

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].

isCalculatedField: boolean

True if this field is a table calculation.

isCombinedField: boolean

True if this field is a combination of multiple fields, false otherwise.

isGenerated: boolean

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.

isGeospatial: boolean

True if this role has a semantic type of geospatial: e.g latitude, longitude, zipcode, City name...

isHidden: boolean

True if this field is hidden, false otherwise.

isPresentOnPublishedDatasource: boolean

True if this field comes from the published datasource. False if it was created in Tableau (as a calculated field, for example).

name: string

The name of the field (i.e. the caption).

role: FieldRoleType

The role of this field.

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

Settings

Member Visibility

On This Page

Properties