Skip to content

using the corrected file #603

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
Jun 12, 2025
Merged

using the corrected file #603

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
20 changes: 10 additions & 10 deletions website/static/api/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>Tableau Extensions</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<link rel="stylesheet" href="./assets/css/main.css">
</head>
<body>
<header>
Expand Down Expand Up @@ -51,7 +51,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
<a href="./globals.html">Globals</a>
</li>
</ul>
<h1>Tableau Extensions</h1>
Expand All @@ -67,9 +67,9 @@ <h1>Tableau Extensions API</h1>
</a>
<p>The Tableau Extensions API is a JavaScript library that is organized into namespaces that contain
the classes and methods for communicating with Tableau components. The Tableau Extensions API
library supports both dashboard extensions and viz extensions (only available in beta), although not
library supports both dashboard extensions and viz extensions, although not
all interfaces and methods apply to both extensions. For an overview of how the API is organized,
see <a href="./trex_api_about.html">Tableau Extensions API Basics</a>.</p>
see <a href="../docs/trex_api_about">Tableau Extensions API Basics</a>.</p>
<div class="alert alert-info">
<b>Note:</b> To see all the methods and properties for the Extensions API interfaces, select the <b>Inherited</b> option in the upper-right corner of your browser window. This option shows any methods and properties inherited from base classes.
</div>
Expand All @@ -94,7 +94,7 @@ <h1>Tableau Extensions API</h1>
</tr>
<tr>
<td align="left"><a href="./interfaces/worksheetcontent.html">WorksheetContent</a></td>
<td align="left"><strong>(Available to viz extensions beta only)</strong> The <code>worksheetContent</code> provides access to the worksheet object. When you have the worksheet object, you have access to all elements in the <a href="./interfaces/worksheet.html">worksheet</a>, including the <a href="./interfaces/dashboard.html#worksheets">worksheets</a>, <a href="./interfaces/markscollection.html">marks</a>, <a href="./interfaces/filter.html">filters</a>, <a href="./interfaces/parameter.html">parameters</a>, and <a href="./interfaces/datasource.html">data sources</a>. For example, to access the worksheet in a workbook (after initialization), you might have a line of code that looks like the following: <br> <code>const worksheet = tableau.extensions.worksheetContent</code></td>
<td align="left"><strong>(Available to viz extensions only)</strong> The <code>worksheetContent</code> provides access to the worksheet object. When you have the worksheet object, you have access to all elements in the <a href="./interfaces/worksheet.html">worksheet</a>, including the <a href="./interfaces/dashboard.html#worksheets">worksheets</a>, <a href="./interfaces/markscollection.html">marks</a>, <a href="./interfaces/filter.html">filters</a>, <a href="./interfaces/parameter.html">parameters</a>, and <a href="./interfaces/datasource.html">data sources</a>. For example, to access the worksheet in a workbook (after initialization), you might have a line of code that looks like the following: <br> <code>const worksheet = tableau.extensions.worksheetContent</code></td>
</tr>
<tr>
<td align="left"><a href="./interfaces/settings.html">Settings</a></td>
Expand All @@ -113,15 +113,15 @@ <h1>Tableau Extensions API</h1>
<h2>Dashboard extensions</h2>
</a>
<p>The following diagram shows the relationship between the extensions namespace and the worksheets in
the dashboard. For more information, see <a href="./trex_api_about.html">Tableau Extensions API Basics</a>.</p>
<p><img src="../assets/tab_ext_class_worksheet.png" alt="Extensions API namespace hierarchy"></p>
the dashboard. For more information, see <a href="../docs/trex_api_about">Tableau Extensions API Basics</a>.</p>
<p><img src="../img/tab_ext_class_worksheet.png" alt="Extensions API namespace hierarchy"></p>
<hr>
<a href="#viz-extensions-available-in-beta-only" id="viz-extensions-available-in-beta-only" style="color: inherit; text-decoration: none;">
<h2>Viz extensions (available in beta only)</h2>
<h2>Viz extensions</h2>
</a>
<p>The following diagram shows the relationship between the extensions namespace and the worksheets in
the workbook. For more information, see <a href="./trex_api_about.html">Tableau Extensions API Basics</a>.</p>
<p><img src="../assets/tab_viz_ext_class_worksheet.png" alt="Viz Extensions API namespace hierarchy"></p>
the workbook. For more information, see <a href="../docs/trex_api_about">Tableau Extensions API Basics</a>.</p>
<p><img src="../img/tab_viz_ext_class_worksheet.png" alt="Viz Extensions API namespace hierarchy"></p>
<!-- Copyright and build date -->
<hr>
<div style="text-align:center">
Expand Down