Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FieldInstance

since

1.11.0 Represents a field and its properties

Hierarchy

  • FieldBase
    • FieldInstance

Index

Properties

aggregation

returns

The type of aggregation for this field.

columnType

columnType: ColumnType
returns

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

dataType

dataType: DataType | undefined
returns

The data type of the field

description

description: string | undefined
returns

User description of field, undefined if there is none.

fieldId

fieldId: string
returns

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

isCalculatedField: boolean
returns

True if this field is a table calculation.

isCombinedField

isCombinedField: boolean
returns

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

isGenerated

isGenerated: boolean
returns

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

isGeospatial: boolean
returns

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

isHidden

isHidden: boolean
returns

True if this field is hidden, false otherwise.

isPresentOnPublishedDatasource

isPresentOnPublishedDatasource: boolean
returns

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

name

name: string
returns

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

role

returns

The role of this field.