Skip to content

Commit 411e365

Browse files
authored
Update column.html
1 parent 75b479f commit 411e365

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/interfaces/column.html

+8-7
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,11 @@ <h3>field<wbr>Id</h3>
121121
<div class="tsd-comment tsd-typography">
122122
<dl class="tsd-comment-tags">
123123
<dt>returns</dt>
124-
<dd><p>The fieldId of the field in the column. In summary data, this includes the aggregation.
125-
The fieldId is not stable across replacing data sources.
126-
For example after replacing the data source [Clipboard_20210305T164000].[sum:Sales:qk] could become
127-
[federated.12usuoq1171o1b1ebdyh60fjnev1].[sum:Sales:qk].</p>
124+
<dd><p>The fieldId of the field in the column. This is a calculated string that is unique across all fields and datasources in the workbook.
125+
It does not directly correspond to any other object Id - it is a combination of DataSource.id, Field.id, and Field type information.
126+
(When retrieved as summary data, this includes the aggregation.)
127+
This means the fieldID will change if the datasource is replaced: for example
128+
[Clipboard_20210305T164000].[sum:Sales:qk] could become [federated.12usuoq1171o1b1ebdyh60fjnev1].[sum:Sales:qk].</p>
128129
</dd>
129130
<dt>since</dt>
130131
<dd><p>1.5.0</p>
@@ -144,8 +145,8 @@ <h3>field<wbr>Name</h3>
144145
<div class="tsd-comment tsd-typography">
145146
<dl class="tsd-comment-tags">
146147
<dt>returns</dt>
147-
<dd><p>The name of the field in the column. In summary data, this includes the aggregation.
148-
The summary data field name is not stable across languages.
148+
<dd><p>The name of the field in the column. In summary data, this includes the aggregation as localized text, therefore
149+
the summary data field name is not stable across languages.
149150
For example, in an English version of Tableau, the field name might be SUM(Sales). In French, this would be SOMME(Sales).</p>
150151
</dd>
151152
</dl>
@@ -299,4 +300,4 @@ <h2>Legend</h2>
299300
ga('send', 'pageview');
300301
</script>
301302
</body>
302-
</html>
303+
</html>

0 commit comments

Comments
 (0)