Skip to content

updated docs for 1.15 release #609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
d45 merged 1 commit into from
Sep 12, 2025
Merged

updated docs for 1.15 release #609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/static/api/assets/js/search.js
View file
Open in desktop

Large diffs are not rendered by default.

42 changes: 42 additions & 0 deletions website/static/api/enums/tableau.extensioncontext.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,10 @@ <h2>Index</h2>
<section class="tsd-index-section ">
<h3>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.extensioncontext.html#cloud" class="tsd-kind-icon">Cloud</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.extensioncontext.html#desktop" class="tsd-kind-icon">Desktop</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.extensioncontext.html#publicdesktop" class="tsd-kind-icon">Public<wbr>Desktop</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.extensioncontext.html#publicweb" class="tsd-kind-icon">Public<wbr>Web</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.extensioncontext.html#server" class="tsd-kind-icon">Server</a></li>
</ul>
</section>
Expand All @@ -90,6 +93,16 @@ <h3>Enumeration members</h3>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="cloud" class="tsd-anchor"></a>
<h3>Cloud</h3>
<div class="tsd-signature tsd-kind-icon">Cloud<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;cloud&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:72</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="desktop" class="tsd-anchor"></a>
<h3>Desktop</h3>
Expand All @@ -100,6 +113,26 @@ <h3>Desktop</h3>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="publicdesktop" class="tsd-anchor"></a>
<h3>Public<wbr>Desktop</h3>
<div class="tsd-signature tsd-kind-icon">Public<wbr>Desktop<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;public-desktop&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:74</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="publicweb" class="tsd-anchor"></a>
<h3>Public<wbr>Web</h3>
<div class="tsd-signature tsd-kind-icon">Public<wbr>Web<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;public-web&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:73</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="server" class="tsd-anchor"></a>
<h3>Server</h3>
Expand Down Expand Up @@ -130,9 +163,18 @@ <h3>Server</h3>
<li class="current tsd-kind-enum tsd-parent-kind-module">
<a href="tableau.extensioncontext.html" class="tsd-kind-icon">Extension<wbr>Context</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="tableau.extensioncontext.html#cloud" class="tsd-kind-icon">Cloud</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="tableau.extensioncontext.html#desktop" class="tsd-kind-icon">Desktop</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="tableau.extensioncontext.html#publicdesktop" class="tsd-kind-icon">Public<wbr>Desktop</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="tableau.extensioncontext.html#publicweb" class="tsd-kind-icon">Public<wbr>Web</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="tableau.extensioncontext.html#server" class="tsd-kind-icon">Server</a>
</li>
Expand Down
4 changes: 2 additions & 2 deletions website/static/api/enums/tableau.extensionmode.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ <h3>Authoring</h3>
<div class="tsd-signature tsd-kind-icon">Authoring<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;authoring&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:78</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:81</li>
</ul>
</aside>
</section>
Expand All @@ -106,7 +106,7 @@ <h3>Viewing</h3>
<div class="tsd-signature tsd-kind-icon">Viewing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;viewing&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:79</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:82</li>
</ul>
</aside>
</section>
Expand Down
37 changes: 29 additions & 8 deletions website/static/api/enums/tableau.tableaueventtype.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ <h2>Index</h2>
<section class="tsd-index-section ">
<h3>All Extensions Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.tableaueventtype.html#dialogmessagereceived" class="tsd-kind-icon">Dialog<wbr>Message<wbr>Received</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.tableaueventtype.html#filterchanged" class="tsd-kind-icon">Filter<wbr>Changed</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.tableaueventtype.html#markselectionchanged" class="tsd-kind-icon">Mark<wbr>Selection<wbr>Changed</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="tableau.tableaueventtype.html#parameterchanged" class="tsd-kind-icon">Parameter<wbr>Changed</a></li>
Expand All @@ -102,13 +103,30 @@ <h3>Viz Extensions Enumeration members</h3>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>All Extensions Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="dialogmessagereceived" class="tsd-anchor"></a>
<h3>Dialog<wbr>Message<wbr>Received</h3>
<div class="tsd-signature tsd-kind-icon">Dialog<wbr>Message<wbr>Received<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;dialog-message-received&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:92</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>experimental</dt>
<dd><p>Raised when a message is received that was sent by a dialog or extension via <code>sendDialogMessageAsync</code>.</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="filterchanged" class="tsd-anchor"></a>
<h3>Filter<wbr>Changed</h3>
<div class="tsd-signature tsd-kind-icon">Filter<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;filter-changed&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:87</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:95</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -123,7 +141,7 @@ <h3>Mark<wbr>Selection<wbr>Changed</h3>
<div class="tsd-signature tsd-kind-icon">Mark<wbr>Selection<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;mark-selection-changed&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:91</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:99</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -139,7 +157,7 @@ <h3>Parameter<wbr>Changed</h3>
<div class="tsd-signature tsd-kind-icon">Parameter<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;parameter-changed&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:98</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:106</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -154,7 +172,7 @@ <h3>Settings<wbr>Changed</h3>
<div class="tsd-signature tsd-kind-icon">Settings<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;settings-changed&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:101</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:109</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -169,7 +187,7 @@ <h3>Summary<wbr>Data<wbr>Changed</h3>
<div class="tsd-signature tsd-kind-icon">Summary<wbr>Data<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;summary-data-changed&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:95</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:103</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -188,7 +206,7 @@ <h3>Dashboard<wbr>Layout<wbr>Changed</h3>
<div class="tsd-signature tsd-kind-icon">Dashboard<wbr>Layout<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;dashboard-layout-changed&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:106</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:114</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -203,7 +221,7 @@ <h3>Workbook<wbr>Formatting<wbr>Changed</h3>
<div class="tsd-signature tsd-kind-icon">Workbook<wbr>Formatting<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;workbook-formatting-changed&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:111</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:119</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -221,7 +239,7 @@ <h3>Worksheet<wbr>Formatting<wbr>Changed</h3>
<div class="tsd-signature tsd-kind-icon">Worksheet<wbr>Formatting<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;worksheet-formatting-changed&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:116</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:124</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -253,6 +271,9 @@ <h3>Worksheet<wbr>Formatting<wbr>Changed</h3>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="tableau.tableaueventtype.html#dashboardlayoutchanged" class="tsd-kind-icon">Dashboard<wbr>Layout<wbr>Changed</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="tableau.tableaueventtype.html#dialogmessagereceived" class="tsd-kind-icon">Dialog<wbr>Message<wbr>Received</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="tableau.tableaueventtype.html#filterchanged" class="tsd-kind-icon">Filter<wbr>Changed</a>
</li>
Expand Down
4 changes: 2 additions & 2 deletions website/static/api/enums/tableau.vizimageencodingtype.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h3>Continuous</h3>
<div class="tsd-signature tsd-kind-icon">Continuous<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;continuous&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:125</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:133</li>
</ul>
</aside>
</section>
Expand All @@ -111,7 +111,7 @@ <h3>Discrete</h3>
<div class="tsd-signature tsd-kind-icon">Discrete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;discrete&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:124</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:132</li>
</ul>
</aside>
</section>
Expand Down
4 changes: 2 additions & 2 deletions website/static/api/enums/tableau.vizimagepalettetype.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h3>Custom<wbr>Diverging</h3>
<div class="tsd-signature tsd-kind-icon">Custom<wbr>Diverging<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;custom-diverging&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:142</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:150</li>
</ul>
</aside>
</section>
Expand All @@ -111,7 +111,7 @@ <h3>Custom<wbr>Sequential</h3>
<div class="tsd-signature tsd-kind-icon">Custom<wbr>Sequential<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;custom-sequential&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:143</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:151</li>
</ul>
</aside>
</section>
Expand Down
6 changes: 3 additions & 3 deletions website/static/api/enums/tableau.vizimagesizesettingalignmenttype.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ <h3>Center</h3>
<div class="tsd-signature tsd-kind-icon">Center<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;center&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:162</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:170</li>
</ul>
</aside>
</section>
Expand All @@ -112,7 +112,7 @@ <h3>Left</h3>
<div class="tsd-signature tsd-kind-icon">Left<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;left&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:161</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:169</li>
</ul>
</aside>
</section>
Expand All @@ -122,7 +122,7 @@ <h3>Right</h3>
<div class="tsd-signature tsd-kind-icon">Right<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;right&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:160</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:168</li>
</ul>
</aside>
</section>
Expand Down
4 changes: 2 additions & 2 deletions website/static/api/enums/tableau.vizimagesizesettingtype.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h3>Fixed</h3>
<div class="tsd-signature tsd-kind-icon">Fixed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;fixed&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:151</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:159</li>
</ul>
</aside>
</section>
Expand All @@ -111,7 +111,7 @@ <h3>Manual</h3>
<div class="tsd-signature tsd-kind-icon">Manual<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;manual&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:152</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:160</li>
</ul>
</aside>
</section>
Expand Down
4 changes: 2 additions & 2 deletions website/static/api/enums/tableau.vizimagesortdirectiontype.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h3>Ascending</h3>
<div class="tsd-signature tsd-kind-icon">Ascending<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;ascending&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:133</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:141</li>
</ul>
</aside>
</section>
Expand All @@ -111,7 +111,7 @@ <h3>Descending</h3>
<div class="tsd-signature tsd-kind-icon">Descending<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;descending&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:134</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Tableau.ts:142</li>
</ul>
</aside>
</section>
Expand Down
Loading