diff --git a/docs/interfaces/column.html b/docs/interfaces/column.html index b95d01a8..3abe9a48 100644 --- a/docs/interfaces/column.html +++ b/docs/interfaces/column.html @@ -121,10 +121,11 @@

fieldId

returns
-

The fieldId of the field in the column. In summary data, this includes the aggregation. - The fieldId is not stable across replacing data sources. - For example after replacing the data source [Clipboard_20210305T164000].[sum:Sales:qk] could become - [federated.12usuoq1171o1b1ebdyh60fjnev1].[sum:Sales:qk].

+

The fieldId of the field in the column. This is a calculated string that is unique across all fields and datasources in the workbook. + It does not directly correspond to any other object Id - it is a combination of DataSource.id, Field.id, and Field type information. + (When retrieved as summary data, this includes the aggregation.) + This means the fieldID will change if the datasource is replaced: for example + [Clipboard_20210305T164000].[sum:Sales:qk] could become [federated.12usuoq1171o1b1ebdyh60fjnev1].[sum:Sales:qk].

since

1.5.0

@@ -144,8 +145,8 @@

fieldName

returns
-

The name of the field in the column. In summary data, this includes the aggregation. - The summary data field name is not stable across languages. +

The name of the field in the column. In summary data, this includes the aggregation as localized text, therefore + the summary data field name is not stable across languages. For example, in an English version of Tableau, the field name might be SUM(Sales). In French, this would be SOMME(Sales).

@@ -299,4 +300,4 @@

Legend

ga('send', 'pageview'); - \ No newline at end of file + diff --git a/docs/interfaces/field.html b/docs/interfaces/field.html index ff6c675d..3505be7d 100644 --- a/docs/interfaces/field.html +++ b/docs/interfaces/field.html @@ -187,7 +187,11 @@

id

returns
-

Unique string representing this field in this datasource.

+

String that represents this field uniquely within this datasource. It is in the format 'a:generated-id:b[:c]', + where 'generated-id' is based on the first name given to the Field and a/b/c are type information. + To match a Field to a Column, use [this.DataSource.id][this.id] == Column.id +

+
@@ -430,4 +434,4 @@

Legend

ga('send', 'pageview'); - \ No newline at end of file +