Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Jackson Huang committed Jul 31, 2018
1 parent 529128f commit 5c6b448
Show file tree
Hide file tree
Showing 13 changed files with 52 additions and 39 deletions.
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ <h1 id="tableau-dashboard-extensions-api">Tableau Dashboard Extensions API</h1>
<td style="text-align:left">The <code>extensions</code> namespace is the namespace for Tableau extensions. A dashboard extension is one type of extension. A dashboard extension has access to the <code>dashboardContent</code> namespace, and all of the objects and classes of the dashboard. Some namespaces, like the <code>settings</code>, <code>environment</code>, and <code>ui</code> are available to all extensions.</td>
</tr>
<tr>
<td style="text-align:left"> <a href="./interfaces/dashboardContent.html">DashboardContent</a></td>
<td style="text-align:left"> <a href="./interfaces/dashboardcontent.html">DashboardContent</a></td>
<td style="text-align:left">The <code>dashboardContent</code> provides access to the dashboard object. When you have the dashboard object, you have access to all elements in the <a href="./interfaces/dashboard.html">dashboard</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 worksheets in a dashboard (after initialization), you might have a line of code that looks like the following: <br><code>worksheets = tableau.extensions.dashboardContent.dashboard.worksheets</code></td>
</tr>
<tr>
Expand Down
8 changes: 4 additions & 4 deletions docs/interfaces/connectionsummary.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ <h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:142</li>
<li>Defined in DataSourceInterfaces.ts:161</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -119,7 +119,7 @@ <h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:137</li>
<li>Defined in DataSourceInterfaces.ts:156</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -136,7 +136,7 @@ <h3>serverURI</h3>
<div class="tsd-signature tsd-kind-icon">serverURI<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:152</li>
<li>Defined in DataSourceInterfaces.ts:171</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -153,7 +153,7 @@ <h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:147</li>
<li>Defined in DataSourceInterfaces.ts:166</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/dashboard.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ <h3>remove<wbr>Event<wbr>Listener</h3>
<p>Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing.
The handler function must the handler function specified in the call to the <code>addEventListener</code> method. Alternatively, use the function
returned from the call to <code>addEventListener</code> to unregister the event listener.
For more information, see <a href="./trex_events.html">Events and Event Handling</a></p>
For more information, see <a href="../trex_events.html">Events and Event Handling</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
9 changes: 3 additions & 6 deletions docs/interfaces/dashboardcontent.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,8 @@ <h1>Interface DashboardContent</h1>
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The <code>DashboardContent</code> namespace is the namespace associated with dashboard extensions. You can use
anything in this namespace if your extensions is registered as a dashboard extension. You register an extension
as a dashboard extension in the <code>.trex</code> manifest file. The <code>&lt;dashboard-extension&gt;</code> element defines the properties
that are used to register the extension with Tableau.
The <code>DashboardContent</code> namespace contains the Dashboard interface. Use the <a href="./dashboard.html">Dashboard Interface</a> to
<p>The <code>DashboardContent</code> namespace is the namespace associated with dashboard extensions.
The <code>DashboardContent</code> namespace contains the <code>Dashboard</code> interface. Use the <a href="./dashboard.html">Dashboard Interface</a> to
access dashboard objects, worksheets, and parameters, and to add or remove event listeners.</p>
</div>
</div>
Expand Down Expand Up @@ -103,7 +100,7 @@ <h3>dashboard</h3>
<div class="tsd-signature tsd-kind-icon">dashboard<span class="tsd-signature-symbol">:</span> <a href="dashboard.html" class="tsd-signature-type">Dashboard</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Namespaces/DashboardContent.ts:16</li>
<li>Defined in Namespaces/DashboardContent.ts:13</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
18 changes: 17 additions & 1 deletion docs/interfaces/datasource.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ <h3>get<wbr>Underlying<wbr>Data<wbr>Async</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:60</li>
<li>Defined in DataSourceInterfaces.ts:79</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -264,6 +264,22 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="dat
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="datatable.html" class="tsd-signature-type">DataTable</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Returns a promise containing a page of data from the underlying data of the datasource.</p>
<p>The following example shows use of the <code>getUnderlyingDataAsync()</code> method to get the underlying data from a specific data source.
The example uses the JavaScript <code>find()</code> method to select the workbook and data source.</p>
<pre><code>tableau.extensions.dashboardContent.dashboard.worksheets.find(<span class="hljs-function"><span class="hljs-params">w</span> =&gt;</span> w.name === <span class="hljs-string">"Sale Map"</span>).getDataSourcesAsync().then(<span class="hljs-function"><span class="hljs-params">datasources</span> =&gt;</span>
{dataSource = datasources.find(<span class="hljs-function"><span class="hljs-params">datasource</span> =&gt;</span> datasource.name === <span class="hljs-string">"Sample - Superstore"</span>);
<span class="hljs-keyword">return</span> dataSource.getUnderlyingDataAsync();
}).then(<span class="hljs-function"><span class="hljs-params">dataTable</span> =&gt;</span> {
<span class="hljs-keyword">let</span> field = dataTable.columns.find(<span class="hljs-function"><span class="hljs-params">column</span> =&gt;</span> column.fieldName === <span class="hljs-string">"Sub-Category"</span>);
<span class="hljs-keyword">let</span> list = [];
<span class="hljs-keyword">for</span> (<span class="hljs-keyword">let</span> row <span class="hljs-keyword">of</span> dataTable.data) {
list.push(row[field.index].value);
}
<span class="hljs-keyword">let</span> values = list.filter(<span class="hljs-function">(<span class="hljs-params">el, i, arr</span>) =&gt;</span> arr.indexOf(el) === i);
<span class="hljs-built_in">console</span>.log(values)
});

</code></pre>
</li>
</ul>
</section>
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/datasourceunderlyingdataoptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> columns<wbr>ToInclude
<div class="tsd-signature tsd-kind-icon">columns<wbr>ToInclude<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:193</li>
<li>Defined in DataSourceInterfaces.ts:212</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -115,7 +115,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr>Aliases</h
<div class="tsd-signature tsd-kind-icon">ignore<wbr>Aliases<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:188</li>
<li>Defined in DataSourceInterfaces.ts:207</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -130,7 +130,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Rows</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Rows<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:198</li>
<li>Defined in DataSourceInterfaces.ts:217</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/eventlistenermanager.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ <h3>remove<wbr>Event<wbr>Listener</h3>
<p>Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing.
The handler function must the handler function specified in the call to the <code>addEventListener</code> method. Alternatively, use the function
returned from the call to <code>addEventListener</code> to unregister the event listener.
For more information, see <a href="./trex_events.html">Events and Event Handling</a></p>
For more information, see <a href="../trex_events.html">Events and Event Handling</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
22 changes: 11 additions & 11 deletions docs/interfaces/field.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ <h3>aggregation</h3>
<div class="tsd-signature tsd-kind-icon">aggregation<span class="tsd-signature-symbol">:</span> <a href="../enums/fieldaggregationtype.html" class="tsd-signature-type">FieldAggregationType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:115</li>
<li>Defined in DataSourceInterfaces.ts:134</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -126,7 +126,7 @@ <h3>column<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">column<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="../enums/columntype.html" class="tsd-signature-type">ColumnType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:121</li>
<li>Defined in DataSourceInterfaces.ts:140</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -145,7 +145,7 @@ <h3>data<wbr>Source</h3>
<div class="tsd-signature tsd-kind-icon">data<wbr>Source<span class="tsd-signature-symbol">:</span> <a href="datasource.html" class="tsd-signature-type">DataSource</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:86</li>
<li>Defined in DataSourceInterfaces.ts:105</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -162,7 +162,7 @@ <h3>description</h3>
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:81</li>
<li>Defined in DataSourceInterfaces.ts:100</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -179,7 +179,7 @@ <h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:76</li>
<li>Defined in DataSourceInterfaces.ts:95</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -196,7 +196,7 @@ <h3>is<wbr>Calculated<wbr>Field</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Calculated<wbr>Field<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:110</li>
<li>Defined in DataSourceInterfaces.ts:129</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -213,7 +213,7 @@ <h3>is<wbr>Combined<wbr>Field</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Combined<wbr>Field<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:126</li>
<li>Defined in DataSourceInterfaces.ts:145</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -230,7 +230,7 @@ <h3>is<wbr>Generated</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Generated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:105</li>
<li>Defined in DataSourceInterfaces.ts:124</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -251,7 +251,7 @@ <h3>is<wbr>Hidden</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Hidden<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:96</li>
<li>Defined in DataSourceInterfaces.ts:115</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -268,7 +268,7 @@ <h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:71</li>
<li>Defined in DataSourceInterfaces.ts:90</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -285,7 +285,7 @@ <h3>role</h3>
<div class="tsd-signature tsd-kind-icon">role<span class="tsd-signature-symbol">:</span> <a href="../enums/fieldroletype.html" class="tsd-signature-type">FieldRoleType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataSourceInterfaces.ts:91</li>
<li>Defined in DataSourceInterfaces.ts:110</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/parameter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ <h3>remove<wbr>Event<wbr>Listener</h3>
<p>Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing.
The handler function must the handler function specified in the call to the <code>addEventListener</code> method. Alternatively, use the function
returned from the call to <code>addEventListener</code> to unregister the event listener.
For more information, see <a href="./trex_events.html">Events and Event Handling</a></p>
For more information, see <a href="../trex_events.html">Events and Event Handling</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/sheet.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ <h3>remove<wbr>Event<wbr>Listener</h3>
<p>Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing.
The handler function must the handler function specified in the call to the <code>addEventListener</code> method. Alternatively, use the function
returned from the call to <code>addEventListener</code> to unregister the event listener.
For more information, see <a href="./trex_events.html">Events and Event Handling</a></p>
For more information, see <a href="../trex_events.html">Events and Event Handling</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
8 changes: 4 additions & 4 deletions docs/interfaces/tableauerror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ <h3>Error</h3>
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in /builds/extensibility/api-external-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:896</li>
<li>Defined in D:/dev/typescript/api-external-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:896</li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -135,7 +135,7 @@ <h3>message</h3>
<aside class="tsd-sources">
<p>Inherited from Error.message</p>
<ul>
<li>Defined in /builds/extensibility/api-external-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:886</li>
<li>Defined in D:/dev/typescript/api-external-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:886</li>
</ul>
</aside>
</section>
Expand All @@ -146,7 +146,7 @@ <h3>name</h3>
<aside class="tsd-sources">
<p>Inherited from Error.name</p>
<ul>
<li>Defined in /builds/extensibility/api-external-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:885</li>
<li>Defined in D:/dev/typescript/api-external-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:885</li>
</ul>
</aside>
</section>
Expand All @@ -158,7 +158,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<p>Inherited from Error.stack</p>
<p>Overrides Error.stack</p>
<ul>
<li>Defined in /builds/extensibility/api-external-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:887</li>
<li>Defined in D:/dev/typescript/api-external-js/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:887</li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit 5c6b448

Please sign in to comment.